CSelectableDialogController Class Reference

Inheritance diagram for CSelectableDialogController:

Public Member Functions
	CSelectableDialogController (IPMUnknown *boss)
virtual void	ResetDialogFields (IActiveContext *myContext)
virtual WidgetID	ValidateDialogFields (IActiveContext *myContext)
virtual void	ApplyDialogFields (IActiveContext *myContext, const WidgetID &widgetId)
virtual void	UserCancelled ()
virtual void	ClosingDialog (IActiveContext *lastChanceToUseMyContext)
virtual void	SelectDialogWidget (const WidgetID &widgetId)
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 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	InitializeDialogFields (IActiveContext *context)
Protected Attributes inherited from CPMUnknown< IDialogController >
HelperInterface	fHelperInterface

Member Function Documentation

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

virtual

Override to retrieve data from the widgets in the dialog and apply it. By default the widget with id kOKButtonWidgetID causes an apply. Override Update to have others call "ApplyDialog"

Parameters

myContext	IN the active context
widgetId	IN the widget that triggered the "apply"

Reimplemented from CDialogController.

virtual void CSelectableDialogController::ClosingDialog ( IActiveContext *  lastChanceToUseMyContext )

virtual

Override to be called during the process of closing the dialog, an opportunity to do some special cleanup. Default implementation is empty.

Reimplemented from CDialogController.

virtual void CSelectableDialogController::ResetDialogFields ( IActiveContext *  myContext )

virtual

Override to modify the default Reset behavior. Called when the user holds down the option/alt key and the cancel button changes to "Reset" and then clicks on the reset button. By default, this function simply calls InitializeDialogFields. For most dialogs, this results in the correct behavior.

Parameters

myContext

IN the active context

Reimplemented from CDialogController.

virtual void CSelectableDialogController::SelectDialogWidget ( const WidgetID &  widgetId )

virtual

This method is typically used in conjuntion with Validate() to select the widget that has "illegal" values.

Reimplemented from CDialogController.

virtual void CSelectableDialogController::UserCancelled ( )

virtual

Override to be called when the user clicks the "cancel" button. Default implementation is empty.

Reimplemented from CDialogController.

virtual WidgetID CSelectableDialogController::ValidateDialogFields ( IActiveContext *  myContext )

virtual

Override to be called when the user clicks the "ok" (or equivalent) button. Use ValidateFields to check that the data in each dialog control is valid and within limits. It's up to the subclass to display an alert if invalid data is found. If one or more of the fields have invalid data, return the WidgetID of the dialog item to select. If all fields are valid, return kDefaultWidgetId. When all fields are valid, the "ApplyDialogFields" function will be called.

Parameters

myContext

IN the active context

Returns

id of the first widget with invalid data

Reimplemented from CDialogController.