#include <ITextFrameOptionsSuite.h>

Inheritance diagram for ITextFrameOptionsSuite:

Public Types
enum	{ kDefaultIID = IID_ITEXTFRAMEOPTIONS_ISUITE }

Public Member Functions
virtual void	FreezeSelectionForModalDialog ()=0

virtual void	ThawSelectionForModalDialog ()=0

virtual bool16	CanApplyTextFrameOptions (void) const =0

virtual void	GetColumnsAndGutter (K2Vector< int32 > &numberOfColumnsVector, K2Vector< PMReal > &gutterWidthVector, bool16 sortedAndUnique) const =0

virtual bool16	GetTextFrameOptionsData (ITextFrameOptionsData *tfoData) const =0

virtual void	SetTextFrameOptionsData (ITextFrameOptionsData *tfoData)=0

virtual void	SetTFOWidthOptions (ITextFrameOptionsData *tfoData) const =0

virtual void	SetTFOInsetOptions (ITextFrameOptionsData *tfoData) const =0

virtual void	SetTFOColumns (ITextFrameOptionsData *tfoData) const =0

virtual void	SetTFOGutterWidth (ITextFrameOptionsData *tfoData) const =0

virtual void	SetTFOIgnoreWrap (ITextFrameOptionsData *tfoData) const =0

virtual void	SetTFOFirstLineOffsetMetric (ITextFrameOptionsData *tfoData) const =0

virtual void	SetTFOMinFirstLineOffset (ITextFrameOptionsData *tfoData) const =0

virtual void	SetTFOVerticalJustify (ITextFrameOptionsData *tfoData) const =0

virtual void	SetTFOMaxVJInterParaSpace (ITextFrameOptionsData *tfoData) const =0

virtual void	SetTFOVJBalanceColumns (ITextFrameOptionsData *tfoData) const =0

virtual void	GetBaselineFrameGridData (ITextFrameOptionsData *tfoData, bool16 convertColorUIDToLayerColor=kTrue) const =0

virtual void	SetBaselineFrameGridData (ITextFrameOptionsData *tfoData)=0

virtual void	SetUseCustomBaselineGridFlag (ITextFrameOptionsData *tfoData) const =0

virtual void	SetStartingOffset (ITextFrameOptionsData *tfoData) const =0

virtual void	SetRelativeOption (ITextFrameOptionsData *tfoData) const =0

virtual void	SetIncrement (ITextFrameOptionsData *tfoData) const =0

virtual void	SetBaselineFrameGridColor (ITextFrameOptionsData *tfoData) const =0

virtual void	SetAutoSizeDimension (ITextFrameOptionsData *tfoData) const =0

virtual void	SetAutoSizeRefPoint (ITextFrameOptionsData *tfoData) const =0

virtual void	SetAutoSizeHasMinHeight (ITextFrameOptionsData *tfoData) const =0

virtual void	SetAutoSizeMinHeightValue (ITextFrameOptionsData *tfoData) const =0

virtual void	SetAutoSizeHasMinWidth (ITextFrameOptionsData *tfoData) const =0

virtual void	SetAutoSizeMinWidthValue (ITextFrameOptionsData *tfoData) const =0

virtual void	SetAutoSizeNoLineBreak (ITextFrameOptionsData *tfoData) const =0

virtual void	GetTextFrameFootnoteOptions (ITextFrameOptionsData *tfoData) const =0

virtual void	SetTextFrameFootnoteOptions (ITextFrameOptionsData *tfoData)=0

virtual void	SetFootnoteOptionsHasEnableOverrides (ITextFrameOptionsData *tfoData) const =0

virtual void	SetFootnoteOptionsHasSpanFootnotesAcross (ITextFrameOptionsData *tfoData) const =0

virtual void	SetFootnoteOptionsMinimumSpacingValue (ITextFrameOptionsData *tfoData) const =0

virtual void	SetFootnoteOptionsSpaceBetweenFootnotesValue (ITextFrameOptionsData *tfoData) const =0

virtual void	GetTextFrameVerticalRuleOptions (ITextFrameOptionsData *tfoData) const =0

virtual void	SetTextFrameVerticalRuleOptions (ITextFrameOptionsData *tfoData) const =0

virtual void	SetUseVerticalRule (ITextFrameOptionsData *tfoData) const =0

virtual void	SetVerticalRuleOffset (ITextFrameOptionsData *tfoData) const =0

virtual void	SetVerticalRuleTopInset (ITextFrameOptionsData *tfoData) const =0

virtual void	SetVerticalRuleInsetChain (ITextFrameOptionsData *tfoData) const =0

virtual void	SetVerticalRuleBottomInset (ITextFrameOptionsData *tfoData) const =0

virtual void	SetVerticalRuleStrokeWidth (ITextFrameOptionsData *tfoData) const =0

virtual void	SetVerticalRuleStrokeColor (ITextFrameOptionsData *tfoData) const =0

virtual void	SetVerticalRuleStrokeType (ITextFrameOptionsData *tfoData) const =0

virtual void	SetVerticalRuleTint (ITextFrameOptionsData *tfoData) const =0

virtual void	SetVerticalRuleOverprint (ITextFrameOptionsData *tfoData) const =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

ITextFrameOptionsSuite

Member Function Documentation

virtual bool16 ITextFrameOptionsSuite::CanApplyTextFrameOptions ( void ) const

pure virtual

 CanApplyTextFrameOptions is used to determine if text frame options can be displayed for the current target.

Returns: kTrue if text frame options can be displayed.

virtual void ITextFrameOptionsSuite::FreezeSelectionForModalDialog ( )

pure virtual

 FreezeSelectionForModalDialog is used to freeze the selection when a modal dialog is about to be invoked.

This allows the modal dialog to operate on the same items regardless of how the changes affect the selection over time. (For example, if you have a caret and increase the columns, such that the caret moves to the next frame, the dialog will still operate on the original text frame). THIS CALL MUST BE PAIRED WITH A CALL TO ThawSelectionForModalDialog()

virtual void ITextFrameOptionsSuite::GetBaselineFrameGridData	(	ITextFrameOptionsData *	tfoData,
		bool16	convertColorUIDToLayerColor = `kTrue`
	)		const

pure virtual

GetBaselineFrameGridData - Get the baseline frame grid data for the current selection. convertColorUIDToLayerColor true if you want the actually color that will be displayed, false means if you are using the layer color it will return kInvalidUID

virtual void ITextFrameOptionsSuite::GetColumnsAndGutter	(	K2Vector< int32 > &	numberOfColumnsVector,
		K2Vector< PMReal > &	gutterWidthVector,
		bool16	sortedAndUnique
	)		const

pure virtual

 GetColumnsAndGutter is used to retrieve the number of columns and gutter width for items in selection.

Parameters

numberOfColumnsVector	OUT The vector for adding column widths to.
gutterWidthVector	OUT The vector for adding gutter widths to.
sortedAndUnique	IN If kTrue the vectors will be sorted and duplicates will be removed.

virtual void ITextFrameOptionsSuite::GetTextFrameFootnoteOptions ( ITextFrameOptionsData * tfoData ) const

pure virtual

GetTextFrameFootnoteOptions - Get the text frame footnote options for the given data.

virtual bool16 ITextFrameOptionsSuite::GetTextFrameOptionsData ( ITextFrameOptionsData * tfoData ) const

pure virtual

GetTextFrameOptionsData - Perform the Text Frame Options dialog. Returns kTrue if current target supports this operation, kFalse otherwise.

virtual void ITextFrameOptionsSuite::GetTextFrameVerticalRuleOptions ( ITextFrameOptionsData * tfoData ) const

pure virtual

GetTextFrameVerticalRuleOptions - Get the text frame column rule options for the given data.

virtual void ITextFrameOptionsSuite::SetAutoSizeDimension ( ITextFrameOptionsData * tfoData ) const

pure virtual

Set Auto Size text frame options data* - Process an action from the Text Frame Options dialog

virtual void ITextFrameOptionsSuite::SetBaselineFrameGridData ( ITextFrameOptionsData * tfoData )

pure virtual

SetBaselineFrameGridData - Sets the baseline frame grid data to the given data

virtual void ITextFrameOptionsSuite::SetFootnoteOptionsHasEnableOverrides ( ITextFrameOptionsData * tfoData ) const

pure virtual

Set Footnote Options text frame options data* - Process an action from the Text Frame Options dialog

virtual void ITextFrameOptionsSuite::SetTextFrameFootnoteOptions ( ITextFrameOptionsData * tfoData )

pure virtual

SetTextFrameFootnoteOptions - Sets the text frame footnote options to the given data

virtual void ITextFrameOptionsSuite::SetTextFrameOptionsData ( ITextFrameOptionsData * tfoData )

pure virtual

setTextFrameOptionsData - Sets the Text Frame Options to the given data

virtual void ITextFrameOptionsSuite::SetTextFrameVerticalRuleOptions ( ITextFrameOptionsData * tfoData ) const

pure virtual

SetTextFrameVerticalRuleOptions - Set the text frame column rule options for the given data.

virtual void ITextFrameOptionsSuite::SetTFOWidthOptions ( ITextFrameOptionsData * tfoData ) const

pure virtual

SetTFO* - Process an action from the Text Frame Options dialog

virtual void ITextFrameOptionsSuite::SetUseCustomBaselineGridFlag ( ITextFrameOptionsData * tfoData ) const

pure virtual

Set baseline frame grid data* - Process an action from the Text Frame Options dialog

virtual void ITextFrameOptionsSuite::SetUseVerticalRule ( ITextFrameOptionsData * tfoData ) const

pure virtual

Set Column Rule Options text frame options data* - Process an action from the Text Frame Options dialog

virtual void ITextFrameOptionsSuite::ThawSelectionForModalDialog ( )

pure virtual

 ThawSelectionForModalDialog is used to thaw the selection when a modal dialog has been closed.

see FreezeSelectionForModalDialog for mor details. THIS CALL MUST BE PAIRED WITH A CALL TO FreezeSelectionForModalDialog()

Public Types

Public Member Functions

Detailed Description

Member Function Documentation