uiMenuItem Struct Reference

Description

A menu item used in conjunction with uiMenu.

#include <ui.h>

Public Member Functions
void	uiMenuItemEnable (uiMenuItem *m)
	Enables the menu item.
void	uiMenuItemDisable (uiMenuItem *m)
	Disables the menu item.
void	uiMenuItemOnClicked (uiMenuItem *m, void(*f)(uiMenuItem *sender, uiWindow *window, void *senderData), void *data)
	Registers a callback for when the menu item is clicked.
int	uiMenuItemChecked (uiMenuItem *m)
	Returns whether or not the menu item's checkbox is checked.
void	uiMenuItemSetChecked (uiMenuItem *m, int checked)
	Sets whether or not the menu item's checkbox is checked.

Member Function Documentation

uiMenuItemChecked()

int uiMenuItemChecked

(

uiMenuItem *

m

)

Returns whether or not the menu item's checkbox is checked.

To be used only with items created via uiMenuAppendCheckItem().

Parameters

m	uiMenuItem instance.

Returns

TRUE if checked, FALSE otherwise. [Default: FALSE]

uiMenuItemDisable()

void uiMenuItemDisable

(

uiMenuItem *

m

)

Disables the menu item.

Menu item is grayed out and user interaction is not possible.

Parameters

m	uiMenuItem instance.

uiMenuItemEnable()

void uiMenuItemEnable

(

uiMenuItem *

m

)

Enables the menu item.

Parameters

m	uiMenuItem instance.

uiMenuItemOnClicked()

void uiMenuItemOnClicked	(	uiMenuItem *	m,
		void(*	f )(uiMenuItem *sender, uiWindow *window, void *senderData),
		void *	data )

Registers a callback for when the menu item is clicked.

Parameters

m	uiMenuItem instance.
f	Callback function. sender Back reference to the instance that triggered the callback. window Reference to the window from which the callback got triggered.\ senderData User data registered with the sender instance.
data	User data to be passed to the callback.

Note

Only one callback can be registered at a time.

uiMenuItemSetChecked()

void uiMenuItemSetChecked	(	uiMenuItem *	m,
		int	checked )

Sets whether or not the menu item's checkbox is checked.

To be used only with items created via uiMenuAppendCheckItem().

Parameters

m	uiMenuItem instance.
checked	TRUE to check menu item checkbox, FALSE otherwise.

---

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

• include/ui.h