ScriptInfo::ScriptElement Class Reference

#include <ScriptInfo.h>

Inheritance diagram for ScriptInfo::ScriptElement:

Public Member Functions
	ScriptElement (const ScriptElementID &siid, const ScriptID &id, const PMString &name, const PMString &desc)
const ElementContext &	GetContext () const
const ScriptElementID &	GetScriptElementID () const
const PluginID &	GetPluginID () 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
virtual void	ReadWrite (IPMStream *s)
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 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

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

The base class for elements in a scripting DOM.

Member Function Documentation

const ElementContext& ScriptInfo::ScriptElement::GetContext ( ) const

inline

Get the context

const ScriptRecordData& ScriptInfo::ScriptElement::GetMetadata ( ) const

inline

Get all the metadata

ScriptRecordData& ScriptInfo::ScriptElement::GetMetadata ( )

inline

Get all the metadata

const PluginID& ScriptInfo::ScriptElement::GetPluginID ( ) const

inline

Get the PluginID in which this element was defined

const ScriptElementID& ScriptInfo::ScriptElement::GetScriptElementID ( ) const

inline

Get the ScriptElementID

bool16 ScriptInfo::ScriptElement::HasMetadata	(	const ScriptID &	key,
		ScriptData &	value
	)		const

Check this element for metadata by key, and, if found, retrieve its value

Parameters

id	is the metadata key IN
value	is filled in with the value associated with the key, if the key is found OUT

Returns

kTrue if the key is found, else kFalse

bool16 ScriptInfo::ScriptElement::HasMetadata

(

const ScriptIDValuePair &

kvp

)

const

Check this element for metadata by key and value

Parameters

m	is the metadata key/value pair to match IN

Returns

kTrue if the key/value pair is found, else kFalse

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

virtual

Persist this object

Reimplemented from ScriptInfo::BaseScriptInfo.

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

void ScriptInfo::ScriptElement::SetContext ( const ElementContext &  context )

inline

Set the context

void ScriptInfo::ScriptElement::SetPluginID

(

const PluginID &

)

Set the PluginID in which this element was defined