diff options
| author | Michael R Sweet <michael.r.sweet@gmail.com> | 2001-11-29 19:24:00 +0000 |
|---|---|---|
| committer | Michael R Sweet <michael.r.sweet@gmail.com> | 2001-11-29 19:24:00 +0000 |
| commit | 09daf20b81cdae78772f07c0af22a571d7cc73eb (patch) | |
| tree | 1641f788cafe20b505355b0479ba0d528297eb30 /documentation/Fl_Choice.html | |
| parent | b105ab8b7fb6281635076559aae96f2b3b12fc51 (diff) | |
Documentation updates galore (up to chapter 7, still need to do chapter
8 and 9, tweek the appendices, and recapture the screenshots...)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@1786 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/Fl_Choice.html')
| -rw-r--r-- | documentation/Fl_Choice.html | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/documentation/Fl_Choice.html b/documentation/Fl_Choice.html index ad22c3448..266c217d5 100644 --- a/documentation/Fl_Choice.html +++ b/documentation/Fl_Choice.html @@ -17,26 +17,26 @@ </PRE> </UL> <H3>Description</H3> - This is a button that when pushed pops up a menu (or hierarchy of + This is a button that when pushed pops up a menu (or hierarchy of menus) defined by an array of <A href=Fl_Menu_Item.html#Fl_Menu_Item><TT> -Fl_Menu_Item</TT></A> objects. Motif calls this an OptionButton. +Fl_Menu_Item</TT></A> objects. Motif calls this an OptionButton. <P>The only difference between this and a <A href=Fl_Menu_Button.html#Fl_Menu_Button> -<TT>Fl_Menu_Button</TT></A> is that the name of the most recent chosen -menu item is displayed inside the box, while the label is displayed -outside the box. However, since the use of this is most often to -control a single variable rather than do individual callbacks, some of -the <TT>Fl_Menu_Button</TT> methods are redescribed here in those +<TT>Fl_Menu_Button</TT></A> is that the name of the most recent chosen +menu item is displayed inside the box, while the label is displayed +outside the box. However, since the use of this is most often to +control a single variable rather than do individual callbacks, some of +the <TT>Fl_Menu_Button</TT> methods are redescribed here in those terms. </P> -<P>When the user picks an item off the menu the <TT>value()</TT> is set +<P>When the user picks an item off the menu the <TT>value()</TT> is set to that item and then the callback is done. </P> -<P>All three mouse buttons pop up the menu. The Forms behavior of the -first two buttons to increment/decrement the choice is not implemented. +<P>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 could be added with a subclass, however. </P> -<P>The menu will also pop up in response to shortcuts indicated by +<P>The menu will also pop up in response to shortcuts indicated by putting a '&' character in the <TT>label()</TT>. See <A href=Fl_Button.html#Fl_Button> <TT>Fl_Button</TT></A> for a description of this. </P> -<P>Typing the <TT>shortcut()</TT> of any of the items will do exactly -the same as when you pick the item with the mouse. The '&' character in +<P>Typing the <TT>shortcut()</TT> of any of the items will do exactly +the same as when you pick the item with the mouse. The '&' character in item names are only looked at when the menu is popped up, however. </P> <P ALIGN=CENTER><IMG src="choice.gif" ALT="Fl_Choice widget."></P> <H3>Methods</H3> @@ -49,33 +49,33 @@ item names are only looked at when the menu is popped up, however. </P> <LI><A href=#Fl_Choice.set_changed>set_changed</A></LI> <LI><A href=#Fl_Choice.value>value</A></LI> </UL> -<H4><A name=Fl_Choice.Fl_Choice>Fl_Choice::Fl_Choice(int x, int y, int +<H4><A name=Fl_Choice.Fl_Choice>Fl_Choice::Fl_Choice(int x, int y, int w, int h, const char *label = 0)</A></H4> - Creates a new <TT>Fl_Choice</TT> widget using the given position, -size, and label string. The default boxtype is <TT>FL_UP_BOX</TT>. + Creates a new <TT>Fl_Choice</TT> widget using the given position, +size, and label string. The default boxtype is <TT>FL_UP_BOX</TT>. <P>The constructor sets <TT>menu()</TT> to <TT>NULL</TT>. See <A href=Fl_Menu_.html#Fl_Menu_> <TT>Fl_Menu_</TT></A> for the methods to set or change the menu. </P> <H4><A name=Fl_Choice.~Fl_Choice>virtual Fl_Choice::~Fl_Choice()</A></H4> - The destructor removes the <TT>Fl_Choice</TT> widget and all of its -menu items. + The destructor removes the <TT>Fl_Choice</TT> widget and all of its +menu items. <H4><A name=Fl_Choice.value>int Fl_Choice::value() const <BR> int Fl_Choice::value(int) <BR> int Fl_Choice::value(const Fl_Menu *)</A></H4> - The value is the index into the <TT>Fl_Menu</TT> array of the last -item chosen by the user. It is zero initially. You can set it as an -integer, or set it with a pointer to a menu item. The set routines -return non-zero if the new value is different than the old one. - Changing it causes a <TT>redraw()</TT>. + The value is the index into the <TT>Fl_Menu</TT> array of the last +item chosen by the user. It is zero initially. You can set it as an +integer, or set it with a pointer to a menu item. The set routines +return non-zero if the new value is different than the old one. + Changing it causes a <TT>redraw()</TT>. <H4><A name=Fl_Choice.changed>int Fl_Widget::changed() const</A></H4> - This value is true if the user picks a different value. <I>It is -turned off by <TT>value()</TT> and just before doing a callback (the + This value is true if the user picks a different value. <I>It is +turned off by <TT>value()</TT> and just before doing a callback (the callback can turn it back on if desired).</I> <H4><A name=Fl_Choice.set_changed>void Fl_Widget::set_changed()</A></H4> - This method sets the <TT>changed()</TT> flag. + This method sets the <TT>changed()</TT> flag. <H4><A name=Fl_Choice.clear_changed>void Fl_Widget::clear_changed()</A></H4> - This method clears the <TT>changed()</TT> flag. + This method clears the <TT>changed()</TT> flag. <H4><A name=Fl_Choice.down_box>Fl_Boxtype Fl_Choice::down_box() const <BR> void Fl_Choice::down_box(Fl_Boxtype b)</A></H4> - The first form gets the current down box, which is used when the menu -is popped up. The default down box type is <TT>FL_DOWN_BOX</TT> The + The first form gets the current down box, which is used when the menu +is popped up. The default down box type is <TT>FL_DOWN_BOX</TT> The second form sets the current down box type to <TT>b</TT>. </BODY></HTML> |
