#include <ITextFrameOptionsData.h>

Inheritance diagram for ITextFrameOptionsData:

Public Types
enum	{ kDefaultIID = IID_ITEXTFRAMEDIALOGOPTIONSDATA }

enum	SelectionTypes { allRectangles, allNonRectangles, mixedOrUnsupported, nothing }

enum	OptionState { unInitialized, mixedValues, unChanged, changed }

enum	EachInsetState { LeftInvalid = ITextInset::kLeft, TopInvalid = ITextInset::kTop, RightInvalid = ITextInset::kRight, BottomInvalid = ITextInset::kBottom, LeftChanged = ITextInset::kLeft<<4, TopChanged = ITextInset::kTop<<4, RightChanged = ITextInset::kRight<<4, BottomChanged = ITextInset::kBottom<<4 }

Public Member Functions
virtual bool16	ProcessTextFrameOptions (UIDList &mcfList)=0

virtual void	Reset ()=0

virtual void	ResetToOther (ITextFrameOptionsData *other)=0

virtual bool16	GetPreviewMode () const =0

virtual void	SetPreviewMode (bool16 newState)=0

virtual bool16	GetForceRedundant () const =0

virtual OptionState	GetNumberOfColumnsState () const =0

virtual bool16	GetColumnWidthIsDisplayable () const =0

virtual int32	GetNumberOfColumns () const =0

virtual void	AddInNumberOfColumns (int32 numberOfColumns)=0

virtual void	UpdateNumberOfColumns (int32 numberOfColumns)=0

virtual OptionState	GetUseFixedWidthColumnsState () const =0

virtual bool16	GetUseFixedWidthColumns () const =0

virtual void	AddInUseFixedWidthColumns (bool16 useFixedWidthColumns)=0

virtual void	UpdateUseFixedWidthColumns (bool16 useFixedWidthColumns)=0

virtual OptionState	GetColumnWidthState () const =0

virtual PMReal	GetColumnWidth () const =0

virtual void	AddInColumnWidth (PMReal columnWidth)=0

virtual void	UpdateColumnWidth (PMReal columnWidth)=0

virtual OptionState	GetUseFlexibleWidthColumnsState () const =0

virtual bool16	GetUseFlexibleWidthColumns () const =0

virtual void	AddInUseFlexibleWidthColumns (bool16 useFlexibleWidthColumns)=0

virtual void	UpdateUseFlexibleWidthColumns (bool16 useFlexibleWidthColumns)=0

virtual OptionState	GetFlexibleColumnWidthMaxState () const =0

virtual PMReal	GetFlexibleColumnWidthMax () const =0

virtual void	AddInFlexibleColumnWidthMax (PMReal flexibleColumnWidthMax)=0

virtual void	UpdateFlexibleColumnWidthMax (PMReal flexibleColumnWidthMax)=0

virtual OptionState	GetGutterWidthState () const =0

virtual PMReal	GetGutterWidth () const =0

virtual void	AddInGutterWidth (PMReal gutterWidth)=0

virtual void	UpdateGutterWidth (PMReal gutterWidth)=0

virtual OptionState	GetVerticalJustifyState () const =0

virtual Text::VerticalJustification	GetVerticalJustify () const =0

virtual void	AddInVerticalJustify (Text::VerticalJustification verticalJustify)=0

virtual void	UpdateVerticalJustify (Text::VerticalJustification verticalJustify)=0

virtual OptionState	GetMaxVJInterParaSpaceState () const =0

virtual PMReal	GetMaxVJInterParaSpace () const =0

virtual void	AddInMaxVJInterParaSpace (PMReal maxVJInterParaSpace)=0

virtual void	UpdateMaxVJInterParaSpace (PMReal maxVJInterParaSpace)=0

virtual OptionState	GetVJBalanceColumnsState () const =0

virtual bool16	GetVJBalanceColumns () const =0

virtual void	AddInVJBalanceColumns (bool16 vjBalanceColumns)=0

virtual void	UpdateVJBalanceColumns (bool16 vjBalanceColumns)=0

virtual OptionState	GetFirstLineOffsetState () const =0

virtual Text::FirstLineOffsetMetric	GetFirstLineOffset () const =0

virtual void	AddInFirstLineOffset (Text::FirstLineOffsetMetric firstLineOffset)=0

virtual void	UpdateFirstLineOffset (Text::FirstLineOffsetMetric firstLineOffset)=0

virtual OptionState	GetMinFirstLineOffsetState () const =0

virtual PMReal	GetMinFirstLineOffset () const =0

virtual void	AddInMinFirstLineOffset (PMReal minFirstLineOffset)=0

virtual void	UpdateMinFirstLineOffset (PMReal minFirstLineOffset)=0

virtual OptionState	GetIgnoreWrapState () const =0

virtual bool16	GetIgnoreWrap () const =0

virtual void	AddInIgnoreWrap (bool16 ignoreWrap)=0

virtual void	UpdateIgnoreWrap (bool16 ignoreWrap)=0

virtual OptionState	GetInsetsState (int32 *eachInset=nil) const =0

virtual PMRect	GetInsets () const =0

virtual void	AddInInsets (PMRect insets)=0

virtual void	UpdateInsetLeft (PMReal left)=0

virtual void	UpdateInsetTop (PMReal top)=0

virtual void	UpdateInsetRight (PMReal right)=0

virtual void	UpdateInsetBottom (PMReal bottom)=0

virtual void	UpdateInsets (PMRect insets)=0

virtual int32	GetIndividualInsetsInvalidity () const =0

virtual bool16	UserChangedWidth () const =0

virtual void	SetUserChangedWidth (bool16 changed)=0

virtual SelectionTypes	GetSelectionType () const =0

virtual void	AddInSelectionType (SelectionTypes selectionType)=0

virtual OptionState	GetUseCustomBaselineGridFlagState () const =0

virtual bool16	GetUseCustomBaselineGridFlag () const =0

virtual void	AddInUseCustomBaselineGridFlag (bool16 flag)=0

virtual void	UpdateUseCustomBaselineGridFlag (bool16 flag)=0

virtual OptionState	GetRelativeOptionState () const =0

virtual IBaselineFrameGridData::RelativeOption	GetRelativeOption () const =0

virtual void	AddInRelativeOption (IBaselineFrameGridData::RelativeOption relativeOption)=0

virtual void	UpdateRelativeOption (IBaselineFrameGridData::RelativeOption relativeOption)=0

virtual OptionState	GetStartingOffsetState () const =0

virtual PMReal	GetStartingOffset () const =0

virtual void	AddInStartingOffset (PMReal staringOffset)=0

virtual void	UpdateStartingOffset (PMReal staringOffset)=0

virtual OptionState	GetIncrementState () const =0

virtual PMReal	GetIncrement () const =0

virtual void	AddInIncrement (PMReal increment)=0

virtual void	UpdateIncrement (PMReal increment)=0

virtual OptionState	GetBaselineFrameGridColorState () const =0

virtual UID	GetBaselineFrameGridColor () const =0

virtual void	AddInBaselineFrameGridColor (UID colorUID)=0

virtual void	UpdateBaselineFrameGridColor (UID colorUID)=0

virtual bool16	ProcessBaselineFrameGridOptions (UIDList &mcfList, bool16 convertColorUIDToLayerColor)=0

virtual OptionState	GetAutoSizeDimensionState () const =0

virtual Text::AutoSizeDimension	GetAutoSizeDimension () const =0

virtual void	AddInAutoSizeDimension (Text::AutoSizeDimension autoSizeDimension)=0

virtual void	UpdateAutoSizeDimension (Text::AutoSizeDimension autoSizeDimension)=0

virtual OptionState	GetAutoSizeRefPointState () const =0

virtual IReferencePointData::ReferencePointPosition	GetAutoSizeRefPoint () const =0

virtual void	AddInAutoSizeRefPoint (IReferencePointData::ReferencePointPosition autoSizeRefPoint)=0

virtual void	UpdateAutoSizeRefPoint (IReferencePointData::ReferencePointPosition autoSizeRefPoint)=0

virtual OptionState	GetAutoSizeHasMinHeightState () const =0

virtual bool16	GetAutoSizeHasMinHeight () const =0

virtual void	AddInAutoSizeHasMinHeight (bool16 autoSizeHasMinHeight)=0

virtual void	UpdateAutoSizeHasMinHeight (bool16 autoSizeHasMinHeight)=0

virtual OptionState	GetAutoSizeMinHeightValueState () const =0

virtual PMReal	GetAutoSizeMinHeightValue () const =0

virtual void	AddInAutoSizeMinHeightValue (PMReal autoSizeMinHeightValue)=0

virtual void	UpdateAutoSizeMinHeightValue (PMReal autoSizeMinHeightValue)=0

virtual OptionState	GetAutoSizeHasMinWidthState () const =0

virtual bool16	GetAutoSizeHasMinWidth () const =0

virtual void	AddInAutoSizeHasMinWidth (bool16 autoSizeHasMinWidth)=0

virtual void	UpdateAutoSizeHasMinWidth (bool16 autoSizeHasMinWidth)=0

virtual OptionState	GetAutoSizeMinWidthValueState () const =0

virtual PMReal	GetAutoSizeMinWidthValue () const =0

virtual void	AddInAutoSizeMinWidthValue (PMReal autoSizeMinWidthValue)=0

virtual void	UpdateAutoSizeMinWidthValue (PMReal autoSizeMinWidthValue)=0

virtual OptionState	GetAutoSizeNoLineBreakState () const =0

virtual bool16	GetAutoSizeNoLineBreak () const =0

virtual void	AddInAutoSizeNoLineBreak (bool16 autoSizeNoLineBreak)=0

virtual void	UpdateAutoSizeNoLineBreak (bool16 autoSizeNoLineBreak)=0

virtual OptionState	GetFootnoteOptionsHasEnableOverridesState () const =0

virtual bool16	GetFootnoteOptionsHasEnableOverrides () const =0

virtual void	AddInFootnoteOptionsHasEnableOverrides (bool16 enableOverrides)=0

virtual void	UpdateFootnoteOptionsHasEnableOverrides (bool16 enableOverrides)=0

virtual OptionState	GetFootnoteOptionsHasSpanFootnotesAcrossState () const =0

virtual bool16	GetFootnoteOptionsHasSpanFootnotesAcross () const =0

virtual void	AddInFootnoteOptionsHasSpanFootnotesAcross (bool16 spanFootnotesAcross)=0

virtual void	UpdateFootnoteOptionsHasSpanFootnotesAcross (bool16 spanFootnotesAcross)=0

virtual OptionState	GetFootnoteOptionsMinimumSpacingValueState () const =0

virtual PMReal	GetFootnoteOptionsMinimumSpacingValue () const =0

virtual void	AddInFootnoteOptionsMinimumSpacingValue (PMReal minimumSpacing)=0

virtual void	UpdateFootnoteOptionsMinimumSpacingValue (PMReal minimumSpacing)=0

virtual OptionState	GetFootnoteOptionsSpaceBetweenFootnotesValueState () const =0

virtual PMReal	GetFootnoteOptionsSpaceBetweenFootnotesValue () const =0

virtual void	AddInFootnoteOptionsSpaceBetweenFootnotesValue (PMReal spaceBetweenFootnotes)=0

virtual void	UpdateFootnoteOptionsSpaceBetweenFootnotesValue (PMReal spaceBetweenFootnotes)=0

virtual bool16	ProcessTextFrameFootnoteOptions (UIDList &mcfList)=0

virtual OptionState	GetUseVerticalRuleState () const =0

virtual bool16	GetUseVerticalRule () const =0

virtual void	AddInUseVerticalRule (bool16 useVerticalRule)=0

virtual void	UpdateUseVerticalRule (bool16 useVerticalRule)=0

virtual OptionState	GetVerticalRuleOffsetState () const =0

virtual PMReal	GetVerticalRuleOffset () const =0

virtual void	AddInVerticalRuleOffset (PMReal verticalRuleOffset)=0

virtual void	UpdateVerticalRuleOffset (PMReal verticalRuleOffset)=0

virtual OptionState	GetVerticalRuleTopInsetState () const =0

virtual PMReal	GetVerticalRuleTopInset () const =0

virtual void	AddInVerticalRuleTopInset (PMReal verticalRuleTopInset)=0

virtual void	UpdateVerticalRuleTopInset (PMReal verticalRuleTopInset)=0

virtual OptionState	GetVerticalRuleInsetChainState () const =0

virtual void	AddInVerticalRuleInsetChain (bool16 isChained)=0

virtual void	UpdateVerticalRuleInsetChain (bool16 isChained)=0

virtual bool16	GetVerticalRuleInsetChain () const =0

virtual OptionState	GetVerticalRuleBottomInsetState () const =0

virtual PMReal	GetVerticalRuleBottomInset () const =0

virtual void	AddInVerticalRuleBottomInset (PMReal verticalRuleBottomInset)=0

virtual void	UpdateVerticalRuleBottomInset (PMReal verticalRuleBottomInset)=0

virtual OptionState	GetVerticalRuleStrokeWidthState () const =0

virtual PMReal	GetVerticalRuleStrokeWidth () const =0

virtual void	AddInVerticalRuleStrokeWidth (PMReal verticalRuleStrokeWidth)=0

virtual void	UpdateVerticalRuleStrokeWidth (PMReal verticalRuleStrokeWidth)=0

virtual OptionState	GetVerticalRuleStrokeColorState () const =0

virtual UID	GetVerticalRuleStrokeColor () const =0

virtual void	AddInVerticalRuleStrokeColor (UID verticalRuleStrokeColorUID)=0

virtual void	UpdateVerticalRuleStrokeColor (UID verticalRuleStrokeColorUID)=0

virtual OptionState	GetVerticalRuleStrokeTypeState () const =0

virtual void	AddInVerticalRuleStrokeType (ICompositionStyle::StrokeType verticalRuleStrokeType)=0

virtual void	UpdateVerticalRuleStrokeType (ICompositionStyle::StrokeType verticalRuleStrokeType)=0

virtual ICompositionStyle::StrokeType	GetVerticalRuleStrokeType () const =0

virtual OptionState	GetVerticalRuleTintState () const =0

virtual void	AddInVerticalRuleTint (PMReal tint)=0

virtual void	UpdateVerticalRuleTint (PMReal tint)=0

virtual PMReal	GetVerticalRuleTint () const =0

virtual OptionState	GetVerticalRuleOverprintState () const =0

virtual void	AddInVerticalRuleOverprint (bool16 isOverprint)=0

virtual void	UpdateVerticalRuleOverprint (bool16 isOverprint)=0

virtual bool16	GetVerticalRuleOverprint () const =0

virtual OptionState	GetVerticalRuleHeightModeState () const =0

virtual void	AddInVerticalRuleHeightMode (IVerticalColumnRuleData::VerticalRuleHeightMode verticalRuleHeightMode)=0

virtual void	UpdateVerticalRuleHeightMode (IVerticalColumnRuleData::VerticalRuleHeightMode verticalRuleHeightMode)=0

virtual IVerticalColumnRuleData::VerticalRuleHeightMode	GetVerticalRuleHeightMode () const =0

virtual bool16	ProcessTextFrameVerticalRuleOptions (UIDList &mcfList)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Usage: This object works off a state variable. The states are as follows: unInitialized -> add-in -> update

unInitialized is the state between construction and the first item being incorporated add-in is the state when items are being incorporated update is the state after all items have been incorporated (and the dialog is shown).

Basically, when initializing the dialog, use the AddInXXX methods when the dialog is open, use the UpdateXXX methods

Dialog constructed: When initializing (the dialog), the caller should call the InitXXX methods. Not only does this set the value of that option, but it also sets internal state for later on.

SelectionSuite processing: When incorporating the selection, each (applicable) selected item is incorporated into the object.

Dialog open: When the user updates a field in the dialog, the handler should call the UpdateXXX methods. Not only does this set the value of that option, but it also updates internal state.

Note: unInitialized is private - it should never been seen by clients

Member Enumeration Documentation

enum ITextFrameOptionsData::EachInsetState

EachInsetState: The location of the state bits for the individual inset values.

enum ITextFrameOptionsData::OptionState

OptionState: The state of a option. Values are as follows: unInitialized: no value set - invalid (clients should treat as opaque) mixedValues: due to the selection, this option does not have a value that can be displayed. This is the default state, so if you forget to call an Init method, you cannot set that value. unChanged: the value in the dialog has never been changed - it still matches the selection, no matter how the dialog is closed/used. changed: the value in the dialog was at one time changed. The attribute values should not be accessed if the state is "unInitialized" or "mixedValues"

Note: The "unInitialized" state should never be seen once all the selected objects have been incorporated into the data.

enum ITextFrameOptionsData::SelectionTypes

SelectionTypes: the entire selection can be composed of differing objects. All we care about is whether anything is selected and, if so, are they homogenous or not and if the former, the type.

Member Function Documentation

virtual void ITextFrameOptionsData::AddInAutoSizeDimension ( Text::AutoSizeDimension autoSizeDimension )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInAutoSizeHasMinHeight ( bool16 autoSizeHasMinHeight )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInAutoSizeHasMinWidth ( bool16 autoSizeHasMinWidth )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInAutoSizeMinHeightValue ( PMReal autoSizeMinHeightValue )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInAutoSizeMinWidthValue ( PMReal autoSizeMinWidthValue )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInAutoSizeNoLineBreak ( bool16 autoSizeNoLineBreak )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInAutoSizeRefPoint ( IReferencePointData::ReferencePointPosition autoSizeRefPoint )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInBaselineFrameGridColor ( UID colorUID )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInColumnWidth ( PMReal columnWidth )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInFirstLineOffset ( Text::FirstLineOffsetMetric firstLineOffset )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInFlexibleColumnWidthMax ( PMReal flexibleColumnWidthMax )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInFootnoteOptionsHasEnableOverrides ( bool16 enableOverrides )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInFootnoteOptionsHasSpanFootnotesAcross ( bool16 spanFootnotesAcross )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInFootnoteOptionsMinimumSpacingValue ( PMReal minimumSpacing )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInFootnoteOptionsSpaceBetweenFootnotesValue ( PMReal spaceBetweenFootnotes )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInGutterWidth ( PMReal gutterWidth )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInIgnoreWrap ( bool16 ignoreWrap )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInIncrement ( PMReal increment )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInInsets ( PMRect insets )

pure virtual

There are 3 cases for insets: 1) If no selection or the selection is all rectangles, then each side of the rectangle can have a seperate inset. In this case, the PMRect reflects accordingly. 2) If the selection is all (or a single) non-rectangles, then only a single inset applies to all sides. In this case, the Top() value of the PMRect is valid (although all the fields are == Top, for convenience).

Note: The GetIndividualInsetsInvalidity() does not treat the other fields as valid - only the Top is valid for it. 3) If the selection is mixed rectangles and not, then all fields are invalid.

The above 3 states are represented by GetSelectionType();

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInMaxVJInterParaSpace ( PMReal maxVJInterParaSpace )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInMinFirstLineOffset ( PMReal minFirstLineOffset )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInNumberOfColumns ( int32 numberOfColumns )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInRelativeOption ( IBaselineFrameGridData::RelativeOption relativeOption )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInSelectionType ( SelectionTypes selectionType )

pure virtual

Internal state - not used by active dialog

This method is used during dialog set up to determine the VJ and selection states.

virtual void ITextFrameOptionsData::AddInStartingOffset ( PMReal staringOffset )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInUseCustomBaselineGridFlag ( bool16 flag )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInUseFixedWidthColumns ( bool16 useFixedWidthColumns )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInUseFlexibleWidthColumns ( bool16 useFlexibleWidthColumns )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInUseVerticalRule ( bool16 useVerticalRule )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInVerticalJustify ( Text::VerticalJustification verticalJustify )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInVerticalRuleBottomInset ( PMReal verticalRuleBottomInset )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInVerticalRuleHeightMode ( IVerticalColumnRuleData::VerticalRuleHeightMode verticalRuleHeightMode )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInVerticalRuleInsetChain ( bool16 isChained )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInVerticalRuleOffset ( PMReal verticalRuleOffset )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInVerticalRuleOverprint ( bool16 isOverprint )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInVerticalRuleStrokeColor ( UID verticalRuleStrokeColorUID )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInVerticalRuleStrokeType ( ICompositionStyle::StrokeType verticalRuleStrokeType )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInVerticalRuleStrokeWidth ( PMReal verticalRuleStrokeWidth )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInVerticalRuleTint ( PMReal tint )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInVerticalRuleTopInset ( PMReal verticalRuleTopInset )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual void ITextFrameOptionsData::AddInVJBalanceColumns ( bool16 vjBalanceColumns )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The AddIn* method is used during dialog set up to add that attribute to the accumulated state for each object selected.

virtual Text::AutoSizeDimension ITextFrameOptionsData::GetAutoSizeDimension ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetAutoSizeDimensionState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetAutoSizeHasMinHeight ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetAutoSizeHasMinHeightState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetAutoSizeHasMinWidth ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetAutoSizeHasMinWidthState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual PMReal ITextFrameOptionsData::GetAutoSizeMinHeightValue ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetAutoSizeMinHeightValueState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual PMReal ITextFrameOptionsData::GetAutoSizeMinWidthValue ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetAutoSizeMinWidthValueState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetAutoSizeNoLineBreak ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetAutoSizeNoLineBreakState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute. The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual IReferencePointData::ReferencePointPosition ITextFrameOptionsData::GetAutoSizeRefPoint ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetAutoSizeRefPointState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual UID ITextFrameOptionsData::GetBaselineFrameGridColor ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetBaselineFrameGridColorState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual PMReal ITextFrameOptionsData::GetColumnWidth ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual bool16 ITextFrameOptionsData::GetColumnWidthIsDisplayable ( ) const

pure virtual

Call this method to determine whether or not the Column Width can be displayed in the UI.

Note: This check is in addition to the state check. The state can be valid, but not displayable.

virtual OptionState ITextFrameOptionsData::GetColumnWidthState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual Text::FirstLineOffsetMetric ITextFrameOptionsData::GetFirstLineOffset ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetFirstLineOffsetState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual PMReal ITextFrameOptionsData::GetFlexibleColumnWidthMax ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetFlexibleColumnWidthMaxState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetFootnoteOptionsHasEnableOverrides ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetFootnoteOptionsHasEnableOverridesState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute. The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetFootnoteOptionsHasSpanFootnotesAcross ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetFootnoteOptionsHasSpanFootnotesAcrossState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute. The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual PMReal ITextFrameOptionsData::GetFootnoteOptionsMinimumSpacingValue ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetFootnoteOptionsMinimumSpacingValueState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute. The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual PMReal ITextFrameOptionsData::GetFootnoteOptionsSpaceBetweenFootnotesValue ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetFootnoteOptionsSpaceBetweenFootnotesValueState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute. The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetForceRedundant ( ) const

pure virtual

Prior to Basil we always fired the equivalent command for every change even though the change itself might be the same as the targets. This had the undesirable side effect for things such as ObjectStyles which might have had the the same values but firing the underlying command would create an unwanted override if it was an overriden masterpage item.

Note: work in progress, only insets and column width, gutter and fixed support this.

Returns: kTrue if the underlying commands should be fired for targets which already have the desired values, kFalse otherwise.

virtual PMReal ITextFrameOptionsData::GetGutterWidth ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetGutterWidthState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetIgnoreWrap ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetIgnoreWrapState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual PMReal ITextFrameOptionsData::GetIncrement ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetIncrementState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual int32 ITextFrameOptionsData::GetIndividualInsetsInvalidity ( ) const

pure virtual

Return which insets are NOT valid. e.g. returns ITextInset::kLeft | kTop | kRight | kBottom if all of those fields are mixedValues or otherwise invalid.

virtual PMRect ITextFrameOptionsData::GetInsets ( ) const

pure virtual

There are 3 cases for insets: 1) If no selection or the selection is all rectangles, then each side of the rectangle can have a seperate inset. In this case, the PMRect reflects accordingly. 2) If the selection is all (or a single) non-rectangles, then only a single inset applies to all sides. In this case, the Top() value of the PMRect is valid (although all the fields are == Top, for convenience).

Note: The GetIndividualInsetsInvalidity() does not treat the other fields as valid - only the Top is valid for it. 3) If the selection is mixed rectangles and not, then all fields are invalid.

The above 3 states are represented by GetSelectionType();

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetInsetsState ( int32 * eachInset = nil ) const

pure virtual

There are 3 cases for insets: 1) If no selection or the selection is all rectangles, then each side of the rectangle can have a seperate inset. In this case, the PMRect reflects accordingly. 2) If the selection is all (or a single) non-rectangles, then only a single inset applies to all sides. In this case, the Top() value of the PMRect is valid (although all the fields are == Top, for convenience).

Note: The GetIndividualInsetsInvalidity() does not treat the other fields as valid - only the Top is valid for it. 3) If the selection is mixed rectangles and not, then all fields are invalid.

The above 3 states are represented by GetSelectionType();

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

Parameters

eachInset,: if non-nil, the bits within will indicate whether each inset is valid/invalid, or changed/unChanged. Treat the same as if Get*State was called for each inset. See EachInsetState for bit locations.

virtual PMReal ITextFrameOptionsData::GetMaxVJInterParaSpace ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetMaxVJInterParaSpaceState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual PMReal ITextFrameOptionsData::GetMinFirstLineOffset ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetMinFirstLineOffsetState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual int32 ITextFrameOptionsData::GetNumberOfColumns ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetNumberOfColumnsState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetPreviewMode ( ) const

pure virtual

Some fields depend on other fields and for auto-calculation, we need to know if preview is on or not.

virtual IBaselineFrameGridData::RelativeOption ITextFrameOptionsData::GetRelativeOption ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetRelativeOptionState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual SelectionTypes ITextFrameOptionsData::GetSelectionType ( ) const

pure virtual

Internal state - not used by active dialog

This method is used during dialog set up to determine the VJ and selection states.

virtual PMReal ITextFrameOptionsData::GetStartingOffset ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetStartingOffsetState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetUseCustomBaselineGridFlag ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetUseCustomBaselineGridFlagState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetUseFixedWidthColumns ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetUseFixedWidthColumnsState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetUseFlexibleWidthColumns ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetUseFlexibleWidthColumnsState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetUseVerticalRule ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetUseVerticalRuleState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual Text::VerticalJustification ITextFrameOptionsData::GetVerticalJustify ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetVerticalJustifyState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual PMReal ITextFrameOptionsData::GetVerticalRuleBottomInset ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetVerticalRuleBottomInsetState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the  attribute.



The Get*State method is used to determine whether the other methods can be called -@see OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual IVerticalColumnRuleData::VerticalRuleHeightMode ITextFrameOptionsData::GetVerticalRuleHeightMode ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetVerticalRuleHeightModeState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual bool16 ITextFrameOptionsData::GetVerticalRuleInsetChain ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetVerticalRuleInsetChainState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual PMReal ITextFrameOptionsData::GetVerticalRuleOffset ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetVerticalRuleOffsetState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetVerticalRuleOverprint ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetVerticalRuleOverprintState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual UID ITextFrameOptionsData::GetVerticalRuleStrokeColor ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetVerticalRuleStrokeColorState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual ICompositionStyle::StrokeType ITextFrameOptionsData::GetVerticalRuleStrokeType ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetVerticalRuleStrokeTypeState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual PMReal ITextFrameOptionsData::GetVerticalRuleStrokeWidth ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetVerticalRuleStrokeWidthState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the  attribute.



The Get*State method is used to determine whether the other methods can be called -@see OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual PMReal ITextFrameOptionsData::GetVerticalRuleTint ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetVerticalRuleTintState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual PMReal ITextFrameOptionsData::GetVerticalRuleTopInset ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetVerticalRuleTopInsetState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::GetVJBalanceColumns ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get* methods return the current value of the attribute.

virtual OptionState ITextFrameOptionsData::GetVJBalanceColumnsState ( ) const

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Get*State method is used to determine whether the other methods can be called -

See Also: OptionState

Note: for convenience, if the state is "unInitialized" the method returns "mixedValues".

virtual bool16 ITextFrameOptionsData::ProcessBaselineFrameGridOptions	(	UIDList &	mcfList,
		bool16	convertColorUIDToLayerColor
	)

pure virtual

Call this to initialize the data from the list of objects (the selection). Return kTrue if any multicolumn objects are in the list, kFalse otherwise. convertColorUIDToLayerColor true if you want the actualy color that will be displayed, false means if you are using the layer color it will return kInvalidUID

virtual bool16 ITextFrameOptionsData::ProcessTextFrameFootnoteOptions ( UIDList & mcfList )

pure virtual

Call this to initialize the data from the list of objects (the selection). Return kTrue if any multicolumn objects are in the list, kFalse otherwise.

virtual bool16 ITextFrameOptionsData::ProcessTextFrameOptions ( UIDList & mcfList )

pure virtual

Call this to initialize the data from the list of objects (the selection). Return kTrue if any multicolumn objects are in the list, kFalse otherwise.

virtual bool16 ITextFrameOptionsData::ProcessTextFrameVerticalRuleOptions ( UIDList & mcfList )

pure virtual

Call this to initialize the data from the list of objects (the selection)

Return kTrue if any multicolumn objects are in the list, kFalse otherwise.

virtual void ITextFrameOptionsData::Reset ( )

pure virtual

Call this when the dialog is created (before anything else).

virtual void ITextFrameOptionsData::ResetToOther ( ITextFrameOptionsData * other )

pure virtual

Resets the data to match anothers.

virtual void ITextFrameOptionsData::SetPreviewMode ( bool16 newState )

pure virtual

Some fields depend on other fields and for auto-calculation, we need to know if preview is on or not.

virtual void ITextFrameOptionsData::SetUserChangedWidth ( bool16 changed )

pure virtual

Internal state - used only by active dialog

This method is used by the dialog when the user changes the (column) width attribute.

virtual void ITextFrameOptionsData::UpdateAutoSizeDimension ( Text::AutoSizeDimension autoSizeDimension )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateAutoSizeHasMinHeight ( bool16 autoSizeHasMinHeight )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateAutoSizeHasMinWidth ( bool16 autoSizeHasMinWidth )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateAutoSizeMinHeightValue ( PMReal autoSizeMinHeightValue )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateAutoSizeMinWidthValue ( PMReal autoSizeMinWidthValue )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateAutoSizeNoLineBreak ( bool16 autoSizeNoLineBreak )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateAutoSizeRefPoint ( IReferencePointData::ReferencePointPosition autoSizeRefPoint )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateBaselineFrameGridColor ( UID colorUID )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateColumnWidth ( PMReal columnWidth )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateFirstLineOffset ( Text::FirstLineOffsetMetric firstLineOffset )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateFlexibleColumnWidthMax ( PMReal flexibleColumnWidthMax )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateFootnoteOptionsHasEnableOverrides ( bool16 enableOverrides )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateFootnoteOptionsHasSpanFootnotesAcross ( bool16 spanFootnotesAcross )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateFootnoteOptionsMinimumSpacingValue ( PMReal minimumSpacing )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateFootnoteOptionsSpaceBetweenFootnotesValue ( PMReal spaceBetweenFootnotes )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateGutterWidth ( PMReal gutterWidth )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateIgnoreWrap ( bool16 ignoreWrap )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateIncrement ( PMReal increment )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateInsetBottom ( PMReal bottom )

pure virtual

There are 3 cases for insets: 1) If no selection or the selection is all rectangles, then each side of the rectangle can have a seperate inset. In this case, the PMRect reflects accordingly. 2) If the selection is all (or a single) non-rectangles, then only a single inset applies to all sides. In this case, the Top() value of the PMRect is valid (although all the fields are == Top, for convenience).

Note: The GetIndividualInsetsInvalidity() does not treat the other fields as valid - only the Top is valid for it. 3) If the selection is mixed rectangles and not, then all fields are invalid.

The above 3 states are represented by GetSelectionType();

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateInsetLeft ( PMReal left )

pure virtual

There are 3 cases for insets: 1) If no selection or the selection is all rectangles, then each side of the rectangle can have a seperate inset. In this case, the PMRect reflects accordingly. 2) If the selection is all (or a single) non-rectangles, then only a single inset applies to all sides. In this case, the Top() value of the PMRect is valid (although all the fields are == Top, for convenience).

Note: The GetIndividualInsetsInvalidity() does not treat the other fields as valid - only the Top is valid for it. 3) If the selection is mixed rectangles and not, then all fields are invalid.

The above 3 states are represented by GetSelectionType();

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateInsetRight ( PMReal right )

pure virtual

There are 3 cases for insets: 1) If no selection or the selection is all rectangles, then each side of the rectangle can have a seperate inset. In this case, the PMRect reflects accordingly. 2) If the selection is all (or a single) non-rectangles, then only a single inset applies to all sides. In this case, the Top() value of the PMRect is valid (although all the fields are == Top, for convenience).

Note: The GetIndividualInsetsInvalidity() does not treat the other fields as valid - only the Top is valid for it. 3) If the selection is mixed rectangles and not, then all fields are invalid.

The above 3 states are represented by GetSelectionType();

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateInsets ( PMRect insets )

pure virtual

There are 3 cases for insets: 1) If no selection or the selection is all rectangles, then each side of the rectangle can have a seperate inset. In this case, the PMRect reflects accordingly. 2) If the selection is all (or a single) non-rectangles, then only a single inset applies to all sides. In this case, the Top() value of the PMRect is valid (although all the fields are == Top, for convenience).

Note: The GetIndividualInsetsInvalidity() does not treat the other fields as valid - only the Top is valid for it. 3) If the selection is mixed rectangles and not, then all fields are invalid.

The above 3 states are represented by GetSelectionType();

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateInsetTop ( PMReal top )

pure virtual

There are 3 cases for insets: 1) If no selection or the selection is all rectangles, then each side of the rectangle can have a seperate inset. In this case, the PMRect reflects accordingly. 2) If the selection is all (or a single) non-rectangles, then only a single inset applies to all sides. In this case, the Top() value of the PMRect is valid (although all the fields are == Top, for convenience).

Note: The GetIndividualInsetsInvalidity() does not treat the other fields as valid - only the Top is valid for it. 3) If the selection is mixed rectangles and not, then all fields are invalid.

The above 3 states are represented by GetSelectionType();

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateMaxVJInterParaSpace ( PMReal maxVJInterParaSpace )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateMinFirstLineOffset ( PMReal minFirstLineOffset )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateNumberOfColumns ( int32 numberOfColumns )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateRelativeOption ( IBaselineFrameGridData::RelativeOption relativeOption )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateStartingOffset ( PMReal staringOffset )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateUseCustomBaselineGridFlag ( bool16 flag )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateUseFixedWidthColumns ( bool16 useFixedWidthColumns )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateUseFlexibleWidthColumns ( bool16 useFlexibleWidthColumns )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateUseVerticalRule ( bool16 useVerticalRule )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateVerticalJustify ( Text::VerticalJustification verticalJustify )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateVerticalRuleBottomInset ( PMReal verticalRuleBottomInset )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateVerticalRuleHeightMode ( IVerticalColumnRuleData::VerticalRuleHeightMode verticalRuleHeightMode )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateVerticalRuleInsetChain ( bool16 isChained )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateVerticalRuleOffset ( PMReal verticalRuleOffset )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateVerticalRuleOverprint ( bool16 isOverprint )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateVerticalRuleStrokeColor ( UID verticalRuleStrokeColorUID )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateVerticalRuleStrokeType ( ICompositionStyle::StrokeType verticalRuleStrokeType )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateVerticalRuleStrokeWidth ( PMReal verticalRuleStrokeWidth )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateVerticalRuleTint ( PMReal tint )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateVerticalRuleTopInset ( PMReal verticalRuleTopInset )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual void ITextFrameOptionsData::UpdateVJBalanceColumns ( bool16 vjBalanceColumns )

pure virtual

Call this method when the dialog is created (before anything else) for the attribute.

The Update* method is used during dialog activation to indicate the user has updated that attribute.

virtual bool16 ITextFrameOptionsData::UserChangedWidth ( ) const

pure virtual

Internal state - used only by active dialog

This method is used by the dialog when the user changes the (column) width attribute.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation