Author: greg.ercolano
Date: 2009-09-08 23:04:36 -0700 (Tue, 08 Sep 2009)
New Revision: 6855
Log:
Docs added for Fl_Menu_Item flags -- solves STR #2157.



Modified:
   branches/branch-1.3/FL/Fl_Menu_Item.H

Modified: branches/branch-1.3/FL/Fl_Menu_Item.H
===================================================================
--- branches/branch-1.3/FL/Fl_Menu_Item.H       2009-09-09 05:29:47 UTC (rev 
6854)
+++ branches/branch-1.3/FL/Fl_Menu_Item.H       2009-09-09 06:04:36 UTC (rev 
6855)
@@ -36,15 +36,15 @@
 #  endif
 
 enum { // values for flags:
-  FL_MENU_INACTIVE = 1,
-  FL_MENU_TOGGLE= 2,
-  FL_MENU_VALUE = 4,
-  FL_MENU_RADIO = 8,
-  FL_MENU_INVISIBLE = 0x10,
-  FL_SUBMENU_POINTER = 0x20,
-  FL_SUBMENU = 0x40,
-  FL_MENU_DIVIDER = 0x80,
-  FL_MENU_HORIZONTAL = 0x100
+  FL_MENU_INACTIVE = 1,                ///< Deactivate menu item (gray out)
+  FL_MENU_TOGGLE= 2,           ///< Item is a checkbox toggle (shows checkbox 
for on/off state)
+  FL_MENU_VALUE = 4,           ///< The on/off state for checkbox/radio 
buttons (if set, state is 'on')
+  FL_MENU_RADIO = 8,           ///< Item is a radio button (one checkbox of 
many can be on)
+  FL_MENU_INVISIBLE = 0x10,    ///< Item will not show up (shortcut will work)
+  FL_SUBMENU_POINTER = 0x20,   ///< Indicates user_data() is a pointer to 
another menu array
+  FL_SUBMENU = 0x40,           ///< This item is a submenu to other items
+  FL_MENU_DIVIDER = 0x80,      ///< Creates divider line below this item. Also 
ends a group of radio buttons.
+  FL_MENU_HORIZONTAL = 0x100   ///< ??? -- reserved
 };
 
 extern FL_EXPORT int fl_old_shortcut(const char*);
@@ -68,15 +68,15 @@
   };
   
   enum { // values for flags:
-   FL_MENU_INACTIVE    = 1,
-   FL_MENU_TOGGLE      = 2,
-   FL_MENU_VALUE       = 4,
-   FL_MENU_RADIO       = 8,
-   FL_MENU_INVISIBLE   = 0x10,
-   FL_SUBMENU_POINTER  = 0x20,
-   FL_SUBMENU          = 0x40,
-   FL_MENU_DIVIDER     = 0x80,
-   FL_MENU_HORIZONTAL  = 0x100
+   FL_MENU_INACTIVE    = 1,      // Deactivate menu item (gray out)
+   FL_MENU_TOGGLE      = 2,      // Item is a checkbox toggle (shows checkbox 
for on/off state)
+   FL_MENU_VALUE       = 4,      // The on/off state for checkbox/radio 
buttons (if set, state is 'on')
+   FL_MENU_RADIO       = 8,      // Item is a radio button (one checkbox of 
many can be on)
+   FL_MENU_INVISIBLE   = 0x10,   // Item will not show up (shortcut will work)
+   FL_SUBMENU_POINTER  = 0x20,   // Indicates user_data() is a pointer to 
another menu array
+   FL_SUBMENU          = 0x40,   // This item is a submenu to other items
+   FL_MENU_DIVIDER     = 0x80,   // Creates divider line below this item. Also 
ends a group of radio buttons.
+   FL_MENU_HORIZONTAL  = 0x100   // ??? -- reserved
   };
   \endcode
   Typically menu items are statically defined; for example:

_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit

Reply via email to