Inheritance diagram for IActionMenuManager:

Public Types
enum	{ kDefaultIID = IID_IACTIONMENUMANAGER }

Public Member Functions
virtual void	AddEventMenuItem (ActionEvent inEvent, const PMString &inName, double inOrder)=0

virtual void	AddEventSeparatorItem (ActionEvent inBeforeEvent, double inOrder)=0

virtual void	BuildEventMenuSupportingSelection (IDropDownListController *inDropDownList, const ActionEvent &inSelectEvent)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Utility interface to specify a name and order for an event, when it is presented in a menu Also used to build an event menu.

Member Function Documentation

virtual void IActionMenuManager::AddEventMenuItem	(	ActionEvent	inEvent,
		const PMString &	inName,
		double	inOrder
	)

pure virtual

Specify a name and order for an ActionEvent (an event that can respond with behavior)

Parameters

inEvent	the event being specified
inName	the name to be used for the event when it is in a menu. If empty, the name used comes from IBehaviorEvent of the service that added the even
inOrder	the order to be used for the event when it is in a menu. May be any double. Lower numbers mean the event appears earlier in the menu. If zero, it will use the order of the kBehaviorEventService iteration order for the event item in the menu

virtual void IActionMenuManager::AddEventSeparatorItem	(	ActionEvent	inBeforeEvent,
		double	inOrder
	)

pure virtual

Indicate that a separator should be placed before an event when it is placed in a menu. Used to group events by type.

Parameters

inEvent	the event to place a separator before.
inOrder	not currently used.

virtual void IActionMenuManager::BuildEventMenuSupportingSelection	(	IDropDownListController *	inDropDownList,
		const ActionEvent &	inSelectEvent
	)

pure virtual

Build an event menu that consists of events supported by the current selection, according to IBehaviorSuite.

Parameters

inDropDownList	The drop down list that will contain the event menu items
inSelectEvent	The event to select in the menu. If 0, the first item is left selected in the menu. if non-zero, that ActionEvent is selected, and the menu is disabled (used when editing an existing behavior).