InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IBehaviorList Class Referenceabstract

#include <IBehaviorList.h>

Inheritance diagram for IBehaviorList:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IBEHAVIORLIST }
 

Public Member Functions

virtual void Adopt (const ActionEvent &inEvent, const UID &inBehavior, const int32 &inPosition=-1)=0
 
virtual ActionEvent Relinquish (const UID &inBehavior)=0
 
virtual std::vector< UIDGet (const ActionEvent &inForEvent) const =0
 
virtual std::vector< std::pair
< ActionEvent, UID > > 
Get () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

A list events which in turn have lists of Behavior bosses. These Behavior bosses should have an IBehaviorData interfaces

Member Function Documentation

virtual void IBehaviorList::Adopt (const ActionEvent & inEvent,
const UIDinBehavior,
const int32 & inPosition = -1 
)
pure virtual

Declare ownership of a behavior. That is, behavior will be deleted by the IBehaviorList's boss.

Parameters
inEventThe event the inBehavior will belong to
inBehaviorA boss UID for the behavior
inPositionOrder for inBehavior. -1, the default, puts inBehavior at the end of the list for inEvent, otherwise inBehavior is placed at position in list.
virtual std::vector<UID> IBehaviorList::Get (const ActionEvent & inForEvent) const
pure virtual
Returns
A list of all the behavior boss UIDs for the event inForEvent
virtual std::vector< std::pair<ActionEvent, UID> > IBehaviorList::Get () const
pure virtual
Returns
All event lists containing all the behavior boss UIDs in this IBehaviorList
virtual ActionEvent IBehaviorList::Relinquish (const UIDinBehavior)
pure virtual

Give up ownership of a behavior.

Parameters
behaviorA boss UID for the behavior
Returns
event behavior was attached to.