summaryrefslogtreecommitdiff
path: root/client/widgets/metawidget.h
diff options
context:
space:
mode:
Diffstat (limited to 'client/widgets/metawidget.h')
-rw-r--r--client/widgets/metawidget.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/client/widgets/metawidget.h b/client/widgets/metawidget.h
index ef3f198..ac18b91 100644
--- a/client/widgets/metawidget.h
+++ b/client/widgets/metawidget.h
@@ -42,6 +42,13 @@
* This widget is simply a caotainer compositing its value from the widgets
* within it. The value of the widget cannot be set and its value attribute is
* therefore ignored.
+ * @example An example of how to use metawidget with two inner widgets:
+ * <metawidget layout="vbox" name="dims" format="${test1}: ${test2}"
+ * storechildren="true">
+ * <lineedit name="test1" value="test"/>
+ * <checkbox name="test2" value="ja" truevalue="ja" falsevalue="nej"
+ * caption="Og svaret er?"/>
+ * </metawidget>
* @att layout the layout of the widget. Can be one of 'vbox' or 'hbox'.
* @att storechildren This attribute indicates wether the child widgets should
* be stored on macro commit. It can be either 'true' or 'false'.