diff options
| author | Joel Bodenmann <joel@seriouslyembedded.com> | 2015-06-18 01:16:25 +0200 |
|---|---|---|
| committer | Joel Bodenmann <joel@seriouslyembedded.com> | 2015-06-18 01:16:25 +0200 |
| commit | 1442ed05a907573109bd0fe1ce9dc2be0f745176 (patch) | |
| tree | 1a8ba9b5d70397caff821f5ade42c08cede9f364 /src | |
| parent | 475dd871b853a665c9fcb196a1bca1ed211aa71d (diff) | |
| download | uGFX-1442ed05a907573109bd0fe1ce9dc2be0f745176.tar.gz uGFX-1442ed05a907573109bd0fe1ce9dc2be0f745176.tar.bz2 uGFX-1442ed05a907573109bd0fe1ce9dc2be0f745176.zip | |
Improving label documentation
Diffstat (limited to 'src')
| -rw-r--r-- | src/gwin/gwin_label.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/src/gwin/gwin_label.h b/src/gwin/gwin_label.h index b5c45589..4c7cab9c 100644 --- a/src/gwin/gwin_label.h +++ b/src/gwin/gwin_label.h @@ -15,6 +15,11 @@ * @details GWIN allos it to create an label widget. The widget * takes no user input. * + * @details Setting the dimensions of the widget to 0 will automatically + * set the labels dimensions to fit the entire text. Note that the + * dimensions of the label will change every time the text is changed + * through gwinSetText(). + * * @pre GFX_USE_GDISP must be set to TRUE in your gfxconf.h * @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h * @pre GDISP_NEED_TEXT must be set to TRUE in your gfxconf.h @@ -46,7 +51,7 @@ extern "C" { /** * @brief Create a label widget. * @details A label widget is a simple window which has a static text. - * + * * @param[in] g The GDisplay to display this window on * @param[in] widget The label structure to initialise. If this is NULL, the structure is dynamically allocated. * @param[in] pInit The initialisation parameters to use. @@ -93,7 +98,7 @@ void gwinLabelSetBorder(GHandle gh, bool_t border); * @api */ void gwinLabelSetAttribute(GHandle gh, coord_t tab, const char* attr); -#endif +#endif #ifdef __cplusplus } @@ -101,4 +106,3 @@ void gwinLabelSetBorder(GHandle gh, bool_t border); #endif // _GWIN_LABEL_H /** @} */ - |