diff options
author | inmarket <andrewh@inmarket.com.au> | 2014-05-01 18:10:31 +1000 |
---|---|---|
committer | inmarket <andrewh@inmarket.com.au> | 2014-05-01 18:10:31 +1000 |
commit | cb99e4ab091fafbee0389a30b6fbe8ee0ffc778e (patch) | |
tree | ae2dd49581767de13bcef903bcc8e0a7a76fc898 /src/gwin/label.h | |
parent | 2bef66a6875171942a1d71e40669247d26ce505b (diff) | |
parent | 763fd061ecd6c9bb4877b5b6f5a01ce363ef09a4 (diff) | |
download | uGFX-cb99e4ab091fafbee0389a30b6fbe8ee0ffc778e.tar.gz uGFX-cb99e4ab091fafbee0389a30b6fbe8ee0ffc778e.tar.bz2 uGFX-cb99e4ab091fafbee0389a30b6fbe8ee0ffc778e.zip |
Merge branch 'master' into gwin
Diffstat (limited to 'src/gwin/label.h')
-rw-r--r-- | src/gwin/label.h | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/src/gwin/label.h b/src/gwin/label.h index 9d62738d..b7218193 100644 --- a/src/gwin/label.h +++ b/src/gwin/label.h @@ -32,6 +32,11 @@ // An label window typedef struct GLabelObject { GWidgetObject w; + + #if GWIN_LABEL_ATTRIBUTE + coord_t tab; + const char* attr; + #endif } GLabelObject; #ifdef __cplusplus @@ -63,6 +68,33 @@ GHandle gwinGLabelCreate(GDisplay *g, GLabelObject *widget, GWidgetInit *pInit); */ void gwinLabelSetBorder(GHandle gh, bool_t border); +#if GWIN_LABEL_ATTRIBUTE || defined(__DOXYGEN__) + /** + * @brief Add an text attribute in front of the normal label text + * @details Often you want to display a text like this: + * Current IP: 192.168.1.42 + * In that case, the actual IP will be variable, the text in front of it + * always remains the same. The static text is called the attribute and can be + * set using this function. + * Furthermore, the tab can be set in order to vertically align multiple labels. + * Please check out the website for further explanation, illustraions and usage + * examples. + * + * @note The attribute text is not copied into private memory and so it + * must be a constant string, not one allocated in a stack buffer. + * @note Use of this construct is discouraged. The appropriate way is to + * create two labels - one for the static text and one for the + * dynamic text. + * + * @param[in] gh The widget handle (must be a label handle) + * @param[in] tab The distance of the label text from the left widget edge + * @param[in] attr The attribute to be displayed + * + * @api + */ + void gwinLabelSetAttribute(GHandle gh, coord_t tab, const char* attr); +#endif + #ifdef __cplusplus } #endif |