summaryrefslogtreecommitdiff
path: root/client/widgets/combobox.h
diff options
context:
space:
mode:
authordeva <deva>2011-03-25 14:54:32 +0000
committerdeva <deva>2011-03-25 14:54:32 +0000
commit93de7f375842c0afb72db8796c45bfda5f1a6f13 (patch)
treef00bb8bab149e11b5fbb7208382b142d9fafc53e /client/widgets/combobox.h
parenta3016fbf0d50bfe82e69a657328ef76370227979 (diff)
Finished documenting the last widgets. Also some changes in the docgen app.
Diffstat (limited to 'client/widgets/combobox.h')
-rw-r--r--client/widgets/combobox.h20
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>&gt;item&lt;</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,