summaryrefslogtreecommitdiff
path: root/client/widgets/checkbox.h
diff options
context:
space:
mode:
authordeva <deva>2011-03-23 08:02:32 +0000
committerdeva <deva>2011-03-23 08:02:32 +0000
commit09c5c0783aef07e714c5613cbbf3a982774676aa (patch)
tree1a159edaea16d12e9c71be983d6746e9af1dcd8f /client/widgets/checkbox.h
parent165afd0d36abc8729b28e303077ed285b577caea (diff)
Documentation step 1
Diffstat (limited to 'client/widgets/checkbox.h')
-rw-r--r--client/widgets/checkbox.h22
1 files changed, 22 insertions, 0 deletions
diff --git a/client/widgets/checkbox.h b/client/widgets/checkbox.h
index 0930d50..de71732 100644
--- a/client/widgets/checkbox.h
+++ b/client/widgets/checkbox.h
@@ -30,6 +30,15 @@
#include "widget.h"
#include <QDomNode>
+/***
+ * CheckBox Widget.
+ * @tag checkbox
+ * @extends widget
+ * @screenshot
+ * @att trueval The value of the widget if it is checked.
+ * @att falseval The value of the widget if it is unchecked.
+ */
+
class QCheckBox;
class CheckBox : public Widget
{
@@ -58,7 +67,20 @@ private:
QCheckBox *checkbox;
};
+/***
+ * @method checked()
+ * This method retrives the current check state of the checkbox.
+ * @return the boolean value true if the checkbox is checked. Return
+ * false if not.
+ */
int chk_checked(lua_State *L);
+
+/***
+ * @method setChecked(checked)
+ * This method sets the current check state of the checkbox.
+ * @param checked A boolean value. If the value is true the checkbox is set to
+ * the state 'checked', otherwise it is set to the state 'unchecked'.
+ */
int chk_set_checked(lua_State *L);
#define CHKBOX_METHS \