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

#include <IBehaviorEvent.h>

Inheritance diagram for IBehaviorEvent:
IPMUnknownCPMUnknown< IBehaviorEvent >BehaviorEvent< Event >

Public Types

enum  { kDefaultIID = IID_IBEHAVIOREVENT }
 

Public Member Functions

virtual PMString GetName () const =0
 
virtual ActionEvent GetEvent () const =0
 
virtual PMString GetDictionaryKey () const =0
 
virtual bool16 IsPageEvent () const =0
 
virtual bool16 SupportsEvent (IPMUnknown *)=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

Base data interface for an Event that can have attached behaviors Examples are MouseDown, MouseUp, Calculate...

See Also
BehaviorEvent

Member Function Documentation

virtual PMString IBehaviorEvent::GetDictionaryKey () const
pure virtual
Returns
a PDF action dictionary key as a PMString for the event e.g. "U" for mouse up, used to generate the PDF action dictionary for actions that belong to this event

Implemented in BehaviorEvent< Event >.

virtual ActionEvent IBehaviorEvent::GetEvent () const
pure virtual
Returns
a unique enum for the event. Value is in kBehaviorEventIDSpace. e.g. kPageOpenEvt

Implemented in BehaviorEvent< Event >.

virtual PMString IBehaviorEvent::GetName () const
pure virtual
Returns
a user-readable name for the event e.g. "Mouse Down"

Implemented in BehaviorEvent< Event >.

virtual bool16 IBehaviorEvent::IsPageEvent () const
pure virtual
Returns
kTrue if this is an event that applies to a page, such as Page Open or Page Close

Implemented in BehaviorEvent< Event >.

virtual bool16 IBehaviorEvent::SupportsEvent (IPMUnknown)
pure virtual
Returns
kTrue if IPMUnknown can 'respond' to events. IPMUnknown could be an IBehaviorData interface or a IFormField interface, but is not limited to this. The default implementation queries an ISupportedEvents on the IPMUnknown to ask it if it supports event types matching this one.

Implemented in BehaviorEvent< Event >.