KDE 3.5 API Reference kdeui
KActionSelector Class Reference
A widget for selecting and arranging actions/objects. More...
#include <kactionselector.h>
Detailed Description
A widget for selecting and arranging actions/objects.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 conflist with keyboard selection in the selected list box, if you set that to anything else than QListBox::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 QListBox methods on lbSelected().
This way, you can use your own QListBoxItem 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 availableListbox() and selectedListBox().
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()
Definition at line 79 of file kactionselector.h.
Member Enumeration Documentation
This enum identifies the icon sizes, used for the move buttons.
The values correspond to the following pixel sizes:
- SmallIcon - the return value of IconSize( KIcon::Small ), the user defined size of a small icon in KDE. This is the default setting.
- Small - 16px
- Medium - 22px
- Large - 32px
- XLarge - 48px
Definition at line 125 of file kactionselector.h.
This enum defines policies for where to insert moved items in a listbox.
The following policies are currently defined:
- BelowCurrent - The item is inserted below the listbox' currentItem() or at the end if there is no curent item.
- Sorted - The listbox is sort()ed after one or more items are inserted.
- AtTop - The item is inserted at index 0 in the listbox.
- AtBottom - The item is inserted at the end of the listbox.
- See also:
- availableInsertionPolicy(), setAvailableInsertionPolicy(), selectedInsertionPolicy(), setSelectedInsertionPolicy().
Definition at line 145 of file kactionselector.h.
Constructor & Destructor Documentation
| KActionSelector::KActionSelector | ( | QWidget * | parent = 0, |
|
| const char * | name = 0 | |||
| ) |
Definition at line 48 of file kactionselector.cpp.
| KActionSelector::~KActionSelector | ( | ) |
Definition at line 119 of file kactionselector.cpp.
Member Function Documentation
| void KActionSelector::added | ( | QListBoxItem * | item | ) | [signal] |
Emitted when an item is moved to the "selected" listbox.
| InsertionPolicy KActionSelector::availableInsertionPolicy | ( | ) | const |
- Returns:
- The current insertion policy for the available listbox. The default policy for the available listbox is Sorted. See also InsertionPolicy, setAvailableInsertionPolicy().
| QString KActionSelector::availableLabel | ( | ) | const |
- Returns:
- The text of the label for the available items listbox.
| QListBox * KActionSelector::availableListBox | ( | ) | const |
- Returns:
- The QListBox holding the available actions
Definition at line 128 of file kactionselector.cpp.
| ButtonIconSize KActionSelector::buttonIconSize | ( | ) | const |
- Returns:
- the current ButtonIconSize.
| bool KActionSelector::keyboardEnabled | ( | ) | const |
- Returns:
- Weather keyboard control is enabled.
- 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
The keyboard actions are enabled by default.
- See also:
- setKeyboardEnabled()
| void KActionSelector::keyPressEvent | ( | QKeyEvent * | e | ) | [protected] |
Reimplamented for internal reasons.
Reimplemented from QWidget.
Definition at line 343 of file kactionselector.cpp.
| void KActionSelector::movedDown | ( | QListBoxItem * | item | ) | [signal] |
Emitted when an item is moved downwards in the "selected" listbox.
| void KActionSelector::movedUp | ( | QListBoxItem * | item | ) | [signal] |
Emitted when an item is moved upwards in the "selected" listbox.
| bool KActionSelector::moveOnDoubleClick | ( | ) | const |
- Returns:
- Wheather moveOnDoubleClcik is enabled.
- See also:
- setMoveOnDoubleClick()
| void KActionSelector::polish | ( | ) | [slot] |
Emitted when an item is moved to the "selected" listbox.
Reimplemented for internal reasons. (calls setButtonsEnabled())
Reimplemented from QWidget.
Definition at line 335 of file kactionselector.cpp.
| void KActionSelector::removed | ( | QListBoxItem * | item | ) | [signal] |
Emitted when an item is moved out of the "selected" listbox.
| InsertionPolicy KActionSelector::selectedInsertionPolicy | ( | ) | const |
- Returns:
- The current insertion policy for the selected listbox. The default policy for the selected listbox is BelowCurrent. See also InsertionPolicy, setSelectedInsertionPolicy().
| QString KActionSelector::selectedLabel | ( | ) | const |
- Returns:
- the label of the selected items listbox.
| QListBox * KActionSelector::selectedListBox | ( | ) | const |
- Returns:
- The QListBox holding the selected actions
Definition at line 133 of file kactionselector.cpp.
| void KActionSelector::setAvailableInsertionPolicy | ( | InsertionPolicy | policy | ) |
Sets the insertion policy for the available listbox.
See also InsertionPolicy, availableInsertionPolicy().
Definition at line 296 of file kactionselector.cpp.
| 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 accellerator to focus te listbox.
Definition at line 264 of file kactionselector.cpp.
| void KActionSelector::setButtonIcon | ( | const QString & | icon, | |
| MoveButton | button | |||
| ) |
Sets the pixmap of the button button to icon.
It calls SmallIconSet(pm) to generate the icon set.
Definition at line 138 of file kactionselector.cpp.
| void KActionSelector::setButtonIconSet | ( | const QIconSet & | iconset, | |
| MoveButton | button | |||
| ) |
Sets the iconset for button button to iconset.
You can use this method to et a costum icon set. Either created by QIconSet, or use the application instance of KIconLoader (recommended).
Definition at line 163 of file kactionselector.cpp.
| void KActionSelector::setButtonIconSize | ( | ButtonIconSize | size | ) |
Sets the button icon size.
See ButtonIconSize for the possible values and their pixel meaning.
Definition at line 284 of file kactionselector.cpp.
| 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 show()n
Definition at line 226 of file kactionselector.cpp.
| void KActionSelector::setButtonTooltip | ( | const QString & | tip, | |
| MoveButton | button | |||
| ) |
| void KActionSelector::setButtonWhatsThis | ( | const QString & | text, | |
| MoveButton | button | |||
| ) |
Sets the whatsthis help for button button to text.
Definition at line 205 of file kactionselector.cpp.
| void KActionSelector::setKeyboardEnabled | ( | bool | enable | ) |
Sets the keyboard enabled depending on enable.
- See also:
- keyboardEnabled()
Definition at line 254 of file kactionselector.cpp.
| void KActionSelector::setMoveOnDoubleClick | ( | bool | enable | ) |
Sets moveOnDoubleClick to enable.
- See also:
- moveOnDoubleClick()
Definition at line 244 of file kactionselector.cpp.
| void KActionSelector::setSelectedInsertionPolicy | ( | InsertionPolicy | policy | ) |
Sets the insertion policy for the selected listbox.
See also InsertionPolicy, selectedInsertionPolicy().
Definition at line 306 of file kactionselector.cpp.
| 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 accellerator to focus te listbox.
Definition at line 274 of file kactionselector.cpp.
| void KActionSelector::setShowUpDownButtons | ( | bool | show | ) |
Sets wheather the Up and Down buttons should be displayed according to show.
Definition at line 316 of file kactionselector.cpp.
| bool KActionSelector::showUpDownButtons | ( | ) | const |
- Returns:
- wheather the Up and Down buttons should be displayed.
Property Documentation
KActionSelector::InsertionPolicy KActionSelector::availableInsertionPolicy [read, write] |
Definition at line 87 of file kactionselector.h.
QString KActionSelector::availableLabel [read, write] |
Definition at line 84 of file kactionselector.h.
KActionSelector::ButtonIconSize KActionSelector::buttonIconSize [read, write] |
Definition at line 86 of file kactionselector.h.
bool KActionSelector::keyboardEnabled [read, write] |
Definition at line 83 of file kactionselector.h.
bool KActionSelector::moveOnDoubleClick [read, write] |
Definition at line 82 of file kactionselector.h.
KActionSelector::InsertionPolicy KActionSelector::selectedInsertionPolicy [read, write] |
Definition at line 88 of file kactionselector.h.
QString KActionSelector::selectedLabel [read, write] |
Definition at line 85 of file kactionselector.h.
bool KActionSelector::showUpDownButtons [read, write] |
Definition at line 89 of file kactionselector.h.
The documentation for this class was generated from the following files:
