IMultiStateObjectBehaviorData Class Reference

#include <IMultiStateObjectBehaviorData.h>

Inheritance diagram for IMultiStateObjectBehaviorData:

Public Types
enum	Position { kExplicitPosition, kNextPosition, kPreviousPosition }
Public Types inherited from IBehaviorData
enum	{ kDefaultIID = IID_IBEHAVIORDATA }

Public Member Functions
virtual Position	GetPosition () const =0
virtual void	SetTarget (UID const &target)=0
virtual UID	GetTarget () const =0
virtual void	SetState (Form::AppearanceState state)=0
virtual Form::AppearanceState	GetState () const =0
virtual void	SetSwitchToPriorStateOnRollOff (bool revertOnRollOff)=0
virtual bool	GetSwitchToPriorStateOnRollOff () const =0
virtual void	SetLoopAtBeginningOrEnd (bool loopsAtBeginningOrEnd)=0
virtual bool	GetLoopAtBeginningOrEnd () const =0
Public Member Functions inherited from IBehaviorData
virtual int32	GetAction () const =0
virtual PMString	GetName () const =0
virtual UID	GetOwner () const =0
virtual void	SetOwner (const UID &owner)=0
virtual bool16	IsEnabled () const =0
virtual bool16	Enable (const bool16 &enable=kTrue)=0
bool16	IsDisabled () const
bool16	Disable ()
virtual void	Copy (IPMUnknown *srcData)=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

Data interface for Switch Multi-state Object (MSO) Behavior.

See Also

INamedPageItemList (for a way of getting candidates for SetTarget())

Member Function Documentation

virtual bool IMultiStateObjectBehaviorData::GetLoopAtBeginningOrEnd ( ) const

pure virtual

Get whether target MSO should loop to the beginning or end when position is either next or previous respectively

Note: This has no meaning if position is explicit

Returns

true if target should loop on next or previous

virtual Position IMultiStateObjectBehaviorData::GetPosition ( ) const

pure virtual

Get Position for this MSO state behavior

Note: This is an intrinsic property of the behavior and cannot be changed.

Returns

One of Position enum

virtual Form::AppearanceState IMultiStateObjectBehaviorData::GetState ( ) const

pure virtual

Get the MSO state to switch to

Returns

The MSO state to switch to

virtual bool IMultiStateObjectBehaviorData::GetSwitchToPriorStateOnRollOff ( ) const

pure virtual

Get whether target MSO should switch back to its prior state on roll off

Note: This only has meaning if this behavior is assigned to the roll over state

Returns

true if target should switch back to its prior state on roll off

virtual UID IMultiStateObjectBehaviorData::GetTarget ( ) const

pure virtual

Get UID of MSO page item to target

Returns

UID of MSO page item to target

virtual void IMultiStateObjectBehaviorData::SetLoopAtBeginningOrEnd ( bool  loopsAtBeginningOrEnd )

pure virtual

Set whether target MSO should loop to the beginning or end when position is either next or previous respectively

Note: This has no meaning if position is explicit

Parameters

loopsAtBeginningOrEnd

Boolean. If true, target should loop on next or previous

virtual void IMultiStateObjectBehaviorData::SetState ( Form::AppearanceState  state )

pure virtual

Set the MSO state to switch to

Parameters

state

The MSO state to switch to

virtual void IMultiStateObjectBehaviorData::SetSwitchToPriorStateOnRollOff ( bool  revertOnRollOff )

pure virtual

Set whether target MSO should switch back to its prior state on roll off

Note: This only has meaning if this behavior is assigned to the roll over state

Parameters

revertOnRollOff

Boolean. If true, target should switch back to its prior state on roll off

virtual void IMultiStateObjectBehaviorData::SetTarget ( UID const &  target )

pure virtual

Set UID of MSO page item to target

Parameters

target

UID of MSO page item to target