aboutsummaryrefslogtreecommitdiffstats
path: root/include/gwin/button.h
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2013-06-08 02:27:59 +1000
committerinmarket <andrewh@inmarket.com.au>2013-06-08 02:27:59 +1000
commit777ec6af7c1b594f7b7a9cbaaf7ead90d8fb7e8f (patch)
tree2827629985d75e63f53b3de689d52a5080404780 /include/gwin/button.h
parent663caba66214acdb6170903f6a203740ea1de8b9 (diff)
downloaduGFX-777ec6af7c1b594f7b7a9cbaaf7ead90d8fb7e8f.tar.gz
uGFX-777ec6af7c1b594f7b7a9cbaaf7ead90d8fb7e8f.tar.bz2
uGFX-777ec6af7c1b594f7b7a9cbaaf7ead90d8fb7e8f.zip
Add a simple GWIN window manager, Change the way GWIN visibility works
Diffstat (limited to 'include/gwin/button.h')
-rw-r--r--include/gwin/button.h11
1 files changed, 8 insertions, 3 deletions
diff --git a/include/gwin/button.h b/include/gwin/button.h
index 1b0ff36b..53096ea3 100644
--- a/include/gwin/button.h
+++ b/include/gwin/button.h
@@ -73,10 +73,15 @@ extern "C" {
* @param[in] width The width of the window
* @param[in] height The height of the window
*
- * @note The drawing color gets set to White and the background drawing color to Black.
- * @note Don't forget to set the font using @p gwinSetFont() or @p gwinSetDefaultFont()
+ * @note The drawing color and the background color get set to the current defaults. If you haven't called
+ * @p gwinSetDefaultColor() or @p gwinSetDefaultBgColor() then these are White and Black respectively.
+ * @note The font gets set to the current default font. If you haven't called @p gwinSetDefaultFont() then there
+ * is no default font and text drawing operations will no nothing.
* @note The dimensions and position may be changed to fit on the real screen.
- * @note The button is not automatically drawn. Call gwinDraw() to draw it.
+ * @note A button remembers its normal button state. If there is a window manager then it is automatically
+ * redrawn if the window is moved or its visibility state is changed.
+ * @note The button is initially marked as invisible so that more properties can be set before display.
+ * Call @p gwinSetVisible() to display it when ready.
*
* @api
*/