From 09c5c0783aef07e714c5613cbbf3a982774676aa Mon Sep 17 00:00:00 2001 From: deva Date: Wed, 23 Mar 2011 08:02:32 +0000 Subject: Documentation step 1 --- client/widgets/checkbox.h | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'client/widgets/checkbox.h') 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 +/*** + * 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 \ -- cgit v1.2.3