uGFX/ugfx
2
0
Fork 0
Code Issues 2 Pull requests Projects Releases Wiki Activity

Doco improvement

Browse source
This commit is contained in:
inmarket 2015-10-06 12:01:29 +10:00
parent 470868f51a
commit 25482f5c90
1 changed files with 18 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
src/gwin/gwin.h
View file

@ -38,19 +38,22 @@ typedef struct GWindowObject *GHandle;
typedef struct GWindowObject { typedef struct GWindowObject {
#if GWIN_NEED_WINDOWMANAGER #if GWIN_NEED_WINDOWMANAGER
// This MUST be the first member of the structure // This MUST be the first member of the structure
gfxQueueASyncItem wmq; // @< The next window (for the window manager) gfxQueueASyncItem wmq; /**< The next window (for the window manager) */
#endif #endif
const struct gwinVMT *vmt; // @< The VMT for this GWIN const struct gwinVMT* vmt; /**< The VMT for this GWIN */
GDisplay * display; // @< The display this window is on. GDisplay * display; /**< The display this window is on */
coord_t x, y; // @< Screen relative position coord_t x; /**< The position relative to the screen */
coord_t width, height; // @< Dimensions of this window coord_t y; /**< The position relative to the screen */
color_t color, bgcolor; // @< The current drawing colors coord_t width; /**< The width of this window */
uint32_t flags; // @< Window flags (the meaning is private to the GWIN class) coord_t height; /**< The height of this window */
color_t color; /**< The current foreground drawing color */
color_t bgcolor; /**< The current background drawing color */
uint32_t flags; /**< Window flags (the meaning is private to the GWIN class) */
#if GDISP_NEED_TEXT #if GDISP_NEED_TEXT
font_t font; // @< The current font font_t font; /**< The current font */
#endif #endif
#if GWIN_NEED_CONTAINERS #if GWIN_NEED_CONTAINERS
GHandle parent; // @< The parent window GHandle parent; /**< The parent window */
#endif #endif
} GWindowObject, * GHandle; } GWindowObject, * GHandle;
/** @} */ /** @} */
@ -68,11 +71,13 @@ typedef struct GWindowObject {
* @{ * @{
*/ */
typedef struct GWindowInit { typedef struct GWindowInit {
coord_t x, y; // @< The initial position relative to its parent coord_t x; /**< The initial position relative to its parent */
coord_t width, height; // @< The initial dimension coord_t y; /**< The initial position relative to its parent */
bool_t show; // @< Should the window be visible initially coord_t width; /**< The width */
coord_t height; /**< The height */
bool_t show; /**< Should the window be visible initially */
#if GWIN_NEED_CONTAINERS #if GWIN_NEED_CONTAINERS
GHandle parent; // @< The parent - must be a container or NULL GHandle parent; /**< The parent - must be a container or NULL */
#endif #endif
} GWindowInit; } GWindowInit;
/** @} */ /** @} */