IScriptLabel Class Reference

#include <IScriptLabel.h>

Inheritance diagram for IScriptLabel:

Public Types
enum	{ kDefaultIID = IID_ISCRIPTLABEL }
typedef PMString	ScriptLabelKey
typedef PMString	ScriptLabelValue
typedef KeyValuePair < ScriptLabelKey, ScriptLabelValue >	ScriptLabelKeyValuePair
typedef K2Vector < ScriptLabelKeyValuePair >	ScriptLabelKeyValueList

Public Member Functions
virtual void	SetTag (const ScriptLabelValue &string)=0
virtual ScriptLabelValue	GetTag () const =0
virtual void	SetTag (const ScriptLabelKey &key, const ScriptLabelValue &value)=0
virtual ScriptLabelValue	GetTag (const ScriptLabelKey &key) const =0
virtual void	SetTags (const ScriptLabelKeyValueList &labels)=0
virtual ScriptLabelKeyValueList	GetTags () const =0
virtual void	ClearTags ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Static Public Attributes
static ScriptLabelKey	kDefaultScriptLabelKey

Detailed Description

Data interface for script labels

Member Function Documentation

virtual void IScriptLabel::ClearTags ( )

pure virtual

Clear all of the user-definable labels

Implemented in CScript.

virtual ScriptLabelValue IScriptLabel::GetTag ( ) const

pure virtual

Get the default label property

Implemented in CScript.

virtual ScriptLabelValue IScriptLabel::GetTag ( const ScriptLabelKey &  key ) const

pure virtual

Get a user-definable label

Parameters

key	is the key

Returns

is the value

Implemented in CScript.

virtual ScriptLabelKeyValueList IScriptLabel::GetTags ( ) const

pure virtual

Get the list of all the user-definable labels

Implemented in CScript.

virtual void IScriptLabel::SetTag ( const ScriptLabelValue &  string )

pure virtual

Set the default label property

Parameters

string

is the label to set

Implemented in CScript.

virtual void IScriptLabel::SetTag ( const ScriptLabelKey &  key, const ScriptLabelValue &  value  )

pure virtual

Set a user-definable label

Parameters

key	is the key
value	is the value

Implemented in CScript, and CProxyScript.

virtual void IScriptLabel::SetTags ( const ScriptLabelKeyValueList &  labels )

pure virtual

Set a list of user-definable labels

Implemented in CScript.

Member Data Documentation

ScriptLabelKey IScriptLabel::kDefaultScriptLabelKey

static

The key for the default label property