summaryrefslogtreecommitdiff
path: root/src/Fl_Tree_Prefs.cxx
diff options
context:
space:
mode:
authorMatthias Melcher <fltk@matthiasm.com>2018-06-23 16:47:40 +0000
committerMatthias Melcher <fltk@matthiasm.com>2018-06-23 16:47:40 +0000
commita9fd08ff5ab8bbf3838200ceace671a72627d212 (patch)
treeb7821c8f82a8ab75c682d9175c24bfaaf2993501 /src/Fl_Tree_Prefs.cxx
parent8c993648dbb568e35271ad4c8bd346d7eb97e69b (diff)
Doxygen: created Group to document drivers, disabled by default
Uncomment `ENABLED_SECTIONS += DriverDev` in documentation/Doxyfile.in to enable driver documentation. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12968 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/Fl_Tree_Prefs.cxx')
-rw-r--r--src/Fl_Tree_Prefs.cxx22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/Fl_Tree_Prefs.cxx b/src/Fl_Tree_Prefs.cxx
index 060d46d4b..19519ff0d 100644
--- a/src/Fl_Tree_Prefs.cxx
+++ b/src/Fl_Tree_Prefs.cxx
@@ -87,6 +87,13 @@ int Fl_Darwin_System_Driver::tree_connector_style() {
#endif // FL_CFG_WIN_COCOA
+
+/**
+ * @cond DriverDev
+ * @addtogroup DriverDeveloper
+ * @{
+ */
+
const char * const Fl_System_Driver::tree_open_xpm[] = {
"11 11 3 1",
". c #fefefe",
@@ -124,6 +131,16 @@ const char * const Fl_System_Driver::tree_close_xpm[] = {
};
+/**
+ * Return the address of a pixmap that show a plus in a box.
+ *
+ * This pixmap is used to indicate a brach of a tree that is closed and
+ * can be opened by clicking it.
+ *
+ * Other platforms may use other symbols which can be reimplemented in the
+ * driver. Notably, Apple Mac systems mark a closed branch with a triangle
+ * pointing to the right, and an open branch with a triangle pointing down.
+ */
Fl_Pixmap *Fl_System_Driver::tree_openpixmap() {
static Fl_Pixmap *pixmap = new Fl_Pixmap(tree_open_xpm);
return pixmap;
@@ -138,6 +155,11 @@ int Fl_System_Driver::tree_connector_style() {
return FL_TREE_CONNECTOR_DOTTED;
}
+/**
+ * @}
+ * @endcond
+ */
+
/// Sets the default icon to be used as the 'open' icon
/// when items are add()ed to the tree.