#include <ScriptInfo.h>

Inheritance diagram for ScriptInfo::MethodParam:

Public Member Functions
	MethodParam (const ScriptID &id, const PMString &name, const PMString &desc, const TypeInfo &type, bool16 optional)

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

PMString	GetFormattedDescription (const ObjectScriptElement *se) const

TypeInfo	GetParamType (const ObjectScriptElement *) const

bool16	IsOptional () const

const ScriptData &	GetDefault () const

bool16	operator== (const MethodParam &) const

virtual void	ReadWrite (IPMStream *s)

void	SetParamType (const TypeInfo &type)

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

MethodParam represents a method parameter in a scripting DOM.

Member Function Documentation

const ScriptData& ScriptInfo::MethodParam::GetDefault ( ) const

inline

Get the default value for the parameter

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

inline

Get the description in the context of the supplied object

virtual const PMString& ScriptInfo::MethodParam::GetFormattedName	(	const RequestContext &	context,
		ScriptElementType	as = `kMethodParameterElement`
	)		const

inlinevirtual

Get the formatted name

Parameters

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

TypeInfo ScriptInfo::MethodParam::GetParamType ( const ObjectScriptElement * ) const

Get the type in the context of the supplied object

bool16 ScriptInfo::MethodParam::IsOptional ( ) const

inline

Get whether the parameter is optional

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

virtual

Persist this object

void ScriptInfo::MethodParam::SetParamType ( const TypeInfo & type )

inline

Set the parameter's type