• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KSelectAction Class Reference

#include <kselectaction.h>

Inheritance diagram for KSelectAction:

Inheritance graph
[legend]

List of all members.


Detailed Description

Action for selecting one of several items.

Action for selecting one of several items.

This action shows up a submenu with a list of items. One of them can be checked. If the user clicks on an item this item will automatically be checked, the formerly checked item becomes unchecked. There can be only one item checked at a time.

Definition at line 51 of file kselectaction.h.


Public Types

enum  ToolBarMode { MenuMode, ComboBoxMode }

Signals

void triggered (const QString &text)
void triggered (int index)
void triggered (QAction *action)

Public Member Functions

QAction * action (const QString &text, Qt::CaseSensitivity cs=Qt::CaseSensitive) const
QAction * action (int index) const
QList< QAction * > actions () const
KAction * addAction (const KIcon &icon, const QString &text)
KAction * addAction (const QString &text)
virtual void addAction (QAction *action)
void changeItem (int index, const QString &text)
void clear ()
int comboWidth () const
QAction * currentAction () const
int currentItem () const
QString currentText () const
bool isEditable () const
QStringList items () const
 KSelectAction (const KIcon &icon, const QString &text, QObject *parent)
 KSelectAction (const QString &text, QObject *parent)
 KSelectAction (QObject *parent)
bool menuAccelsEnabled () const
virtual QAction * removeAction (QAction *action)
void removeAllActions ()
QActionGroup * selectableActionGroup () const
void setComboWidth (int width)
bool setCurrentAction (const QString &text, Qt::CaseSensitivity cs=Qt::CaseSensitive)
bool setCurrentAction (QAction *action)
bool setCurrentItem (int index)
void setEditable (bool)
void setItems (const QStringList &lst)
void setMaxComboViewCount (int n)
void setMenuAccelsEnabled (bool b)
void setToolBarMode (ToolBarMode mode)
void setToolButtonPopupMode (QToolButton::ToolButtonPopupMode mode)
ToolBarMode toolBarMode () const
QToolButton::ToolButtonPopupMode toolButtonPopupMode () const
virtual ~KSelectAction ()

Protected Slots

virtual void actionTriggered (QAction *action)
void slotToggled (bool)

Protected Member Functions

virtual QWidget * createWidget (QWidget *parent)
virtual void deleteWidget (QWidget *widget)
virtual bool eventFilter (QObject *watched, QEvent *event)
 KSelectAction (KSelectActionPrivate &dd, QObject *parent)

Protected Attributes

KSelectActionPrivate * d_ptr

Properties

int comboWidth
QAction currentAction
int currentItem
QString currentText
bool editable
QStringList items
ToolBarMode toolBarMode
QToolButton::ToolButtonPopupMode toolButtonPopupMode

Member Enumeration Documentation

enum KSelectAction::ToolBarMode

Enumerator:
MenuMode  Creates a button which pops up a menu when interacted with, as defined by toolButtonPopupMode().
ComboBoxMode  Creates a combo box which contains the actions.

This is the default.

Definition at line 106 of file kselectaction.h.


Constructor & Destructor Documentation

KSelectAction::KSelectAction ( QObject *  parent  )  [explicit]

Constructs a selection action with the specified parent.

Parameters:
parent The action's parent object.

Definition at line 64 of file kselectaction.cpp.

KSelectAction::KSelectAction ( const QString &  text,
QObject *  parent 
)

Constructs a selection action with text; a shortcut may be specified by the ampersand character (e.g.

"&amp;Option" creates a shortcut with key O )

This is the most common KSelectAction used when you do not have a corresponding icon (note that it won't appear in the current version of the "Edit ToolBar" dialog, because an action needs an icon to be plugged in a toolbar...).

Parameters:
text The text that will be displayed.
parent The action's parent object.

Definition at line 72 of file kselectaction.cpp.

KSelectAction::KSelectAction ( const KIcon &  icon,
const QString &  text,
QObject *  parent 
)

Constructs a selection action with text and an icon; a shortcut may be specified by the ampersand character (e.g.

"&amp;Option" creates a shortcut with key O )

This is the other common KSelectAction used. Use it when you do have a corresponding icon.

Parameters:
icon The icon to display.
text The text that will be displayed.
parent The action's parent object.

Definition at line 81 of file kselectaction.cpp.

KSelectAction::~KSelectAction (  )  [virtual]

Destructor.

Definition at line 97 of file kselectaction.cpp.

KSelectAction::KSelectAction ( KSelectActionPrivate &  dd,
QObject *  parent 
) [protected]

For internal use only.

Creates a new KSelectAction object.

Parameters:
dd the private d member
parent The action's parent object.

Definition at line 89 of file kselectaction.cpp.


Member Function Documentation

QAction * KSelectAction::action ( const QString &  text,
Qt::CaseSensitivity  cs = Qt::CaseSensitive 
) const

Searches for an action with the specified text, using a search whose case sensitivity is defined by cs.

Definition at line 177 of file kselectaction.cpp.

QAction * KSelectAction::action ( int  index  )  const

Returns the action at index, if one exists.

Definition at line 169 of file kselectaction.cpp.

QList< QAction * > KSelectAction::actions (  )  const

Returns the list of selectable actions.

Definition at line 117 of file kselectaction.cpp.

void KSelectAction::actionTriggered ( QAction *  action  )  [protected, virtual, slot]

This function is called whenever an action from the selections is triggered.

Reimplemented in KCodecAction, and KFontSizeAction.

Definition at line 299 of file kselectaction.cpp.

KAction * KSelectAction::addAction ( const KIcon &  icon,
const QString &  text 
)

Definition at line 271 of file kselectaction.cpp.

KAction * KSelectAction::addAction ( const QString &  text  ) 

Definition at line 254 of file kselectaction.cpp.

KSelectAction::addAction ( QAction *  action  )  [virtual]

Add action to the list of selectable actions.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

The newly created action is checkable and not user configurable.

Definition at line 237 of file kselectaction.cpp.

void KSelectAction::changeItem ( int  index,
const QString &  text 
)

Changes the text of item.

Parameters:
index to
text .

Definition at line 327 of file kselectaction.cpp.

void KSelectAction::clear (  ) 

Clears up all the items in this action.

Warning:
The actions will be deleted for backwards compatibility with KDE3. If you just want to remove all actions, use removeAllActions()

Reimplemented in KRecentFilesAction.

Definition at line 366 of file kselectaction.cpp.

int KSelectAction::comboWidth (  )  const

When this action is plugged into a toolbar, it creates a combobox.

This returns the maximum width set by setComboWidth

QWidget * KSelectAction::createWidget ( QWidget *  parent  )  [protected, virtual]

Reimplemented from.

See also:
QWidgetAction.

Reimplemented from QWidgetAction.

Reimplemented in KFontAction.

Definition at line 500 of file kselectaction.cpp.

QAction* KSelectAction::currentAction (  )  const

Returns the current QAction.

See also:
setCurrentAction

int KSelectAction::currentItem (  )  const

Returns the index of the current item.

See also:
currentItem and currentAction

QString KSelectAction::currentText (  )  const

Returns the text of the currently selected item.

See also:
currentItem and currentAction

void KSelectAction::deleteWidget ( QWidget *  widget  )  [protected, virtual]

Reimplemented from.

See also:
QWidgetAction.

Reimplemented from QWidgetAction.

Definition at line 554 of file kselectaction.cpp.

bool KSelectAction::eventFilter ( QObject *  watched,
QEvent *  event 
) [protected, virtual]

Definition at line 610 of file kselectaction.cpp.

bool KSelectAction::isEditable (  )  const

When this action is plugged into a toolbar, it creates a combobox.

Returns:
true if the combo editable.

Definition at line 405 of file kselectaction.cpp.

QStringList KSelectAction::items (  )  const

Convenience function which returns the items that can be selected with this action.

It is the same as iterating selectableActionGroup()->actions() and looking at each action's text().

bool KSelectAction::menuAccelsEnabled (  )  const

Returns whether ampersands passed to methods using QStrings are interpreted as keyboard accelerator indicators or as literal ampersands.

Definition at line 494 of file kselectaction.cpp.

QAction * KSelectAction::removeAction ( QAction *  action  )  [virtual]

Remove the specified action from this action selector.

You take ownership here, so save or delete it in order to not leak the action.

Reimplemented in KRecentFilesAction.

Definition at line 278 of file kselectaction.cpp.

void KSelectAction::removeAllActions (  ) 

Definition at line 387 of file kselectaction.cpp.

QActionGroup * KSelectAction::selectableActionGroup (  )  const

The action group used to create exclusivity between the actions associated with this action.

Definition at line 111 of file kselectaction.cpp.

void KSelectAction::setComboWidth ( int  width  ) 

When this action is plugged into a toolbar, it creates a combobox.

This gives a _maximum_ size to the combobox. The minimum size is automatically given by the contents (the items).

Definition at line 208 of file kselectaction.cpp.

bool KSelectAction::setCurrentAction ( const QString &  text,
Qt::CaseSensitivity  cs = Qt::CaseSensitive 
)

Definition at line 202 of file kselectaction.cpp.

KSelectAction::setCurrentAction ( QAction *  action  ) 

Sets the currently checked item.

Parameters:
action the QAction to become the currently checked item.
Returns:
true if a corresponding action was found and successfully checked.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

If there is no action at that index, the currently checked action (if any) will be deselected.

Returns:
true if a corresponding action was found and thus set to the current action, otherwise false
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

If there is no action at that index, the currently checked action (if any) will be deselected.

Returns:
true if a corresponding action was found, otherwise false

Definition at line 140 of file kselectaction.cpp.

bool KSelectAction::setCurrentItem ( int  index  ) 

Definition at line 163 of file kselectaction.cpp.

void KSelectAction::setEditable ( bool  edit  ) 

When this action is plugged into a toolbar, it creates a combobox.

This makes the combo editable or read-only.

Definition at line 394 of file kselectaction.cpp.

void KSelectAction::setItems ( const QStringList &  lst  ) 

Convenience function to create the list of selectable items.

Any previously existing items will be cleared.

Definition at line 339 of file kselectaction.cpp.

void KSelectAction::setMaxComboViewCount ( int  n  ) 

Sets the maximum items that are visible at once if the action is a combobox, that is the number of items in the combobox's viewport.

Definition at line 222 of file kselectaction.cpp.

void KSelectAction::setMenuAccelsEnabled ( bool  b  ) 

Sets whether any occurrence of the ampersand character ( & ) in items should be interpreted as keyboard accelerator for items displayed in a menu or not.

Only applies to (overloaded) methods dealing with QStrings, not those dealing with QActions.

Defaults to true.

Parameters:
b true if ampersands indicate a keyboard accelerator, otherwise false.

Definition at line 488 of file kselectaction.cpp.

void KSelectAction::setToolBarMode ( ToolBarMode  mode  ) 

Set the type of widget to be inserted in a toolbar to mode.

Definition at line 424 of file kselectaction.cpp.

void KSelectAction::setToolButtonPopupMode ( QToolButton::ToolButtonPopupMode  mode  ) 

Set how this list of actions should behave when in popup mode and plugged into a toolbar.

Definition at line 436 of file kselectaction.cpp.

void KSelectAction::slotToggled ( bool  checked  )  [protected, slot]

For structured menu building.

Deselects all items if the action was unchecked by the top menu

Definition at line 411 of file kselectaction.cpp.

ToolBarMode KSelectAction::toolBarMode (  )  const

Returns which type of widget (combo box or button with drop-down menu) will be inserted in a toolbar.

QToolButton::ToolButtonPopupMode KSelectAction::toolButtonPopupMode (  )  const

Returns the style for the list of actions, when this action is plugged into a KToolBar.

The default value is QToolButton::InstantPopup

See also:
QToolButton::setPopupMode()

void KSelectAction::triggered ( const QString &  text  )  [signal]

This signal is emitted when an item is selected;.

Parameters:
text indicates the item selected.

Reimplemented in KCodecAction.

void KSelectAction::triggered ( int  index  )  [signal]

This signal is emitted when an item is selected;.

Parameters:
index indicates the item selected.

void KSelectAction::triggered ( QAction *  action  )  [signal]

This signal is emitted when an item is selected;.

Parameters:
action indicates the item selected.


Member Data Documentation

KSelectActionPrivate* KSelectAction::d_ptr [protected]

Definition at line 374 of file kselectaction.h.


Property Documentation

int KSelectAction::comboWidth [read, write]

Definition at line 56 of file kselectaction.h.

QAction * KSelectAction::currentAction [read, write]

Definition at line 54 of file kselectaction.h.

int KSelectAction::currentItem [read, write]

Definition at line 61 of file kselectaction.h.

QString KSelectAction::currentText [read]

Definition at line 57 of file kselectaction.h.

bool KSelectAction::editable [read, write]

Definition at line 55 of file kselectaction.h.

QStringList KSelectAction::items [read, write]

Definition at line 62 of file kselectaction.h.

KSelectAction::ToolBarMode KSelectAction::toolBarMode [read, write]

Definition at line 59 of file kselectaction.h.

QToolButton::ToolButtonPopupMode KSelectAction::toolButtonPopupMode [read, write]

Definition at line 60 of file kselectaction.h.


The documentation for this class was generated from the following files:
  • kselectaction.h
  • kselectaction.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal