FLTK 1.3.4
Fl_Menu_Bar Class Reference

This widget provides a standard menubar interface. More...

#include <Fl_Menu_Bar.H>

Inheritance diagram for Fl_Menu_Bar:
Fl_Menu_ Fl_Widget Fl_Sys_Menu_Bar

Public Member Functions

 Fl_Menu_Bar (int X, int Y, int W, int H, const char *l=0)
 Creates a new Fl_Menu_Bar widget using the given position, size, and label string. More...
 
int handle (int)
 Handles the specified event. More...
 
- Public Member Functions inherited from Fl_Menu_
int add (const char *, int shortcut, Fl_Callback *, void *=0, int=0)
 Adds a new menu item. More...
 
int add (const char *a, const char *b, Fl_Callback *c, void *d=0, int e=0)
 See int Fl_Menu_::add(const char* label, int shortcut, Fl_Callback*, void *user_data=0, int flags=0)
 
int add (const char *)
 This is a Forms (and SGI GL library) compatible add function, it adds many menu items, with '|' separating the menu items, and tab separating the menu item names from an optional shortcut string. More...
 
void clear ()
 Same as menu(NULL), set the array pointer to null, indicating a zero-length menu. More...
 
int clear_submenu (int index)
 Clears the specified submenu pointed to by index of all menu items. More...
 
void copy (const Fl_Menu_Item *m, void *user_data=0)
 Sets the menu array pointer with a copy of m that will be automatically deleted. More...
 
Fl_Boxtype down_box () const
 This box type is used to surround the currently-selected items in the menus. More...
 
void down_box (Fl_Boxtype b)
 See Fl_Boxtype Fl_Menu_::down_box() const.
 
Fl_Color down_color () const
 For back compatibility, same as selection_color()
 
void down_color (unsigned c)
 For back compatibility, same as selection_color()
 
int find_index (const char *name) const
 Find the menu item index for a given menu pathname, such as "Edit/Copy". More...
 
int find_index (const Fl_Menu_Item *item) const
 Find the index into the menu array for a given item. More...
 
int find_index (Fl_Callback *cb) const
 Find the index into the menu array for a given callback cb. More...
 
const Fl_Menu_Itemfind_item (const char *name)
 Find the menu item for a given menu pathname, such as "Edit/Copy". More...
 
const Fl_Menu_Itemfind_item (Fl_Callback *)
 Find the menu item for the given callback cb. More...
 
 Fl_Menu_ (int, int, int, int, const char *=0)
 Creates a new Fl_Menu_ widget using the given position, size, and label string. More...
 
void global ()
 Make the shortcuts for this menu work no matter what window has the focus when you type it. More...
 
int insert (int index, const char *, int shortcut, Fl_Callback *, void *=0, int=0)
 Inserts a new menu item at the specified index position. More...
 
int insert (int index, const char *a, const char *b, Fl_Callback *c, void *d=0, int e=0)
 See int Fl_Menu_::insert(const char* label, int shortcut, Fl_Callback*, void *user_data=0, int flags=0)
 
int item_pathname (char *name, int namelen, const Fl_Menu_Item *finditem=0) const
 Get the menu 'pathname' for the specified menuitem. More...
 
const Fl_Menu_Itemmenu () const
 Returns a pointer to the array of Fl_Menu_Items. More...
 
void menu (const Fl_Menu_Item *m)
 Sets the menu array pointer directly. More...
 
void mode (int i, int fl)
 Sets the flags of item i. More...
 
int mode (int i) const
 Gets the flags of item i. More...
 
const Fl_Menu_Itemmvalue () const
 Returns a pointer to the last menu item that was picked. More...
 
const Fl_Menu_Itempicked (const Fl_Menu_Item *)
 When user picks a menu item, call this. More...
 
void remove (int)
 Deletes item i from the menu. More...
 
void replace (int, const char *)
 Changes the text of item i. More...
 
void setonly (Fl_Menu_Item *item)
 Turns the radio item "on" for the menu item and turns "off" adjacent radio items of the same group. More...
 
void shortcut (int i, int s)
 Changes the shortcut of item i to s. More...
 
int size () const
 This returns the number of Fl_Menu_Item structures that make up the menu, correctly counting submenus. More...
 
void size (int W, int H)
 
const Fl_Menu_Itemtest_shortcut ()
 Returns the menu item with the entered shortcut (key value). More...
 
const char * text () const
 Returns the title of the last item chosen. More...
 
const char * text (int i) const
 Returns the title of item i. More...
 
Fl_Color textcolor () const
 Get the current color of menu item labels. More...
 
void textcolor (Fl_Color c)
 Sets the current color of menu item labels. More...
 
Fl_Font textfont () const
 Gets the current font of menu item labels. More...
 
void textfont (Fl_Font c)
 Sets the current font of menu item labels. More...
 
Fl_Fontsize textsize () const
 Gets the font size of menu item labels. More...
 
void textsize (Fl_Fontsize c)
 Sets the font size of menu item labels. More...
 
int value () const
 Returns the index into menu() of the last item chosen by the user. More...
 
int value (const Fl_Menu_Item *)
 The value is the index into menu() of the last item chosen by the user. More...
 
int value (int i)
 The value is the index into menu() of the last item chosen by the user. More...
 
- Public Member Functions inherited from Fl_Widget
void _clear_fullscreen ()
 
void _set_fullscreen ()
 
void activate ()
 Activates the widget. More...
 
unsigned int active () const
 Returns whether the widget is active. More...
 
int active_r () const
 Returns whether the widget and all of its parents are active. More...
 
Fl_Align align () const
 Gets the label alignment. More...
 
void align (Fl_Align alignment)
 Sets the label alignment. More...
 
long argument () const
 Gets the current user data (long) argument that is passed to the callback function. More...
 
void argument (long v)
 Sets the current user data (long) argument that is passed to the callback function. More...
 
virtual class Fl_Gl_Windowas_gl_window ()
 Returns an Fl_Gl_Window pointer if this widget is an Fl_Gl_Window. More...
 
virtual Fl_Groupas_group ()
 Returns an Fl_Group pointer if this widget is an Fl_Group. More...
 
virtual Fl_Windowas_window ()
 Returns an Fl_Window pointer if this widget is an Fl_Window. More...
 
Fl_Boxtype box () const
 Gets the box type of the widget. More...
 
void box (Fl_Boxtype new_box)
 Sets the box type for the widget. More...
 
Fl_Callback_p callback () const
 Gets the current callback function for the widget. More...
 
void callback (Fl_Callback *cb, void *p)
 Sets the current callback function for the widget. More...
 
void callback (Fl_Callback *cb)
 Sets the current callback function for the widget. More...
 
void callback (Fl_Callback0 *cb)
 Sets the current callback function for the widget. More...
 
void callback (Fl_Callback1 *cb, long p=0)
 Sets the current callback function for the widget. More...
 
unsigned int changed () const
 Checks if the widget value changed since the last callback. More...
 
void clear_active ()
 Marks the widget as inactive without sending events or changing focus. More...
 
void clear_changed ()
 Marks the value of the widget as unchanged. More...
 
void clear_damage (uchar c=0)
 Clears or sets the damage flags. More...
 
void clear_output ()
 Sets a widget to accept input. More...
 
void clear_visible ()
 Hides the widget. More...
 
void clear_visible_focus ()
 Disables keyboard focus navigation with this widget. More...
 
Fl_Color color () const
 Gets the background color of the widget. More...
 
void color (Fl_Color bg)
 Sets the background color of the widget. More...
 
void color (Fl_Color bg, Fl_Color sel)
 Sets the background and selection color of the widget. More...
 
Fl_Color color2 () const
 For back compatibility only. More...
 
void color2 (unsigned a)
 For back compatibility only. More...
 
int contains (const Fl_Widget *w) const
 Checks if w is a child of this widget. More...
 
void copy_label (const char *new_label)
 Sets the current label. More...
 
void copy_tooltip (const char *text)
 Sets the current tooltip text. More...
 
uchar damage () const
 Returns non-zero if draw() needs to be called. More...
 
void damage (uchar c)
 Sets the damage bits for the widget. More...
 
void damage (uchar c, int x, int y, int w, int h)
 Sets the damage bits for an area inside the widget. More...
 
int damage_resize (int, int, int, int)
 Internal use only. More...
 
void deactivate ()
 Deactivates the widget. More...
 
Fl_Imagedeimage ()
 Gets the image that is used as part of the widget label. More...
 
const Fl_Imagedeimage () const
 
void deimage (Fl_Image *img)
 Sets the image to use as part of the widget label. More...
 
void deimage (Fl_Image &img)
 Sets the image to use as part of the widget label. More...
 
void do_callback ()
 Calls the widget callback. More...
 
void do_callback (Fl_Widget *o, long arg)
 Calls the widget callback. More...
 
void do_callback (Fl_Widget *o, void *arg=0)
 Calls the widget callback. More...
 
void draw_label (int, int, int, int, Fl_Align) const
 Draws the label in an arbitrary bounding box with an arbitrary alignment. More...
 
int h () const
 Gets the widget height. More...
 
virtual void hide ()
 Makes a widget invisible. More...
 
Fl_Imageimage ()
 Gets the image that is used as part of the widget label. More...
 
const Fl_Imageimage () const
 
void image (Fl_Image *img)
 Sets the image to use as part of the widget label. More...
 
void image (Fl_Image &img)
 Sets the image to use as part of the widget label. More...
 
int inside (const Fl_Widget *wgt) const
 Checks if this widget is a child of wgt. More...
 
int is_label_copied () const
 Returns whether the current label was assigned with copy_label(). More...
 
const char * label () const
 Gets the current label text. More...
 
void label (const char *text)
 Sets the current label pointer. More...
 
void label (Fl_Labeltype a, const char *b)
 Shortcut to set the label text and type in one call. More...
 
Fl_Color labelcolor () const
 Gets the label color. More...
 
void labelcolor (Fl_Color c)
 Sets the label color. More...
 
Fl_Font labelfont () const
 Gets the font to use. More...
 
void labelfont (Fl_Font f)
 Sets the font to use. More...
 
Fl_Fontsize labelsize () const
 Gets the font size in pixels. More...
 
void labelsize (Fl_Fontsize pix)
 Sets the font size in pixels. More...
 
Fl_Labeltype labeltype () const
 Gets the label type. More...
 
void labeltype (Fl_Labeltype a)
 Sets the label type. More...
 
void measure_label (int &ww, int &hh) const
 Sets width ww and height hh accordingly with the label size. More...
 
unsigned int output () const
 Returns if a widget is used for output only. More...
 
Fl_Groupparent () const
 Returns a pointer to the parent widget. More...
 
void parent (Fl_Group *p)
 Internal use only - "for hacks only". More...
 
void position (int X, int Y)
 Repositions the window or widget. More...
 
void redraw ()
 Schedules the drawing of the widget. More...
 
void redraw_label ()
 Schedules the drawing of the label. More...
 
virtual void resize (int x, int y, int w, int h)
 Changes the size or position of the widget. More...
 
Fl_Color selection_color () const
 Gets the selection color. More...
 
void selection_color (Fl_Color a)
 Sets the selection color. More...
 
void set_active ()
 Marks the widget as active without sending events or changing focus. More...
 
void set_changed ()
 Marks the value of the widget as changed. More...
 
void set_output ()
 Sets a widget to output only. More...
 
void set_visible ()
 Makes the widget visible. More...
 
void set_visible_focus ()
 Enables keyboard focus navigation with this widget. More...
 
virtual void show ()
 Makes a widget visible. More...
 
void size (int W, int H)
 Changes the size of the widget. More...
 
int take_focus ()
 Gives the widget the keyboard focus. More...
 
unsigned int takesevents () const
 Returns if the widget is able to take events. More...
 
int test_shortcut ()
 Returns true if the widget's label contains the entered '&x' shortcut. More...
 
const char * tooltip () const
 Gets the current tooltip text. More...
 
void tooltip (const char *text)
 Sets the current tooltip text. More...
 
Fl_Windowtop_window () const
 Returns a pointer to the top-level window for the widget. More...
 
Fl_Windowtop_window_offset (int &xoff, int &yoff) const
 Finds the x/y offset of the current widget relative to the top-level window. More...
 
uchar type () const
 Gets the widget type. More...
 
void type (uchar t)
 Sets the widget type. More...
 
int use_accents_menu ()
 Returns non zero if MAC_USE_ACCENTS_MENU flag is set, 0 otherwise.
 
void * user_data () const
 Gets the user data for this widget. More...
 
void user_data (void *v)
 Sets the user data for this widget. More...
 
unsigned int visible () const
 Returns whether a widget is visible. More...
 
void visible_focus (int v)
 Modifies keyboard focus navigation. More...
 
unsigned int visible_focus ()
 Checks whether this widget has a visible focus. More...
 
int visible_r () const
 Returns whether a widget and all its parents are visible. More...
 
int w () const
 Gets the widget width. More...
 
Fl_When when () const
 Returns the conditions under which the callback is called. More...
 
void when (uchar i)
 Sets the flags used to decide when a callback is called. More...
 
Fl_Windowwindow () const
 Returns a pointer to the nearest parent window up the widget hierarchy. More...
 
int x () const
 Gets the widget position in its window. More...
 
int y () const
 Gets the widget position in its window. More...
 
virtual ~Fl_Widget ()
 Destroys the widget. More...
 

Protected Member Functions

void draw ()
 Draws the widget. More...
 
- Protected Member Functions inherited from Fl_Menu_
int item_pathname_ (char *name, int namelen, const Fl_Menu_Item *finditem, const Fl_Menu_Item *menu=0) const
 
- Protected Member Functions inherited from Fl_Widget
void clear_flag (unsigned int c)
 Clears a flag in the flags mask.
 
void draw_backdrop () const
 If FL_ALIGN_IMAGE_BACKDROP is set, the image or deimage will be drawn.
 
void draw_box () const
 Draws the widget box according its box style.
 
void draw_box (Fl_Boxtype t, Fl_Color c) const
 Draws a box of type t, of color c at the widget's position and size. More...
 
void draw_box (Fl_Boxtype t, int x, int y, int w, int h, Fl_Color c) const
 Draws a box of type t, of color c at the position X,Y and size W,H. More...
 
void draw_focus ()
 draws a focus rectangle around the widget
 
void draw_focus (Fl_Boxtype t, int x, int y, int w, int h) const
 Draws a focus box for the widget at the given position and size.
 
void draw_label () const
 Draws the widget's label at the defined label position. More...
 
void draw_label (int, int, int, int) const
 Draws the label in an arbitrary bounding box. More...
 
 Fl_Widget (int x, int y, int w, int h, const char *label=0L)
 Creates a widget at the given position and size. More...
 
unsigned int flags () const
 Gets the widget flags mask.
 
void h (int v)
 Internal use only. More...
 
void set_flag (unsigned int c)
 Sets a flag in the flags mask.
 
void w (int v)
 Internal use only. More...
 
void x (int v)
 Internal use only. More...
 
void y (int v)
 Internal use only. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Fl_Widget
static void default_callback (Fl_Widget *cb, void *d)
 The default callback for all widgets that don't set a callback. More...
 
static unsigned int label_shortcut (const char *t)
 Returns the Unicode value of the '&x' shortcut in a given text. More...
 
static int test_shortcut (const char *, const bool require_alt=false)
 Returns true if the given text t contains the entered '&x' shortcut. More...
 
- Protected Types inherited from Fl_Widget
enum  {
  INACTIVE = 1<<0, INVISIBLE = 1<<1, OUTPUT = 1<<2, NOBORDER = 1<<3,
  FORCE_POSITION = 1<<4, NON_MODAL = 1<<5, SHORTCUT_LABEL = 1<<6, CHANGED = 1<<7,
  OVERRIDE = 1<<8, VISIBLE_FOCUS = 1<<9, COPIED_LABEL = 1<<10, CLIP_CHILDREN = 1<<11,
  MENU_WINDOW = 1<<12, TOOLTIP_WINDOW = 1<<13, MODAL = 1<<14, NO_OVERLAY = 1<<15,
  GROUP_RELATIVE = 1<<16, COPIED_TOOLTIP = 1<<17, FULLSCREEN = 1<<18, MAC_USE_ACCENTS_MENU = 1<<19,
  USERFLAG3 = 1<<29, USERFLAG2 = 1<<30, USERFLAG1 = 1<<31
}
 flags possible values enumeration. More...
 
- Protected Attributes inherited from Fl_Menu_
uchar alloc
 
uchar down_box_
 
Fl_Color textcolor_
 
Fl_Font textfont_
 
Fl_Fontsize textsize_
 

Detailed Description

This widget provides a standard menubar interface.

Usually you will put this widget along the top edge of your window. The height of the widget should be 30 for the menu titles to draw correctly with the default font.

The items on the bar and the menus they bring up are defined by a single Fl_Menu_Item array. Because a Fl_Menu_Item array defines a hierarchy, the top level menu defines the items in the menubar, while the submenus define the pull-down menus. Sub-sub menus and lower pop up to the right of the submenus.

menubar.png

If there is an item in the top menu that is not a title of a submenu, then it acts like a "button" in the menubar. Clicking on it will pick it.

When the user clicks a menu item, value() is set to that item and then:

  • The item's callback is done if one has been set; the Fl_Menu_Bar is passed as the Fl_Widget* argument, along with any userdata configured for the callback.
  • If the item does not have a callback, the Fl_Menu_Bar's callback is done instead, along with any userdata configured for the callback. The callback can determine which item was picked using value(), mvalue(), item_pathname(), etc.

Submenus will also pop up in response to shortcuts indicated by putting a '&' character in the name field of the menu item. If you put a '&' character in a top-level "button" then the shortcut picks it. The '&' character in submenus is ignored until the menu is popped up.

Typing the shortcut() of any of the menu items will cause callbacks exactly the same as when you pick the item with the mouse.

Constructor & Destructor Documentation

Fl_Menu_Bar::Fl_Menu_Bar ( int  X,
int  Y,
int  W,
int  H,
const char *  l = 0 
)

Creates a new Fl_Menu_Bar widget using the given position, size, and label string.

The default boxtype is FL_UP_BOX.

The constructor sets menu() to NULL. See Fl_Menu_ for the methods to set or change the menu.

labelsize(), labelfont(), and labelcolor() are used to control how the menubar items are drawn. They are initialized from the Fl_Menu static variables, but you can change them if desired.

label() is ignored unless you change align() to put it outside the menubar.

The destructor removes the Fl_Menu_Bar widget and all of its menu items.

Member Function Documentation

void Fl_Menu_Bar::draw ( )
protectedvirtual

Draws the widget.

Never call this function directly. FLTK will schedule redrawing whenever needed. If your widget must be redrawn as soon as possible, call redraw() instead.

Override this function to draw your own widgets.

If you ever need to call another widget's draw method from within your own draw() method, e.g. for an embedded scrollbar, you can do it (because draw() is virtual) like this:

Fl_Widget *s = &scroll; // scroll is an embedded Fl_Scrollbar
s->draw(); // calls Fl_Scrollbar::draw()

Implements Fl_Widget.

Reimplemented in Fl_Sys_Menu_Bar.

int Fl_Menu_Bar::handle ( int  event)
virtual

Handles the specified event.

You normally don't call this method directly, but instead let FLTK do it when the user interacts with the widget.

When implemented in a widget, this function must return 0 if the widget does not use the event or 1 otherwise.

Most of the time, you want to call the inherited handle() method in your overridden method so that you don't short-circuit events that you don't handle. In this last case you should return the callee retval.

Parameters
[in]eventthe kind of event received
Return values
0if the event was not used or understood
1if the event was used and can be deleted
See Also
Fl_Event

Reimplemented from Fl_Widget.


The documentation for this class was generated from the following files: