KActionSelector Class
A widget for selecting and arranging actions/objects. More...
| Header: | #include <KActionSelector> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS WidgetsAddons)target_link_libraries(mytarget PRIVATE KF6::WidgetsAddons) |
| Inherits: | QWidget |
Public Types
| enum | InsertionPolicy { BelowCurrent, Sorted, AtTop, AtBottom } |
| enum | MoveButton { ButtonAdd, ButtonRemove, ButtonUp, ButtonDown } |
Properties
|
|
Public Functions
| KActionSelector(QWidget *parent = nullptr) | |
| KActionSelector::InsertionPolicy | availableInsertionPolicy() const |
| QString | availableLabel() const |
| QListWidget * | availableListWidget() const |
| bool | keyboardEnabled() const |
| bool | moveOnDoubleClick() const |
| KActionSelector::InsertionPolicy | selectedInsertionPolicy() const |
| QString | selectedLabel() const |
| QListWidget * | selectedListWidget() const |
| void | setAvailableInsertionPolicy(KActionSelector::InsertionPolicy policy) |
| void | setAvailableLabel(const QString &text) |
| void | setButtonIcon(const QString &icon, KActionSelector::MoveButton button) |
| void | setButtonIconSet(const QIcon &iconset, KActionSelector::MoveButton button) |
| void | setButtonTooltip(const QString &tip, KActionSelector::MoveButton button) |
| void | setButtonWhatsThis(const QString &text, KActionSelector::MoveButton button) |
| void | setKeyboardEnabled(bool enable) |
| void | setMoveOnDoubleClick(bool enable) |
| void | setSelectedInsertionPolicy(KActionSelector::InsertionPolicy policy) |
| void | setSelectedLabel(const QString &text) |
| void | setShowUpDownButtons(bool show) |
| bool | showUpDownButtons() const |
Public Slots
| void | setButtonsEnabled() |
Signals
| void | added(QListWidgetItem *item) |
| void | movedDown(QListWidgetItem *item) |
| void | movedUp(QListWidgetItem *item) |
| void | removed(QListWidgetItem *item) |
Detailed Description
This widget allows the user to select from a set of objects and arrange the order of the selected ones using two list boxes labeled "Available" and "Used" with horizontal arrows in between to move selected objects between the two, and vertical arrows on the right to arrange the order of the selected objects.
The widget moves objects to the other listbox when doubleclicked if the property moveOnDoubleClick is set to true (default). See moveOnDoubleClick() and setMoveOnDoubleClick().
The user control the widget using the keyboard if enabled (default), see keyboardEnabled.
Note that this may conflict with keyboard selection in the selected list box, if you set that to anything else than QListWidget::Single (which is the default).
To use it, simply construct an instance and then add items to the two listboxes, available through lbAvailable() and lbSelected(). Whenever you want, you can retrieve the selected options using QListWidget methods on lbSelected().
This way, you can use your own QListWidgetItem class, allowing you to easily store object data in those.
When an item is moved to a listbox, it is placed below the current item of that listbox.
Standard arrow icons are used, but you can use icons of your own choice if desired, see setButtonIcon(). It is also possible to set tooltips and whatsthis help for the buttons. See setButtonTooltip() and setButtonWhatsThis().
To set whatsthis or tooltips for the listboxes, access them through availableListWidget() and selectedListWidget().
All the moving buttons are automatically set enabled as expected.
Signals are sent each time an item is moved, allowing you to follow the users actions if you need to. See addedToSelection(), removedFromSelection(), movedUp() and movedDown()
Member Type Documentation
enum KActionSelector::InsertionPolicy
This enum defines policies for where to insert moved items in a listbox.
| Constant | Value | Description |
|---|---|---|
KActionSelector::BelowCurrent | 0 | The item is inserted below the listbox' currentItem() or at the end if there is no current item. |
KActionSelector::Sorted | 1 | The listbox is sort()ed after one or more items are inserted. |
KActionSelector::AtTop | 2 | The item is inserted at index 0 in the listbox. |
KActionSelector::AtBottom | 3 | The item is inserted at the end of the listbox. |
See also availableInsertionPolicy(), setAvailableInsertionPolicy(), selectedInsertionPolicy(), and setSelectedInsertionPolicy().
enum KActionSelector::MoveButton
This enum identifies the moving buttons
| Constant | Value |
|---|---|
KActionSelector::ButtonAdd | 0 |
KActionSelector::ButtonRemove | 1 |
KActionSelector::ButtonUp | 2 |
KActionSelector::ButtonDown | 3 |
Property Documentation
availableInsertionPolicy : InsertionPolicy
Access functions:
| KActionSelector::InsertionPolicy | availableInsertionPolicy() const |
| void | setAvailableInsertionPolicy(KActionSelector::InsertionPolicy policy) |
availableLabel : QString
Access functions:
| QString | availableLabel() const |
| void | setAvailableLabel(const QString &text) |
keyboardEnabled : bool
Access functions:
| bool | keyboardEnabled() const |
| void | setKeyboardEnabled(bool enable) |
moveOnDoubleClick : bool
Access functions:
| bool | moveOnDoubleClick() const |
| void | setMoveOnDoubleClick(bool enable) |
selectedInsertionPolicy : InsertionPolicy
Access functions:
| KActionSelector::InsertionPolicy | selectedInsertionPolicy() const |
| void | setSelectedInsertionPolicy(KActionSelector::InsertionPolicy policy) |
selectedLabel : QString
Access functions:
| QString | selectedLabel() const |
| void | setSelectedLabel(const QString &text) |
showUpDownButtons : bool
Access functions:
| bool | showUpDownButtons() const |
| void | setShowUpDownButtons(bool show) |
Member Function Documentation
[explicit] KActionSelector::KActionSelector(QWidget *parent = nullptr)
[signal] void KActionSelector::added(QListWidgetItem *item)
Emitted when an item is moved to the "selected" listbox.
KActionSelector::InsertionPolicy KActionSelector::availableInsertionPolicy() const
Returns The current insertion policy for the available listbox.
The default policy for the available listbox is Sorted.
Note: Getter function for property availableInsertionPolicy.
See also InsertionPolicy and setAvailableInsertionPolicy().
QString KActionSelector::availableLabel() const
Returns The text of the label for the available items listbox.
Note: Getter function for property availableLabel.
See also setAvailableLabel().
QListWidget *KActionSelector::availableListWidget() const
Returns The QListWidget holding the available actions
bool KActionSelector::keyboardEnabled() const
Returns Whether keyboard control is enabled.
When Keyboard control is enabled, the widget will react to the following keyboard actions:
- CTRL + Right - simulate clicking the add button
- CTRL + Left - simulate clicking the remove button
- CTRL + Up - simulate clicking the up button
- CTRL + Down - simulate clicking the down button
Additionally, pressing RETURN or ENTER on one of the list boxes will cause the current item of that listbox to be moved to the other listbox.
The keyboard actions are enabled by default.
Note: Getter function for property keyboardEnabled.
See also setKeyboardEnabled().
bool KActionSelector::moveOnDoubleClick() const
Returns Whether moveOnDoubleClick is enabled.
If enabled, an item in any listbox will be moved to the other one whenever double-clicked.
This feature is enabled by default.
Note: Getter function for property moveOnDoubleClick.
See also setMoveOnDoubleClick().
[signal] void KActionSelector::movedDown(QListWidgetItem *item)
Emitted when an item is moved downwards in the "selected" listbox.
[signal] void KActionSelector::movedUp(QListWidgetItem *item)
Emitted when an item is moved upwards in the "selected" listbox.
[signal] void KActionSelector::removed(QListWidgetItem *item)
Emitted when an item is moved out of the "selected" listbox.
KActionSelector::InsertionPolicy KActionSelector::selectedInsertionPolicy() const
Returns The current insertion policy for the selected listbox.
The default policy for the selected listbox is BelowCurrent.
Note: Getter function for property selectedInsertionPolicy.
See also InsertionPolicy and setSelectedInsertionPolicy().
QString KActionSelector::selectedLabel() const
Returns the label of the selected items listbox.
Note: Getter function for property selectedLabel.
See also setSelectedLabel().
QListWidget *KActionSelector::selectedListWidget() const
Returns The QListWidget holding the selected actions
void KActionSelector::setAvailableInsertionPolicy(KActionSelector::InsertionPolicy policy)
Sets the insertion policy for the available listbox.
Note: Setter function for property availableInsertionPolicy.
See also InsertionPolicy and availableInsertionPolicy().
void KActionSelector::setAvailableLabel(const QString &text)
Sets the label for the available items listbox to text. Note that this label has the listbox as its buddy, so that if you have a single ampersand in the text, the following character will become the accelerator to focus the listbox.
Note: Setter function for property availableLabel.
See also availableLabel().
void KActionSelector::setButtonIcon(const QString &icon, KActionSelector::MoveButton button)
Sets the pixmap of the button button to icon. It calls SmallIconSet(pm) to generate the icon set.
void KActionSelector::setButtonIconSet(const QIcon &iconset, KActionSelector::MoveButton button)
Sets the iconset for button button to iconset. You can use this method to set a custom icon set. Either created by QIconSet, or use the application instance of KIconLoader (recommended).
void KActionSelector::setButtonTooltip(const QString &tip, KActionSelector::MoveButton button)
Sets the tooltip for the button button to tip.
void KActionSelector::setButtonWhatsThis(const QString &text, KActionSelector::MoveButton button)
Sets the whatsthis help for button button to text.
[slot] void KActionSelector::setButtonsEnabled()
Sets the enabled state of all moving buttons to reflect the current options.
Be sure to call this if you add or removes items to either listbox after the widget is shown
void KActionSelector::setKeyboardEnabled(bool enable)
Sets the keyboard enabled depending on enable.
Note: Setter function for property keyboardEnabled.
See also keyboardEnabled().
void KActionSelector::setMoveOnDoubleClick(bool enable)
Sets moveOnDoubleClick to enable
Note: Setter function for property moveOnDoubleClick.
See also moveOnDoubleClick().
void KActionSelector::setSelectedInsertionPolicy(KActionSelector::InsertionPolicy policy)
Sets the insertion policy for the selected listbox.
Note: Setter function for property selectedInsertionPolicy.
See also InsertionPolicy and selectedInsertionPolicy().
void KActionSelector::setSelectedLabel(const QString &text)
Sets the label for the selected items listbox to text. Note that this label has the listbox as its buddy, so that if you have a single ampersand in the text, the following character will become the accelerator to focus the listbox.
Note: Setter function for property selectedLabel.
See also selectedLabel().
void KActionSelector::setShowUpDownButtons(bool show)
Sets whether the Up and Down buttons should be displayed according to show
Note: Setter function for property showUpDownButtons.
See also showUpDownButtons().
bool KActionSelector::showUpDownButtons() const
Returns whether the Up and Down buttons should be displayed.
Note: Getter function for property showUpDownButtons.
See also setShowUpDownButtons().