SnipRunParameterUtils Class Reference

Inheritance diagram for SnipRunParameterUtils:

Public Member Functions
	SnipRunParameterUtils (IPMUnknown *boss)
virtual	~SnipRunParameterUtils ()
virtual PMString	GetPMString (const PMString &prompt, const PMString &defaultValue="") const
virtual int32	GetInt32 (const PMString &prompt, const int32 defaultValue=0, const int32 lowerLimit=0, const int32 upperLimit=0) const
virtual PMReal	GetPMReal (const PMString &prompt, const PMReal &defaultValue=0, const PMReal &lowerLimit=0, const PMReal &upperLimit=0) const
virtual int32	GetChoice (const PMString &prompt, const K2Vector< PMString > &choices, const int32 defaultChoiceIndex=0) const
virtual bool16	WasDialogCancelled () const
virtual void	EnableDialog (const bool16 enable)
virtual bool16	IsDialogEnabled () const
virtual void	EnableTranslation (const bool16 enable)
virtual bool16	IsTranslationEnabled () const
virtual void	SetParameters (const PMString &params)
virtual PMString	GetParameters ()
Public Member Functions inherited from CPMUnknown< ISnipRunParameterUtils >
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 ISnipRunParameterUtils
enum	{ kDefaultIID = IID_ISNIPRUNPARAMETERUTILS }
Protected Member Functions inherited from CPMUnknown< ISnipRunParameterUtils >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< ISnipRunParameterUtils >
HelperInterface	fHelperInterface

Detailed Description

Implements ISnipRunParameterUtils. Parameter gathering has three modes:

1. Interactive; the user is prompted for parameter values via dialog as the code snippet runs. The values entered by the user are recorded and made available to the SnippetRunner user interface in its parameter edit box widget.
2. Non-interactive; the user is not prompted for parameter values, instead parameter values are parsed from a CSV string supplied by client code. (the parameters in the parameter edit box widget in the SnippetRunner user interface are passed in).
3. Default; the default parameter values specified by code snippets are used.

See Also

ISnipRunParameterUtils

Constructor & Destructor Documentation

SnipRunParameterUtils::SnipRunParameterUtils

(

IPMUnknown *

boss

)

Constructor.

SnipRunParameterUtils::~SnipRunParameterUtils ( )

virtual

Destructor.

Member Function Documentation

void SnipRunParameterUtils::EnableDialog ( const bool16  enable )

virtual

See ISnipRunParameterUtils::EnableDialog

Implements ISnipRunParameterUtils.

void SnipRunParameterUtils::EnableTranslation ( const bool16  enable )

virtual

See ISnipRunParameterUtils::EnableTranslation

Implements ISnipRunParameterUtils.

int32 SnipRunParameterUtils::GetChoice ( const PMString &  prompt, const K2Vector< PMString > &  choices, const int32  defaultChoiceIndex = 0  ) const

virtual

See ISnipRunParameterUtils::GetChoice

Implements ISnipRunParameterUtils.

int32 SnipRunParameterUtils::GetInt32 ( const PMString &  prompt, const int32  defaultValue = 0, const int32  lowerLimit = 0, const int32  upperLimit = 0  ) const

virtual

See ISnipRunParameterUtils::GetInt32

Implements ISnipRunParameterUtils.

PMString SnipRunParameterUtils::GetParameters ( )

virtual

See ISnipRunParameterUtils::GetParameters

Implements ISnipRunParameterUtils.

PMReal SnipRunParameterUtils::GetPMReal ( const PMString &  prompt, const PMReal &  defaultValue = 0, const PMReal &  lowerLimit = 0, const PMReal &  upperLimit = 0  ) const

virtual

See ISnipRunParameterUtils::GetPMReal

Implements ISnipRunParameterUtils.

PMString SnipRunParameterUtils::GetPMString ( const PMString &  prompt, const PMString &  defaultValue = ""  ) const

virtual

See ISnipRunParameterUtils::GetPMString

Implements ISnipRunParameterUtils.

bool16 SnipRunParameterUtils::IsDialogEnabled ( ) const

virtual

See ISnipRunParameterUtils::IsDialogEnabled

Implements ISnipRunParameterUtils.

bool16 SnipRunParameterUtils::IsTranslationEnabled ( ) const

virtual

See ISnipRunParameterUtils::IsTranslationEnabled

Implements ISnipRunParameterUtils.

void SnipRunParameterUtils::SetParameters ( const PMString &  params )

virtual

See ISnipRunParameterUtils::SetParameters

Implements ISnipRunParameterUtils.

bool16 SnipRunParameterUtils::WasDialogCancelled ( ) const

virtual

See ISnipRunParameterUtils::WasDialogCancelled

Implements ISnipRunParameterUtils.