InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
IScriptMutationData Class Referenceabstract

#include <IScriptMutationData.h>

Inheritance diagram for IScriptMutationData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISCRIPTMUTATIONDATA }
 

Public Member Functions

virtual void SetAttribute (ScriptID propID)=0
 
virtual ScriptID GetAttribute () const =0
 
virtual PMString GetAttributeName (IScript *target, const EngineContext &context) const =0
 
virtual ScriptReturnData GetAttributeValue (IScript *target, const EngineContext &context) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Static Public Member Functions

static void InitMutationEventCallback (IScriptEvent *e, IScriptEventTarget::InitCallbackType t, void *privateData)
 

Detailed Description

An interface used by the kMutationScriptEventBoss to store associated data.

Member Function Documentation

virtual ScriptID IScriptMutationData::GetAttribute () const
pure virtual

Get the attribute that changed

virtual PMString IScriptMutationData::GetAttributeName (IScript * target,
const EngineContext & context 
) const
pure virtual

Return the name of the attribute formatted for the appropriate client context

virtual ScriptReturnData IScriptMutationData::GetAttributeValue (IScript * target,
const EngineContext & context 
) const
pure virtual

Return the value of the attribute formatted for the appropriate client context

static void IScriptMutationData::InitMutationEventCallback (IScriptEvent * e,
IScriptEventTarget::InitCallbackType t,
void * privateData 
)
inlinestatic

A standard event initializer callback for mutation events. See .h. The code to dispatch the MutationEvent for a change in the name of an object might look like this: 

ScriptID propID = p_Name ;

InterfacePtr<IScriptEventTarget> target( iScript, UseDefaultIID() ) ;

if ( target )

    target->DispatchScriptEvent( kAfterAttributeChangedEventScriptElement, 

        &IScriptMutationData::InitMutationEventCallback, &propID ) ;
virtual void IScriptMutationData::SetAttribute (ScriptID propID)
pure virtual

Set the attribute that changed