diff options
| author | Michael R Sweet <michael.r.sweet@gmail.com> | 1999-01-13 19:28:54 +0000 |
|---|---|---|
| committer | Michael R Sweet <michael.r.sweet@gmail.com> | 1999-01-13 19:28:54 +0000 |
| commit | d7b88a3bcc7e76f38ee5799be7722fd5a10781ef (patch) | |
| tree | d8984d45424c9b2cdb199c1918f38bfea4a8211d /documentation/Fl_Menu_Item.html | |
| parent | 30fa233681467b82b165e7d42cd0bea778b93768 (diff) | |
Updated all links so they work between files.
Revision 1.
git-svn-id: file:///fltk/svn/fltk/trunk@219 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/Fl_Menu_Item.html')
| -rw-r--r-- | documentation/Fl_Menu_Item.html | 607 |
1 files changed, 268 insertions, 339 deletions
diff --git a/documentation/Fl_Menu_Item.html b/documentation/Fl_Menu_Item.html index 4dc738c26..bdce5feb9 100644 --- a/documentation/Fl_Menu_Item.html +++ b/documentation/Fl_Menu_Item.html @@ -1,33 +1,27 @@ -<html> -<body> - -<hr break> - -<h2><a name="Fl_Menu_Item">struct Fl_Menu_Item</a></h2> - -<hr> - -<h3>Class Hierarchy</h3> - -<ul><pre> -<a href="#Fl_Widget">Fl_Widget</a> +<HTML><BODY> +<HR break> +<H2><A name=Fl_Menu_Item>struct Fl_Menu_Item</A></H2> +<HR> +<H3>Class Hierarchy</H3> +<UL> +<PRE> +<A href=Fl_Widget.html#Fl_Widget>Fl_Widget</A> | - +----<b>Fl_Menu_Item</b>----<a href="#Fl_Menu_">Fl_Menu_</a> -</pre></ul> - -<h3>Include Files</h3> - -<ul><pre> -#include <FL/Fl_Menu_Item.H> -</pre></ul> - -<h3>Description</h3> - -The <tt>Fl_Menu_Item</tt> structure defines a single menu item that is -used by the <tt>Fl_Menu_</tt> class. This structure is defined in -<tt><FL/Fl_Menu_Item.H></tt> - -<ul><pre> + +----<B>Fl_Menu_Item</B>----<A href=Fl_Menu_.html#Fl_Menu_>Fl_Menu_</A> +</PRE> +</UL> +<H3>Include Files</H3> +<UL> +<PRE> +#include <FL/Fl_Menu_Item.H> +</PRE> +</UL> +<H3>Description</H3> + The <TT>Fl_Menu_Item</TT> structure defines a single menu item that is +used by the <TT>Fl_Menu_</TT> class. This structure is defined in <TT> +<FL/Fl_Menu_Item.H></TT> +<UL> +<PRE> struct Fl_Menu_Item { const char* text; // label() ulong shortcut_; @@ -51,316 +45,251 @@ enum { // values for flags: FL_MENU_DIVIDER = 0x80, FL_MENU_HORIZONTAL = 0x100 }; -</pre></ul> - -Typically menu items are statically defined; for example: - -<table> -<tr valign=top> - <td><img align=left src=menu.gif></td> - <td><pre> +</PRE> +</UL> + Typically menu items are statically defined; for example: +<TABLE> +<TR valign=top><TD><IMG align=left src=./menu.gif></TD><TD> +<PRE> Fl_Menu_Item popup[] = { - {"&alpha", FL_ALT+'a', the_cb, (void*)1}, - {"&beta", FL_ALT+'b', the_cb, (void*)2}, - {"gamma", FL_ALT+'c', the_cb, (void*)3, FL_MENU_DIVIDER}, - {"&strange", 0, strange_cb}, - {"&charm", 0, charm_cb}, - {"&truth", 0, truth_cb}, - {"b&eauty", 0, beauty_cb}, - {"sub&menu", 0, 0, 0, FL_SUBMENU}, - {"one"}, - {"two"}, - {"three"}, + {", FL_ALT+'a', the_cb, (void*)1}, + {", FL_ALT+'b', the_cb, (void*)2}, + {"gamma", FL_ALT+'c', the_cb, (void*)3, FL_MENU_DIVIDER}, + {", 0, strange_cb}, + {", 0, charm_cb}, + {", 0, truth_cb}, + {"b, 0, beauty_cb}, + {"sub, 0, 0, 0, FL_SUBMENU}, + {"one"}, + {"two"}, + {"three"}, {0}, - {"inactive", FL_ALT+'i', 0, 0, FL_MENU_INACTIVE|FL_MENU_DIVIDER}, - {"invisible",FL_ALT+'i', 0, 0, FL_MENU_INVISIBLE}, - {"check", FL_ALT+'i', 0, 0, FL_MENU_TOGGLE|FL_MENU_VALUE}, - {"box", FL_ALT+'i', 0, 0, FL_MENU_TOGGLE}, + {"inactive", FL_ALT+'i', 0, 0, FL_MENU_INACTIVE|FL_MENU_DIVIDER}, + {"invisible",FL_ALT+'i', 0, 0, FL_MENU_INVISIBLE}, + {"check", FL_ALT+'i', 0, 0, FL_MENU_TOGGLE|FL_MENU_VALUE}, + {"box", FL_ALT+'i', 0, 0, FL_MENU_TOGGLE}, {0}}; - </pre></td> -</tr> -</table> - -A submenu title is identified by the bit <tt>FL_SUBMENU</tt> in the -<tt>flags</tt> field, and ends with a <tt>label()</tt> that is -<tt>NULL</tt>. You can nest menus to any depth. A pointer to the -first item in the submenu can be treated as an <tt>Fl_Menu</tt> array -itself. It is also possible to make seperate submenu arrays with -<tt>FL_SUBMENU_POINTER</tt> flags. - -<p>You should use the method functions to access structure members and -not access them directly to avoid compatibility problems with future -releases of FLTK. - -<h3>Methods</h3> - -<center> -<table width=90%> -<tr> -<td align=left valign=top> -<ul> - <li><a href="#Fl_Menu_Item.label">label</a> - <li><a href="#Fl_Menu_Item.labeltype">labeltype</a> - <li><a href="#Fl_Menu_Item.labelcolor">labelcolor</a> - <li><a href="#Fl_Menu_Item.labelfont">labelfont</a> - <li><a href="#Fl_Menu_Item.labelsize">labelsize</a> - <li><a href="#Fl_Menu_Item.callback">callback</a> -</ul> -</td> -<td align=left valign=top> -<ul> - <li><a href="#Fl_Menu_Item.user_data">user_data</a> - <li><a href="#Fl_Menu_Item.argument">argument</a> - <li><a href="#Fl_Menu_Item.do_callback">do_callback</a> - <li><a href="#Fl_Menu_Item.shortcut">shortcut</a> - <li><a href="#Fl_Menu_Item.submenu">submenu</a> - <li><a href="#Fl_Menu_Item.checkbox">checkbox</a> -</ul> -</td> -<td align=left valign=top> -<ul> - <li><a href="#Fl_Menu_Item.radio">radio</a> - <li><a href="#Fl_Menu_Item.value">value</a> - <li><a href="#Fl_Menu_Item.set">set</a> - <li><a href="#Fl_Menu_Item.setonly">setonly</a> - <li><a href="#Fl_Menu_Item.clear">clear</a> - <li><a href="#Fl_Menu_Item.visible">visible</a> -</ul> -</td> -<td align=left valign=top> -<ul> - <li><a href="#Fl_Menu_Item.show">show</a> - <li><a href="#Fl_Menu_Item.hide">hide</a> - <li><a href="#Fl_Menu_Item.active">active</a> - <li><a href="#Fl_Menu_Item.activate">activate</a> - <li><a href="#Fl_Menu_Item.deactivate">deactivate</a> -</ul> -</td> -<td align=left valign=top> -<ul> - <li><a href="#Fl_Menu_Item.popup">popup</a> - <li><a href="#Fl_Menu_Item.pulldown">pulldown</a> - <li><a href="#Fl_Menu_Item.test_shortcut">test_shortcut</a> - <li><a href="#Fl_Menu_Item.size">size</a> - <li><a href="#Fl_Menu_Item.next">next</a> -</ul> -</td> -</tr> -</table> -</center> - -<h4><a name="Fl_Menu_Item.label">const char* Fl_Menu_Item::label() const<br> -void Fl_Menu_Item::label(const char*)<br> -void Fl_Menu_Item::label(Fl_Labeltype, const char*)</a></h4> - -This is the title of the item. A <tt>NULL</tt> here indicates the end of the -menu (or of a submenu). A '&' in the item will print an underscore -under the next letter, and if the menu is popped up that letter will -be a "shortcut" to pick that item. To get a real '&' put two in a -row. - -<h4><a name="Fl_Menu_Item.labeltype">Fl_Labeltype Fl_Menu_Item::labeltype() const<br> -void Fl_Menu_Item::labeltype(Fl_Labeltype)</a></h4> - -A <tt>labeltype</tt> identifies a routine that draws the label of the -widget. This can be used for special effects such as emboss, or to use -the <tt>label()</tt> pointer as another form of data such as a bitmap. -The value <tt>FL_NORMAL_LABEL</tt> prints the label as text. - -<h4><a name="Fl_Menu_Item.labelcolor">Fl_Color Fl_Menu_Item::labelcolor() const<br> -void Fl_Menu_Item::labelcolor(Fl_Color)</a></h4> - -This color is passed to the labeltype routine, and is typically the -color of the label text. This defaults to <tt>FL_BLACK</tt>. If this -color is not black fltk will <i>not</i> use overlay bitplanes to draw -the menu - this is so that images put in the menu draw correctly. - -<h4><a name="Fl_Menu_Item.labelfont">Fl_Font Fl_Menu_Item::labelfont() const<br> -void Fl_Menu_Item::labelfont(Fl_Font)</a></h4> - -Fonts are identified by small 8-bit indexes into a table. See the <a -href="#Enumerations">enumeration list</a> for predefined fonts. The -default value is a Helvetica font. The function <a -href="#set_font"><tt>Fl::set_font()</tt></a> can define new fonts. - -<h4><a name="Fl_Menu_Item.labelsize">uchar Fl_Menu_Item::labelsize() const<br> -void Fl_Menu_Item::labelsize(uchar)</a></h4> - -Gets or sets the label font pixel size/height. - -<h4><a name="Fl_Menu_Item.callback">typedef void (Fl_Callback)(Fl_Widget*, void*)<br> -Fl_Callback* Fl_Menu_Item::callback() const<br> -void Fl_Menu_Item::callback(Fl_Callback*, void* = 0)<br> -void Fl_Menu_Item::callback(void (*)(Fl_Widget*))</a></h4> - -Each item has space for a callback function and an argument for that -function. Due to back compatability, the <tt>Fl_Menu_Item</tt> itself -is not passed to the callback, instead you have to get it by calling -<tt>((Fl_Menu_*)w)->mvalue()</tt> where <tt>w</tt> is the widget -argument. - -<h4><a name="Fl_Menu_Item.user_data">void* Fl_Menu_Item::user_data() const<br> -void Fl_Menu_Item::user_data(void*)</a></h4> - -Get or set the <tt>user_data</tt> argument that is sent to the callback -function. - -<h4><a name="Fl_Menu_Item.argument">void Fl_Menu_Item::callback(void (*)(Fl_Widget*, long), long = 0)<br> -long Fl_Menu_Item::argument() const<br> -void Fl_Menu_Item::argument(long)</a></h4> - -For convenience you can also define the callback as taking a -<tt>long</tt> argument. This is implemented by casting this to a -<tt>Fl_Callback</tt> and casting the <tt>long</tt> to a <tt>void*</tt> -and may not be portable to some machines. - -<h4><a name="Fl_Menu_Item.do_callback">void Fl_Menu_Item::do_callback(Fl_Widget*)<br> -void Fl_Menu_Item::do_callback(Fl_Widget*, void*)<br> -void Fl_Menu_Item::do_callback(Fl_Widget*, long)</a></h4> - -Call the <tt>Fl_Menu_Item</tt> item's callback, and provide the -<tt>Fl_Widget</tt> argument (and optionally override the user_data() -argument). You must first check that <tt>callback()</tt> is non-zero before -calling this. - -<h4><a name="Fl_Menu_Item.shortcut">ulong Fl_Menu_Item::shortcut() const<br> -void Fl_Menu_Item::shortcut(ulong)</a></h4> - -Sets exactly what key combination will trigger the menu item. The -value is a logical 'or' of a key and a set of shift flags, for -instance <tt>FL_ALT+'a'</tt> or <tt>FL_ALT+FL_F+10</tt> or -just 'a'. A value of zero disables the shortcut. - -<p>The key can be any value returned by <a -href="#event_key"><tt>Fl::event_key()</tt></a>, but will usually be an -ASCII letter. Use a lower-case letter unless you require the shift key -to be held down. - -<p>The shift flags can be any set of values accepted by <a -href="#event_state"><tt>Fl::event_state()</tt></a>. If the bit is on -that shift key must be pushed. Meta, Alt, Ctrl, and Shift must be off -if they are not in the shift flags (zero for the other bits indicates -a "don't care" setting). - -<h4><a name="Fl_Menu_Item.submenu">int Fl_Menu_Item::submenu() const</a></h4> - -Returns true if either <tt>FL_SUBMENU</tt> or -<tt>FL_SUBMENU_POINTER</tt> is on in the flags. <tt>FL_SUBMENU</tt> -indicates an embedded submenu that goes from the next item through the -next one with a <tt>NULL</tt> <tt>label()</tt>. -<tt>FL_SUBMENU_POINTER</tt> indicates that <tt>user_data()</tt> is a -pointer to another menu array. - -<h4><a name="Fl_Menu_Item.checkbox">int Fl_Menu_Item::checkbox() const</a></h4> - -Returns true if a checkbox will be drawn next to this item. This is -true if <tt>FL_MENU_TOGGLE</tt> or <tt>FL_MENU_RADIO</tt> is set in the flags. - -<h4><a name="Fl_Menu_Item.radio">int Fl_Menu_Item::radio() const</a></h4> - -Returns true if this item is a radio item. When a radio button is -selected all "adjacent" radio buttons are turned off. A set of radio -items is delimited by an item that has <tt>radio()</tt> false, or by an item -with <tt>FL_MENU_DIVIDER</tt> turned on. - -<h4><a name="Fl_Menu_Item.value">int Fl_Menu_Item::value() const</a></h4> - -Returns the current value of the check or radio item. - -<h4><a name="Fl_Menu_Item.set">void Fl_Menu_Item::set()</a></h4> - -Turns the check or radio item "on" for the menu item. Note that this does not -turn off any adjacent radio items like <tt>set_only()</tt> does. - -<h4><a name="Fl_Menu_Item.setonly">void Fl_Menu_Item::setonly()</a></h4> - -Turns the radio item "on" for the menu item and turns off adjacent radio -item. - -<h4><a name="Fl_Menu_Item.clear">void Fl_Menu_Item::clear()</a></h4> - -Turns the check or radio item "off" for the menu item. - -<h4><a name="Fl_Menu_Item.visible">int Fl_Menu_Item::visible() const</a></h4> - -Gets the visibility of an item. - -<h4><a name="Fl_Menu_Item.show">void Fl_Menu_Item::show()</a></h4> - -Makes an item visible in the menu. - -<h4><a name="Fl_Menu_Item.hide">void Fl_Menu_Item::hide()</a></h4> - -Hides an item in the menu. - -<h4><a name="Fl_Menu_Item.active">int Fl_Menu_Item::active() const</a></h4> - -Get whether or not the item can be picked. - -<h4><a name="Fl_Menu_Item.activate">void Fl_Menu_Item::activate()</a></h4> - -Allows a menu item to be picked. - -<h4><a name="Fl_Menu_Item.deactivate">void Fl_Menu_Item::deactivate()</a></h4> - -Prevents a menu item from being picked. Note that this will also cause the -menu item to appear grayed-out. - -<h4><a name="Fl_Menu_Item.popup">const Fl_Menu_Item *Fl_Menu_Item::popup(int X, int Y, const char* title = 0, const Fl_Menu_Item* picked = 0, const Fl_Menu_* button = 0) const</a></h4> - -This method is called by widgets that want to display menus. The menu -stays up until the user picks an item or dismisses it. The selected -item (or <tt>NULL</tt> if none) is returned. <i>This does not do the -callbacks or change the state of check or radio items.</i> - -<p><tt>X,Y</tt> is the position of the mouse cursor, relative to the -window that got the most recent event (usually you can pass -<tt>Fl::event_x()</tt> and <tt>Fl::event_y()</tt> unchanged here). - -<p><tt>title</tt> is a character string title for the menu. If non-zero -a small box appears above the menu with the title in it. - -<p>The menu is positioned so the cursor is centered over the item -<tt>picked</tt>. This will work even if <tt>picked</tt> is in a submenu. -If <tt>picked</tt> is zero or not in the menu item table the menu is -positioned with the cursor in the top-left corner. - -<p><tt>button</tt> is a pointer to an <a href="#Fl_Menu_"><tt>Fl_Menu_</tt></a> -from which the color and boxtypes for the menu are pulled. If <tt>NULL</tt> -then defaults are used. - -<h4><a name="Fl_Menu_Item.pulldown">const Fl_Menu_Item *Fl_Menu_Item::pulldown(int X, int Y, int W, int H, const Fl_Menu_Item* picked = 0, const Fl_Menu_* button = 0, const Fl_Menu_Item* title = 0, int menubar=0) const</a></h4> - -<tt>pulldown()</tt> is similar to <tt>popup()</tt>, but a rectangle is -provided to position the menu. The menu is made at least <tt>W</tt> -wide, and the <tt>picked</tt> item is centered over the rectangle (like -<tt>Fl_Choice</tt> uses). If <tt>picked</tt> is zero or not found, the -menu is aligned just below the rectangle (like a pulldown menu). - -<p>The <tt>title</tt> and <tt>menubar</tt> arguments are used internally by -the <tt>Fl_Menu_</tt> widget. - -<h4><a name="Fl_Menu_Item.test_shortcut">const Fl_Menu_Item* Fl_Menu_Item::test_shortcut() const</a></h4> - -This is designed to be called by a widgets <tt>handle()</tt> method in -response to a <tt>FL_SHORTCUT</tt> event. If the current event matches -one of the items shortcut, that item is returned. If the keystroke -does not match any shortcuts then <tt>NULL</tt> is returned. This only -matches the <tt>shortcut()</tt> fields, not the letters in the title -preceeded by '&'. - -<h4><a name="Fl_Menu_Item.size">int Fl_Menu_Item::size()</a></h4> - -Return the offset of the <tt>NULL</tt> terminator that ends this menu, -correctly skipping over submenus. To copy a menu you should copy -<tt>size() + 1</tt> structures. - -<h4><a name="Fl_Menu_Item.next">const Fl_Menu_Item* Fl_Menu_Item::next(int n=1) const<br> -Fl_Menu_Item* Fl_Menu_Item::next(int n=1);</a></h4> - -Advance a pointer by <tt>n</tt> items through a menu array, skipping the -contents of submenus and invisible items. There are two calls so that -you can advance through const and non-const data. - -</body> -</html> + </PRE> +</TD></TR> +</TABLE> + A submenu title is identified by the bit <TT>FL_SUBMENU</TT> in the <TT> +flags</TT> field, and ends with a <TT>label()</TT> that is <TT>NULL</TT> +. You can nest menus to any depth. A pointer to the first item in the +submenu can be treated as an <TT>Fl_Menu</TT> array itself. It is also +possible to make seperate submenu arrays with <TT>FL_SUBMENU_POINTER</TT> + flags. +<P>You should use the method functions to access structure members and +not access them directly to avoid compatibility problems with future +releases of FLTK. </P> +<H3>Methods</H3> +<CENTER> +<TABLE width=90%> +<TR><TD align=left valign=top> +<UL> +<LI><A href=#Fl_Menu_Item.label>label</A></LI> +<LI><A href=#Fl_Menu_Item.labeltype>labeltype</A></LI> +<LI><A href=#Fl_Menu_Item.labelcolor>labelcolor</A></LI> +<LI><A href=#Fl_Menu_Item.labelfont>labelfont</A></LI> +<LI><A href=#Fl_Menu_Item.labelsize>labelsize</A></LI> +<LI><A href=#Fl_Menu_Item.callback>callback</A></LI> +</UL> +</TD><TD align=left valign=top> +<UL> +<LI><A href=#Fl_Menu_Item.user_data>user_data</A></LI> +<LI><A href=#Fl_Menu_Item.argument>argument</A></LI> +<LI><A href=#Fl_Menu_Item.do_callback>do_callback</A></LI> +<LI><A href=#Fl_Menu_Item.shortcut>shortcut</A></LI> +<LI><A href=#Fl_Menu_Item.submenu>submenu</A></LI> +<LI><A href=#Fl_Menu_Item.checkbox>checkbox</A></LI> +</UL> +</TD><TD align=left valign=top> +<UL> +<LI><A href=#Fl_Menu_Item.radio>radio</A></LI> +<LI><A href=#Fl_Menu_Item.value>value</A></LI> +<LI><A href=#Fl_Menu_Item.set>set</A></LI> +<LI><A href=#Fl_Menu_Item.setonly>setonly</A></LI> +<LI><A href=#Fl_Menu_Item.clear>clear</A></LI> +<LI><A href=#Fl_Menu_Item.visible>visible</A></LI> +</UL> +</TD><TD align=left valign=top> +<UL> +<LI><A href=#Fl_Menu_Item.show>show</A></LI> +<LI><A href=#Fl_Menu_Item.hide>hide</A></LI> +<LI><A href=#Fl_Menu_Item.active>active</A></LI> +<LI><A href=#Fl_Menu_Item.activate>activate</A></LI> +<LI><A href=#Fl_Menu_Item.deactivate>deactivate</A></LI> +</UL> +</TD><TD align=left valign=top> +<UL> +<LI><A href=#Fl_Menu_Item.popup>popup</A></LI> +<LI><A href=#Fl_Menu_Item.pulldown>pulldown</A></LI> +<LI><A href=#Fl_Menu_Item.test_shortcut>test_shortcut</A></LI> +<LI><A href=#Fl_Menu_Item.size>size</A></LI> +<LI><A href=#Fl_Menu_Item.next>next</A></LI> +</UL> +</TD></TR> +</TABLE> +</CENTER> +<H4><A name=Fl_Menu_Item.label>const char* Fl_Menu_Item::label() const +<BR> void Fl_Menu_Item::label(const char*) +<BR> void Fl_Menu_Item::label(Fl_Labeltype, const char*)</A></H4> + This is the title of the item. A <TT>NULL</TT> here indicates the end +of the menu (or of a submenu). A ''in the item will print an +underscore under the next letter, and if the menu is popped up that +letter will be a "shortcut" to pick that item. To get a real ''put two +in a row. +<H4><A name=Fl_Menu_Item.labeltype>Fl_Labeltype +Fl_Menu_Item::labeltype() const +<BR> void Fl_Menu_Item::labeltype(Fl_Labeltype)</A></H4> + A <TT>labeltype</TT> identifies a routine that draws the label of the +widget. This can be used for special effects such as emboss, or to use +the <TT>label()</TT> pointer as another form of data such as a bitmap. + The value <TT>FL_NORMAL_LABEL</TT> prints the label as text. +<H4><A name=Fl_Menu_Item.labelcolor>Fl_Color Fl_Menu_Item::labelcolor() +const +<BR> void Fl_Menu_Item::labelcolor(Fl_Color)</A></H4> + This color is passed to the labeltype routine, and is typically the +color of the label text. This defaults to <TT>FL_BLACK</TT>. If this +color is not black fltk will <I>not</I> use overlay bitplanes to draw +the menu - this is so that images put in the menu draw correctly. +<H4><A name=Fl_Menu_Item.labelfont>Fl_Font Fl_Menu_Item::labelfont() +const +<BR> void Fl_Menu_Item::labelfont(Fl_Font)</A></H4> + Fonts are identified by small 8-bit indexes into a table. See the <A href=enumerations.html#Enumerations> +enumeration list</A> for predefined fonts. The default value is a +Helvetica font. The function <A href=functions.html#set_font><TT> +Fl::set_font()</TT></A> can define new fonts. +<H4><A name=Fl_Menu_Item.labelsize>uchar Fl_Menu_Item::labelsize() const +<BR> void Fl_Menu_Item::labelsize(uchar)</A></H4> + Gets or sets the label font pixel size/height. +<H4><A name=Fl_Menu_Item.callback>typedef void +(Fl_Callback)(Fl_Widget*, void*) +<BR> Fl_Callback* Fl_Menu_Item::callback() const +<BR> void Fl_Menu_Item::callback(Fl_Callback*, void* = 0) +<BR> void Fl_Menu_Item::callback(void (*)(Fl_Widget*))</A></H4> + Each item has space for a callback function and an argument for that +function. Due to back compatability, the <TT>Fl_Menu_Item</TT> itself +is not passed to the callback, instead you have to get it by calling <TT> +((Fl_Menu_*)w)->mvalue()</TT> where <TT>w</TT> is the widget argument. +<H4><A name=Fl_Menu_Item.user_data>void* Fl_Menu_Item::user_data() const +<BR> void Fl_Menu_Item::user_data(void*)</A></H4> + Get or set the <TT>user_data</TT> argument that is sent to the +callback function. +<H4><A name=Fl_Menu_Item.argument>void Fl_Menu_Item::callback(void +(*)(Fl_Widget*, long), long = 0) +<BR> long Fl_Menu_Item::argument() const +<BR> void Fl_Menu_Item::argument(long)</A></H4> + For convenience you can also define the callback as taking a <TT>long</TT> + argument. This is implemented by casting this to a <TT>Fl_Callback</TT> + and casting the <TT>long</TT> to a <TT>void*</TT> and may not be +portable to some machines. +<H4><A name=Fl_Menu_Item.do_callback>void +Fl_Menu_Item::do_callback(Fl_Widget*) +<BR> void Fl_Menu_Item::do_callback(Fl_Widget*, void*) +<BR> void Fl_Menu_Item::do_callback(Fl_Widget*, long)</A></H4> + Call the <TT>Fl_Menu_Item</TT> item's callback, and provide the <TT> +Fl_Widget</TT> argument (and optionally override the user_data() +argument). You must first check that <TT>callback()</TT> is non-zero +before calling this. +<H4><A name=Fl_Menu_Item.shortcut>ulong Fl_Menu_Item::shortcut() const +<BR> void Fl_Menu_Item::shortcut(ulong)</A></H4> + Sets exactly what key combination will trigger the menu item. The +value is a logical 'or' of a key and a set of shift flags, for instance <TT> +FL_ALT+'a'</TT> or <TT>FL_ALT+FL_F+10</TT> or just 'a'. A value of +zero disables the shortcut. +<P>The key can be any value returned by <A href=functions.html#event_key> +<TT>Fl::event_key()</TT></A>, but will usually be an ASCII letter. Use +a lower-case letter unless you require the shift key to be held down. </P> +<P>The shift flags can be any set of values accepted by <A href=events.html#event_state> +<TT>Fl::event_state()</TT></A>. If the bit is on that shift key must +be pushed. Meta, Alt, Ctrl, and Shift must be off if they are not in +the shift flags (zero for the other bits indicates a "don't care" +setting). </P> +<H4><A name=Fl_Menu_Item.submenu>int Fl_Menu_Item::submenu() const</A></H4> + Returns true if either <TT>FL_SUBMENU</TT> or <TT>FL_SUBMENU_POINTER</TT> + is on in the flags. <TT>FL_SUBMENU</TT> indicates an embedded submenu +that goes from the next item through the next one with a <TT>NULL</TT><TT> +label()</TT>. <TT>FL_SUBMENU_POINTER</TT> indicates that <TT>user_data()</TT> + is a pointer to another menu array. +<H4><A name=Fl_Menu_Item.checkbox>int Fl_Menu_Item::checkbox() const</A></H4> + Returns true if a checkbox will be drawn next to this item. This is +true if <TT>FL_MENU_TOGGLE</TT> or <TT>FL_MENU_RADIO</TT> is set in the +flags. +<H4><A name=Fl_Menu_Item.radio>int Fl_Menu_Item::radio() const</A></H4> + Returns true if this item is a radio item. When a radio button is +selected all "adjacent" radio buttons are turned off. A set of radio +items is delimited by an item that has <TT>radio()</TT> false, or by an +item with <TT>FL_MENU_DIVIDER</TT> turned on. +<H4><A name=Fl_Menu_Item.value>int Fl_Menu_Item::value() const</A></H4> + Returns the current value of the check or radio item. +<H4><A name=Fl_Menu_Item.set>void Fl_Menu_Item::set()</A></H4> + Turns the check or radio item "on" for the menu item. Note that this +does not turn off any adjacent radio items like <TT>set_only()</TT> + does. +<H4><A name=Fl_Menu_Item.setonly>void Fl_Menu_Item::setonly()</A></H4> + Turns the radio item "on" for the menu item and turns off adjacent +radio item. +<H4><A name=Fl_Menu_Item.clear>void Fl_Menu_Item::clear()</A></H4> + Turns the check or radio item "off" for the menu item. +<H4><A name=Fl_Menu_Item.visible>int Fl_Menu_Item::visible() const</A></H4> + Gets the visibility of an item. +<H4><A name=Fl_Menu_Item.show>void Fl_Menu_Item::show()</A></H4> + Makes an item visible in the menu. +<H4><A name=Fl_Menu_Item.hide>void Fl_Menu_Item::hide()</A></H4> + Hides an item in the menu. +<H4><A name=Fl_Menu_Item.active>int Fl_Menu_Item::active() const</A></H4> + Get whether or not the item can be picked. +<H4><A name=Fl_Menu_Item.activate>void Fl_Menu_Item::activate()</A></H4> + Allows a menu item to be picked. +<H4><A name=Fl_Menu_Item.deactivate>void Fl_Menu_Item::deactivate()</A></H4> + Prevents a menu item from being picked. Note that this will also cause +the menu item to appear grayed-out. +<H4><A name=Fl_Menu_Item.popup>const Fl_Menu_Item +*Fl_Menu_Item::popup(int X, int Y, const char* title = 0, const +Fl_Menu_Item* picked = 0, const Fl_Menu_* button = 0) const</A></H4> + This method is called by widgets that want to display menus. The menu +stays up until the user picks an item or dismisses it. The selected +item (or <TT>NULL</TT> if none) is returned. <I>This does not do the +callbacks or change the state of check or radio items.</I> +<P><TT>X,Y</TT> is the position of the mouse cursor, relative to the +window that got the most recent event (usually you can pass <TT> +Fl::event_x()</TT> and <TT>Fl::event_y()</TT> unchanged here). </P> +<P><TT>title</TT> is a character string title for the menu. If +non-zero a small box appears above the menu with the title in it. </P> +<P>The menu is positioned so the cursor is centered over the item <TT> +picked</TT>. This will work even if <TT>picked</TT> is in a submenu. +If <TT>picked</TT> is zero or not in the menu item table the menu is +positioned with the cursor in the top-left corner. </P> +<P><TT>button</TT> is a pointer to an <A href=Fl_Menu_.html#Fl_Menu_><TT> +Fl_Menu_</TT></A> from which the color and boxtypes for the menu are +pulled. If <TT>NULL</TT> then defaults are used. </P> +<H4><A name=Fl_Menu_Item.pulldown>const Fl_Menu_Item +*Fl_Menu_Item::pulldown(int X, int Y, int W, int H, const Fl_Menu_Item* +picked = 0, const Fl_Menu_* button = 0, const Fl_Menu_Item* title = 0, +int menubar=0) const</A></H4> +<TT>pulldown()</TT> is similar to <TT>popup()</TT>, but a rectangle is +provided to position the menu. The menu is made at least <TT>W</TT> + wide, and the <TT>picked</TT> item is centered over the rectangle +(like <TT>Fl_Choice</TT> uses). If <TT>picked</TT> is zero or not +found, the menu is aligned just below the rectangle (like a pulldown +menu). +<P>The <TT>title</TT> and <TT>menubar</TT> arguments are used +internally by the <TT>Fl_Menu_</TT> widget. </P> +<H4><A name=Fl_Menu_Item.test_shortcut>const Fl_Menu_Item* +Fl_Menu_Item::test_shortcut() const</A></H4> + This is designed to be called by a widgets <TT>handle()</TT> method in +response to a <TT>FL_SHORTCUT</TT> event. If the current event matches +one of the items shortcut, that item is returned. If the keystroke +does not match any shortcuts then <TT>NULL</TT> is returned. This only +matches the <TT>shortcut()</TT> fields, not the letters in the title +preceeded by ' +<H4><A name=Fl_Menu_Item.size>int Fl_Menu_Item::size()</A></H4> + Return the offset of the <TT>NULL</TT> terminator that ends this menu, +correctly skipping over submenus. To copy a menu you should copy <TT> +size() + 1</TT> structures. +<H4><A name=Fl_Menu_Item.next>const Fl_Menu_Item* +Fl_Menu_Item::next(int n=1) const +<BR> Fl_Menu_Item* Fl_Menu_Item::next(int n=1);</A></H4> + Advance a pointer by <TT>n</TT> items through a menu array, skipping +the contents of submenus and invisible items. There are two calls so +that you can advance through const and non-const data. </BODY></HTML>
\ No newline at end of file |