#include <ScriptInfo.h>

Inheritance diagram for ScriptInfo::MethodScriptElement:

Public Member Functions
	MethodScriptElement (const ScriptElementID &siid, const ScriptID &id, const PMString &name, const PMString &desc, const TypeInfo &type, const PMString &returnDesc)

virtual const PMString &	GetFormattedName (const RequestContext &context, ScriptElementType as=kMethodElement) const

PMString	GetFormattedDescription (const ObjectScriptElement *se) const

TypeInfo	GetReturnType (const ObjectScriptElement *) const

PMString	GetReturnDescription (const ObjectScriptElement *) const

MethodParamList	GetParameters (const ObjectScriptElement *) const

MethodParamList &	GetParameters ()

const MethodParam *	FindParameter (const ObjectScriptElement *, const ScriptID &id) const

bool16	operator== (const MethodScriptElement &) 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

MethodScriptElement represents a method in a scripting DOM.

Member Function Documentation

const MethodParam* ScriptInfo::MethodScriptElement::FindParameter	(	const ObjectScriptElement *	,
		const ScriptID &	id
	)		const

Get the matching method parameter in the context of the supplied object

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

inline

Get the description in the context of the supplied object

virtual const PMString& ScriptInfo::MethodScriptElement::GetFormattedName	(	const RequestContext &	context,
		ScriptElementType	as = `kMethodElement`
	)		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.

MethodParamList ScriptInfo::MethodScriptElement::GetParameters ( const ObjectScriptElement * ) const

Get the method's parameters using the supplied object's request context to validate parameter types

MethodParamList& ScriptInfo::MethodScriptElement::GetParameters ( )

inline

Get the method's parameters

PMString ScriptInfo::MethodScriptElement::GetReturnDescription ( const ObjectScriptElement * ) const

Get the description in the context of the supplied object

TypeInfo ScriptInfo::MethodScriptElement::GetReturnType ( const ObjectScriptElement * ) const

Get the type in the context of the supplied object

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

virtual

Persist this object

Reimplemented from ScriptInfo::ScriptElement.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation