KSelectAction

Search for usage in LXR

#include <KSelectAction>

Inheritance diagram for KSelectAction:

Public Types

enum  ToolBarMode { MenuMode, ComboBoxMode }
 
- Public Types inherited from QAction
enum  ActionEvent
 
enum  MenuRole
 
enum  Priority
 

Properties

int comboWidth
 
QAction currentAction
 
int currentItem
 
QString currentText
 
bool editable
 
QStringList items
 
ToolBarMode toolBarMode
 
QToolButton::ToolButtonPopupMode toolButtonPopupMode
 
- Properties inherited from QAction
 autoRepeat
 
 checkable
 
 checked
 
 enabled
 
 font
 
 icon
 
 iconText
 
 iconVisibleInMenu
 
 menuRole
 
 priority
 
 shortcut
 
 shortcutContext
 
 shortcutVisibleInContextMenu
 
 statusTip
 
 text
 
 toolTip
 
 visible
 
 whatsThis
 
- Properties inherited from QObject
 objectName
 

Signals

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

Public Member Functions

 KSelectAction (QObject *parent)
 
 KSelectAction (const QString &text, QObject *parent)
 
 KSelectAction (const QIcon &icon, const QString &text, QObject *parent)
 
 ~KSelectAction () override
 
QActionaction (int index) const
 
QActionaction (const QString &text, Qt::CaseSensitivity cs=Qt::CaseSensitive) const
 
QList< QAction * > actions () const
 
void addAction (QAction *action)
 
QActionaddAction (const QString &text)
 
QActionaddAction (const QIcon &icon, const QString &text)
 
void changeItem (int index, const QString &text)
 
void clear ()
 
int comboWidth () const
 
QActioncurrentAction () const
 
int currentItem () const
 
QString currentText () const
 
virtual void insertAction (QAction *before, QAction *action)
 
bool isEditable () const
 
QStringList items () const
 
bool menuAccelsEnabled () const
 
virtual QActionremoveAction (QAction *action)
 
void removeAllActions ()
 
QActionGroupselectableActionGroup () const
 
void setComboWidth (int width)
 
bool setCurrentAction (QAction *action)
 
bool setCurrentAction (const QString &text, Qt::CaseSensitivity cs=Qt::CaseSensitive)
 
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
 
- Public Member Functions inherited from QWidgetAction
 QWidgetAction (QObject *parent)
 
QWidgetdefaultWidget () const const
 
void releaseWidget (QWidget *widget)
 
QWidgetrequestWidget (QWidget *parent)
 
void setDefaultWidget (QWidget *widget)
 
- Public Member Functions inherited from QAction
 QAction (QObject *parent)
 
 QAction (const QString &text, QObject *parent)
 
 QAction (const QIcon &icon, const QString &text, QObject *parent)
 
QActionGroupactionGroup () const const
 
void activate (QAction::ActionEvent event)
 
QList< QGraphicsWidget * > associatedGraphicsWidgets () const const
 
QList< QWidget * > associatedWidgets () const const
 
bool autoRepeat () const const
 
void changed ()
 
QVariant data () const const
 
QFont font () const const
 
void hover ()
 
void hovered ()
 
QIcon icon () const const
 
QString iconText () const const
 
bool isCheckable () const const
 
bool isChecked () const const
 
bool isEnabled () const const
 
bool isIconVisibleInMenu () const const
 
bool isSeparator () const const
 
bool isShortcutVisibleInContextMenu () const const
 
bool isVisible () const const
 
QMenumenu () const const
 
QAction::MenuRole menuRole () const const
 
QWidgetparentWidget () const const
 
QAction::Priority priority () const const
 
void setActionGroup (QActionGroup *group)
 
void setAutoRepeat (bool)
 
void setCheckable (bool)
 
void setChecked (bool)
 
void setData (const QVariant &userData)
 
void setDisabled (bool b)
 
void setEnabled (bool)
 
void setFont (const QFont &font)
 
void setIcon (const QIcon &icon)
 
void setIconText (const QString &text)
 
void setIconVisibleInMenu (bool visible)
 
void setMenu (QMenu *menu)
 
void setMenuRole (QAction::MenuRole menuRole)
 
void setPriority (QAction::Priority priority)
 
void setSeparator (bool b)
 
void setShortcut (const QKeySequence &shortcut)
 
void setShortcutContext (Qt::ShortcutContext context)
 
void setShortcuts (const QList< QKeySequence > &shortcuts)
 
void setShortcuts (QKeySequence::StandardKey key)
 
void setShortcutVisibleInContextMenu (bool show)
 
void setStatusTip (const QString &statusTip)
 
void setText (const QString &text)
 
void setToolTip (const QString &tip)
 
void setVisible (bool)
 
void setWhatsThis (const QString &what)
 
QKeySequence shortcut () const const
 
Qt::ShortcutContext shortcutContext () const const
 
QList< QKeySequenceshortcuts () const const
 
bool showStatusText (QWidget *widget)
 
QString statusTip () const const
 
QString text () const const
 
void toggle ()
 
void toggled (bool checked)
 
QString toolTip () const const
 
void trigger ()
 
void triggered (bool checked)
 
QString whatsThis () const const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Slots

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

Protected Member Functions

 KSelectAction (KSelectActionPrivate &dd, QObject *parent)
 
QWidgetcreateWidget (QWidget *parent) override
 
void deleteWidget (QWidget *widget) override
 
bool event (QEvent *event) override
 
bool eventFilter (QObject *watched, QEvent *event) override
 
- Protected Member Functions inherited from QWidgetAction
QList< QWidget * > createdWidgets () const const
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Protected Attributes

std::unique_ptr< class KSelectActionPrivate > const d_ptr
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QAction
 AboutQtRole
 
 AboutRole
 
 ApplicationSpecificRole
 
 HighPriority
 
 Hover
 
 LowPriority
 
 NormalPriority
 
 NoRole
 
 PreferencesRole
 
 QuitRole
 
 TextHeuristicRole
 
 Trigger
 
- Public Attributes inherited from QObject
typedef QObjectList
 

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 44 of file kselectaction.h.

Member Enumeration Documentation

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 96 of file kselectaction.h.

Constructor & Destructor Documentation

KSelectAction::KSelectAction ( QObject parent)
explicit

Constructs a selection action with the specified parent.

Parameters
parentThe action's parent object.

Definition at line 52 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. "&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
textThe text that will be displayed.
parentThe action's parent object.

Definition at line 57 of file kselectaction.cpp.

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.

Parameters
iconThe icon to display.
textThe text that will be displayed.
parentThe action's parent object.

Definition at line 63 of file kselectaction.cpp.

KSelectAction::~KSelectAction ( )
override

Destructor.

Definition at line 78 of file kselectaction.cpp.

KSelectAction::KSelectAction ( KSelectActionPrivate &  dd,
QObject parent 
)
protected

Creates a new KSelectAction object.

Parameters
ddthe private d member
parentThe action's parent object.

Definition at line 70 of file kselectaction.cpp.

Member Function Documentation

QAction * KSelectAction::action ( int  index) const

Returns the action at index, if one exists.

Definition at line 159 of file kselectaction.cpp.

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 168 of file kselectaction.cpp.

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

Returns the list of selectable actions.

Definition at line 102 of file kselectaction.cpp.

void KSelectAction::actionTriggered ( QAction action)
protectedvirtualslot

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 triggered(QAction *), triggered(int) and triggered(const QString &) as well as since 5.78 the signals indexTriggered(int) and textTriggered(const QString &).

Definition at line 315 of file kselectaction.cpp.

void KSelectAction::addAction ( QAction action)

Add action to the list of selectable actions.

Definition at line 235 of file kselectaction.cpp.

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.

Definition at line 240 of file kselectaction.cpp.

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.

Definition at line 257 of file kselectaction.cpp.

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

Changes the text of item.

Parameters
indexto
text.

Definition at line 353 of file kselectaction.cpp.

void KSelectAction::clear ( )

Remove and delete all the items in this action.

See also
removeAllActions()

Definition at line 391 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)
overrideprotectedvirtual

Reimplemented from QWidgetAction.

Reimplemented from QWidgetAction.

Definition at line 521 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
currentText(), currentAction()
QString KSelectAction::currentText ( ) const

Returns the text of the currently selected item.

See also
currentItem(), currentAction()
void KSelectAction::deleteWidget ( QWidget widget)
overrideprotectedvirtual

Reimplemented from QWidgetAction.

Reimplemented from QWidgetAction.

Definition at line 599 of file kselectaction.cpp.

void KSelectAction::indexTriggered ( int  index)
signal

This signal is emitted when an item is selected.

Parameters
indexindicates the item selected

In your KSelectAction subclass to be backward-compatible to KF < 5.78, emit instead just the deprecated signal triggered(int). That will also automatically emit indexTriggered(int) because this signal is connected to the deprecated one in the KSelectAction constructor. Only if you compile against a variant of KWidgetsAddons built without all API deprecated up to version 5.78, then emit this signal directly. Your code would be like this:

const int index = selectableActionGroup()->actions().indexOf(action);
#if KWIDGETSADDONS_BUILD_DEPRECATED_SINCE(5, 78)
// will also indirectly emit indexTriggered since 5.78
Q_EMIT triggered(index);
#else
#endif
Since
5.78
void KSelectAction::insertAction ( QAction before,
QAction action 
)
virtual

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.

Since
5.0

Definition at line 293 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 431 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 515 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 264 of file kselectaction.cpp.

void KSelectAction::removeAllActions ( )

Remove all the items in this action.

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

See also
clear()

Definition at line 411 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 96 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 201 of file kselectaction.cpp.

bool KSelectAction::setCurrentAction ( QAction action)

Sets the currently checked item.

Parameters
actionthe QAction to become the currently checked item.
Returns
true if a corresponding action was found and successfully checked.

Definition at line 126 of file kselectaction.cpp.

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

Definition at line 195 of file kselectaction.cpp.

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

Definition at line 153 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 419 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 364 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 217 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
btrue if ampersands indicate a keyboard accelerator, otherwise false.

Definition at line 509 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 451 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 463 of file kselectaction.cpp.

void KSelectAction::slotToggled ( bool  checked)
protectedslot

For structured menu building.

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

Definition at line 437 of file kselectaction.cpp.

void KSelectAction::textTriggered ( const QString text)
signal

This signal is emitted when an item is selected.

Parameters
textindicates the item selected

In your KSelectAction subclass to be backward-compatible to KF < 5.78, emit instead just the deprecated signal triggered(const QString &). That will also automatically emit textTriggered(const QString &) because this signal is connected to the deprecated one in the KSelectAction constructor. Only if you compile against a variant of KWidgetsAddons built without all API deprecated up to version 5.78, then emit this signal directly. Your code would be like this:

#if KWIDGETSADDONS_BUILD_DEPRECATED_SINCE(5, 78)
// will also indirectly emit textTriggered since 5.78
#else
#endif
Since
5.78
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 ( QAction action)
signal

This signal is emitted when an item is selected.

Parameters
actionindicates the item selected
void KSelectAction::triggered ( int  index)
signal

This signal is emitted when an item is selected.

Parameters
indexindicates the item selected
Deprecated:
Since 5.78, use indexTriggered(int)
void KSelectAction::triggered ( const QString text)
signal

This signal is emitted when an item is selected.

Parameters
textindicates the item selected
Deprecated:
Since 5.78, use textTriggered(const QString &)

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue May 11 2021 22:44:02 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.