libyui
3.3.2
|
ComboBox (or "drop down box", "drop down selection"); may be editable. More...
#include <YComboBox.h>
Public Member Functions | |
virtual | ~YComboBox () |
Destructor. | |
virtual const char * | widgetClass () const |
Returns a descriptive name of this widget class for logging, debugging etc. | |
bool | editable () const |
Return 'true' if this ComboBox is editable, i.e. More... | |
std::string | value () |
Return the value of this ComboBox: More... | |
void | setValue (const std::string &newText) |
Set the value of this ComboBox by string: Try to find a list item with that label and select it. More... | |
virtual YItem * | selectedItem () |
Return the (first) selected item or 0 if none is selected or if this ComboBox is editable and the user entered something that does not match any of the ComboBox's list items (in that case, use value() instead). More... | |
virtual YItemCollection | selectedItems () |
Return all selected items. More... | |
virtual void | selectItem (YItem *item, bool selected=true) |
Select or deselect an item. More... | |
std::string | validChars () |
Get the valid input characters. More... | |
virtual void | setValidChars (const std::string &validChars) |
Set the valid input characters. More... | |
int | inputMaxLength () const |
The maximum input length, i.e., the maximum number of characters the user can enter. More... | |
virtual void | setInputMaxLength (int numberOfChars) |
Set the maximum input length, i.e., the maximum number of characters the user can enter. More... | |
virtual bool | setProperty (const std::string &propertyName, const YPropertyValue &val) |
Set a property. More... | |
virtual YPropertyValue | getProperty (const std::string &propertyName) |
Get a property. More... | |
virtual const YPropertySet & | propertySet () |
Return this class's property set. More... | |
const char * | userInputProperty () |
The name of the widget property that will return user input. More... | |
![]() | |
virtual | ~YSelectionWidget () |
Destructor. | |
std::string | label () const |
Return this widget's label (the caption above the item list). | |
virtual void | setLabel (const std::string &newLabel) |
Change this widget's label (the caption above the item list). More... | |
virtual void | addItem (YItem *item_disown) |
Add one item. More... | |
void | addItem (const std::string &itemLabel, bool selected=false) |
Overloaded for convenience: Add an item by string. | |
void | addItem (const std::string &itemLabel, const std::string &iconName, bool selected=false) |
Overloaded for convenience: Add an item with a text and an icon. More... | |
virtual void | addItems (const YItemCollection &itemCollection) |
Add multiple items. More... | |
virtual void | deleteAllItems () |
Delete all items. More... | |
void | setItems (const YItemCollection &itemCollection) |
Delete all items and add new items. | |
YItemIterator | itemsBegin () |
Return an iterator that points to the first item. More... | |
YItemConstIterator | itemsBegin () const |
YItemIterator | itemsEnd () |
Return an iterator that points behind the last item. | |
YItemConstIterator | itemsEnd () const |
bool | hasItems () const |
Return 'true' if this widget has any items. | |
int | itemsCount () const |
Return the number of items. More... | |
YItem * | firstItem () const |
Return the first item or 0 if there is none. | |
bool | hasSelectedItem () |
Return 'true' if any item is selected. | |
virtual void | deselectAllItems () |
Deselect all items. More... | |
void | setIconBasePath (const std::string &basePath) |
Set this widget's base path where to look up icons. More... | |
std::string | iconBasePath () const |
Return this widget's base path where to look up icons as set with setIconBasePath(). | |
std::string | iconFullPath (const std::string &iconName) const |
Return the full path + file name for the specified icon name. More... | |
std::string | iconFullPath (YItem *item) const |
Return the full path + file name for the icon of the specified item. More... | |
bool | itemsContain (YItem *item) const |
Return 'true' if this widget's items contain the specified item. | |
YItem * | findItem (const std::string &itemLabel) const |
Find the (first) item with the specified label. More... | |
virtual std::string | shortcutString () const |
Get the string of this widget that holds the keyboard shortcut. More... | |
virtual void | setShortcutString (const std::string &str) |
Set the string of this widget that holds the keyboard shortcut. More... | |
![]() | |
virtual | ~YWidget () |
Destructor. | |
virtual std::string | debugLabel () const |
Returns a descriptive label of this widget instance. More... | |
std::string | helpText () const |
Return the help text for this widget. | |
void | setHelpText (const std::string &helpText) |
Set a help text for this widget. More... | |
bool | hasChildren () const |
Returns 'true' if this widget has any children. | |
YWidget * | firstChild () const |
Returns the first child or 0 if there is none. More... | |
YWidget * | lastChild () const |
Returns the last child or 0 if there is none. | |
YWidgetListIterator | childrenBegin () const |
Return an iterator that points to the first child or to childrenEnd() if there are no children. | |
YWidgetListIterator | childrenEnd () const |
Return an interator that points after the last child. | |
YWidgetListConstIterator | childrenConstBegin () const |
Return a const iterator that points to the first child or to childrenEnd() if there are no children. | |
YWidgetListConstIterator | childrenConstEnd () const |
Return a const interator that points after the last child. | |
YWidgetListIterator | begin () |
A helper for the range-based "for" loop. More... | |
YWidgetListIterator | end () |
A helper for the range-based "for" loop. More... | |
int | childrenCount () const |
Returns the current number of children. | |
bool | contains (YWidget *child) const |
Checks if 'child' is a (direct!) child of this widget. | |
virtual void | addChild (YWidget *child) |
Add a new child. More... | |
virtual void | removeChild (YWidget *child) |
Remove a child. More... | |
void | deleteChildren () |
Delete all children and remove them from the children manager's list. | |
YWidget * | parent () const |
Return this widget's parent or 0 if it doesn't have a parent. | |
bool | hasParent () const |
Return 'true' if this widget has a parent, 'false' if not. | |
void | setParent (YWidget *newParent) |
Set this widget's parent. | |
YDialog * | findDialog () |
Traverse up the widget hierarchy and find the dialog this widget belongs to. More... | |
YWidget * | findWidget (YWidgetID *id, bool doThrow=true) const |
Recursively find a widget by its ID. More... | |
virtual int | preferredWidth ()=0 |
Preferred width of the widget. More... | |
virtual int | preferredHeight ()=0 |
Preferred height of the widget. More... | |
virtual int | preferredSize (YUIDimension dim) |
Preferred size of the widget in the specified dimension. More... | |
virtual void | setSize (int newWidth, int newHeight)=0 |
Set the new size of the widget. More... | |
bool | isValid () const |
Checks whether or not this object is valid. More... | |
bool | beingDestroyed () const |
Check if this widget is in the process of being destroyed. | |
void * | widgetRep () const |
Return a pointer to the underlying toolkit's (Qt, ...) widget representing this abstract UI widget. | |
void | setWidgetRep (void *toolkitWidgetRep) |
Set the pointer to the underlying toolkit's (Qt, ...) widget representing this abstract UI widget. More... | |
bool | hasId () const |
Returns 'true' if this widget has an ID. | |
YWidgetID * | id () const |
Returns this widget's ID. | |
void | setId (YWidgetID *newId_disown) |
Set this widget's ID. More... | |
virtual void | setEnabled (bool enabled=true) |
Enable or disable this widget, i.e. More... | |
void | setDisabled () |
Disable this widget (overloaded for better readability). | |
virtual bool | isEnabled () const |
Returns 'true' if this widget is enabled. | |
virtual bool | stretchable (YUIDimension dim) const |
This is a boolean value that determines whether the widget is resizable beyond its preferred size in the specified dimension. More... | |
void | setStretchable (YUIDimension dim, bool newStretch) |
Set the stretchable state to "newStretch" regardless of any hstretch or vstretch options. | |
void | setDefaultStretchable (YUIDimension dim, bool newStretch) |
Set the stretchable state to "newStretch". More... | |
virtual int | weight (YUIDimension dim) |
The weight is used in situations where all widgets can get their preferred size and yet space is available. More... | |
bool | hasWeight (YUIDimension dim) |
Return whether or not the widget has a weight in the specified dimension. | |
void | setWeight (YUIDimension dim, int weight) |
Set a weight in the specified dimension. | |
void | setNotify (bool notify=true) |
Sets the Notify property. | |
bool | notify () const |
Returns whether the widget will notify, i.e. More... | |
void | setNotifyContextMenu (bool notifyContextMenu=true) |
Sets the notifyContextMenu property. | |
bool | notifyContextMenu () const |
Returns whether the widget will send an event when the user clicks selects the context menu e.g. More... | |
bool | sendKeyEvents () const |
Returns 'true' if this widget should send key events, i.e. More... | |
void | setSendKeyEvents (bool doSend) |
Specify whether or not this widget should send key events. | |
bool | autoShortcut () const |
Returns 'true' if a keyboard shortcut should automatically be assigned to this widget - without complaints in the log file. | |
void | setAutoShortcut (bool _newAutoShortcut) |
Sets the 'autoShortcut' flag. | |
int | functionKey () const |
Return a function key number that is assigned to this widget. More... | |
bool | hasFunctionKey () const |
Check if a function key is assigned to this widget. | |
virtual void | setFunctionKey (int fkey_no) |
Assign a function key to this widget (1 for F1, 2 for F2, etc. More... | |
virtual bool | setKeyboardFocus () |
Set the keyboard focus to this widget. More... | |
void | dumpWidgetTree (int indentationLevel=0) |
Debugging function: Dump the widget tree from here on to the log file. | |
void | dumpDialogWidgetTree () |
Debugging function: Dump the widget tree from this widget's dialog parent. More... | |
void | setChildrenEnabled (bool enabled) |
Enable or disable all widgets in this widget tree. | |
virtual void | saveUserInput (YMacroRecorder *macroRecorder) |
Recursively save the user input of all child widgets to a macro recorder: More... | |
void * | operator new (size_t size) |
Overloaded operator new to ensure widgets are always created on the heap, never on the stack. More... | |
virtual void | startMultipleChanges () |
In some UIs updating the screen content is an expensive operation. More... | |
virtual void | doneMultipleChanges () |
Protected Member Functions | |
YComboBox (YWidget *parent, const std::string &label, bool editable) | |
Constructor. More... | |
virtual std::string | text ()=0 |
Return this ComboBox's current value as text. More... | |
virtual void | setText (const std::string &newText)=0 |
Set this ComboBox's current value as text. More... | |
![]() | |
YSelectionWidget (YWidget *parent, const std::string &label, bool enforceSingleSelection, bool recurisveSelection=false) | |
Constructor. More... | |
void | setEnforceSingleSelection (bool on) |
Set single selection mode on or off. More... | |
bool | enforceSingleSelection () const |
Return 'true' if this base class should enforce single selection. | |
bool | recursiveSelection () const |
Return 'true' if this base class should select children recursively. | |
YItem * | findSelectedItem (YItemConstIterator begin, YItemConstIterator end) |
Recursively try to find the first selected item between iterators 'begin' and 'end'. More... | |
void | findSelectedItems (YItemCollection &selectedItems, YItemConstIterator begin, YItemConstIterator end) |
Recursively find all selected items between iterators 'begin' and 'end' and add each of them to the 'selectedItems' YItemCollection. | |
void | deselectAllItems (YItemIterator begin, YItemIterator end) |
Recursively deselect all items between iterators 'begin' and 'end'. | |
YItem * | findItem (const std::string &wantedItemLabel, YItemConstIterator begin, YItemConstIterator end) const |
Recursively try to find an item with label 'wantedItemLabel' between iterators 'begin' and 'end'. More... | |
bool | itemsContain (YItem *wantedItem, YItemConstIterator begin, YItemConstIterator end) const |
Recursively check if 'wantedItem' is between iterators 'begin' and 'end'. | |
YItem * | itemAt (int index) const |
Return the item at index 'index' (from 0) or 0 if there is no such item. | |
![]() | |
YWidget (YWidget *parent) | |
Constructor. | |
YWidgetChildrenManager * | childrenManager () const |
Returns this widget's children manager. | |
void | setChildrenManager (YWidgetChildrenManager *manager) |
Sets a new children manager for this widget. More... | |
void | setBeingDestroyed () |
Set the "being destroyed" flag, i.e. More... | |
void | dumpWidget (YWidget *w, int indentationLevel) |
Helper function for dumpWidgetTree(): Dump one widget to the log file. | |
ComboBox (or "drop down box", "drop down selection"); may be editable.
A widget with a drop-down list of predefined values to select from. Optionally, this widget can be created in "editable" mode which means that the user can freely enter any text.
In non-editable mode, a ComboBox works very much like a SelectionBox that uses fewer screen space. In that mode, it is recommended to use selectedItem() to retrieve its current value and selectItem() to set it.
In editable mode, a ComboBox is more like an InputField with a list to pick predefined values from (for less typing). In that mode, it is recommended to use value() and setValue().
In either mode, it might be dangerous to use the iterators the (itemsBegin(), itemsEnd()) the base class (YSelectionWidget) provides to find the currently selected item: The items' "selected" flag may or may not be up to date. YComboBox::selectedItem() makes sure they are up to date.
Definition at line 53 of file YComboBox.h.
|
protected |
Constructor.
'editable' means the user can freely enter any value without being restricted to the items of the ComboBox's list.
Definition at line 49 of file YComboBox.cc.
bool YComboBox::editable | ( | ) | const |
Return 'true' if this ComboBox is editable, i.e.
if the user can freely enter any value without being restricted to the items of the ComboBox's list.
Notice that this can only be set in the constructor.
Definition at line 64 of file YComboBox.cc.
|
virtual |
Get a property.
Reimplemented from YWidget.
This method may throw YUIPropertyExceptions.
Reimplemented from YWidget.
Definition at line 220 of file YComboBox.cc.
int YComboBox::inputMaxLength | ( | ) | const |
The maximum input length, i.e., the maximum number of characters the user can enter.
-1 means no limit.
This is only meaningful for if the ComboBox is editable.
Definition at line 82 of file YComboBox.cc.
|
virtual |
Return this class's property set.
This also initializes the property upon the first call.
Reimplemented from YWidget.
Reimplemented from YWidget.
Definition at line 172 of file YComboBox.cc.
|
virtual |
Return the (first) selected item or 0 if none is selected or if this ComboBox is editable and the user entered something that does not match any of the ComboBox's list items (in that case, use value() instead).
Reimplemented from YSelectionWidget for better reliability: This will compare an editable ComboBox's user input against the text labels of all items and try to return an item if there is any match.
Reimplemented from YSelectionWidget.
Definition at line 136 of file YComboBox.cc.
|
virtual |
Return all selected items.
This is not particularly useful for ComboBoxes since there can be no more than one selected item anyway; * better use selectedItem() or value() instead.
This function does not transfer ownership of those items to the caller, so don't try to delete them!
Reimplemented from YSelectionWidget for better reliability.
Reimplemented from YSelectionWidget.
Definition at line 157 of file YComboBox.cc.
|
virtual |
Select or deselect an item.
See also setValue().
Reimplemented from YSelectionWidget.
Reimplemented from YSelectionWidget.
Definition at line 122 of file YComboBox.cc.
|
virtual |
Set the maximum input length, i.e., the maximum number of characters the user can enter.
-1 means no limit.
This is only meaningful for if the ComboBox is editable.
Derived classes are free to reimplement this, but they should call this base class method at the end of the overloaded function.
Definition at line 88 of file YComboBox.cc.
|
virtual |
Set a property.
Reimplemented from YWidget.
This function may throw YUIPropertyExceptions.
This function returns 'true' if the value was successfully set and 'false' if that value requires special handling (not in error cases: those are covered by exceptions).
Reimplemented from YWidget.
Definition at line 200 of file YComboBox.cc.
|
protectedpure virtual |
Set this ComboBox's current value as text.
Called internally whenever the content is to change programmatically. Don't call setValue() or selectItem() from here.
Derived classes are required to implement this function.
|
virtual |
Set the valid input characters.
No input validation is performed (i.e., the user can enter anything) if this is empty.
This is only meaningful for if the ComboBox is editable.
Derived classes are free to reimplement this, but they should call this base class method at the end of the overloaded function.
Definition at line 76 of file YComboBox.cc.
void YComboBox::setValue | ( | const std::string & | newText | ) |
Set the value of this ComboBox by string: Try to find a list item with that label and select it.
If there is no matching list item, editable ComboBoxes will set their input field to that text. Non-editable ComboBoxes will throw an exception.
See also selectItem().
Definition at line 100 of file YComboBox.cc.
|
protectedpure virtual |
Return this ComboBox's current value as text.
Called internally from value(), selectedItem() and related.
Derived classes are required to implement this function.
|
inlinevirtual |
The name of the widget property that will return user input.
Inherited from YWidget.
Reimplemented from YWidget.
Definition at line 211 of file YComboBox.h.
std::string YComboBox::validChars | ( | ) |
Get the valid input characters.
No input validation is performed (i.e., the user can enter anything) if this is empty.
This is only meaningful for if the ComboBox is editable.
Definition at line 70 of file YComboBox.cc.
std::string YComboBox::value | ( | ) |
Return the value of this ComboBox:
The text of a list item if the user (or the appplication) selected a list item or the content of the ComboBox's input field if the ComboBox is editable and the user (or the application) entered text there.
See also YComboBox::selectedItem().
Definition at line 94 of file YComboBox.cc.