InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITextFrameDialogUtils Class Referenceabstract

#include <ITextFrameDialogUtils.h>

Inheritance diagram for ITextFrameDialogUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTFRAMEDIALOGUTILS }
 
enum  ColumnResizingMethod {
  kFixedNumberResizing = 0, kFixedWidthResizing = 1, kFlexibleWidthResizing = 2, kIgnoreResizing = 3,
  kFixedWidthOffResizing = 4, kFlexibleWidthOffResizing = 5
}
 

Public Member Functions

virtual void ActivateTextFrameDialog (bool16 fromMenu, WidgetID dialogPanelID)=0
 
virtual void DisplayTextFrameDialog (bool16 fromMenu, WidgetID dialogPanelID)=0
 
virtual void SetTFODialogVJOptions (IDialogController *controller, const ITextFrameOptionsData *tfoData) const =0
 
virtual void SetTFODialogFixedAndFlexibleOptions (IDialogController *controller, const ITextFrameOptionsData *tfoData) const =0
 
virtual void SetTFODialogColumnResizingFocus (IDialogController *controller, const ITextFrameOptionsData *tfoData) const =0
 
virtual ColumnResizingMethod GetColumnResizingMethod (IPMUnknown *dialogUnknown) const =0
 
virtual ColumnResizingMethod GetColumnResizingMethod (ITextFrameOptionsData *tfo) const =0
 
virtual void SetColumnResizingMethod (IPMUnknown *dialogUnknown, ColumnResizingMethod method) const =0
 
virtual void SetTFDlgAutoSizeOptions (IDialogController *controller, const ITextFrameOptionsData *tfoData) const =0
 
virtual void SetTFDlgAutoSizeDimension (IDialogController *controller, const ITextFrameOptionsData *tfo) const =0
 
virtual void SetTFDlgAutoSizeHasMinHeight (IDialogController *controller, const ITextFrameOptionsData *tfo) const =0
 
virtual void SetTFDlgAutoSizeHasMinWidth (IDialogController *controller, const ITextFrameOptionsData *tfo) const =0
 
virtual void SetTFOAutoSizeDimensionWithReference (IPMUnknown *panelData, Text::AutoSizeDimension asDimension, IReferencePointData::ReferencePointPosition refPoint) const =0
 
virtual void EnableTFOAutoSizeMinHeight (IPMUnknown *panelData) const =0
 
virtual void EnableTFOAutoSizeMinWidth (IPMUnknown *panelData) const =0
 
virtual WidgetID GetAutoSizeWidgetIDFromRefPoint (IReferencePointData::ReferencePointPosition refPoint) const =0
 
virtual
IReferencePointData::ReferencePointPosition 
GetAutoSizeRefPointFromWidgetID (WidgetID widgetID) const =0
 
virtual void SetTFOVerticalRuleOptions (IActiveContext *ac, IDialogController *controller, const ITextFrameOptionsData *tfoData) const =0
 
virtual
IVerticalColumnRuleData::VerticalRuleHeightMode 
GetDesiredVerticalRuleHeightMode () const =0
 
virtual void GetTopAndBottomDeltaFromAscentDescentToEmbox (PMReal &topDeltaFromEmboxToAscent, PMReal &bottomDeltaFromEmboxToAscent) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Utility class used primarily for the TextFrameOptions dialog.

NOTE: requires the use of ITextFrameOptionsData

Member Enumeration Documentation

Constants for the resizing dropdown list
Enumerator
kFixedWidthResizing 

Maps to fixed width off and flexible width off

kFlexibleWidthResizing 

Maps to fixed width on (and flexible width off)

kIgnoreResizing 

Maps to flexible width on (and fixed width off)

kFixedWidthOffResizing 

Maps to column resizing not set, used in Object Styles

kFlexibleWidthOffResizing 

Maps to fixed width off attribute, used in F/C

Member Function Documentation

virtual void ITextFrameDialogUtils::ActivateTextFrameDialog (bool16 fromMenu,
WidgetID dialogPanelID 
)
pure virtual

Invoke the dialog

virtual void ITextFrameDialogUtils::DisplayTextFrameDialog (bool16 fromMenu,
WidgetID dialogPanelID 
)
pure virtual

Same as DisplayTextFrameDialog, but only invokes the dialog if the current selection supports Text Frame Options operations.

virtual void ITextFrameDialogUtils::EnableTFOAutoSizeMinHeight (IPMUnknownpanelData) const
pure virtual

Method to enable and disable the auto sizing min height edit box based on the state of associated check-box.

virtual void ITextFrameDialogUtils::EnableTFOAutoSizeMinWidth (IPMUnknownpanelData) const
pure virtual

Method to enable and disable the auto sizing min width edit box based on the state of associated check-box.

virtual IReferencePointData::ReferencePointPosition ITextFrameDialogUtils::GetAutoSizeRefPointFromWidgetID (WidgetID widgetID) const
pure virtual

Gets the reference point position from the given auto size proxy widget ID

virtual WidgetID ITextFrameDialogUtils::GetAutoSizeWidgetIDFromRefPoint (IReferencePointData::ReferencePointPosition refPoint) const
pure virtual

Gets the auto size widget ID from the given reference point

virtual ColumnResizingMethod ITextFrameDialogUtils::GetColumnResizingMethod (IPMUnknowndialogUnknown) const
pure virtual

Return the method for column resizing from the dialog set in the kResizingDropDownWidgetID dropdown

virtual ColumnResizingMethod ITextFrameDialogUtils::GetColumnResizingMethod (ITextFrameOptionsDatatfo) const
pure virtual

Return the method for column resizing from dialog data

virtual IVerticalColumnRuleData::VerticalRuleHeightMode ITextFrameDialogUtils::GetDesiredVerticalRuleHeightMode () const
pure virtual

Gets the desired vertical rule height mode

virtual void ITextFrameDialogUtils::GetTopAndBottomDeltaFromAscentDescentToEmbox (PMRealtopDeltaFromEmboxToAscent,
PMRealbottomDeltaFromEmboxToAscent 
) const
pure virtual

Gets the top delta from ascent to embox and bottom delta from descent to embox.

virtual void ITextFrameDialogUtils::SetColumnResizingMethod (IPMUnknowndialogUnknown,
ColumnResizingMethod method 
) const
pure virtual

Set method to choose correct string in kResizingDropDownWidgetID dropdown

virtual void ITextFrameDialogUtils::SetTFDlgAutoSizeDimension (IDialogControllercontroller,
const ITextFrameOptionsDatatfo 
) const
pure virtual

Set method to set the correct value of Auto Size dimension in the associated drop down, and controls enable/disable of dependent controls

virtual void ITextFrameDialogUtils::SetTFDlgAutoSizeHasMinHeight (IDialogControllercontroller,
const ITextFrameOptionsDatatfo 
) const
pure virtual

Set method to set Auto size minimum height check-box state and controls enable/disable of associated edit field.

virtual void ITextFrameDialogUtils::SetTFDlgAutoSizeHasMinWidth (IDialogControllercontroller,
const ITextFrameOptionsDatatfo 
) const
pure virtual

Set method to set Auto size minimum width check-box state and controls enable/disable of associated edit field.

virtual void ITextFrameDialogUtils::SetTFDlgAutoSizeOptions (IDialogControllercontroller,
const ITextFrameOptionsDatatfoData 
) const
pure virtual

Handle dialog changes affecting the MCF (multi-column frames) associated with the selection for Auto Size

This should be called when the user changes any of the corresponding attributes.

virtual void ITextFrameDialogUtils::SetTFOAutoSizeDimensionWithReference (IPMUnknownpanelData,
Text::AutoSizeDimension asDimension,
IReferencePointData::ReferencePointPosition refPoint 
) const
pure virtual

Set method to set Auto size dimension and reference point for the Auto-sizing panel.

virtual void ITextFrameDialogUtils::SetTFODialogColumnResizingFocus (IDialogControllercontroller,
const ITextFrameOptionsDatatfoData 
) const
pure virtual

Put focus into column number, column width, or max column width widgets when user changes the column resizing method.

This should be called when the user changes any of the corresponding attributes.

virtual void ITextFrameDialogUtils::SetTFODialogFixedAndFlexibleOptions (IDialogControllercontroller,
const ITextFrameOptionsDatatfoData 
) const
pure virtual

Handle dialog changes affecting the MCF (multi-column frames) associated with the selection for fixed and range columns

This should be called when the user changes any of the corresponding attributes.

virtual void ITextFrameDialogUtils::SetTFODialogVJOptions (IDialogControllercontroller,
const ITextFrameOptionsDatatfoData 
) const
pure virtual

Handle dialog changes affecting the MCF (multi-column frames) associated with the selection for VJOptions

This should be called when the user changes any of the corresponding attributes.

virtual void ITextFrameDialogUtils::SetTFOVerticalRuleOptions (IActiveContextac,
IDialogControllercontroller,
const ITextFrameOptionsDatatfoData 
) const
pure virtual
Handle dialog changes affecting the Vertical Column rule

This should be called when the user changes any of the corresponding attributes.