YComboBox Class Reference
Implementation of the ComboBox widget.
More...
#include <YComboBox.h>
Inheritance diagram for YComboBox:
List of all members.
Detailed Description
Implementation of the ComboBox widget.
ComboBox
- string label list items the items contained in the combo box editable the user can enter any value. `ComboBox( `id( `pizza ), "select your Pizza:", [ "Margarita", `item( `id( `na ), "Napoli" ) ] ) ComboBox1.ycp ComboBox2.ycp ComboBox3.ycp ComboBox4.ycp ComboBox-replace-items1.ycp ComboBox-setInputMaxLength.ycp
A combo box is a combination of a selection box and an input field. It gives the user a one-out-of-many choice from a list of items. Each item has a ( mandatory ) label and an ( optional ) id. When the 'editable' option is set, the user can also freely enter any value. By default, the user can only select an item already present in the list.
The items are very much like SelectionBox items: They can have an (optional) ID, they have a mandatory text to be displayed and an optional boolean parameter indicating the selected state. Only one of the items may have this parameter set to "true"; this will be the default selection on startup.
- Note:
- You can and should set a keyboard shortcut within the label. When the user presses the hotkey, the combo box will get the keyboard focus.
Constructor & Destructor Documentation
Member Function Documentation
|
Implements the ui command changeWidget.
Reimplemented from YWidget. |
bool YComboBox::editable |
( |
|
) |
const [inline] |
|
|
Returns whether or not any value ( not only from the list ) can be entered. |
virtual int YComboBox::getCurrentItem |
( |
|
) |
const [protected, pure virtual] |
|
|
Returns the index of the currently selected item (from 0 on) or -1 if no item is selected. |
|
Get the valid input characters. |
virtual YCPString YComboBox::getValue |
( |
|
) |
const [protected, pure virtual] |
|
|
Returns the ComboBox value. |
|
Implements the ui command queryWidget
Reimplemented from YWidget. |
void YComboBox::saveUserInput |
( |
YMacroRecorder * |
macroRecorder |
) |
[private, virtual] |
|
|
Save the widget's user input to a macro recorder. Intentionally declared as "private" so all macro recording internals are handled by the abstract libyui level, not by a specific UI.
Reimplemented from YWidget. |
virtual void YComboBox::setCurrentItem |
( |
int |
index |
) |
[protected, pure virtual] |
|
void YComboBox::setInputMaxLength |
( |
const YCPInteger & |
numberOfChars |
) |
[virtual] |
|
|
Specify the amount of characters which can be inserted.
Overload this to limit the input. |
void YComboBox::setValidChars |
( |
const YCPString & |
validChars |
) |
[virtual] |
|
virtual void YComboBox::setValue |
( |
const YCPString & |
new_value |
) |
[protected, pure virtual] |
|
|
Sets the ComboBox value to a random value that is not already in the item list. Will be called for editable ComboBox widgets only. |
const char* YComboBox::userInputProperty |
( |
|
) |
[inline, virtual] |
|
|
The name of the widget property that will return user input. Inherited from YWidget.
Reimplemented from YWidget. |
virtual char* YComboBox::widgetClass |
( |
|
) |
[inline, virtual] |
|
|
Returns a descriptive name of this widget class for logging, debugging etc.
Reimplemented from YSelectionWidget. |
Member Data Documentation
|
Any input ( not only from the list ) permitted? |
The documentation for this class was generated from the following files:
Generated on Fri Jun 16 18:07:46 2006 for yast2-core by
1.4.6