From c732a4d635e8b6fe2765bb18bb8e8ef19cbaf2f2 Mon Sep 17 00:00:00 2001 From: Greg Ercolano Date: Sat, 10 Jan 2015 22:05:15 +0000 Subject: Documentation clarification for all menu oriented widgets regarding callbacks. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10513 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Menu_Button.H | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) (limited to 'FL/Fl_Menu_Button.H') diff --git a/FL/Fl_Menu_Button.H b/FL/Fl_Menu_Button.H index 6a556aeb3..7f18eab66 100644 --- a/FL/Fl_Menu_Button.H +++ b/FL/Fl_Menu_Button.H @@ -42,10 +42,18 @@ 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. + + When the user clicks a menu item, value() is set to that item + and then: + + - The item's callback is done if one has been set; the + Fl_Menu_Button is passed as the Fl_Widget* argument, + along with any userdata configured for the callback. + + - If the item does not have a callback, the Fl_Menu_Button's callback + is done instead, along with any userdata configured for it. + The callback can determine which item was picked using + value(), mvalue(), item_pathname(), etc. */ class FL_EXPORT Fl_Menu_Button : public Fl_Menu_ { protected: -- cgit v1.2.3