InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ScriptInfo::EventScriptElement Class Reference

#include <ScriptInfo.h>

Inheritance diagram for ScriptInfo::EventScriptElement:
ScriptInfo::ScriptElementScriptInfo::BaseScriptInfo

Public Member Functions

virtual const PMStringGetFormattedName (const RequestContext &context, ScriptElementType as=kEventElement) const
 
PMString GetFormattedDescription (const ObjectScriptElement *se) const
 
bool16 GetBubbles () const
 
bool16 GetCancelable () const
 
ClassID GetEventClassID () const
 
ScriptID GetEventScriptID () const
 
bool16 operator== (const EventScriptElement &) const
 
virtual void ReadWrite (IPMStream *s)
 
- Public Member Functions inherited from ScriptInfo::ScriptElement
 ScriptElement (const ScriptElementID &siid, const ScriptID &id, const PMString &name, const PMString &desc)
 
const ElementContextGetContext () const
 
const ScriptElementIDGetScriptElementID () const
 
const PluginIDGetPluginID () const
 
const ScriptRecordData & GetMetadata () const
 
ScriptRecordData & GetMetadata ()
 
bool16 HasMetadata (const ScriptID &key, ScriptData &value) const
 
bool16 HasMetadata (const ScriptIDValuePair &kvp) const
 
bool16 operator== (const ScriptElement &) const
 
void SetContext (const ElementContext &context)
 
void SetPluginID (const PluginID &)
 
- Public Member Functions inherited from ScriptInfo::BaseScriptInfo
 BaseScriptInfo (const ScriptID &id, const PMString &name, const PMString &desc)
 
 BaseScriptInfo (const BaseScriptInfo &other)
 
const ScriptIDGetScriptID () const
 
const PMStringGetName () const
 
void SetName (const PMString &name)
 
const PMStringGetFormattedName (const FormatNamePolicy &policy) const
 
virtual PMString GetDescription () const
 
BaseScriptInfooperator= (const BaseScriptInfo &)
 
bool16 operator== (const BaseScriptInfo &) const
 

Additional Inherited Members

- Public Types inherited from ScriptInfo::BaseScriptInfo
typedef object_type data_type
 
- Protected Types inherited from ScriptInfo::BaseScriptInfo
typedef
IDThreading::lock_guard
< IDThreading::spin_mutex
LockGuard
 
- Protected Member Functions inherited from ScriptInfo::BaseScriptInfo
PMString GetFormattedDescription (const ObjectScriptElement *) const
 
- Static Protected Member Functions inherited from ScriptInfo::BaseScriptInfo
static void FormatDescription (PMString &desc, const ObjectScriptElement *)
 
- Protected Attributes inherited from ScriptInfo::BaseScriptInfo
IDThreading::spin_mutex fMutex
 

Detailed Description

EventScriptElement represents an attachable event in a scripting DOM.

Member Function Documentation

bool16 ScriptInfo::EventScriptElement::GetBubbles () const
inline

Get whether this event propagates up through the targets ancestors

bool16 ScriptInfo::EventScriptElement::GetCancelable () const
inline

Get whether the default action of this event may be suppressed by an event handler

PMString ScriptInfo::EventScriptElement::GetFormattedDescription (const ObjectScriptElementse) const
inline

Get the description formatted in the context of the supplied object

virtual const PMString& ScriptInfo::EventScriptElement::GetFormattedName (const RequestContextcontext,
ScriptElementType as = kEventElement 
) const
inlinevirtual

Get the formatted name

Parameters
contextthe request context in which to format the name
aswhich type of script element

Reimplemented from ScriptInfo::BaseScriptInfo.

virtual void ScriptInfo::EventScriptElement::ReadWrite (IPMStreams)
virtual

Persist this object

Reimplemented from ScriptInfo::ScriptElement.