ScriptInfo::PropertyScriptElement Class Reference

#include <ScriptInfo.h>

Inheritance diagram for ScriptInfo::PropertyScriptElement:

Public Member Functions
virtual const PMString &	GetFormattedName (const RequestContext &context, ScriptElementType as=kPropertyElement) const
PMString	GetFormattedDescription (const ObjectScriptElement *se) const
TypeInfo	GetStorageType (const ObjectScriptElement *, bool16 includeAssignableTypes=kFalse) const
const TypeInfoList &	GetAssignableTypes () const
TypeInfoList &	GetAssignableTypes ()
const ClassID &	GetAttributeID () const
bool16	operator== (const PropertyScriptElement &) 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 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
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 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

PropertyScriptElement represents a property in a scripting DOM.

Member Function Documentation

const TypeInfoList& ScriptInfo::PropertyScriptElement::GetAssignableTypes ( ) const

inline

Get any additional types that may be used to set the property

const ClassID& ScriptInfo::PropertyScriptElement::GetAttributeID ( ) const

inline

Get the associated text, graphic, or table attribute id

PMString ScriptInfo::PropertyScriptElement::GetFormattedDescription ( const ObjectScriptElement *  se ) const

inline

Get the description formatted in the context of the supplied object

virtual const PMString& ScriptInfo::PropertyScriptElement::GetFormattedName ( const RequestContext &  context, ScriptElementType  as = kPropertyElement  ) const

inlinevirtual

Get the formatted name

Parameters

context	the request context in which to format the name
as	which type of script element

Reimplemented from ScriptInfo::BaseScriptInfo.

TypeInfo ScriptInfo::PropertyScriptElement::GetStorageType	(	const ObjectScriptElement *	,
		bool16	includeAssignableTypes = kFalse
	)		const

Get the type in the context of the supplied object

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

virtual

Persist this object

Reimplemented from ScriptInfo::ScriptElement.