summaryrefslogtreecommitdiff
path: root/FL/Fl_Choice.H
diff options
context:
space:
mode:
authorGreg Ercolano <erco@seriss.com>2015-01-10 22:05:15 +0000
committerGreg Ercolano <erco@seriss.com>2015-01-10 22:05:15 +0000
commitc732a4d635e8b6fe2765bb18bb8e8ef19cbaf2f2 (patch)
treec30bc0754eaed481aa1effb8ebe65f195f43a089 /FL/Fl_Choice.H
parent8fe94273fffb5b968c0ac2dcf13d829de449ae0a (diff)
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
Diffstat (limited to 'FL/Fl_Choice.H')
-rw-r--r--FL/Fl_Choice.H15
1 files changed, 11 insertions, 4 deletions
diff --git a/FL/Fl_Choice.H b/FL/Fl_Choice.H
index 8146f9476..1f93fb40a 100644
--- a/FL/Fl_Choice.H
+++ b/FL/Fl_Choice.H
@@ -38,10 +38,17 @@
often to control a single variable rather than do individual callbacks,
some of the Fl_Menu_Button methods are redescribed here in those terms.
- When the user picks an item off the menu the value() is set to that item
- and then the item's callback is done with the menu_button as the
- \c 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_Choice 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_Choice widget'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.
All three mouse buttons pop up the menu. The Forms behavior of the first
two buttons to increment/decrement the choice is not implemented. This