summaryrefslogtreecommitdiff
path: root/documentation/Fl_Menu_Button.html
diff options
context:
space:
mode:
authorMichael R Sweet <michael.r.sweet@gmail.com>2001-11-29 19:24:00 +0000
committerMichael R Sweet <michael.r.sweet@gmail.com>2001-11-29 19:24:00 +0000
commit09daf20b81cdae78772f07c0af22a571d7cc73eb (patch)
tree1641f788cafe20b505355b0479ba0d528297eb30 /documentation/Fl_Menu_Button.html
parentb105ab8b7fb6281635076559aae96f2b3b12fc51 (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_Menu_Button.html')
-rw-r--r--documentation/Fl_Menu_Button.html62
1 files changed, 31 insertions, 31 deletions
diff --git a/documentation/Fl_Menu_Button.html b/documentation/Fl_Menu_Button.html
index b8e4a382d..602a50472 100644
--- a/documentation/Fl_Menu_Button.html
+++ b/documentation/Fl_Menu_Button.html
@@ -17,23 +17,23 @@
</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.
+Fl_Menu_Item</TT></A> objects.
<P ALIGN=CENTER><IMG src="menu_button.gif" ALT="Fl_Menu_Button widget."></P>
-<P>Normally any mouse button will pop up a menu and it is lined up
+<P>Normally any mouse button will pop up a menu and it is lined up
below the button as shown in the picture. However an <TT>Fl_Menu_Button</TT>
may also control a pop-up menu. This is done by setting the <TT>type()</TT>
, see below. </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 '&amp;' character in the <TT>label()</TT>. </P>
-<P>Typing the <TT>shortcut()</TT> of any of the menu items will cause
-callbacks exactly the same as when you pick the item with the mouse.
- The '&amp;' character in menu item names are only looked at when the menu is
+<P>Typing the <TT>shortcut()</TT> of any of the menu items will cause
+callbacks exactly the same as when you pick the item with the mouse.
+ The '&amp;' character in menu item names are only looked at when the menu is
popped up, however. </P>
-<P>When the user picks an item off the menu, the item's callback is
-done with the menu_button as the <TT>Fl_Widget*</TT> argument. If the
-item does not have a callback the menu_button's callback is done
+<P>When the user picks an item off the menu, the item's callback is
+done with the menu_button as the <TT>Fl_Widget*</TT> argument. If the
+item does not have a callback the menu_button's callback is done
instead. </P>
<H3>Methods</H3>
<UL>
@@ -43,37 +43,37 @@ instead. </P>
<LI><A href=#Fl_Menu_Button.type>type</A></LI>
</UL>
<H4><A name=Fl_Menu_Button.Fl_Menu_Button>
-Fl_Menu_Button::Fl_Menu_Button(int x, int y, int w, int h, const char
+Fl_Menu_Button::Fl_Menu_Button(int x, int y, int w, int h, const char
*label = 0)</A></H4>
- Creates a new <TT>Fl_Menu_Button</TT> widget using the given position,
-size, and label string. The default boxtype is <TT>FL_UP_BOX</TT>.
+ Creates a new <TT>Fl_Menu_Button</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_Menu_Button.~Fl_Menu_Button>virtual
+<H4><A name=Fl_Menu_Button.~Fl_Menu_Button>virtual
Fl_Menu_Button::~Fl_Menu_Button()</A></H4>
- The destructor removes the <TT>Fl_Menu_Button</TT> widget and all of
-its menu items.
+ The destructor removes the <TT>Fl_Menu_Button</TT> widget and all of
+its menu items.
<H4><A name=Fl_Menu_Button.popup>const Fl_Menu* Fl_Menu_Button::popup()</A>
</H4>
- Act exactly as though the user clicked the button or typed the
-shortcut key. The menu appears, it waits for the user to pick an item,
-and if they pick one it sets <TT>value()</TT> and does the callback or
-sets <TT>changed()</TT> as described above. The menu item is returned
-or <TT>NULL</TT> if the user dismisses the menu.
+ Act exactly as though the user clicked the button or typed the
+shortcut key. The menu appears, it waits for the user to pick an item,
+and if they pick one it sets <TT>value()</TT> and does the callback or
+sets <TT>changed()</TT> as described above. The menu item is returned
+or <TT>NULL</TT> if the user dismisses the menu.
<H4><A name=Fl_Menu_Button.type>void Fl_Menu_Button::type(uchar)</A></H4>
- If <TT>type()</TT> is zero a normal menu button is produced. If it is
+ If <TT>type()</TT> is zero a normal menu button is produced. If it is
nonzero then this is a pop-up menu. The bits in <TT>type()</TT>
- indicate what mouse buttons pop up the menu. For convienece the
-constants <TT>Fl_Menu_Button::POPUP1, POPUP2, POPUP3, POPUP12, POPUP13,
+ indicate what mouse buttons pop up the menu. For convienece the
+constants <TT>Fl_Menu_Button::POPUP1, POPUP2, POPUP3, POPUP12, POPUP13,
POPUP23</TT>, and <TT>POPUP123</TT> are defined. <TT>
-Fl_Menu_Button::POPUP3</TT> is usually what you want.
-<P>A popup menu button is invisible and does not interfere with any
-events other than the mouse button specified (and any shortcuts). The
-widget can be stretched to cover all your other widgets by putting it
-last in the hierarchy so it is &quot;on top&quot;. You can also make several
+Fl_Menu_Button::POPUP3</TT> is usually what you want.
+<P>A popup menu button is invisible and does not interfere with any
+events other than the mouse button specified (and any shortcuts). The
+widget can be stretched to cover all your other widgets by putting it
+last in the hierarchy so it is &quot;on top&quot;. You can also make several
widgets covering different areas for context-sensitive popup menus. </P>
-<P>The popup menus appear with the cursor pointing at the previously
+<P>The popup menus appear with the cursor pointing at the previously
selected item. This is a <I>feature</I>. If you don't like it, do <TT>
-value(0)</TT> after the menu items are picked to forget the current
+value(0)</TT> after the menu items are picked to forget the current
item. </P>
</BODY></HTML>