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

More doxygen improvements

ugfx_release_2.6
Joel Bodenmann 2015-11-03 22:05:04 +01:00
parent 86aef5990a
commit 07bf8a37f9
13 changed files with 201 additions and 159 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doxygenfile
View File

@ -2015,7 +2015,7 @@ ALLEXTERNALS = NO
# listed. # listed.
# The default value is: YES. # The default value is: YES.
EXTERNAL_GROUPS = YES EXTERNAL_GROUPS = NO
# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
# the related pages index. If set to NO, only the current project's pages will # the related pages index. If set to NO, only the current project's pages will

2
src/gwin/gwin_button.h
View File

@ -86,7 +86,7 @@ GHandle gwinGButtonCreate(GDisplay *g, GButtonObject *gb, const GWidgetInit *pIn
bool_t gwinButtonIsPressed(GHandle gh); bool_t gwinButtonIsPressed(GHandle gh);
/** /**
* @defgroup Renderings_Button Button rendering functions * @defgroup Renderings_Button Renderings
* *
* @brief Built-in rendering functions for the button widget. * @brief Built-in rendering functions for the button widget.
* *

2
src/gwin/gwin_checkbox.h
View File

@ -99,7 +99,7 @@ void gwinCheckboxCheck(GHandle gh, bool_t isChecked);
bool_t gwinCheckboxIsChecked(GHandle gh); bool_t gwinCheckboxIsChecked(GHandle gh);
/** /**
* @defgroup Renderings_Checkbox Checkbox rendering functions * @defgroup Renderings_Checkbox Renderings
* *
* @brief Built-in rendering functions for the checkbox widget. * @brief Built-in rendering functions for the checkbox widget.
* *

37
src/gwin/gwin_container.h
View File

@ -120,7 +120,7 @@ GHandle gwinGContainerCreate(GDisplay *g, GContainerObject *gw, const GWidgetIni
/** /**
* @defgroup Renderings_Container Container rendering functions * @defgroup Renderings_Container Renderings
* *
* @brief Built-in rendering functions for the container widget. * @brief Built-in rendering functions for the container widget.
* *
@ -158,21 +158,26 @@ void gwinContainerDraw_Std(GWidgetObject *gw, void *param);
*/ */
void gwinContainerDraw_Transparent(GWidgetObject *gw, void *param); void gwinContainerDraw_Transparent(GWidgetObject *gw, void *param);
/** #if GDISP_NEED_IMAGE || defined(__DOXYGEN__)
* @brief Renders the container and uses the specified image for the client area. /**
* * @brief Renders the container and uses the specified image for the client area.
* @details The image will be tiled throghout the client area. Therefore, to archive the best looking result the *
* supplied image needs to be of the same size as the client area size of the container widget (inner size). * @details The image will be tiled throghout the client area. Therefore, to archive the best looking result the
* * supplied image needs to be of the same size as the client area size of the container widget (inner size).
* @param[in] gw The widget object (must be a container object). *
* @param[in] param A parameter passed in from the user. Must be an image handle. See note below. * @param[in] gw The widget object (must be a container object).
* * @param[in] param A parameter passed in from the user. Must be an image handle. See note below.
* @note The image must be already opened before calling @p gwinSetCustomDraw(). The handle is passed as the parameter *
* to this function. * @note The image must be already opened before calling @p gwinSetCustomDraw(). The handle is passed as the parameter
* * to this function.
* @api *
*/ * @pre GDISP_NEED_IMAGE must be set to TRUE
void gwinContainerDraw_Image(GWidgetObject *gw, void *param); *
* @api
*/
void gwinContainerDraw_Image(GWidgetObject *gw, void *param);
#endif /* GDISP_NEED_IMAGE */
/** @} */ /** @} */
#ifdef __cplusplus #ifdef __cplusplus

36
src/gwin/gwin_frame.h
View File

@ -62,7 +62,7 @@ GHandle gwinGFrameCreate(GDisplay *g, GFrameObject *fo, GWidgetInit *pInit, uint
#define gwinFrameCreate(fo, pInit, flags) gwinGFrameCreate(GDISP, fo, pInit, flags); #define gwinFrameCreate(fo, pInit, flags) gwinGFrameCreate(GDISP, fo, pInit, flags);
/** /**
* @defgroup Renderings_Frame Frame rendering functions * @defgroup Renderings_Frame Renderings
* *
* @brief Built-in rendering functions for the frame widget. * @brief Built-in rendering functions for the frame widget.
* *
@ -103,21 +103,25 @@ void gwinFrameDraw_Std(GWidgetObject *gw, void *param);
*/ */
void gwinFrameDraw_Transparent(GWidgetObject *gw, void *param); void gwinFrameDraw_Transparent(GWidgetObject *gw, void *param);
/** #if GDISP_NEED_IMAGE || defined(__DOXYGEN__)
* @brief Renders the frame widget and uses the specified image for the client area. /**
* * @brief Renders the frame widget and uses the specified image for the client area.
* @details The image will be tiled throghout the client area. Therefore, to archive the best looking result the *
* supplied image needs to be of the same size as the client area size of the frame widget (inner size). * @details The image will be tiled throghout the client area. Therefore, to archive the best looking result the
* * supplied image needs to be of the same size as the client area size of the frame widget (inner size).
* @param[in] gw The widget object (must be a frame object). *
* @param[in] param A parameter passed in from the user. Must be an image handle. See note below. * @param[in] gw The widget object (must be a frame object).
* * @param[in] param A parameter passed in from the user. Must be an image handle. See note below.
* @note The image must be already opened before calling @p gwinSetCustomDraw(). The handle is passed as the parameter *
* to this function. * @note The image must be already opened before calling @p gwinSetCustomDraw(). The handle is passed as the parameter
* * to this function.
* @api *
*/ * @pre GDISP_NEED_IMAGE must be set to TRUE
void gwinFrameDraw_Image(GWidgetObject *gw, void *param); *
* @api
*/
void gwinFrameDraw_Image(GWidgetObject *gw, void *param);
#endif /* GDISP_NEED_IMAGE */
/** @} */ /** @} */
#ifdef __cplusplus #ifdef __cplusplus

4
src/gwin/gwin_keyboard.h
View File

@ -9,7 +9,7 @@
* @file src/gwin/gwin_keyboard.h * @file src/gwin/gwin_keyboard.h
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Keyboard Keyboard * @defgroup VirtualKeyboard VirtualKeyboard
* @ingroup Widgets * @ingroup Widgets
* *
* @details GWIN allows it to easily create buttons with different styles * @details GWIN allows it to easily create buttons with different styles
@ -102,7 +102,7 @@ GSourceHandle gwinKeyboardGetEventSource(GHandle gh);
void gwinKeyboardSetLayout(GHandle gh, struct GVKeyTable *layout); void gwinKeyboardSetLayout(GHandle gh, struct GVKeyTable *layout);
/** /**
* @defgroup Renderings_Keyboard Keyboard rendering functions * @defgroup Renderings_Keyboard Renderings
* *
* @brief Built-in rendering functions for the keyboard widget. * @brief Built-in rendering functions for the keyboard widget.
* *

2
src/gwin/gwin_label.h
View File

@ -101,7 +101,7 @@ void gwinLabelSetBorder(GHandle gh, bool_t border);
#endif #endif
/** /**
* @defgroup Renderings_Label Label rendering functions * @defgroup Renderings_Label Renderings
* *
* @brief Built-in rendering functions for the label widget. * @brief Built-in rendering functions for the label widget.
* *

2
src/gwin/gwin_list.h
View File

@ -327,7 +327,7 @@ void gwinListViewItem(GHandle gh, int item);
#endif #endif
/** /**
* @defgroup Renderings_List List rendering functions * @defgroup Renderings_List Renderings
* *
* @brief Built-in rendering functions for the list widget. * @brief Built-in rendering functions for the list widget.
* *

2
src/gwin/gwin_progressbar.h
View File

@ -176,7 +176,7 @@ void gwinProgressbarDecrement(GHandle gh);
#endif /* GWIN_PROGRESSBAR_AUTO */ #endif /* GWIN_PROGRESSBAR_AUTO */
/** /**
* @defgroup Renderings_Progressbar Progressbar rendering functions * @defgroup Renderings_Progressbar Renderings
* *
* @brief Built-in rendering functions for the progressbar widget. * @brief Built-in rendering functions for the progressbar widget.
* *

2
src/gwin/gwin_radio.h
View File

@ -116,7 +116,7 @@ bool_t gwinRadioIsPressed(GHandle gh);
GHandle gwinRadioGetActive(uint16_t group); GHandle gwinRadioGetActive(uint16_t group);
/** /**
* @defgroup Renderings_Radiobutton RadioButton rendering functions * @defgroup Renderings_Radiobutton Renderings
* *
* @brief Built-in rendering functions for the radiobutton widget. * @brief Built-in rendering functions for the radiobutton widget.
* *

2
src/gwin/gwin_slider.h
View File

@ -143,7 +143,7 @@ void gwinSliderSetPosition(GHandle gh, int pos);
void gwinSliderSendExtendedEvents(GHandle gh, bool_t enabled); void gwinSliderSendExtendedEvents(GHandle gh, bool_t enabled);
/** /**
* @defgroup Renderings_Slider Slider rendering functions * @defgroup Renderings_Slider Renderings
* *
* @brief Built-in rendering functions for the slider widget. * @brief Built-in rendering functions for the slider widget.
* *

265
src/gwin/gwin_tabset.h
View File

@ -62,140 +62,173 @@ typedef struct GTabsetObject {
extern "C" { extern "C" {
#endif #endif
/** /**
* @brief Create a tabset widget * @brief Create a tabset widget
* *
* @details This widget provides a set of tabs. * @details This widget provides a set of tabs.
* *
* @param[in] g The GDisplay to display this window on * @param[in] g The GDisplay to display this window on
* @param[in] fo The GTabsetObject structure to initialize. If this is NULL the structure is dynamically allocated. * @param[in] fo The GTabsetObject structure to initialize. If this is NULL the structure is dynamically allocated.
* @param[in] pInit The initialization parameters * @param[in] pInit The initialization parameters
* @param[in] flags Some flags, see notes. * @param[in] flags Some flags, see notes.
* *
* @note Possible flags are: GWIN_TABSET_BORDER * @note Possible flags are: GWIN_TABSET_BORDER
* *
* @return NULL if there is no resulting widget. A valid GHandle otherwise. * @return NULL if there is no resulting widget. A valid GHandle otherwise.
* *
* @api * @api
*/ */
GHandle gwinGTabsetCreate(GDisplay *g, GTabsetObject *fo, GWidgetInit *pInit, uint32_t flags); GHandle gwinGTabsetCreate(GDisplay *g, GTabsetObject *fo, GWidgetInit *pInit, uint32_t flags);
#define gwinTabsetCreate(fo, pInit, flags) gwinGTabsetCreate(GDISP, fo, pInit, flags); #define gwinTabsetCreate(fo, pInit, flags) gwinGTabsetCreate(GDISP, fo, pInit, flags);
/** /**
* @brief Add a tab-page to the tabset * @brief Add a tab-page to the tabset
* @returns The GHandle of the tab-page container. * @returns The GHandle of the tab-page container.
* *
* @param[in] gh The tabset handle * @param[in] gh The tabset handle
* @param[in] title The text to set. This must be a constant string unless useAlloc is set. * @param[in] title The text to set. This must be a constant string unless useAlloc is set.
* @param[in] useAlloc If TRUE the string specified will be copied into dynamically allocated memory. * @param[in] useAlloc If TRUE the string specified will be copied into dynamically allocated memory.
* *
* @api * @api
*/ */
GHandle gwinTabsetAddTab(GHandle gh, const char *title, bool_t useAlloc); GHandle gwinTabsetAddTab(GHandle gh, const char *title, bool_t useAlloc);
/** /**
* @brief Delete a tab-page. * @brief Delete a tab-page.
* @details Any widgets on the page will also be destroyed * @details Any widgets on the page will also be destroyed
* *
* @param[in] gh The tab-page handle * @param[in] gh The tab-page handle
* *
* @note The index position of all tabs after this tab in the tabset are automatically renumbered. * @note The index position of all tabs after this tab in the tabset are automatically renumbered.
* *
* @api * @api
*/ */
#define gwinTabsetDeleteTab(gh) gwinDestroy(gh) #define gwinTabsetDeleteTab(gh) gwinDestroy(gh)
/** /**
* @brief Count the number of tabs in the tabset * @brief Count the number of tabs in the tabset
* @returns The number of tabs or zero if none exist. * @returns The number of tabs or zero if none exist.
* *
* @param[in] gh The tabset handle * @param[in] gh The tabset handle
* *
* @api * @api
*/ */
int gwinTabsetCountTabs(GHandle gh); int gwinTabsetCountTabs(GHandle gh);
/** /**
* @brief Get the GHandle of a tab based on its position * @brief Get the GHandle of a tab based on its position
* @returns The GHandle of the tab-page container or NULL if that tab-page doesn't exist. * @returns The GHandle of the tab-page container or NULL if that tab-page doesn't exist.
* *
* @param[in] gh The tabset handle * @param[in] gh The tabset handle
* @param[in] index The tab-page handle to return (0 to number of pages - 1) * @param[in] index The tab-page handle to return (0 to number of pages - 1)
* *
* @api * @api
*/ */
GHandle gwinTabsetGetTabByIndex(GHandle gh, int index); GHandle gwinTabsetGetTabByIndex(GHandle gh, int index);
/** /**
* @brief Get the GHandle of a tab based on its title * @brief Get the GHandle of a tab based on its title
* @returns The GHandle of the tab-page container or NULL if that tab-page doesn't exist. * @returns The GHandle of the tab-page container or NULL if that tab-page doesn't exist.
* *
* @param[in] gh The tabset handle * @param[in] gh The tabset handle
* @param[in] title The title to search for * @param[in] title The title to search for
* *
* @api * @api
*/ */
GHandle gwinTabsetGetTabByTitle(GHandle gh, const char *title); GHandle gwinTabsetGetTabByTitle(GHandle gh, const char *title);
/** /**
* @brief Set the title of a tab-page. * @brief Set the title of a tab-page.
* *
* @param[in] gh The tab-page handle (NB: Use the page handle NOT the tabset handle) * @param[in] gh The tab-page handle (NB: Use the page handle NOT the tabset handle)
* @param[in] title The text to set. This must be a constant string unless useAlloc is set. * @param[in] title The text to set. This must be a constant string unless useAlloc is set.
* @param[in] useAlloc If TRUE the string specified will be copied into dynamically allocated memory. * @param[in] useAlloc If TRUE the string specified will be copied into dynamically allocated memory.
* *
* @note This function should be used to change the text associated with a tab-page * @note This function should be used to change the text associated with a tab-page
* rather than @p gwinSetText(). * rather than @p gwinSetText().
* *
* @api * @api
*/ */
void gwinTabsetSetTitle(GHandle gh, const char *title, bool_t useAlloc); void gwinTabsetSetTitle(GHandle gh, const char *title, bool_t useAlloc);
/** /**
* @brief Get the title of a tab-page. * @brief Get the title of a tab-page.
* @return The title of the tab. * @return The title of the tab.
* *
* @param[in] gh The tab-page handle (NB: Use the page handle NOT the tabset handle) * @param[in] gh The tab-page handle (NB: Use the page handle NOT the tabset handle)
* *
* @api * @api
*/ */
#define gwinTabsetGetTitle(gh) gwinGetText(gh) #define gwinTabsetGetTitle(gh) gwinGetText(gh)
/** /**
* @brief Set the active tab in a tabset. * @brief Set the active tab in a tabset.
* *
* @param[in] gh The tab-page handle (NB: Use the page handle NOT the tabset handle) * @param[in] gh The tab-page handle (NB: Use the page handle NOT the tabset handle)
* *
* @api * @api
*/ */
void gwinTabsetSetTab(GHandle gh); void gwinTabsetSetTab(GHandle gh);
/**
* @defgroup Renderings_Tabset Renderings
*
* @brief Built-in rendering functions for the tabset widget.
*
* @details These function may be passed to @p gwinSetCustomDraw() to get different tabset drawing styles.
*
* @note In your custom tabset drawing function you may optionally call these
* standard functions and then draw your extra details on top.
* @note These custom drawing routines don't have to worry about setting clipping as the framework
* sets clipping to the object window prior to calling these routines.
*
* @{
*/
/**
* @brief The default rendering function for the tabset widget.
*
* @details Fills the client area with the background color.
*
* @param[in] gw The widget object (must be a container object).
* @param[in] param A parameter passed in from the user. Ignored by this function.
*
* @api
*/
void gwinTabsetDraw_Std(GWidgetObject *gw, void *param);
/**
* @brief Renders the tabset but leaves the client area transparent.
*
* @details Will not fill the client area at all.
*
* @param[in] gw The widget object (must be a container object).
* @param[in] param A parameter passed in from the user. Ignored by this function.
*
* @api
*/
void gwinTabsetDraw_Transparent(GWidgetObject *gw, void *param);
#if GDISP_NEED_IMAGE || defined(__DOXYGEN__)
/** /**
* @brief The custom draw routines for a frame window * @brief Renders the tabset and uses the specified image for the client area.
* @details These function may be passed to @p gwinSetCustomDraw() to get different frame drawing styles
* *
* @param[in] gw The widget object (in this case a frame) * @details The image will be tiled throghout the client area. Therefore, to archive the best looking result the
* @param[in] param A parameter passed in from the user * supplied image needs to be of the same size as the client area size of the tabset widget (inner size).
* *
* @note In your own custom drawing function you may optionally call these * @param[in] gw The widget object (must be a tabset object).
* standard functions and then draw your extra details on top. * @param[in] param A parameter passed in from the user. Must be an image handle. See note below.
* *
* @note gwinTabsetDraw_Std() will fill the client area with the background color.<br/> * @note The image must be already opened before calling @p gwinSetCustomDraw(). The handle is passed as the parameter
* gwinTabsetDraw_Transparent() will not fill the client area at all.<br/> * to this function.
* gwinTabsetDraw_Image() will tile the image throughout the client area.<br/>
* All these drawing functions draw the frame itself the same way.
* *
* @note The standard functions below ignore the param parameter except for @p gwinTabsetDraw_Image(). * @pre GDISP_NEED_IMAGE must be set to TRUE
* @note The image custom draw function @p gwinTabsetDraw_Image() uses param to pass in the gdispImage pointer.
* The image must be already opened before calling @p gwinSetCustomDraw().
* *
* @api * @api
* @{
*/ */
void gwinTabsetDraw_Std(GWidgetObject *gw, void *param);
void gwinTabsetDraw_Transparent(GWidgetObject *gw, void *param);
void gwinTabsetDraw_Image(GWidgetObject *gw, void *param); void gwinTabsetDraw_Image(GWidgetObject *gw, void *param);
/** @} */ #endif /* GDISP_NEED_IMAGE */
/** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }

2
src/gwin/gwin_textedit.h
View File

@ -61,7 +61,7 @@ GHandle gwinGTexteditCreate(GDisplay* g, GTexteditObject* wt, GWidgetInit* pInit
#define gwinTexteditCreate(wt, pInit, maxSize) gwinGTexteditCreate(GDISP, wt, pInit, maxSize) #define gwinTexteditCreate(wt, pInit, maxSize) gwinGTexteditCreate(GDISP, wt, pInit, maxSize)
/** /**
* @defgroup Renderings_Textedit Textedit rendering functions * @defgroup Renderings_Textedit Renderings
* *
* @brief Built-in rendering functions for the textedit widget. * @brief Built-in rendering functions for the textedit widget.
* *