#include <IFramePrefsCmdData.h>

Inheritance diagram for IFramePrefsCmdData:

Public Types
enum	{ kDefaultIID = IID_IFRAMEPREFSCMDDATA }

Public Member Functions
virtual void	Set (bool16 useFixedWidth, bool16 useVerticalAlign, bool16 ignoreTextWrap, int32 numColumns, PMReal gutter, PMReal columnWidth, PMReal leftInset, PMReal topInset, PMReal rightInset, PMReal bottomInset, Text::FirstLineOffsetMetric firstLineOffsetMetric, PMReal minFirstLineOffset, Text::VerticalJustification vj, PMReal maxVJInterParaSpace, bool16 vjBalanceColumns, bool16 useFlexibleWidth, PMReal maxColumnWidth, Text::AutoSizeDimension asDimension, IReferencePointData::ReferencePointPosition refPoint, bool16 useMinHeight, PMReal minHeightValue, bool16 useMinWidth, PMReal minWidthValue, bool16 noLineBreak, bool16 useVerticalRule, PMReal verticalRuleOffset, PMReal verticalRuleTopInset, bool16 verticalRuleInsetChain, PMReal verticalRuleBottomInset, PMReal verticalRuleStrokeWidth, UID verticalRuleStrokeColor, ICompositionStyle::StrokeType verticalRuleStrokeType, PMReal verticalRuleTint, bool16 verticalRuleOverprint, const UIDRef &doc)=0

virtual bool16	GetUseFixedWidth ()=0

virtual bool16	GetUseVerticalAlignment ()=0

virtual bool16	GetIgnoreTextWrap ()=0

virtual int32	GetNumColumns ()=0

virtual PMReal	GetGutter ()=0

virtual PMReal	GetFixedColumnWidth ()=0

virtual const void	GetInsets (PMReal &left, PMReal &top, PMReal &right, PMReal &bottom)=0

virtual Text::FirstLineOffsetMetric	GetFirstLineOffsetMetric ()=0

virtual PMReal	GetMinFirstLineOffset ()=0

virtual const UIDRef &	GetDocument ()=0

virtual Text::VerticalJustification	GetVerticalJustification () const =0

virtual PMReal	GetMaxVJInterParaSpace () const =0

virtual bool16	GetVJBalanceColumns () const =0

virtual bool16	GetUseFlexibleWidth ()=0

virtual PMReal	GetMinColumnWidth ()=0

virtual PMReal	GetMaxColumnWidth ()=0

virtual Text::AutoSizeDimension	GetAutoSizeDimension ()=0

virtual IReferencePointData::ReferencePointPosition	GetAutoSizeRefPoint ()=0

virtual bool16	GetAutoSizeHasMinHeight ()=0

virtual PMReal	GetAutoSizeMinHeightValue ()=0

virtual bool16	GetAutoSizeHasMinWidth ()=0

virtual PMReal	GetAutoSizeMinWidthValue ()=0

virtual bool16	GetAutoSizeNoLineBreak ()=0

virtual bool16	GetUseVerticalRule ()=0

virtual PMReal	GetVerticalRuleOffset ()=0

virtual PMReal	GetVerticalRuleTopInset ()=0

virtual bool16	GetVerticalRuleInsetChain ()=0

virtual PMReal	GetVerticalRuleBottomInset ()=0

virtual PMReal	GetVerticalRuleStrokeWidth ()=0

virtual UID	GetVerticalRuleStrokeColor ()=0

virtual ICompositionStyle::StrokeType	GetVerticalRuleStrokeType ()=0

virtual PMReal	GetVerticalRuleTint ()=0

virtual bool16	GetVerticalRuleOverprint ()=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

Interface used to set up kSetFramePrefsCmdImpl for text frames.

Member Function Documentation

virtual Text::AutoSizeDimension IFramePrefsCmdData::GetAutoSizeDimension ( )

pure virtual

Get the value configured in the set method param asDimension.

Returns: auto size dimension.

virtual bool16 IFramePrefsCmdData::GetAutoSizeHasMinHeight ( )

pure virtual

Get the value configured in the set method param useMinHeight.

Returns: true if using given min height.

virtual bool16 IFramePrefsCmdData::GetAutoSizeHasMinWidth ( )

pure virtual

Get the value configured in the set method param useMinWidth.

Returns: true if using given min width.

virtual PMReal IFramePrefsCmdData::GetAutoSizeMinHeightValue ( )

pure virtual

Get the value configured in the set method param minHeightValue.

Returns: min height value.

virtual PMReal IFramePrefsCmdData::GetAutoSizeMinWidthValue ( )

pure virtual

Get the value configured in the set method param minWidthValue.

Returns: min width value.

virtual bool16 IFramePrefsCmdData::GetAutoSizeNoLineBreak ( )

pure virtual

Get the value configured in the set method param useNoLineBreak.

Returns: true if has no line breaks.

virtual IReferencePointData::ReferencePointPosition IFramePrefsCmdData::GetAutoSizeRefPoint ( )

pure virtual

Get the value configured in the set method param refPoint.

Returns: reference point.

virtual const UIDRef& IFramePrefsCmdData::GetDocument ( )

pure virtual

Get reference to the document that owns the frame values are being set on.

Returns: document reference.

virtual Text::FirstLineOffsetMetric IFramePrefsCmdData::GetFirstLineOffsetMetric ( )

pure virtual

Get the value configured in the set method param minFirstLineOffset.

Returns: type of first line offset.

virtual PMReal IFramePrefsCmdData::GetFixedColumnWidth ( )

pure virtual

Get the value configured in the set method param columnWidth.

Returns: column width.

virtual PMReal IFramePrefsCmdData::GetGutter ( )

pure virtual

Get the value configured in the set method param gutter.

Returns: gutter width.

virtual bool16 IFramePrefsCmdData::GetIgnoreTextWrap ( )

pure virtual

Get the value configured in the set method param ignoreTextWrap.

Returns: kTrue if ignoring text wrap.

virtual const void IFramePrefsCmdData::GetInsets	(	PMReal &	left,
		PMReal &	top,
		PMReal &	right,
		PMReal &	bottom
	)

pure virtual

Get the value configured in the set method inset params.

Parameters

left	- left inset value
top	- top inset value
right	- right inset value
bottom	- bottom inset value

Returns: none.

virtual PMReal IFramePrefsCmdData::GetMaxColumnWidth ( )

pure virtual

Get the value configured in the set method param maxColumnWidth.

Returns: maximum column width.

virtual PMReal IFramePrefsCmdData::GetMaxVJInterParaSpace ( ) const

pure virtual

Get the value configured in the set method param maxInterParaSpace.

Returns: maximum inter-paragraph spacing value.

virtual PMReal IFramePrefsCmdData::GetMinColumnWidth ( )

pure virtual

Get the value configured in the set method param minColumnWidth.

Returns: minimum column width.

virtual PMReal IFramePrefsCmdData::GetMinFirstLineOffset ( )

pure virtual

Get the value configured in the set method param firstLineOffsetMetric.

Returns: minimum first line offset value.

virtual int32 IFramePrefsCmdData::GetNumColumns ( )

pure virtual

Get the value configured in the set method param numColumns.

Returns: number of columns.

virtual bool16 IFramePrefsCmdData::GetUseFixedWidth ( )

pure virtual

Get the value configured in the set method param useFixedWidth.

Returns: kTrue using fixed columns.

virtual bool16 IFramePrefsCmdData::GetUseFlexibleWidth ( )

pure virtual

Get the value configured in the set method param useFlexibleWidth.

Returns: kTrue using flexible width columns.

virtual bool16 IFramePrefsCmdData::GetUseVerticalAlignment ( )

pure virtual

Get the value configured in the set method param useVerticalAlign.

Returns: kTrue using vertical alignment.

virtual bool16 IFramePrefsCmdData::GetUseVerticalRule ( )

pure virtual

Get the value configured in the set method param useVerticalRule.

Returns: true if vertical rule has applied.

virtual Text::VerticalJustification IFramePrefsCmdData::GetVerticalJustification ( ) const

pure virtual

Get the value configured in the set method param vj.

Returns: vertical justification setting.

virtual PMReal IFramePrefsCmdData::GetVerticalRuleBottomInset ( )

pure virtual

Get the value configured in the set method param verticalRuleBottomInset.

Returns: vertical rule bottom inset

virtual bool16 IFramePrefsCmdData::GetVerticalRuleInsetChain ( )

pure virtual

Get the value configured in the set method param verticalRuleInsetChain.

Returns: vertical rule inset chain value.

virtual PMReal IFramePrefsCmdData::GetVerticalRuleOffset ( )

pure virtual

Get the value configured in the set method param verticalRuleOffset.

Returns: vertical rule offset.

virtual bool16 IFramePrefsCmdData::GetVerticalRuleOverprint ( )

pure virtual

Get the value configured in the set method param verticalRuleStrokeColor.

Returns: true if vertical rule stroke overprint is applied.

virtual UID IFramePrefsCmdData::GetVerticalRuleStrokeColor ( )

pure virtual

Get the value configured in the set method param verticalRuleStrokeColor.

Returns: vertical rule stroke color.

virtual ICompositionStyle::StrokeType IFramePrefsCmdData::GetVerticalRuleStrokeType ( )

pure virtual

Get the value configured in the set method param verticalRuleStrokeColor.

Returns: vertical rule stroke type.

virtual PMReal IFramePrefsCmdData::GetVerticalRuleStrokeWidth ( )

pure virtual

Get the value configured in the set method param verticalRuleStrokeWidth.

Returns: vertical rule stroke width.

virtual PMReal IFramePrefsCmdData::GetVerticalRuleTint ( )

pure virtual

Get the value configured in the set method param verticalRuleStrokeColor.

Returns: vertical rule stroke tint.

virtual PMReal IFramePrefsCmdData::GetVerticalRuleTopInset ( )

pure virtual

Get the value configured in the set method param verticalRuleTopInset.

Returns: vertical rule top inset

virtual bool16 IFramePrefsCmdData::GetVJBalanceColumns ( ) const

pure virtual

Get the value configured in the set method param vjBalanceColumns.

Returns: vj balance columns value.

virtual void IFramePrefsCmdData::Set	(	bool16	useFixedWidth,
		bool16	useVerticalAlign,
		bool16	ignoreTextWrap,
		int32	numColumns,
		PMReal	gutter,
		PMReal	columnWidth,
		PMReal	leftInset,
		PMReal	topInset,
		PMReal	rightInset,
		PMReal	bottomInset,
		Text::FirstLineOffsetMetric	firstLineOffsetMetric,
		PMReal	minFirstLineOffset,
		Text::VerticalJustification	vj,
		PMReal	maxVJInterParaSpace,
		bool16	vjBalanceColumns,
		bool16	useFlexibleWidth,
		PMReal	maxColumnWidth,
		Text::AutoSizeDimension	asDimension,
		IReferencePointData::ReferencePointPosition	refPoint,
		bool16	useMinHeight,
		PMReal	minHeightValue,
		bool16	useMinWidth,
		PMReal	minWidthValue,
		bool16	noLineBreak,
		bool16	useVerticalRule,
		PMReal	verticalRuleOffset,
		PMReal	verticalRuleTopInset,
		bool16	verticalRuleInsetChain,
		PMReal	verticalRuleBottomInset,
		PMReal	verticalRuleStrokeWidth,
		UID	verticalRuleStrokeColor,
		ICompositionStyle::StrokeType	verticalRuleStrokeType,
		PMReal	verticalRuleTint,
		bool16	verticalRuleOverprint,
		const UIDRef &	doc
	)

pure virtual

Set the values for the command. Most of the parameters can be retrieved from ITextOptions if custom values aren't desired.

Parameters

useFixedWidth	- if kTrue use fixed column widths
useVerticalAlign	- if kTrue frame is vertically aligned
ignoreTextWrap	- if kTrue ignore text wrap
numColumns	- 1 to n columns in frame (non fixed column sizing)
gutter	- what is the gutter width
columnWidth	- how wide are the columns (fixed column sizing)
leftInset	- value for left inset
topInset	- value for top inset
rightInset	- value for right inset
bottomInset	- value for bottom inset
firstLineOffsetMetric	- type of first line offset metric
minFirstLineOffset	- minimum value for first line offset (see ITextOptions)
vj	- vertical justification type (see ITextOptions)
maxVJInterParaSpace	- See ITextOptions
vjBalanceColumns	- See ITextOptions
useFlexibleWidth	- if kTrue use flexible column widths
maxColumnWidth	- maximum column width (flexible column sizing)
auto	sizing dimension - dimension of auto sizing - Off, Width, Height, Both or proportionally
auto	sizing reference point - reference point from 9 point proxy
auto	sizing min height flag - if true use minimum height value
auto	sizing min height value - the value of minimum height
auto	sizing min width flag - if true use minimum width value
auto	sizing min width value - the value of minimum width
auto	sizing has line breaks flag - if true then line breaks are not applied
useVerticalRule	- if true then vertical column is applied
verticalRuleOffset	- offset for vertical column rule
verticalRuleTopInset	- inset from top of vertical cloumn rule
verticalRuleInsetChain	- inset's chain value of vertical cloumn rule
verticalRuleBottomInset	- inset from bottom of vertical column rule
verticalRuleStrokeWidth	- width of vertical column rule
verticalRuleStrokeColor	- color of vertical column rule
verticalRuleStrokeType	- type of vertical column rule
verticalRuleTint	- tint of vertical column rule
verticalRuleOverprint	- if true then overprint of vertical column is applied

Returns: none.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation