diff options
Diffstat (limited to 'client/widgets/checkbox.h')
| -rw-r--r-- | client/widgets/checkbox.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/client/widgets/checkbox.h b/client/widgets/checkbox.h index de71732..92cc4b3 100644 --- a/client/widgets/checkbox.h +++ b/client/widgets/checkbox.h @@ -31,10 +31,14 @@ #include <QDomNode> /*** - * CheckBox Widget. + * CheckBox Widget * @tag checkbox * @extends widget * @screenshot + * This widget is used to retrieve boolean values from the user. The widget can + * either be in checked state or unschecked state. The value of the widget + * depends on its state and the values of the falseval and trueval attributes. + * @att caption The caption of the checkbox. * @att trueval The value of the widget if it is checked. * @att falseval The value of the widget if it is unchecked. */ @@ -68,7 +72,7 @@ private: }; /*** - * @method checked() + * @method boolean 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. @@ -76,7 +80,7 @@ private: int chk_checked(lua_State *L); /*** - * @method setChecked(checked) + * @method nil setChecked(boolean 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'. |