KSelectAction Class

Member Function Documentation

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

Constructs a selection action with the specified parent.

parent The action's parent object.

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

Constructs a selection action with text; a shortcut may be specified by the ampersand character (e.g. "&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...).

text The text that will be displayed.

parent The action's parent object.

KSelectAction::KSelectAction(const QIcon &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. "&Option" creates a shortcut with key O )

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

icon The icon to display.

text The text that will be displayed.

parent The action's parent object.

QAction *KSelectAction::action(int index) const

Returns the action at index, if one exists.

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.

[signal, since 6.0] void KSelectAction::actionTriggered(QAction *action)

This signal is emitted when an item is selected.

action indicates the item selected

This function was introduced in 6.0.

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

Returns the list of selectable actions

void KSelectAction::addAction(QAction *action)

Add action to the list of selectable actions.

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

Overloaded member function, provided for convenience, which creates an action from text and inserts it into the list of selectable actions.

The newly created action is checkable and not user configurable.

QAction *KSelectAction::addAction(const QIcon &icon, const QString &text)

Overloaded member function, provided for convenience, which creates an action from text and icon and inserts it into the list of selectable actions.

The newly created action is checkable and not user configurable.

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

Changes the text of item index to text .

void KSelectAction::clear()

Remove and delete all the items in this action.

See also removeAllActions().

int KSelectAction::comboWidth() const

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

This returns the maximum width set by setComboWidth

See also setComboWidth().

QAction *KSelectAction::currentAction() const

Returns the current QAction.

See also setCurrentAction.

int KSelectAction::currentItem() const

Returns the index of the current item.

See also setCurrentItem(), currentText(), and currentAction().

QString KSelectAction::currentText() const

Returns the text of the currently selected item.

See also currentItem() and currentAction().

[signal, since 5.78] void KSelectAction::indexTriggered(int index)

This signal is emitted when an item is selected.

index indicates the item selected

This function was introduced in 5.78.

[virtual, since 5.0] void KSelectAction::insertAction(QAction *before, QAction *action)

Inserts the action action to this widget's list of actions, before the action before. It appends the action if before is a null pointer or before is not a valid action for this widget.

This function was introduced in 5.0.

bool KSelectAction::isEditable() const

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

Returns true if the combo editable.

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().

See also setItems().

bool KSelectAction::menuAccelsEnabled() const

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

See also setMenuAccelsEnabled().

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

Remove the specified action from this action selector.

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

void KSelectAction::removeAllActions()

Remove all the items in this action.

Unlike clear(), this will not delete the actions.

See also clear().

QActionGroup *KSelectAction::selectableActionGroup() const

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

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).

See also comboWidth().

bool KSelectAction::setCurrentAction(QAction *action)

Sets the currently checked item.

action the QAction to become the currently checked item.

Returns true if a corresponding action was found and successfully checked.

See also currentAction().

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

Overloaded member function, provided for convenience, to set the currently checked action to be the action which has text as its text().

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

bool KSelectAction::setCurrentItem(int index)

Convenience function to set the currently checked action to be the action at index index.

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

See also currentItem().

void KSelectAction::setEditable(bool)

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

This makes the combo editable or read-only.

See also isEditable().

void KSelectAction::setItems(const QStringList &lst)

Convenience function to create the list of selectable items.

Any previously existing items will be cleared.

See also items().

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

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.

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

See also menuAccelsEnabled().

void KSelectAction::setToolBarMode(KSelectAction::ToolBarMode mode)

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

See also toolBarMode().

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

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

See also toolButtonPopupMode().

[virtual protected slot, since 6.0] void KSelectAction::slotActionTriggered(QAction *action)

This function is called whenever an action from the selections is triggered. The default implementation calls trigger() if isCheckable() is true, then emits the signals actionTriggered(QAction *), indexTriggered(int) and textTriggered(const QString &).

This function was introduced in 6.0.

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

For structured menu building. Deselects all items if the action was unchecked by the top menu

[signal, since 5.78] void KSelectAction::textTriggered(const QString &text)

This signal is emitted when an item is selected.

text indicates the item selected

This function was introduced in 5.78.

KSelectAction::ToolBarMode KSelectAction::toolBarMode() const

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

See also setToolBarMode().

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 setToolButtonPopupMode() and QToolButton::setPopupMode().