IActionStateList Class Reference

#include <IActionStateList.h>

Public Member Functions
virtual int32	Length () const =0
virtual ActionID	GetNthAction (int32 index) const =0
virtual void	SetNthActionState (int32 index, int16 state)=0
virtual int16	GetNthActionState (int32 index) const =0
virtual void	SetNthActionName (int32 index, const PMString &name)=0
virtual const PMString &	GetNthActionName (int32 index) const =0

Detailed Description

Class used to pass/update state of multiple actions at once.

Member Function Documentation

virtual ActionID IActionStateList::GetNthAction ( int32  index ) const

pure virtual

Get the nth action from this list

Parameters

index

which action

Returns

nth ActionID

virtual const PMString& IActionStateList::GetNthActionName ( int32  index ) const

pure virtual

Get the name for the nth action in this list

Parameters

index

which action

Returns

name for this action.

virtual int16 IActionStateList::GetNthActionState ( int32  index ) const

pure virtual

Get the enable/selected state for the nth action in this list

Parameters

index

which action

Returns

state for this action. Some combination of kDisabled_Unselected,kEnabledAction,kSelectedAction,kMultiSelectedAction,kAltSelectedAction

virtual int32 IActionStateList::Length ( ) const

pure virtual

Get the count of actions in this list

Returns

count

virtual void IActionStateList::SetNthActionName ( int32  index, const PMString &  name  )

pure virtual

Set the name for the nth action in this list. This only needs to be done if the name of the action is changing.

Parameters

index	which action
name	new name for this action. Typically used to dynamically change the name of a menu item that does different things based on some state.

virtual void IActionStateList::SetNthActionState ( int32  index, int16  state  )

pure virtual

Set the enable/selected state for the nth action in this list. Enable state for all actions defaults to kDisabled_Unselected

Parameters

index	which action
state	new state for this action. Some combination of kDisabled_Unselected,kEnabledAction,kSelectedAction,kMultiSelectedAction,kAltSelectedAction