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

Public Member Functions

 HidTxtEdDlgController (IPMUnknown *boss)
 
virtual void InitializeDialogFields (IActiveContext *dlgContext)
 
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 WidgetID ValidateDialogFields (IActiveContext *myContext)
 
virtual void ResetDialogFields (IActiveContext *myContext)
 
- Protected Attributes inherited from CPMUnknown< IDialogController >
HelperInterface fHelperInterface
 

Detailed Description

Implements the dialog controller(CDialogController) for editing hidden text.

Member Function Documentation

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

This method is called if the dialog settings should be applied to the model. The WidgetID is the ID of the widget that caused this method to be invoked (typically the 'OK' button.) In this plug-in, when the OK is hit, we need to determine if the dialog data is entered for the New or Modify action, after that, we will use functions in the IHidTxtSuite to change the data

Parameters
myContextcontext specifies the ISelectionManager to use to query IBPISuite
widgetIdidentifies the widget used to dismiss the dialog.

Reimplemented from CDialogController.

void HidTxtEdDlgController::InitializeDialogFields (IActiveContextdlgContext)
virtual

Called when the dialog opens to initialise the dialog. The dialog used in this plug-in is shared between Modify and New operations, so the dialog needs to be initialized with proper mode

Parameters
dlgContextcontext specifies the ISelectionManager to use to query IBPISuite

Reimplemented from CDialogController.