#include <IBehaviorSuite.h>

Inheritance diagram for IBehaviorSuite:

Public Types
enum	{ kDefaultIID = IID_IBEHAVIORSUITE }

Public Member Functions
virtual bool16	CanApplyActions () const =0

virtual bool16	IsEventSupported (IBehaviorEvent *inEvent) const =0

virtual bool16	CanMoveAction (const UID &actionToMove, const ActionEvent &newEvent, int32 newPosition)=0

virtual void	GetActions (const ActionEvent &forEvent, IDataBase *&db, std::vector< UID > &actions) const =0

virtual void	GetEventAndActions (IDataBase *&db, std::vector< std::pair< ActionEvent, UID > > &actions) const =0

virtual ErrorCode	AddAction (const ActionEvent &forEvent, IBehaviorData *actionData, UID &newAction)=0

virtual ErrorCode	ReplaceAction (const ActionEvent &forEvent, const UID &actionToReplace, IBehaviorData *actionData)=0

virtual ErrorCode	DuplicateAction (const ActionEvent &forEvent, const UID &actionToDuplicate, UID &newAction)=0

virtual ErrorCode	DeleteAction (const UID &actionToDelete)=0

virtual ErrorCode	MoveAction (const UID &actionToMove, const ActionEvent &newEvent, int32 newPosition)=0

virtual ErrorCode	EnableAction (const UID &actionToEnable, const bool16 &enable=kTrue)=0

virtual ErrorCode	DeleteAllActions ()=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

Selection suite for manipulating behaviors on selections that can have behaviors (e.g. Form Fields)

This suite also doesn't operate on multiple selections.

See Also: IBehaviorList

Member Function Documentation

virtual ErrorCode IBehaviorSuite::AddAction	(	const ActionEvent &	forEvent,
		IBehaviorData *	actionData,
		UID &	newAction
	)

pure virtual

Add an action to an event.

Parameters

forEvent	The event for which the action is to be executed
actionData	IBehaviorData interface on action boss to be added.

Returns: The result of command execution

virtual bool16 IBehaviorSuite::CanApplyActions ( ) const

pure virtual

Returns: kTrue if the selection can have attached behaviors, i.e. everything has a IBehaviorList

virtual bool16 IBehaviorSuite::CanMoveAction	(	const UID &	actionToMove,
		const ActionEvent &	newEvent,
		int32	newPosition
	)

pure virtual

Tests whether the action can be moved to the new event and new position. Actions that can have targets appear in the action list before actions that do not have targets and they cannot be mixed.

Parameters

actionToMove	UID for action to be moved
newEvent	The new event of the action
newPosition	The new position within the event of the action.

Returns: kTrue if it can be moved or kFalse

virtual ErrorCode IBehaviorSuite::DeleteAction ( const UID & actionToDelete )

pure virtual

Delete an action

Parameters

actionToDelete UID for action to be deleted

Returns: The result of command execution

virtual ErrorCode IBehaviorSuite::DeleteAllActions ( )

pure virtual

Remove all actions for all events.

Returns: The result of command execution

virtual ErrorCode IBehaviorSuite::DuplicateAction	(	const ActionEvent &	forEvent,
		const UID &	actionToDuplicate,
		UID &	newAction
	)

pure virtual

Duplicate an action

Parameters

forEvent	The event for which the action is to be executed
actionToDuplicate	UID for action to be duplicated

Returns: The result of command execution

virtual ErrorCode IBehaviorSuite::EnableAction	(	const UID &	actionToEnable,
		const bool16 &	enable = `kTrue`
	)

pure virtual

Enable or disable an action for PDF export. If disabled, the action will show up the behavior UI without a checkbox, and will not be exported to the PDF file.

Parameters

actionToEnable	UID for action to be enabled or disabled
enable	If kTrue, enabled the action, else, disable it

Returns: The result of command execution

virtual void IBehaviorSuite::GetActions	(	const ActionEvent &	forEvent,
		IDataBase *&	db,
		std::vector< UID > &	actions
	)		const

pure virtual

Get a list of actions for a particular event

Parameters

forEvent	Event to examine
db,on	exit, the Database of the actions
actions,on	exit, a lists of action UIDs that are executed for forEvent

virtual void IBehaviorSuite::GetEventAndActions	(	IDataBase *&	db,
		std::vector< std::pair< ActionEvent, UID > > &	actions
	)		const

pure virtual

Get a list of all actions for all events

Parameters

db,on	exit, the Database of the actions
actions,on	exit, a lists of action UID/event pairs

virtual bool16 IBehaviorSuite::IsEventSupported ( IBehaviorEvent * inEvent ) const

pure virtual

Returns: kTrue if the selection supports inEvent. For example, if inEvent is format, and the selection is a form field, this would return kTrue for text fields, but kFalse for push button fields.

virtual ErrorCode IBehaviorSuite::MoveAction	(	const UID &	actionToMove,
		const ActionEvent &	newEvent,
		int32	newPosition
	)

pure virtual

Move an action, either reordering it within its owning event or moving it to another event.

Parameters

actionToMove	UID for action to be moved
newEvent	The new event of the action
newPosition	The new position within the event of the action.

Returns: The result of command execution

virtual ErrorCode IBehaviorSuite::ReplaceAction	(	const ActionEvent &	forEvent,
		const UID &	actionToReplace,
		IBehaviorData *	actionData
	)

pure virtual

Replace one action with another.

Parameters

forEvent	The event for which the action is to be executed
actionToReplace	UID for action to be replaced
actionData	IBehaviorData interface on the new action

Returns: The result of command execution

Public Types

Public Member Functions

Detailed Description

Member Function Documentation