A class to create, modify and delete menus that appear on Mac OS X in the menu bar at the top of the screen. More...

#include <Fl_Sys_Menu_Bar.H>

Inheritance diagram for Fl_Sys_Menu_Bar:

Public Member Functions
int	add (const char label, const char shortcut, Fl_Callback cb, void user_data=0, int flags=0)
	Adds a new menu item.

int	add (const char label, int shortcut, Fl_Callback , void *user_data=0, int flags=0)
	Add a new menu item to the system menu bar.

int	add (const char *str)
	Forms-compatible procedure to add items to the system menu bar.

void	clear ()
	Set the Fl_Menu_Item array pointer to null, indicating a zero-length menu.

int	clear_submenu (int index)
	Clears the specified submenu pointed to by index of all menu items.

	Fl_Sys_Menu_Bar (int x, int y, int w, int h, const char *l=0)
	The constructor.

void	global ()
	Make the shortcuts for this menu work no matter what window has the focus when you type it.

int	insert (int index, const char label, const char shortcut, Fl_Callback cb, void user_data=0, int flags=0)
	Insert a new menu item.

int	insert (int index, const char label, int shortcut, Fl_Callback cb, void *user_data=0, int flags=0)
	insert in the system menu bar a new menu item

const Fl_Menu_Item *	menu () const
	Return the system menu's array of Fl_Menu_Item's.

void	menu (const Fl_Menu_Item *m)
	create a system menu bar using the given list of menu structs

int	mode (int i) const
	Gets the flags of item i.

void	mode (int i, int fl)
	Sets the flags of item i.

void	remove (int n)
	remove an item from the system menu bar

void	replace (int index, const char *name)
	rename an item from the system menu bar

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.

void	shortcut (int i, int s)
	Changes the shortcut of item i to n.

void	update ()
	Updates the system menu after any change to its items.

	~Fl_Sys_Menu_Bar ()
	The destructor.

Public Member Functions inherited from 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.

int	handle (int)
	Handles the specified event.

Public Member Functions inherited from Fl_Menu_
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.

int	add (const char , int shortcut, Fl_Callback , void *=0, int=0)
	Adds a new menu item.

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)

void	clear ()
	Same as menu(NULL), set the array pointer to null, indicating a zero-length menu.

int	clear_submenu (int index)
	Clears the specified submenu pointed to by `index` of all menu items.

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.

Fl_Boxtype	down_box () const
	This box type is used to surround the currently-selected items in the menus.

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".

int	find_index (const Fl_Menu_Item *item) const
	Find the index into the menu array for a given `item`.

int	find_index (Fl_Callback *cb) const
	Find the index into the menu array for a given callback `cb`.

const Fl_Menu_Item *	find_item (const char *name)
	Find the menu item for a given menu `pathname`, such as "Edit/Copy".

const Fl_Menu_Item *	find_item (Fl_Callback *)
	Find the menu item for the given callback `cb`.

	Fl_Menu_ (int, int, int, int, const char *=0)
	Creates a new Fl_Menu_ widget using the given position, size, and label string.

void	global ()
	Make the shortcuts for this menu work no matter what window has the focus when you type it.

int	insert (int index, const char , int shortcut, Fl_Callback , void *=0, int=0)
	Inserts a new menu item at the specified `index` position.

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.

const Fl_Menu_Item *	menu () const
	Returns a pointer to the array of Fl_Menu_Items.

void	menu (const Fl_Menu_Item *m)
	Sets the menu array pointer directly.

int	mode (int i) const
	Gets the flags of item i.

void	mode (int i, int fl)
	Sets the flags of item i.

const Fl_Menu_Item *	mvalue () const
	Returns a pointer to the last menu item that was picked.

const Fl_Menu_Item *	picked (const Fl_Menu_Item *)
	When user picks a menu item, call this.

void	remove (int)
	Deletes item `i` from the menu.

void	replace (int, const char *)
	Changes the text of item `i`.

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.

void	shortcut (int i, int s)
	Changes the shortcut of item `i` to `s`.

int	size () const
	This returns the number of Fl_Menu_Item structures that make up the menu, correctly counting submenus.

void	size (int W, int H)

const Fl_Menu_Item *	test_shortcut ()
	Returns the menu item with the entered shortcut (key value).

const char *	text () const
	Returns the title of the last item chosen.

const char *	text (int i) const
	Returns the title of item i.

Fl_Color	textcolor () const
	Get the current color of menu item labels.

void	textcolor (Fl_Color c)
	Sets the current color of menu item labels.

Fl_Font	textfont () const
	Gets the current font of menu item labels.

void	textfont (Fl_Font c)
	Sets the current font of menu item labels.

Fl_Fontsize	textsize () const
	Gets the font size of menu item labels.

void	textsize (Fl_Fontsize c)
	Sets the font size of menu item labels.

int	value () const
	Returns the index into menu() of the last item chosen by the user.

int	value (const Fl_Menu_Item *)
	The value is the index into menu() of the last item chosen by the user.

int	value (int i)
	The value is the index into menu() of the last item chosen by the user.

Public Member Functions inherited from Fl_Widget
void	_clear_fullscreen ()

void	_set_fullscreen ()

void	activate ()
	Activates the widget.

unsigned int	active () const
	Returns whether the widget is active.

int	active_r () const
	Returns whether the widget and all of its parents are active.

Fl_Align	align () const
	Gets the label alignment.

void	align (Fl_Align alignment)
	Sets the label alignment.

long	argument () const
	Gets the current user data (long) argument that is passed to the callback function.

void	argument (long v)
	Sets the current user data (long) argument that is passed to the callback function.

virtual class Fl_Gl_Window *	as_gl_window ()
	Returns an Fl_Gl_Window pointer if this widget is an Fl_Gl_Window.

virtual Fl_Group *	as_group ()
	Returns an Fl_Group pointer if this widget is an Fl_Group.

virtual Fl_Window *	as_window ()
	Returns an Fl_Window pointer if this widget is an Fl_Window.

Fl_Boxtype	box () const
	Gets the box type of the widget.

void	box (Fl_Boxtype new_box)
	Sets the box type for the widget.

Fl_Callback_p	callback () const
	Gets the current callback function for the widget.

void	callback (Fl_Callback *cb)
	Sets the current callback function for the widget.

void	callback (Fl_Callback cb, void p)
	Sets the current callback function for the widget.

void	callback (Fl_Callback0 *cb)
	Sets the current callback function for the widget.

void	callback (Fl_Callback1 *cb, long p=0)
	Sets the current callback function for the widget.

unsigned int	changed () const
	Checks if the widget value changed since the last callback.

void	clear_active ()
	Marks the widget as inactive without sending events or changing focus.

void	clear_changed ()
	Marks the value of the widget as unchanged.

void	clear_damage (uchar c=0)
	Clears or sets the damage flags.

void	clear_output ()
	Sets a widget to accept input.

void	clear_visible ()
	Hides the widget.

void	clear_visible_focus ()
	Disables keyboard focus navigation with this widget.

Fl_Color	color () const
	Gets the background color of the widget.

void	color (Fl_Color bg)
	Sets the background color of the widget.

void	color (Fl_Color bg, Fl_Color sel)
	Sets the background and selection color of the widget.

Fl_Color	color2 () const
	For back compatibility only.

void	color2 (unsigned a)
	For back compatibility only.

int	contains (const Fl_Widget *w) const
	Checks if w is a child of this widget.

void	copy_label (const char *new_label)
	Sets the current label.

void	copy_tooltip (const char *text)
	Sets the current tooltip text.

uchar	damage () const
	Returns non-zero if draw() needs to be called.

void	damage (uchar c)
	Sets the damage bits for the widget.

void	damage (uchar c, int x, int y, int w, int h)
	Sets the damage bits for an area inside the widget.

int	damage_resize (int, int, int, int)
	Internal use only.

void	deactivate ()
	Deactivates the widget.

Fl_Image *	deimage ()
	Gets the image that is used as part of the widget label.

const Fl_Image *	deimage () const

void	deimage (Fl_Image &img)
	Sets the image to use as part of the widget label.

void	deimage (Fl_Image *img)
	Sets the image to use as part of the widget label.

void	do_callback ()
	Calls the widget callback.

void	do_callback (Fl_Widget *o, long arg)
	Calls the widget callback.

void	do_callback (Fl_Widget o, void arg=0)
	Calls the widget callback.

void	draw_label (int, int, int, int, Fl_Align) const
	Draws the label in an arbitrary bounding box with an arbitrary alignment.

int	h () const
	Gets the widget height.

virtual void	hide ()
	Makes a widget invisible.

Fl_Image *	image ()
	Gets the image that is used as part of the widget label.

const Fl_Image *	image () const

void	image (Fl_Image &img)
	Sets the image to use as part of the widget label.

void	image (Fl_Image *img)
	Sets the image to use as part of the widget label.

int	inside (const Fl_Widget *wgt) const
	Checks if this widget is a child of `wgt`.

int	is_label_copied () const
	Returns whether the current label was assigned with copy_label().

const char *	label () const
	Gets the current label text.

void	label (const char *text)
	Sets the current label pointer.

void	label (Fl_Labeltype a, const char *b)
	Shortcut to set the label text and type in one call.

Fl_Color	labelcolor () const
	Gets the label color.

void	labelcolor (Fl_Color c)
	Sets the label color.

Fl_Font	labelfont () const
	Gets the font to use.

void	labelfont (Fl_Font f)
	Sets the font to use.

Fl_Fontsize	labelsize () const
	Gets the font size in pixels.

void	labelsize (Fl_Fontsize pix)
	Sets the font size in pixels.

Fl_Labeltype	labeltype () const
	Gets the label type.

void	labeltype (Fl_Labeltype a)
	Sets the label type.

void	measure_label (int &ww, int &hh) const
	Sets width ww and height hh accordingly with the label size.

unsigned int	output () const
	Returns if a widget is used for output only.

Fl_Group *	parent () const
	Returns a pointer to the parent widget.

void	parent (Fl_Group *p)
	Internal use only - "for hacks only".

void	position (int X, int Y)
	Repositions the window or widget.

void	redraw ()
	Schedules the drawing of the widget.

void	redraw_label ()
	Schedules the drawing of the label.

virtual void	resize (int x, int y, int w, int h)
	Changes the size or position of the widget.

Fl_Color	selection_color () const
	Gets the selection color.

void	selection_color (Fl_Color a)
	Sets the selection color.

void	set_active ()
	Marks the widget as active without sending events or changing focus.

void	set_changed ()
	Marks the value of the widget as changed.

void	set_output ()
	Sets a widget to output only.

void	set_visible ()
	Makes the widget visible.

void	set_visible_focus ()
	Enables keyboard focus navigation with this widget.

virtual void	show ()
	Makes a widget visible.

void	size (int W, int H)
	Changes the size of the widget.

int	take_focus ()
	Gives the widget the keyboard focus.

unsigned int	takesevents () const
	Returns if the widget is able to take events.

int	test_shortcut ()
	Returns true if the widget's label contains the entered '&x' shortcut.

const char *	tooltip () const
	Gets the current tooltip text.

void	tooltip (const char *text)
	Sets the current tooltip text.

Fl_Window *	top_window () const
	Returns a pointer to the top-level window for the widget.

Fl_Window *	top_window_offset (int &xoff, int &yoff) const
	Finds the x/y offset of the current widget relative to the top-level window.

uchar	type () const
	Gets the widget type.

void	type (uchar t)
	Sets the widget type.

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.

void	user_data (void *v)
	Sets the user data for this widget.

unsigned int	visible () const
	Returns whether a widget is visible.

unsigned int	visible_focus ()
	Checks whether this widget has a visible focus.

void	visible_focus (int v)
	Modifies keyboard focus navigation.

int	visible_r () const
	Returns whether a widget and all its parents are visible.

int	w () const
	Gets the widget width.

Fl_When	when () const
	Returns the conditions under which the callback is called.

void	when (uchar i)
	Sets the flags used to decide when a callback is called.

Fl_Window *	window () const
	Returns a pointer to the nearest parent window up the widget hierarchy.

int	x () const
	Gets the widget position in its window.

int	y () const
	Gets the widget position in its window.

virtual	~Fl_Widget ()
	Destroys the widget.

Protected Member Functions
void	draw ()
	Draws the widget.

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.

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.

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.

void	draw_label (int, int, int, int) const
	Draws the label in an arbitrary bounding box.

	Fl_Widget (int x, int y, int w, int h, const char *label=0L)
	Creates a widget at the given position and size.

unsigned int	flags () const
	Gets the widget flags mask.

void	h (int v)
	Internal use only.

void	set_flag (unsigned int c)
	Sets a flag in the flags mask.

void	w (int v)
	Internal use only.

void	x (int v)
	Internal use only.

void	y (int v)
	Internal use only.

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.

static unsigned int	label_shortcut (const char *t)
	Returns the Unicode value of the '&x' shortcut in a given text.

static int	test_shortcut (const char *, const bool require_alt=false)
	Returns true if the given text `t` contains the entered '&x' shortcut.

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

A class to create, modify and delete menus that appear on Mac OS X in the menu bar at the top of the screen.

On other than Mac OS X platforms, Fl_Sys_Menu_Bar is a synonym of class Fl_Menu_Bar.
To use this class, just replace Fl_Menu_Bar by Fl_Sys_Menu_Bar, and, on the Mac platform, a system menu at the top of the screen will be available. This menu will match an array of Fl_Menu_Item's exactly as with standard FLTK menus.

Changes to the menu state are immediately visible in the menubar when they are made using member functions of the Fl_Sys_Menu_Bar class. Other changes (e.g., by a call to Fl_Menu_Item::set()) should be followed by a call to Fl_Sys_Menu_Bar::update() to be visible in the menubar across all platforms.

A few FLTK features are not supported by the Mac System menu:

no symbolic labels
no embossed labels
no font sizes

You can configure a callback for the 'About' menu item to invoke your own code with fl_mac_set_about().

Constructor & Destructor Documentation

◆ Fl_Sys_Menu_Bar()

Fl_Sys_Menu_Bar::Fl_Sys_Menu_Bar	(	int	x,
		int	y,
		int	w,
		int	h,
		const char *	l = `0`
	)

The constructor.

On Mac OS X, all arguments are unused. On other platforms they are used as by Fl_Menu_Bar::Fl_Menu_Bar().

Member Function Documentation

◆ add() [1/3]

int Fl_Sys_Menu_Bar::add	(	const char *	label,
		const char *	shortcut,
		Fl_Callback *	cb,
		void *	user_data = `0`,
		int	flags = `0`
	)

inline

Adds a new menu item.

See also: Fl_Menu_::add(const char* label, int shortcut, Fl_Callback*, void *user_data=0, int flags=0)

◆ add() [2/3]

int Fl_Sys_Menu_Bar::add	(	const char *	label,
		int	shortcut,
		Fl_Callback *	cb,
		void *	user_data = `0`,
		int	flags = `0`
	)

Add a new menu item to the system menu bar.

Parameters

label	- new menu item's label
shortcut	- new menu item's integer shortcut (can be 0 for none, or e.g. FL_ALT+'x')
cb	- callback to be invoked when item selected (can be 0 for none, in which case the menubar's callback() can be used instead)
user_data	- argument to the callback
flags	- item's flags, e.g. FL_MENU_TOGGLE, etc.

Returns: the index into the menu() array, where the entry was added

See also: Fl_Menu_::add(const char* label, int shortcut, Fl_Callback *cb, void *user_data, int flags)

◆ add() [3/3]

int Fl_Sys_Menu_Bar::add ( const char * str )

Forms-compatible procedure to add items to the system menu bar.

Returns: the index into the menu() array, where the entry was added

See also: Fl_Menu_::add(const char* str)

◆ clear()

void Fl_Sys_Menu_Bar::clear ( )

Set the Fl_Menu_Item array pointer to null, indicating a zero-length menu.

See also: Fl_Menu_::clear()

◆ clear_submenu()

int Fl_Sys_Menu_Bar::clear_submenu ( int index )

Clears the specified submenu pointed to by index of all menu items.

See also: Fl_Menu_::clear_submenu(int index)

◆ draw()

void Fl_Sys_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()

Fl_Widget

Fl_Widget is the base class for all widgets in FLTK.

Definition Fl_Widget.H:101

Reimplemented from Fl_Menu_Bar.

◆ insert() [1/2]

int Fl_Sys_Menu_Bar::insert	(	int	index,
		const char *	label,
		const char *	shortcut,
		Fl_Callback *	cb,
		void *	user_data = `0`,
		int	flags = `0`
	)

inline

Insert a new menu item.

See also: Fl_Menu_::insert(int index, const char* label, const char* shortcut, Fl_Callback *cb, void *user_data=0, int flags=0)

◆ insert() [2/2]

int Fl_Sys_Menu_Bar::insert	(	int	index,
		const char *	label,
		int	shortcut,
		Fl_Callback *	cb,
		void *	user_data = `0`,
		int	flags = `0`
	)

insert in the system menu bar a new menu item

Insert in the system menu bar a new menu item, with a title string, shortcut int, callback, argument to the callback, and flags.

Returns: the index into the menu() array, where the entry was inserted

See also: Fl_Menu_::insert(int index, const char* label, int shortcut, Fl_Callback *cb, void *user_data, int flags)

◆ menu()

void Fl_Sys_Menu_Bar::menu ( const Fl_Menu_Item * m )

create a system menu bar using the given list of menu structs

Author: Matthias Melcher

Parameters

m	list of Fl_Menu_Item

◆ mode()

void Fl_Sys_Menu_Bar::mode	(	int	i,
		int	fl
	)

inline

Sets the flags of item i.

See also: Fl_Menu_::mode(int i, int fl)

◆ remove()

void Fl_Sys_Menu_Bar::remove ( int index )

remove an item from the system menu bar

Parameters

index the index of the item to remove

◆ replace()

void Fl_Sys_Menu_Bar::replace	(	int	index,
		const char *	name
	)

rename an item from the system menu bar

Parameters

index	the index of the item to rename
name	the new item name as a UTF8 string

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

Fl_Sys_Menu_Bar.H
Fl_Sys_Menu_Bar.mm

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Fl_Sys_Menu_Bar()

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ clear()

◆ clear_submenu()

◆ draw()

◆ insert() [1/2]

◆ insert() [2/2]

◆ menu()

◆ mode()

◆ remove()

◆ replace()