diff options
Diffstat (limited to 'client/widgets/combobox.h')
| -rw-r--r-- | client/widgets/combobox.h | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/client/widgets/combobox.h b/client/widgets/combobox.h index 657d458..8a8fbd3 100644 --- a/client/widgets/combobox.h +++ b/client/widgets/combobox.h @@ -32,6 +32,26 @@ #include "widget.h" +/*** + * ComboBox Widget + * @tag combobox + * @extends widget + * @screenshot + * The ComboBox is used to make a selection from a list of items. + * The ComboBox contains <code>>item<</code> tags each describing + * an entry in the selection list. + * @att type The selection method of the ComboBox. Can be one 'select', where + * the user can select items using either the mouse or the arrow keys, 'edit', + * where the user can write freely in the ComboBox in the same way as in a + * LineEdit during which it will present but not limit to the matching values + * of its list, and finally 'search', where the user can write in the ComboBox + * but is restricted to writing strings matching the items in the list. + * @att value [item] The value of the item. This will be the value of the + * ComboBox if this item is selected. + * @att caption [item] The caption of this item. This is the text presented + * to the user in the ComboBox. + */ + typedef enum { SELECT, EDIT, |