From fdcfef214e67b0b1162ef4098ba960efd7049523 Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Mon, 15 Sep 2008 00:27:28 +0000 Subject: Doxygen documentation WP7 Done. Fl_Menu_Item was a real pain to doxyfy. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6248 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Menu_Button.H | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'FL/Fl_Menu_Button.H') 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. +

\image html src=

+

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.

+

The menu will also pop up in response to shortcuts indicated by + putting a '&' character in the label().

+

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.

+

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(); -- cgit v1.2.3