summaryrefslogtreecommitdiff
path: root/client/widgets/radiobuttons.h
diff options
context:
space:
mode:
Diffstat (limited to 'client/widgets/radiobuttons.h')
-rw-r--r--client/widgets/radiobuttons.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/client/widgets/radiobuttons.h b/client/widgets/radiobuttons.h
index b83f7a9..3ddb05c 100644
--- a/client/widgets/radiobuttons.h
+++ b/client/widgets/radiobuttons.h
@@ -32,6 +32,23 @@
#include "widget.h"
+/***
+ * Radio Button Group Widget
+ * @tag radiobuttons
+ * @extends widget
+ * @screenshot
+ * @container
+ * This widget is in many ways similar to the @see listbox widget. It is a
+ * container for radiobuttons represented by <code>&lt;radiobutton&gt;</code>
+ * tags. The value of the widget is retrieved from the selected radiobutton.
+ * When the value of the radiobuttons widget is set the corresponding
+ * radiobutton will be selected.
+ * @att layout the layout of the widget. Can be one of 'vbox' or 'hbox'.
+ * @att caption [radiobutton] This is the caption of the radio button.
+ * @att value [radiobutton] This is the value of the radiobutton, which will
+ * be the value of the radiobuttons widget should this radiobutton be selected.
+ */
+
class QFrame;
class QEvent;
class RadioButton;