BehaviorEvent< Event > Class Template Reference

#include <BehaviorEvent.h>

Inheritance diagram for BehaviorEvent< Event >:

Public Member Functions
	BehaviorEvent (IPMUnknown *boss)
virtual	~BehaviorEvent ()
virtual ActionEvent	GetEvent () const
virtual PMString	GetName () const
virtual PMString	GetDictionaryKey () const
virtual bool16	IsPageEvent () const
virtual bool16	SupportsEvent (IPMUnknown *inBoss)
Public Member Functions inherited from CPMUnknown< IBehaviorEvent >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Additional Inherited Members
Public Types inherited from IBehaviorEvent
enum	{ kDefaultIID = IID_IBEHAVIOREVENT }
Protected Member Functions inherited from CPMUnknown< IBehaviorEvent >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< IBehaviorEvent >
HelperInterface	fHelperInterface

Detailed Description

template<int32 Event>
class BehaviorEvent< Event >

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

See Also

IBehaviorEvent

Constructor & Destructor Documentation

template<int32 Event>

BehaviorEvent< Event >::BehaviorEvent ( IPMUnknown *  boss )

inline

Construct a new BehaviorEvent object

template<int32 Event>

virtual BehaviorEvent< Event >::~BehaviorEvent ( )

inlinevirtual

Destroy a BehaviorEvent object

Member Function Documentation

template<int32 Event>

virtual PMString BehaviorEvent< Event >::GetDictionaryKey ( ) const

inlinevirtual

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

Implements IBehaviorEvent.

template<int32 Event>

virtual ActionEvent BehaviorEvent< Event >::GetEvent ( ) const

inlinevirtual

Returns a unique enum for the event. Value is in kBehaviorEventIDSpace. e.g. kPageOpenEvt

Implements IBehaviorEvent.

template<int32 Event>

virtual PMString BehaviorEvent< Event >::GetName ( ) const

inlinevirtual

Returns a user-readable name for the event e.g. "Mouse Down"

Implements IBehaviorEvent.

template<int32 Event>

virtual bool16 BehaviorEvent< Event >::IsPageEvent ( ) const

inlinevirtual

Returns kTrue if this is an event that applies to a page, i.e. does the event belong in a page's "AA" dict rather than an annotation's "AA" dict.

Implements IBehaviorEvent.

template<int32 Event>

virtual bool16 BehaviorEvent< Event >::SupportsEvent ( IPMUnknown *  inBoss )

inlinevirtual

Returns kTrue if IPMUnknown can 'respond' to events. IPMUnknown could be an IBehaviorData interface or a IFormField interface, but is not limited to this.

Implements IBehaviorEvent.