IScriptPreferences Class Reference

#include <IScriptPreferences.h>

Inheritance diagram for IScriptPreferences:

Public Types
enum	{ kDefaultIID = IID_ISCRIPTPREFERENCES }
enum	InteractionLevel { kNeverInteract = en_NeverInteract, kInteractWithAlerts = en_InteractWithAlerts, kInteractWithAll = en_InteractWithAll }

Public Member Functions
virtual const ScriptVersion &	GetVersion () const =0
virtual void	SetVersion (const ScriptVersion &)=0
virtual const PMLocaleId &	GetLocale () const =0
virtual void	SetLocale (const PMLocaleId &)=0
virtual InteractionLevel	GetInteractionLevel () const =0
virtual void	SetInteractionLevel (InteractionLevel)=0
virtual ClassID	GetUnitOfMeasure () const =0
virtual void	SetUnitOfMeasure (const ClassID &bossId)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Preferences for the client when executing a script.

Member Enumeration Documentation

enum IScriptPreferences::InteractionLevel

Levels of UI interaction with the user during script execution

Member Function Documentation

virtual InteractionLevel IScriptPreferences::GetInteractionLevel ( ) const

pure virtual

Returns the current level of UI interaction

virtual const PMLocaleId& IScriptPreferences::GetLocale ( ) const

pure virtual

Returns the locale of the script info resources used for scripting requests

virtual ClassID IScriptPreferences::GetUnitOfMeasure ( ) const

pure virtual

Gets the class id of the measurement system. e.g. kPointsBoss, kMillimetersBoss If the class id is valid, it is used when converting script data to/from unit type.

Returns

ClassID

virtual const ScriptVersion& IScriptPreferences::GetVersion ( ) const

pure virtual

Returns the version of the script info resources used for scripting requests

virtual void IScriptPreferences::SetInteractionLevel ( InteractionLevel  )

pure virtual

Sets the level of UI interaction

virtual void IScriptPreferences::SetLocale ( const PMLocaleId &  )

pure virtual

Sets the locale of the script info resources used for scripting requests

virtual void IScriptPreferences::SetUnitOfMeasure ( const ClassID &  bossId )

pure virtual

Sets the class id of the measurement system. This is used when converting script data to/from unit type.

See Also

ScriptData.

Parameters

bossId

- the classID of the measurement system. Pass in kInvalidClass to clear the unit.

virtual void IScriptPreferences::SetVersion ( const ScriptVersion &  )

pure virtual

Sets the version of the script info resources used for scripting requests