summaryrefslogtreecommitdiff
path: root/FL/Fl_Menu_Button.H
diff options
context:
space:
mode:
Diffstat (limited to 'FL/Fl_Menu_Button.H')
-rw-r--r--FL/Fl_Menu_Button.H20
1 files changed, 20 insertions, 0 deletions
diff --git a/FL/Fl_Menu_Button.H b/FL/Fl_Menu_Button.H
index b0d669a05..7acebcef0 100644
--- a/FL/Fl_Menu_Button.H
+++ b/FL/Fl_Menu_Button.H
@@ -30,6 +30,26 @@
#include "Fl_Menu_.H"
+/**
+ This is a button that when pushed pops up a menu (or hierarchy of
+ menus) defined by an array of
+ Fl_Menu_Item objects.
+ <P ALIGN=CENTER>\image html src=</P>
+ <P>Normally any mouse button will pop up a menu and it is lined up
+ below the button as shown in the picture. However an Fl_Menu_Button
+ may also control a pop-up menu. This is done by setting the type()
+ , see below. </P>
+ <P>The menu will also pop up in response to shortcuts indicated by
+ putting a '&' character in the label(). </P>
+ <P>Typing the shortcut() of any of the menu items will cause
+ callbacks exactly the same as when you pick the item with the mouse.
+ The '&' character in menu item names are only looked at when the menu is
+ popped up, however. </P>
+ <P>When the user picks an item off the menu, the item's callback is
+ done with the menu_button as the Fl_Widget* argument. If the
+ item does not have a callback the menu_button's callback is done
+ instead.
+*/
class FL_EXPORT Fl_Menu_Button : public Fl_Menu_ {
protected:
void draw();