InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
TranFxUIDialogController Class Reference
Inheritance diagram for TranFxUIDialogController:
CDialogControllerCPMUnknown< IDialogController >IDialogControllerIPMUnknown

Public Member Functions

 TranFxUIDialogController (IPMUnknown *boss)
 
virtual ~TranFxUIDialogController ()
 
virtual void InitializeDialogFields (IActiveContext *context)
 
virtual WidgetID ValidateDialogFields (IActiveContext *myContext)
 
virtual void ApplyDialogFields (IActiveContext *myContext, const WidgetID &widgetId)
 
- Public Member Functions inherited from CDialogController
 CDialogController (IPMUnknown *boss)
 
virtual void UserCancelled ()
 
virtual void ClosingDialog (IActiveContext *lastChanceToUseMyContext)
 
virtual bool16 HasBeenInitialized () const
 
virtual void SetInitialized (bool16 initialized)
 
virtual void SetOwner (IControlView *ownerPanel)
 
virtual IControlViewGetOwner () 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 IStringListControlDataQueryListControlDataInterface (const WidgetID &widgetId, const IPanelControlData *panel=nil) const
 
virtual IPanelControlDataQueryIfNilElseAddRef (const IPanelControlData *panel) const
 
virtual void SelectDialogWidget (const WidgetID &widgetId)
 
virtual bool16 GetPreviewModeOn ()
 
virtual void SetPreviewModeOn (bool16 bOn)
 
virtual IActiveContextQueryDialogContext ()
 
- Public Member Functions inherited from CPMUnknown< IDialogController >
IPMUnknownQueryInterface (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
 
CPMUnknownoperator= (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

Implements a dialog controller, IDialogController based on CDialogController, that uses ITranFxSuite to initialise the state of the dialog's widgets. The dialog observer, TranFxUIDialogObserver, handles each change of a widget value made by the user.

See Also
TranFxUIDialogObserver

Constructor & Destructor Documentation

TranFxUIDialogController::TranFxUIDialogController (IPMUnknownboss)
inline

Constructor.

Parameters
bossinterface ptr from boss object on which this interface is aggregated.
virtual TranFxUIDialogController::~TranFxUIDialogController ()
inlinevirtual

Destructor.

Member Function Documentation

void TranFxUIDialogController::ApplyDialogFields (IActiveContextmyContext,
const WidgetIDwidgetId 
)
virtual

Null implementation.

Parameters
widgetIdidentifies the widget on which to act.

Reimplemented from CDialogController.

void TranFxUIDialogController::InitializeDialogFields (IActiveContextcontext)
virtual

Initialises each widget in the dialog.

Reimplemented from CDialogController.

WidgetID TranFxUIDialogController::ValidateDialogFields (IActiveContextmyContext)
virtual

Null implementation.

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

Reimplemented from CDialogController.