InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
ScriptInfo::BaseScriptInfo Class Reference

#include <ScriptInfo.h>

Inheritance diagram for ScriptInfo::BaseScriptInfo:
ScriptInfo::EnumValueScriptInfo::MethodParamScriptInfo::ScriptElementScriptInfo::EnumScriptElementScriptInfo::EventScriptElementScriptInfo::MethodScriptElementScriptInfo::ObjectScriptElementScriptInfo::PropertyScriptElementScriptInfo::SuiteScriptElementScriptInfo::TypeDefScriptElement

Public Types

typedef object_type data_type
 

Public Member Functions

 BaseScriptInfo (const ScriptID &id, const PMString &name, const PMString &desc)
 
 BaseScriptInfo (const BaseScriptInfo &other)
 
const ScriptID & GetScriptID () const
 
const PMString & GetName () const
 
void SetName (const PMString &name)
 
const PMString & GetFormattedName (const FormatNamePolicy &policy) const
 
virtual const PMString & GetFormattedName (const RequestContext &context, ScriptElementType as) const
 
virtual PMString GetDescription () const
 
BaseScriptInfo & operator= (const BaseScriptInfo &)
 
bool16 operator== (const BaseScriptInfo &) const
 
virtual void ReadWrite (IPMStream *s)
 

Protected Types

typedef
IDThreading::lock_guard
< IDThreading::spin_mutex > 		LockGuard
 

Protected Member Functions

PMString GetFormattedDescription (const ObjectScriptElement *) const
 

Static Protected Member Functions

static void FormatDescription (PMString &desc, const ObjectScriptElement *)
 

Protected Attributes

IDThreading::spin_mutex fMutex
 

Detailed Description

The base class for sub-elements in a scripting DOM.

Member Function Documentation

static void ScriptInfo::BaseScriptInfo::FormatDescription (PMString & desc,
const ObjectScriptElement *  
)
staticprotected

Format a description in the context of the supplied object

virtual PMString ScriptInfo::BaseScriptInfo::GetDescription () const
inlinevirtual

Get the description

PMString ScriptInfo::BaseScriptInfo::GetFormattedDescription (const ObjectScriptElement * ) const
protected

Get the formatted description in the context of the supplied object

const PMString& ScriptInfo::BaseScriptInfo::GetFormattedName (const FormatNamePolicy & policy) const

Get the formatted name

Parameters
policyindicates how to format the name
virtual const PMString& ScriptInfo::BaseScriptInfo::GetFormattedName (const RequestContext & context,
ScriptElementType as 
) const
virtual

Get the formatted name

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

Reimplemented in ScriptInfo::EnumScriptElement, ScriptInfo::EnumValue, ScriptInfo::EventScriptElement, ScriptInfo::PropertyScriptElement, ScriptInfo::MethodScriptElement, ScriptInfo::MethodParam, ScriptInfo::SuiteScriptElement, and ScriptInfo::TypeDefScriptElement.

const PMString& ScriptInfo::BaseScriptInfo::GetName (void ) const
inline

Get the name

const ScriptID& ScriptInfo::BaseScriptInfo::GetScriptID () const
inline

Get the ScriptID

virtual void ScriptInfo::BaseScriptInfo::ReadWrite (IPMStream * s)
virtual

Persist this object

Reimplemented in ScriptInfo::EnumScriptElement, ScriptInfo::EventScriptElement, ScriptInfo::PropertyScriptElement, ScriptInfo::MethodScriptElement, ScriptInfo::MethodParam, ScriptInfo::ObjectScriptElement, ScriptInfo::TypeDefScriptElement, and ScriptInfo::ScriptElement.

void ScriptInfo::BaseScriptInfo::SetName (const PMString & name)

Set the name