SnipRunDialogController Class Reference

Inheritance diagram for SnipRunDialogController:

Public Member Functions
	SnipRunDialogController (IPMUnknown *boss)
virtual	~SnipRunDialogController ()
virtual void	InitializeDialogFields (IActiveContext *dlgContext)
virtual WidgetID	ValidateDialogFields (IActiveContext *myContext)
virtual void	ApplyDialogFields (IActiveContext *myContext, const WidgetID &widgetId)
virtual void	ClosingDialog (IActiveContext *lastChanceToUseMyContext)
virtual void	UserCancelled ()
Public Member Functions inherited from CDialogController
	CDialogController (IPMUnknown *boss)
virtual bool16	HasBeenInitialized () const
virtual void	SetInitialized (bool16 initialized)
virtual void	SetOwner (IControlView *ownerPanel)
virtual IControlView *	GetOwner () const
virtual void	GetName (PMString &name)
virtual void	SetTextControlData (const WidgetID &widgetId, const PMString &text, const IPanelControlData *panel=nil, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)
virtual PMString	GetTextControlData (const WidgetID &widgetId, const IPanelControlData *panel=nil) const
virtual void	SetTextValue (const WidgetID &widgetId, const PMReal &value, const IPanelControlData *panel=nil, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)
virtual PMReal	GetTextValue (const WidgetID &widgetId, const IPanelControlData *panel=nil, bool16 *outParsingError=nil, bool16 *outIsBlank=nil) const
virtual void	SetTextValueControlState (const WidgetID &widgetId, ITextValue::TextControlState controlState, const IPanelControlData *panel=nil, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)
virtual ITextValue::TextControlState	GetTextValueControlState (const WidgetID &widgetId, const IPanelControlData *panel=nil) const
virtual void	SetBooleanControlData (const WidgetID &widgetId, bool16 isChecked, const IPanelControlData *panel=nil, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)
virtual bool16	GetBooleanControlData (const WidgetID &widgetId, const IPanelControlData *panel=nil) const
virtual void	SetTriStateControlData (const WidgetID &widgetId, bool16 isSelected, const IPanelControlData *panel=nil, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)
virtual void	SetTriStateControlData (const WidgetID &widgetId, ITriStateControlData::TriState triState, const IPanelControlData *panel=nil, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)
virtual ITriStateControlData::TriState	GetTriStateControlData (const WidgetID &widgetId, const IPanelControlData *panel=nil) const
virtual WidgetID	GetSelectedClusterWidget (WidgetID cluster, const IPanelControlData *panel=nil)
virtual void	SetSelectedClusterWidget (WidgetID clusterId, WidgetID widgetToSelect, const IPanelControlData *panel=nil, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)
virtual IStringListControlData *	QueryListControlDataInterface (const WidgetID &widgetId, const IPanelControlData *panel=nil) const
virtual IPanelControlData *	QueryIfNilElseAddRef (const IPanelControlData *panel) const
virtual void	SelectDialogWidget (const WidgetID &widgetId)
virtual bool16	GetPreviewModeOn ()
virtual void	SetPreviewModeOn (bool16 bOn)
virtual IActiveContext *	QueryDialogContext ()
Public Member Functions inherited from CPMUnknown< IDialogController >
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
Dialog protocol
Dialog query methods
Owner query methods
Previewable dialog methods
Dialog helper methods

Additional Inherited Members
Public Types inherited from IDialogController
enum	{ kDefaultIID = IID_IDIALOGCONTROLLER }
Protected Member Functions inherited from CDialogController
virtual void	ResetDialogFields (IActiveContext *myContext)
Protected Attributes inherited from CPMUnknown< IDialogController >
HelperInterface	fHelperInterface

Detailed Description

Prompts the user for the value of a data type described by the caller in ISnipRunDialogData. Only one data type value can be gathered per dialog.

The dialog has a widget per data type e.g. one for PMStrings, one for int32, one for PMReal and so on that are used to gather the value.

Implements IDialogController based on the partial implementation CDialogController.

Constructor & Destructor Documentation

SnipRunDialogController::SnipRunDialogController

(

IPMUnknown *

boss

)

Constructor.

Parameters

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

SnipRunDialogController::~SnipRunDialogController ( )

virtual

Destructor.

Member Function Documentation

void SnipRunDialogController::ApplyDialogFields ( IActiveContext *  myContext, const WidgetID &  widgetId  )

virtual

Retrieve the values from the widgets and act on them.

Parameters

myContext
widgetId	identifies the widget on which to act.

Reimplemented from CDialogController.

void SnipRunDialogController::ClosingDialog ( IActiveContext *  lastChanceToUseMyContext )

virtual

Called when the dialog is closing & used to control widget visibility.

Parameters

lastChanceToUseMyContext

Reimplemented from CDialogController.

void SnipRunDialogController::InitializeDialogFields ( IActiveContext *  dlgContext )

virtual

Called when the dialog is opened to initialize each widget in the dialog with its default value.

Parameters

dlgContext

IN

Reimplemented from CDialogController.

void SnipRunDialogController::UserCancelled ( void  )

virtual

Called when the user uses the cancel button to dismiss the dialog

Reimplemented from CDialogController.

WidgetID SnipRunDialogController::ValidateDialogFields ( IActiveContext *  myContext )

virtual

Validate the values in the widgets. By default, the widget with ID kOKButtonWidgetID causes ValidateFields to be called. When all widgets are valid, ApplyFields will be called.

Parameters

myContext

Returns

kDefaultWidgetId if all widget values are valid, WidgetID of the widget to select otherwise.

Reimplemented from CDialogController.