summaryrefslogtreecommitdiff
path: root/client/widgets/listbox.h
diff options
context:
space:
mode:
Diffstat (limited to 'client/widgets/listbox.h')
-rw-r--r--client/widgets/listbox.h15
1 files changed, 15 insertions, 0 deletions
diff --git a/client/widgets/listbox.h b/client/widgets/listbox.h
index d775655..fcfc1b0 100644
--- a/client/widgets/listbox.h
+++ b/client/widgets/listbox.h
@@ -31,6 +31,21 @@
#include <QDomNode>
+/***
+ * ListBox Widget
+ * @tag listbox
+ * @screenshot
+ * @extends widget
+ * This widget is a list of selectable items.
+ * @att value [item] The value of the item and the value of the widget if this
+ * item is selected.
+ * @att caption [item] The caption of the item. This is the text presented to
+ * the user.
+ * @att type [item] The item type. Can be either 'separator' which will show
+ * the item as a line or 'header' which will highlight its caption. Ommit this
+ * attribute if the item is selectable.
+ */
+
class QListWidget;
class ListBox : public Widget
{