aboutsummaryrefslogtreecommitdiffstats
path: root/src/gwin/gwin_list.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/gwin/gwin_list.h')
-rw-r--r--src/gwin/gwin_list.h27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/gwin/gwin_list.h b/src/gwin/gwin_list.h
index 28506778..8e69aa5d 100644
--- a/src/gwin/gwin_list.h
+++ b/src/gwin/gwin_list.h
@@ -326,6 +326,33 @@ void gwinListViewItem(GHandle gh, int item);
void gwinListItemSetImage(GHandle gh, int item, gdispImage *pimg);
#endif
+/**
+ * @defgroup Renderings_List List rendering functions
+ *
+ * @brief Built-in rendering functions for the list widget.
+ *
+ * @details These function may be passed to @p gwinSetCustomDraw() to get different list drawing styles.
+ *
+ * @note In your custom list 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 list widget
+ *
+ * @param[in] gw The widget object (must be a list object)
+ * @param[in] param A parameter passed in from the user. Ignored by this function.
+ *
+ * @api
+ */
+void gwinListDefaultDraw(GWidgetObject* gw, void* param);
+
+/** @} */
+
#ifdef __cplusplus
}
#endif