DzActionMenuItem Class Reference
[Interface Components]

Class that encapsulates an 'Action Menu' item. More...

List of all members.

Enumerations
enum	Type { Separator, Action, CustomAction, SubMenu }
Properties
String	action
String	subMenuLabel
Type	type
Methods
DzActionMenu	getSubMenu ()
void	setSubMenu (DzActionMenu menu)

---

Detailed Description

Class that encapsulates an 'Action Menu' item.

See also:

DzActionMenu::getItem()

---

Member Enumeration Documentation

enum DzActionMenuItem::Type

The types of action menu items

Enumerator:

Separator	A menu separator (i.e. horizontal divider)
Action	An action item - a menu entry that activates a DzAction object
CustomAction	A custom action item - a menu entry that activates a custom action. See DzActionMgr for more about custom actions.
SubMenu	A submenu action item - a menu entry that opens a submenu

---

Member Function Documentation

DzActionMenu DzActionMenuItem::getSubMenu

(

)

Returns:

A pointer to the submenu that is displayed by this menu entry. This function returns NULL if the menu has not been set, or if the type of the item is not SubMenu.

void DzActionMenuItem::setSubMenu

(

DzActionMenu

menu

)

Sets the menu that is displayed as the submenu when this menu item is activated. This call has no effect unless the type of this item is SubMenu.

Parameters:

menu

The menu that is displayed as a submenu when this menu entry is activated. The menu item takes ownership of the menu - the menu will be deleted when this item is destroyed.

---

Member Data Documentation

String DzActionMenuItem::action

The class name of the action for this item

String DzActionMenuItem::subMenuLabel

The name of the submenu for this item

DzActionMenuItem::Type DzActionMenuItem::type

The type of the menu item

---

Copyright © 2002 - 2009 DAZ 3D, Inc.