summaryrefslogtreecommitdiff
path: root/client/widgets/groupbox.h
diff options
context:
space:
mode:
Diffstat (limited to 'client/widgets/groupbox.h')
-rw-r--r--client/widgets/groupbox.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/client/widgets/groupbox.h b/client/widgets/groupbox.h
index f2da306..73b6508 100644
--- a/client/widgets/groupbox.h
+++ b/client/widgets/groupbox.h
@@ -31,6 +31,23 @@
#include <QDomNode>
+/*
+ * NOTE: This documentation is both for the groupbox and frame classes.
+ */
+/***
+ * Layout or Frame Widget
+ * @tag frame
+ * @extends widget
+ * @screenshot
+ * This widget is used to control the layout of the child widgets and/or produce
+ * a frame and caption for them. <em>NOTE</em>: The value of this widget is
+ * always the empty string. It cannot be set.
+ * @att layout The layout assigned to the frame. Can be one of 'hbox' or
+ * 'vbox'.
+ * @att caption The optional caption of the frame. (leave this out to draw
+ * without the frame and caption). En empty caption attribute will produce a
+ * nameless frame.
+ */
class QGroupBox;
class GroupBox : public Widget
{