FLTK 1.3.0
Fl_Menu_Item.H
1 //
2 // "$Id: Fl_Menu_Item.H 7983 2010-12-09 00:04:06Z AlbrechtS $"
3 //
4 // Menu item header file for the Fast Light Tool Kit (FLTK).
5 //
6 // Copyright 1998-2010 by Bill Spitzak and others.
7 //
8 // This library is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU Library General Public
10 // License as published by the Free Software Foundation; either
11 // version 2 of the License, or (at your option) any later version.
12 //
13 // This library is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // Library General Public License for more details.
17 //
18 // You should have received a copy of the GNU Library General Public
19 // License along with this library; if not, write to the Free Software
20 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 // USA.
22 //
23 // Please report all bugs and problems on the following page:
24 //
25 // http://www.fltk.org/str.php
26 //
27 
28 #ifndef Fl_Menu_Item_H
29 #define Fl_Menu_Item_H
30 
31 # include "Fl_Widget.H"
32 # include "Fl_Image.H"
33 
34 # if defined(__APPLE__) && defined(check)
35 # undef check
36 # endif
37 
38 enum { // values for flags:
39  FL_MENU_INACTIVE = 1,
40  FL_MENU_TOGGLE= 2,
41  FL_MENU_VALUE = 4,
42  FL_MENU_RADIO = 8,
43  FL_MENU_INVISIBLE = 0x10,
44  FL_SUBMENU_POINTER = 0x20,
45  FL_SUBMENU = 0x40,
46  FL_MENU_DIVIDER = 0x80,
47  FL_MENU_HORIZONTAL = 0x100
48 };
49 
50 extern FL_EXPORT Fl_Shortcut fl_old_shortcut(const char*);
51 
52 class Fl_Menu_;
53 
118 struct FL_EXPORT Fl_Menu_Item {
119  const char *text;
120  int shortcut_;
122  void *user_data_;
123  int flags;
128 
129  // advance N items, skipping submenus:
130  const Fl_Menu_Item *next(int=1) const;
131 
137  Fl_Menu_Item *next(int i=1) {
138  return (Fl_Menu_Item*)(((const Fl_Menu_Item*)this)->next(i));}
139 
141  const Fl_Menu_Item *first() const { return next(0); }
142 
144  Fl_Menu_Item *first() { return next(0); }
145 
146  // methods on menu items:
154  const char* label() const {return text;}
155 
157  void label(const char* a) {text=a;}
158 
160  void label(Fl_Labeltype a,const char* b) {labeltype_ = a; text = b;}
161 
169  Fl_Labeltype labeltype() const {return (Fl_Labeltype)labeltype_;}
170 
178  void labeltype(Fl_Labeltype a) {labeltype_ = a;}
179 
187  Fl_Color labelcolor() const {return labelcolor_;}
188 
193  void labelcolor(Fl_Color a) {labelcolor_ = a;}
200  Fl_Font labelfont() const {return labelfont_;}
201 
208  void labelfont(Fl_Font a) {labelfont_ = a;}
209 
211  Fl_Fontsize labelsize() const {return labelsize_;}
212 
214  void labelsize(Fl_Fontsize a) {labelsize_ = a;}
215 
223  Fl_Callback_p callback() const {return callback_;}
224 
229  void callback(Fl_Callback* c, void* p) {callback_=c; user_data_=p;}
230 
236  void callback(Fl_Callback* c) {callback_=c;}
237 
243  void callback(Fl_Callback0*c) {callback_=(Fl_Callback*)c;}
244 
252  void callback(Fl_Callback1*c, long p=0) {callback_=(Fl_Callback*)c; user_data_=(void*)p;}
253 
257  void* user_data() const {return user_data_;}
261  void user_data(void* v) {user_data_ = v;}
268  long argument() const {return (long)(fl_intptr_t)user_data_;}
276  void argument(long v) {user_data_ = (void*)v;}
277 
279  int shortcut() const {return shortcut_;}
280 
296  void shortcut(int s) {shortcut_ = s;}
304  int submenu() const {return flags&(FL_SUBMENU|FL_SUBMENU_POINTER);}
309  int checkbox() const {return flags&FL_MENU_TOGGLE;}
316  int radio() const {return flags&FL_MENU_RADIO;}
318  int value() const {return flags&FL_MENU_VALUE;}
323  void set() {flags |= FL_MENU_VALUE;}
324 
326  void clear() {flags &= ~FL_MENU_VALUE;}
327 
328  void setonly();
329 
331  int visible() const {return !(flags&FL_MENU_INVISIBLE);}
332 
334  void show() {flags &= ~FL_MENU_INVISIBLE;}
335 
337  void hide() {flags |= FL_MENU_INVISIBLE;}
338 
340  int active() const {return !(flags&FL_MENU_INACTIVE);}
341 
343  void activate() {flags &= ~FL_MENU_INACTIVE;}
348  void deactivate() {flags |= FL_MENU_INACTIVE;}
350  int activevisible() const {return !(flags & (FL_MENU_INACTIVE|FL_MENU_INVISIBLE));}
351 
352  // compatibility for FLUID so it can set the image of a menu item...
353 
355  void image(Fl_Image* a) {a->label(this);}
356 
358  void image(Fl_Image& a) {a.label(this);}
359 
360  // used by menubar:
361  int measure(int* h, const Fl_Menu_*) const;
362  void draw(int x, int y, int w, int h, const Fl_Menu_*, int t=0) const;
363 
364  // popup menus without using an Fl_Menu_ widget:
365  const Fl_Menu_Item* popup(
366  int X, int Y,
367  const char *title = 0,
368  const Fl_Menu_Item* picked=0,
369  const Fl_Menu_* = 0) const;
370  const Fl_Menu_Item* pulldown(
371  int X, int Y, int W, int H,
372  const Fl_Menu_Item* picked = 0,
373  const Fl_Menu_* = 0,
374  const Fl_Menu_Item* title = 0,
375  int menubar=0) const;
376  const Fl_Menu_Item* test_shortcut() const;
377  const Fl_Menu_Item* find_shortcut(int *ip=0, const bool require_alt = false) const;
378 
384  void do_callback(Fl_Widget* o) const {callback_(o, user_data_);}
385 
391  void do_callback(Fl_Widget* o,void* arg) const {callback_(o, arg);}
392 
400  void do_callback(Fl_Widget* o,long arg) const {callback_(o, (void*)arg);}
401 
402  // back-compatibility, do not use:
403 
405  int checked() const {return flags&FL_MENU_VALUE;}
406 
408  void check() {flags |= FL_MENU_VALUE;}
409 
411  void uncheck() {flags &= ~FL_MENU_VALUE;}
412 
413  int insert(int,const char*,int,Fl_Callback*,void* =0, int =0);
414  int add(const char*, int shortcut, Fl_Callback*, void* =0, int = 0);
415 
417  int add(const char*a, const char* b, Fl_Callback* c,
418  void* d = 0, int e = 0) {
419  return add(a,fl_old_shortcut(b),c,d,e);}
420 
421  int size() const ;
422 };
423 
424 typedef Fl_Menu_Item Fl_Menu; // back compatibility
425 
426 enum { // back-compatibility enum:
427  FL_PUP_NONE = 0,
428  FL_PUP_GREY = FL_MENU_INACTIVE,
429  FL_PUP_GRAY = FL_MENU_INACTIVE,
430  FL_MENU_BOX = FL_MENU_TOGGLE,
431  FL_PUP_BOX = FL_MENU_TOGGLE,
432  FL_MENU_CHECK = FL_MENU_VALUE,
433  FL_PUP_CHECK = FL_MENU_VALUE,
434  FL_PUP_RADIO = FL_MENU_RADIO,
435  FL_PUP_INVISIBLE = FL_MENU_INVISIBLE,
436  FL_PUP_SUBMENU = FL_SUBMENU_POINTER
437 };
438 
439 #endif
440 
441 //
442 // End of "$Id: Fl_Menu_Item.H 7983 2010-12-09 00:04:06Z AlbrechtS $".
443 //
Fl_Widget is the base class for all widgets in FLTK.
Definition: Fl_Widget.H:109
uchar labeltype_
how the menu item text looks like
Definition: Fl_Menu_Item.H:124
void set()
Turns the check or radio item "on" for the menu item.
Definition: Fl_Menu_Item.H:323
Fl_Callback * callback_
menu item callback
Definition: Fl_Menu_Item.H:121
long argument() const
Gets the user_data() argument that is sent to the callback function.
Definition: Fl_Menu_Item.H:268
int shortcut_
menu item shortcut
Definition: Fl_Menu_Item.H:120
void do_callback(Fl_Widget *o, long arg) const
Calls the Fl_Menu_Item item's callback, and provides the Fl_Widget argument.
Definition: Fl_Menu_Item.H:400
void shortcut(int s)
Sets exactly what key combination will trigger the menu item.
Definition: Fl_Menu_Item.H:296
Fl_Menu_Item * first()
Returns the first menu item, same as next(0).
Definition: Fl_Menu_Item.H:144
void labeltype(Fl_Labeltype a)
Sets the menu item's labeltype.
Definition: Fl_Menu_Item.H:178
virtual void label(Fl_Widget *w)
The label() methods are an obsolete way to set the image attribute of a widget or menu item...
Definition: Fl_Image.cxx:118
FL_EXPORT Fl_Shortcut fl_old_shortcut(const char *)
Emulation of XForms named shortcuts.
Definition: fl_shortcut.cxx:284
void check()
back compatibility only
Definition: Fl_Menu_Item.H:408
Fl_Font labelfont_
which font for this menu item text
Definition: Fl_Menu_Item.H:125
void callback(Fl_Callback0 *c)
Sets the menu item's callback function.
Definition: Fl_Menu_Item.H:243
int flags
menu item flags like FL_MENU_TOGGLE, FL_MENU_RADIO
Definition: Fl_Menu_Item.H:123
int radio() const
Returns true if this item is a radio item.
Definition: Fl_Menu_Item.H:316
int checked() const
back compatibility only
Definition: Fl_Menu_Item.H:405
void activate()
Allows a menu item to be picked.
Definition: Fl_Menu_Item.H:343
int activevisible() const
Returns non 0 if FL_INACTIVE and FL_INVISIBLE are cleared, 0 otherwise.
Definition: Fl_Menu_Item.H:350
int shortcut() const
Gets what key combination shortcut will trigger the menu item.
Definition: Fl_Menu_Item.H:279
Fl_Image is the base class used for caching and drawing all kinds of images in FLTK.
Definition: Fl_Image.H:51
void labelfont(Fl_Font a)
Sets the menu item's label font.
Definition: Fl_Menu_Item.H:208
int add(const char *a, const char *b, Fl_Callback *c, void *d=0, int e=0)
See int add(const char*, int shortcut, Fl_Callback*, void*, int)
Definition: Fl_Menu_Item.H:417
Fl_Callback_p callback() const
Returns the callback function that is set for the menu item.
Definition: Fl_Menu_Item.H:223
const Fl_Menu_Item * first() const
Returns the first menu item, same as next(0).
Definition: Fl_Menu_Item.H:141
Fl_Fontsize labelsize_
size of menu item text
Definition: Fl_Menu_Item.H:126
long fl_intptr_t
Definition: Fl_Widget.H:48
Fl_Font labelfont() const
Gets the menu item's label font.
Definition: Fl_Menu_Item.H:200
int checkbox() const
Returns true if a checkbox will be drawn next to this item.
Definition: Fl_Menu_Item.H:309
void uncheck()
back compatibility only
Definition: Fl_Menu_Item.H:411
void( Fl_Callback1)(Fl_Widget *, long)
Callback type definition passing the widget and a long data value.
Definition: Fl_Widget.H:64
void do_callback(Fl_Widget *o) const
Calls the Fl_Menu_Item item's callback, and provides the Fl_Widget argument.
Definition: Fl_Menu_Item.H:384
void callback(Fl_Callback1 *c, long p=0)
Sets the menu item's callback function and userdata() argument.
Definition: Fl_Menu_Item.H:252
int visible() const
Gets the visibility of an item.
Definition: Fl_Menu_Item.H:331
void deactivate()
Prevents a menu item from being picked.
Definition: Fl_Menu_Item.H:348
void clear()
Turns the check or radio item "off" for the menu item.
Definition: Fl_Menu_Item.H:326
void( Fl_Callback)(Fl_Widget *, void *)
Default callback type definition for all fltk widgets (by far the most used)
Definition: Fl_Widget.H:58
void callback(Fl_Callback *c, void *p)
Sets the menu item's callback function and userdata() argument.
Definition: Fl_Menu_Item.H:229
Fl_Menu_Item * next(int i=1)
Advances a pointer by n items through a menu array, skipping the contents of submenus and invisible i...
Definition: Fl_Menu_Item.H:137
Fl_Widget, Fl_Label classes .
void image(Fl_Image *a)
compatibility api for FLUID, same as a->label(this)
Definition: Fl_Menu_Item.H:355
void labelsize(Fl_Fontsize a)
Sets the label font pixel size/height.
Definition: Fl_Menu_Item.H:214
int active() const
Gets whether or not the item can be picked.
Definition: Fl_Menu_Item.H:340
void user_data(void *v)
Sets the user_data() argument that is sent to the callback function.
Definition: Fl_Menu_Item.H:261
int Fl_Fontsize
Size of a font in pixels.
Definition: Enumerations.H:741
void( Fl_Callback0)(Fl_Widget *)
One parameter callback type definition passing only the widget.
Definition: Fl_Widget.H:62
void callback(Fl_Callback *c)
Sets the menu item's callback function.
Definition: Fl_Menu_Item.H:236
void * user_data() const
Gets the user_data() argument that is sent to the callback function.
Definition: Fl_Menu_Item.H:257
The Fl_Menu_Item structure defines a single menu item that is used by the Fl_Menu_ class...
Definition: Fl_Menu_Item.H:118
void hide()
Hides an item in the menu.
Definition: Fl_Menu_Item.H:337
unsigned int Fl_Color
an FLTK color value
Definition: Enumerations.H:769
Fl_Labeltype
The labeltype() method sets the type of the label.
Definition: Enumerations.H:606
Fl_Callback * Fl_Callback_p
Default callback type pointer definition for all fltk widgets.
Definition: Fl_Widget.H:60
int Fl_Font
A font number is an index into the internal font table.
Definition: Enumerations.H:712
void show()
Makes an item visible in the menu.
Definition: Fl_Menu_Item.H:334
const char * text
menu item text, returned by label()
Definition: Fl_Menu_Item.H:119
Fl_Color labelcolor_
menu item text color
Definition: Fl_Menu_Item.H:127
Base class of all widgets that have a menu in FLTK.
Definition: Fl_Menu_.H:48
void label(const char *a)
See const char* Fl_Menu_Item::label() const.
Definition: Fl_Menu_Item.H:157
int value() const
Returns the current value of the check or radio item.
Definition: Fl_Menu_Item.H:318
Fl_Labeltype labeltype() const
Returns the menu item's labeltype.
Definition: Fl_Menu_Item.H:169
void do_callback(Fl_Widget *o, void *arg) const
Calls the Fl_Menu_Item item's callback, and provides the Fl_Widget argument.
Definition: Fl_Menu_Item.H:391
void argument(long v)
Sets the user_data() argument that is sent to the callback function.
Definition: Fl_Menu_Item.H:276
int submenu() const
Returns true if either FL_SUBMENU or FL_SUBMENU_POINTER is on in the flags.
Definition: Fl_Menu_Item.H:304
void image(Fl_Image &a)
compatibility api for FLUID, same as a.label(this)
Definition: Fl_Menu_Item.H:358
Fl_Color labelcolor() const
Gets the menu item's label color.
Definition: Fl_Menu_Item.H:187
void label(Fl_Labeltype a, const char *b)
See const char* Fl_Menu_Item::label() const.
Definition: Fl_Menu_Item.H:160
Fl_Fontsize labelsize() const
Gets the label font pixel size/height.
Definition: Fl_Menu_Item.H:211
const char * label() const
Returns the title of the item.
Definition: Fl_Menu_Item.H:154
void labelcolor(Fl_Color a)
Sets the menu item's label color.
Definition: Fl_Menu_Item.H:193
unsigned char uchar
unsigned char
Definition: fl_types.h:39
unsigned int Fl_Shortcut
24-bit Unicode character + 8-bit indicator for keyboard flags
Definition: fl_types.h:55
void * user_data_
menu item user_data for the menu's callback
Definition: Fl_Menu_Item.H:122