uiMenu Struct Reference

Description

An application level menu bar.

The various operating systems impose different requirements on the creation and placement of menu bar items, hence the abstraction of the items Quit, Preferences and About.

An exemplary, cross platform menu bar:

• File
  • New
  • Open
  • Save
  • Quit, use uiMenuAppendQuitItem()
• Edit
  • Undo
  • Redo
  • Cut
  • Copy
  • Paste
  • Select All
  • Preferences, use uiMenuAppendPreferencesItem()
• Help
  • About, use uiMenuAppendAboutItem()

#include <ui.h>

Public Member Functions
uiMenuItem *	uiMenuAppendItem (uiMenu *m, const char *name)
	Appends a generic menu item.
uiMenuItem *	uiMenuAppendCheckItem (uiMenu *m, const char *name)
	Appends a generic menu item with a checkbox.
uiMenuItem *	uiMenuAppendQuitItem (uiMenu *m)
	Appends a new Quit menu item.
uiMenuItem *	uiMenuAppendPreferencesItem (uiMenu *m)
	Appends a new Preferences menu item.
uiMenuItem *	uiMenuAppendAboutItem (uiMenu *m)
	Appends a new About menu item.
void	uiMenuAppendSeparator (uiMenu *m)
	Appends a new separator.

Static Public Member Functions
uiMenu *	uiNewMenu (const char *name)
	Creates a new menu.

Member Function Documentation

uiMenuAppendAboutItem()

uiMenuItem * uiMenuAppendAboutItem

(

uiMenu *

m

)

Appends a new About menu item.

Parameters

m	uiMenu instance.

Warning

Only one such menu item may exist per application.

Returns

A new uiMenuItem instance.

uiMenuAppendCheckItem()

uiMenuItem * uiMenuAppendCheckItem	(	uiMenu *	m,
		const char *	name )

Appends a generic menu item with a checkbox.

Parameters

m	uiMenu instance.
name	Menu item text. A NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.

Returns

A new uiMenuItem instance.

uiMenuAppendItem()

uiMenuItem * uiMenuAppendItem	(	uiMenu *	m,
		const char *	name )

Appends a generic menu item.

Parameters

m	uiMenu instance.
name	Menu item text. A NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.

Returns

A new uiMenuItem instance.

uiMenuAppendPreferencesItem()

uiMenuItem * uiMenuAppendPreferencesItem

(

uiMenu *

m

)

Appends a new Preferences menu item.

Parameters

m	uiMenu instance.

Returns

A new uiMenuItem instance.

Warning

Only one such menu item may exist per application.

uiMenuAppendQuitItem()

uiMenuItem * uiMenuAppendQuitItem

(

uiMenu *

m

)

Appends a new Quit menu item.

Parameters

m	uiMenu instance.

Returns

A new uiMenuItem instance.

Warning

Only one such menu item may exist per application.

uiMenuAppendSeparator()

void uiMenuAppendSeparator

(

uiMenu *

m

)

Appends a new separator.

Parameters

m	uiMenu instance.

uiNewMenu()

uiMenu * uiNewMenu ( const char * name )

static

Creates a new menu.

Typical values are File, Edit, Help.

Parameters

name	Menu label. A NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.

Returns

A new uiMenu instance.

---

The documentation for this struct was generated from the following file:

• include/ui.h