BscShpScript Class Reference

Inheritance diagram for BscShpScript:

Public Member Functions
	BscShpScript (IPMUnknown *boss)
virtual	~BscShpScript (void)
virtual ScriptID	GetObjectType (const RequestContext &context) const
virtual void	SetObjectType (const ScriptID &type, const RequestContext &context)
virtual IPMUnknown *	QueryParent (const PMIID &iid, const RequestContext &context) const
Public Member Functions inherited from CScript
	CScript (IPMUnknown *boss)
virtual bool16	IsObjectType (const ScriptID &type, const RequestContext &context) const
virtual bool16	IsObjectType (const ScriptElementID &type, const RequestContext &context) const
virtual const ObjectScriptElement *	GetObjectInfo (const RequestContext &context) const
virtual IDataBase *	GetDataBase (const RequestContext &context) const
virtual ScriptObject	GetScriptObject (const RequestContext &context) const
virtual bool16	HasBeenDeleted (const RequestContext &context)
virtual bool16	IsEqual (const IScript *script, const RequestContext &context) const
virtual void	RegisterClientObject (ScriptClientObject *clientObject)
virtual void	UnregisterClientObject (ScriptClientObject *clientObject)
virtual void	NotifyClientObjectsToReleaseMe ()
virtual void	SetTag (const ScriptLabelValue &string)
virtual ScriptLabelValue	GetTag () const
virtual void	SetTag (const ScriptLabelKey &key, const ScriptLabelValue &value)
virtual ScriptLabelValue	GetTag (const ScriptLabelKey &key) const
virtual void	SetTags (const ScriptLabelKeyValueList &labels)
virtual ScriptLabelKeyValueList	GetTags () const
virtual void	ClearTags ()
virtual void	ReadWrite (IPMStream *s, ImplementationID prop)
Public Member Functions inherited from CPMUnknown< IScript >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Additional Inherited Members
Public Types inherited from IScript
enum	{ kDefaultIID = IID_ISCRIPT }
Static Public Attributes inherited from IScriptLabel
static ScriptLabelKey	kDefaultScriptLabelKey
Protected Member Functions inherited from CPMUnknown< IScript >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< IScript >
HelperInterface	fHelperInterface

Detailed Description

From SDK sample; shows how to implement CScript for this plug-in's scriptable custom page item, kBscShpPageItemBoss.

See Also

kBscShpPageItemBoss

BscShpScriptProvider

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * BscShpScript::BscShpScript

(

IPMUnknown *

boss

)

Constructor

Parameters

boss	interface ptr from boss object on which this interface is aggregated.

BscShpScript::~BscShpScript ( void  )

virtual

Destructor.

Member Function Documentation

ScriptID BscShpScript::GetObjectType ( const RequestContext &  context ) const

virtual

Return the object's type.

Parameters

context

is the request context

Returns

The object's ScriptID.

Implements CScript.

IPMUnknown * BscShpScript::QueryParent ( const PMIID &  iid, const RequestContext &  context  ) const

virtual

Return the parent of this object in the script DOM hierarchy. IDOMElement::QueryParent delegates to this method.

Parameters

iid	IN IID of interest on the parent DOM object.
context	is the request context

Returns

An interface pointer to the IID of interest on the parent DOM object.

Implements CScript.

void BscShpScript::SetObjectType ( const ScriptID &  type, const RequestContext &  context  )

virtual

Set the object's type.

Parameters

context

is the request context

Reimplemented from CScript.