diff options
Diffstat (limited to 'include/gwin/class_gwin.h')
| -rw-r--r-- | include/gwin/class_gwin.h | 170 |
1 files changed, 109 insertions, 61 deletions
diff --git a/include/gwin/class_gwin.h b/include/gwin/class_gwin.h index b7d8c5a8..5e3cb01f 100644 --- a/include/gwin/class_gwin.h +++ b/include/gwin/class_gwin.h @@ -24,55 +24,91 @@ #if GFX_USE_GWIN || defined(__DOXYGEN__) /** - * @brief The Virtual Method Table for a GWIN window + * @brief The predefined flags for a Window * @{ */ -typedef struct gwinVMT { - const char *classname; // @< The GWIN classname - void (*Destroy)(GWindowObject *gh); // @< The GWIN Destroy function (optional) - void (*AfterClear)(GWindowObject *gh); // @< The GWIN After-Clear function (optional) -} gwinVMT; +#define GWIN_FLG_DYNAMIC 0x0001 // @< The GWIN structure is allocated +#define GWIN_FLG_VISIBLE 0x0002 // @< The window is visible +#define GWIN_FLG_MINIMIZED 0x0004 // @< The window is minimized +#define GWIN_FLG_MAXIMIZED 0x0008 // @< The window is maximized +#define GWIN_FLG_WIDGET 0x0010 // @< This is a widget +#define GWIN_FLG_ENABLED 0x0020 // @< The widget is enabled +#define GWIN_FLG_ALLOCTXT 0x0040 // @< The widget text is allocated +#define GWIN_FLG_MOUSECAPTURE 0x0080 // @< The widget has captured the mouse +#define GWIN_FIRST_WM_FLAG 0x0100 // @< 4 bits free for the window manager to use +#define GWIN_FIRST_CONTROL_FLAG 0x1000 // @< 4 bits free for Windows and Widgets to use /* @} */ /** - * @brief The Virtual Method Table for a widget - * @note A widget must have a destroy function. Either use @p _gwidgetDestroy() or use your own function - * which internally calls @p _gwidgetDestroy(). - * @note If no MouseDown(), MouseUp() or MouseMove() function is provided, the widget will not accept being attached to a mouse input source. - * @note If no ToggleOn() or ToggleOff() function is provided, the widget will not accept being attached to a toggle input source. - * @note If no DialMove() function is provided, the widget will not accept being attached to a dial input source. - * @note AssignToggle() and AssignDial() enable a widget to handle more than one toggle/dial device attached to the widget. - * For example, a slider might accept two toggles, one for slider-down and one for slider-up. - * The function enables the widget to record that a particular device instance performs each particular role. - * (eg toggle0 = slider-down, toggle1 = slider-up). + * @brief The Virtual Method Table for a GWIN window * @{ */ -typedef struct gwidgetVMT { - struct gwinVMT g; // @< This is still a GWIN - void (*DefaultDraw) (GWidgetObject *gw, void *param); // @< The default drawing routine (mandatory) - void (*MouseDown) (GWidgetObject *gw, coord_t x, coord_t y); // @< Process mouse down events (optional) - void (*MouseUp) (GWidgetObject *gw, coord_t x, coord_t y); // @< Process mouse up events (optional) - void (*MouseMove) (GWidgetObject *gw, coord_t x, coord_t y); // @< Process mouse move events (optional) - void (*ToggleOff) (GWidgetObject *gw, uint16_t instance); // @< Process toggle off events (optional) - void (*ToggleOn) (GWidgetObject *gw, uint16_t instance); // @< Process toggle on events (optional) - void (*DialMove) (GWidgetObject *gw, uint16_t instance, uint16_t value); // @< Process dial move events (optional) - void (*AllEvents) (GWidgetObject *gw, GEvent *pe); // @< Process all events (optional) - bool_t (*AssignToggle) (GWidgetObject *gw, uint16_t role, uint16_t instance); // @< Test the role and save the toggle instance handle (optional) - bool_t (*AssignDial) (GWidgetObject *gw, uint16_t role, uint16_t instance); // @< Test the role and save the dial instance handle (optional) -} gwidgetVMT; +typedef struct gwinVMT { + const char * classname; // @< The GWIN classname (mandatory) + void (*Destroy) (GWindowObject *gh); // @< The GWIN destroy function (optional) + void (*Redraw) (GWindowObject *gh); // @< The GWIN redraw routine (optional) + void (*AfterClear) (GWindowObject *gh); // @< The GWIN after-clear function (optional) +} gwinVMT; /* @} */ -/** - * @brief The predefined flags for a GWIN and a Widget - * @{ - */ -#define GWIN_FLG_DYNAMIC 0x0001 // @< The GWIN structure is allocated -#define GWIN_FLG_WIDGET 0x0002 // @< This is a widget -#define GWIN_FLG_ENABLED 0x0002 // @< The widget is enabled -#define GWIN_FLG_ALLOCTXT 0x0008 // @< The widget text is allocated -#define GWIN_FLG_MOUSECAPTURE 0x0010 // @< The widget has captured the mouse -#define GWIN_FIRST_CONTROL_FLAG 0x0100 // @< Free for GWINs and Widgets to use -/* @} */ +#if GWIN_NEED_WIDGET || defined(__DOXYGEN__) + /** + * @brief The Virtual Method Table for a widget + * @note A widget must have a destroy function. Either use @p _gwidgetDestroy() or use your own function + * which internally calls @p _gwidgetDestroy(). + * @note A widget must have a redraw function. Use @p _gwidgetRedraw(). + * @note If no MouseDown(), MouseUp() or MouseMove() function is provided, the widget will not accept being attached to a mouse input source. + * @note If no ToggleOn() or ToggleOff() function is provided, the widget will not accept being attached to a toggle input source. + * @note If no DialMove() function is provided, the widget will not accept being attached to a dial input source. + * @note AssignToggle() and AssignDial() enable a widget to handle more than one toggle/dial device attached to the widget. + * For example, a slider might accept two toggles, one for slider-down and one for slider-up. + * The function enables the widget to record that a particular device instance performs each particular role. + * (eg toggle0 = slider-down, toggle1 = slider-up). + * @{ + */ + typedef struct gwidgetVMT { + struct gwinVMT g; // @< This is still a GWIN + void (*DefaultDraw) (GWidgetObject *gw, void *param); // @< The default drawing routine (mandatory) + void (*MouseDown) (GWidgetObject *gw, coord_t x, coord_t y); // @< Process mouse down events (optional) + void (*MouseUp) (GWidgetObject *gw, coord_t x, coord_t y); // @< Process mouse up events (optional) + void (*MouseMove) (GWidgetObject *gw, coord_t x, coord_t y); // @< Process mouse move events (optional) + void (*ToggleOff) (GWidgetObject *gw, uint16_t instance); // @< Process toggle off events (optional) + void (*ToggleOn) (GWidgetObject *gw, uint16_t instance); // @< Process toggle on events (optional) + void (*DialMove) (GWidgetObject *gw, uint16_t instance, uint16_t value); // @< Process dial move events (optional) + void (*AllEvents) (GWidgetObject *gw, GEvent *pe); // @< Process all events (optional) + bool_t (*AssignToggle) (GWidgetObject *gw, uint16_t role, uint16_t instance); // @< Test the role and save the toggle instance handle (optional) + bool_t (*AssignDial) (GWidgetObject *gw, uint16_t role, uint16_t instance); // @< Test the role and save the dial instance handle (optional) + } gwidgetVMT; + /* @} */ +#endif + +#if GWIN_NEED_WINDOWMANAGER || defined(__DOXYGEN__) + // @note There is only ever one instance of each GWindowManager type + typedef struct GWindowManager { + const struct gwmVMT *vmt; + } GWindowManager; + + /** + * @brief The Virtual Method Table for a window manager + * @{ + */ + typedef struct gwmVMT { + void (*Init) (void); // @< The window manager has just been set as the current window manager + void (*DeInit) (void); // @< The window manager has just been removed as the current window manager + bool_t (*Add) (GHandle gh, coord_t x, coord_t y, coord_t w, coord_t h); // @< A window has been added + void (*Delete) (GHandle gh); // @< A window has been deleted + void (*Visible) (GHandle gh); // @< A window has changed its visibility state + void (*Redim) (GHandle gh, coord_t x, coord_t y, coord_t w, coord_t h); // @< A window wants to be moved or resized + void (*Raise) (GHandle gh); // @< A window wants to be on top + void (*MinMax) (GHandle gh, GWindowMinMax minmax); // @< A window wants to be minimized/maximised + } gwmVMT; + /* @} */ + + /** + * @brief The list of all windows in the system + */ + extern gfxQueueASync _GWINList; +#endif #ifdef __cplusplus extern "C" { @@ -86,32 +122,44 @@ extern "C" { * @param[in] w, h The width and height of the GWIN window * @param[in] size The size of the GWIN object to allocate * @param[in] vmt The virtual method table for the GWIN object + * @param[in] flags The default flags to use * * @notapi */ -GHandle _gwinInit(GWindowObject *pgw, coord_t x, coord_t y, coord_t w, coord_t h, size_t size, const gwinVMT *vmt); +GHandle _gwindowInit(GWindowObject *pgw, coord_t x, coord_t y, coord_t w, coord_t h, size_t size, const gwinVMT *vmt, uint16_t flags); -/** - * @brief Initialise (and allocate if necessary) the base Widget object - * - * @param[in] pgw The GWidgetObject structure. If NULL one is allocated from the heap - * @param[in] x, y The top left corner of the Widget relative to the screen - * @param[in] w, h The width and height of the Widget window - * @param[in] size The size of the Widget object to allocate - * @param[in] vmt The virtual method table for the Widget object - * - * @notapi - */ -GHandle _gwidgetInit(GWidgetObject *pgw, coord_t x, coord_t y, coord_t w, coord_t h, size_t size, const gwidgetVMT *vmt); +#if GWIN_NEED_WIDGET || defined(__DOXYGEN__) + /** + * @brief Initialise (and allocate if necessary) the base Widget object + * + * @param[in] pgw The GWidgetObject structure. If NULL one is allocated from the heap + * @param[in] x, y The top left corner of the Widget relative to the screen + * @param[in] w, h The width and height of the Widget window + * @param[in] size The size of the Widget object to allocate + * @param[in] vmt The virtual method table for the Widget object + * + * @notapi + */ + GHandle _gwidgetInit(GWidgetObject *pgw, coord_t x, coord_t y, coord_t w, coord_t h, size_t size, const gwidgetVMT *vmt); -/** - * @brief Destroy the Widget object - * - * @param[in] gw The widget to destroy - * - * @notapi - */ -void _gwidgetDestroy(GHandle gh); + /** + * @brief Destroy the Widget object + * + * @param[in] gh The widget to destroy + * + * @notapi + */ + void _gwidgetDestroy(GHandle gh); + + /** + * @brief Redraw the Widget object + * + * @param[in] gh The widget to redraw + * + * @notapi + */ + void _gwidgetRedraw(GHandle gh); +#endif #ifdef __cplusplus } |