diff options
author | Joel Bodenmann <joel@seriouslyembedded.com> | 2015-11-03 20:39:16 +0100 |
---|---|---|
committer | Joel Bodenmann <joel@seriouslyembedded.com> | 2015-11-03 20:39:16 +0100 |
commit | 86aef5990a702cc10c99d41c8aa7cc15b3338cae (patch) | |
tree | bc49b57f90581c88214f07ef9e29c8d6cdb55884 /src/gwin/gwin_checkbox.h | |
parent | de149299ae02d36c8393cbe52ba9025f3ed2de21 (diff) | |
download | uGFX-86aef5990a702cc10c99d41c8aa7cc15b3338cae.tar.gz uGFX-86aef5990a702cc10c99d41c8aa7cc15b3338cae.tar.bz2 uGFX-86aef5990a702cc10c99d41c8aa7cc15b3338cae.zip |
Doxygen (documenting each built-in rendering function for widgets)
Diffstat (limited to 'src/gwin/gwin_checkbox.h')
-rw-r--r-- | src/gwin/gwin_checkbox.h | 41 |
1 files changed, 34 insertions, 7 deletions
diff --git a/src/gwin/gwin_checkbox.h b/src/gwin/gwin_checkbox.h index f0a8e9f0..d2d2c42c 100644 --- a/src/gwin/gwin_checkbox.h +++ b/src/gwin/gwin_checkbox.h @@ -99,23 +99,50 @@ void gwinCheckboxCheck(GHandle gh, bool_t isChecked); bool_t gwinCheckboxIsChecked(GHandle gh); /** - * @brief Some custom checkbox drawing routines - * @details These function may be passed to @p gwinSetCustomDraw() to get different checkbox drawing styles + * @defgroup Renderings_Checkbox Checkbox rendering functions * - * @param[in] gw The widget (which must be a checkbox) - * @param[in] param A parameter passed in from the user + * @brief Built-in rendering functions for the checkbox widget. * - * @note In your custom checkbox drawing function you may optionally call this + * @details These function may be passed to @p gwinSetCustomDraw() to get different checkbox drawing styles. + * + * @note In your custom checkbox drawing function you may optionally call these * standard functions and then draw your extra details on top. - * @note The standard functions below ignore the param parameter. * @note These custom drawing routines don't have to worry about setting clipping as the framework * sets clipping to the object window prior to calling these routines. * - * @api * @{ */ + +/** + * @brief Renders a square checkbox where the text is on the right side of the checkbox. + * + * @param[in] gw The widget (must be a checkbox) + * @param[in] param A parameter passed in from the user. Ignored by this function. + * + * @api + */ void gwinCheckboxDraw_CheckOnLeft(GWidgetObject *gw, void *param); + +/** + * @brief Renders a square checkbox where the text is on the left side of the checkbox. + * + * @param[in] gw The widget (must be a checkbox) + * @param[in] param A parameter passed in from the user. Ignored by this function. + * + * @api + */ void gwinCheckboxDraw_CheckOnRight(GWidgetObject *gw, void *param); + +/** + * @brief Renders a checkbox in form of a rectangular button with the text inside of it. + * + * @details This behaves like a button that can be toggled. + * + * @param[in] gw The widget (must be a checkbox) + * @param[in] param A parameter passed in from the user. Ignored by this function. + * + * @api + */ void gwinCheckboxDraw_Button(GWidgetObject *gw, void *param); /** @} */ |