summaryrefslogtreecommitdiff
path: root/FL/Fl_Menu_Item.H
diff options
context:
space:
mode:
authorGreg Ercolano <erco@seriss.com>2009-09-09 06:04:36 +0000
committerGreg Ercolano <erco@seriss.com>2009-09-09 06:04:36 +0000
commitd018dd0971c482763eff43e90dd8ed940159cf06 (patch)
treeeef8b3406930f3720e0e68bf4667938bb42055fa /FL/Fl_Menu_Item.H
parent4c816df99ac38bd27eefa6a642e1664424ab4540 (diff)
Docs added for Fl_Menu_Item flags -- solves STR #2157.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6855 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Menu_Item.H')
-rw-r--r--FL/Fl_Menu_Item.H36
1 files changed, 18 insertions, 18 deletions
diff --git a/FL/Fl_Menu_Item.H b/FL/Fl_Menu_Item.H
index ddc3eb472..99f8a71be 100644
--- a/FL/Fl_Menu_Item.H
+++ b/FL/Fl_Menu_Item.H
@@ -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 @@ class Fl_Menu_;
};
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: