summaryrefslogtreecommitdiff
path: root/FL
diff options
context:
space:
mode:
authorGreg Ercolano <erco@seriss.com>2019-07-26 12:14:49 -0700
committerGreg Ercolano <erco@seriss.com>2019-07-26 12:14:49 -0700
commitc03583a8bc52772d19467128ef3161c1854c23e1 (patch)
tree3ef37c063c548b0348e04b7dc008a6dd9afa7ade /FL
parent8c7b7eea4b45d0727fbbda430cb7978c9b9f952d (diff)
Add small code example, moved widget screenshot higher on doc page
Diffstat (limited to 'FL')
-rw-r--r--FL/Fl_Choice.H26
1 files changed, 24 insertions, 2 deletions
diff --git a/FL/Fl_Choice.H b/FL/Fl_Choice.H
index 1f93fb40a..377bee181 100644
--- a/FL/Fl_Choice.H
+++ b/FL/Fl_Choice.H
@@ -28,6 +28,9 @@
\class Fl_Choice
\brief A button that is used to pop up a menu.
+ \image html choice.png
+ \image latex choice.png "Fl_Choice" width=4cm
+
This is a button that, when pushed, pops up a menu (or hierarchy of menus)
defined by an array of Fl_Menu_Item objects.
Motif calls this an OptionButton.
@@ -62,8 +65,6 @@
you pick the item with the mouse. The '\&' character in item names are
only looked at when the menu is popped up, however.
- \image html choice.png
- \image latex choice.png "Fl_Choice" width=4cm
\todo Refactor the doxygen comments for Fl_Choice changed() documentation.
\li <tt>int Fl_Widget::changed() const</tt>
@@ -79,6 +80,27 @@
The default down box type is \c FL_DOWN_BOX.
\li <tt>void Fl_Choice::down_box(Fl_Boxtype b)</tt>
Sets the current down box type to \p b.
+
+ Simple example:
+ \par
+ \code
+ #include <FL/Fl.H>
+ #include <FL/Fl_Window.H>
+ #include <FL/Fl_Choice.H>
+ int main() {
+ Fl_Window *win = new Fl_Window(300,200);
+ Fl_Choice *choice = new Fl_Choice(100,10,100,25,"Choice:");
+ choice->add("Zero");
+ choice->add("One");
+ choice->add("Two");
+ choice->add("Three");
+ choice->value(2); // make "Two" selected by default (zero based!)
+ win->end();
+ win->show();
+ return Fl::run();
+ }
+ \endcode
+
*/
class FL_EXPORT Fl_Choice : public Fl_Menu_ {
protected: