IBaselineFrameGridData Class Reference

Inheritance diagram for IBaselineFrameGridData:

Public Types
enum	{ kDefaultIID = IID_IBASELINEFRAMEGRIDDATA }
enum	RelativeOption { kTopOfPage, kTopOfMargin, kTopOfFrame, kTopOfInset }
enum	SetValueID {   kSetNone = 0, kSetUseBaselineGrid = 1, kSetStartingOffset = 2, kSetRelativeOption = 4,   kSetIncrement = 8, kSetBaselineFrameGridColor = 16 }

Public Member Functions
virtual void	SetUseCustomBaselineGridFlag (const bool16 &flag)=0
virtual bool16	GetUseCustomBaselineGridFlag () const =0
virtual void	SetStartingOffset (const PMReal &startingOffset)=0
virtual PMReal	GetStartingOffset () const =0
virtual void	SetRelativeOption (IBaselineFrameGridData::RelativeOption &relativeOption)=0
virtual IBaselineFrameGridData::RelativeOption	GetRelativeOption () const =0
virtual void	SetIncrement (const PMReal &increment)=0
virtual PMReal	GetIncrement () const =0
virtual bool16	GetBaselineFrameGridShown () const =0
virtual UIDRef	GetBaselineFrameGridColor ()=0
virtual void	SetBaselineFrameGridColor (const UID &colorUID)=0
virtual PMReal	GetBaselineFrameGridViewThreshold () const =0
virtual void	SetValue (const IBaselineFrameGridData::SetValueID &val)=0
virtual void	ClearSetValues ()=0
virtual bool16	ApplyValue (const IBaselineFrameGridData::SetValueID &val) 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

Member Enumeration Documentation

enum IBaselineFrameGridData::SetValueID

Turns on the bit to let the command know to set this value in the IBaselineFrameGridData

Parameters

val	IN what baselinegrid value we are setting

Member Function Documentation

virtual bool16 IBaselineFrameGridData::ApplyValue ( const IBaselineFrameGridData::SetValueID &  val ) const

pure virtual

Is this value set? Should the command apply it

virtual void IBaselineFrameGridData::ClearSetValues ( )

pure virtual

Clears the flags currently set

virtual UIDRef IBaselineFrameGridData::GetBaselineFrameGridColor ( )

pure virtual

Get the color of baseline frame grid from document preference.

Returns

UIDRef the swatch to draw the baseline frame grid.

virtual bool16 IBaselineFrameGridData::GetBaselineFrameGridShown ( ) const

pure virtual

Get the show/hide flag of baseline frame grid from document preference.

Returns

bool16 kTrue indicates show the baseline frame grid, otherwise kFalse.

virtual PMReal IBaselineFrameGridData::GetBaselineFrameGridViewThreshold ( ) const

pure virtual

Get the view limit of baseline frame grid from document preference. Under this view threshold, baseline frame grid will be invisible.

Returns

PMReal the view threshold.

virtual PMReal IBaselineFrameGridData::GetIncrement ( ) const

pure virtual

Get the distance between grid lines.

Returns

PMReal the distance.

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

pure virtual

Get the relative type defined as above such as kTopOfPage(top of page).

Returns

RelativeType the type of relative to.

virtual PMReal IBaselineFrameGridData::GetStartingOffset ( ) const

pure virtual

Get the distance between the starting point and its relative(e.g., top of page).

Returns

PMReal the distance.

virtual bool16 IBaselineFrameGridData::GetUseCustomBaselineGridFlag ( ) const

pure virtual

Get the flag that determining if we use custom baseline grid or not.

Returns

bool16 kTrue indicates that text frame has a grid of its own, otherwise kFalse.

virtual void IBaselineFrameGridData::SetBaselineFrameGridColor ( const UID &  colorUID )

pure virtual

Set the drawing color for baseline frame grid.

Parameters

colorUID

IN the new color.

virtual void IBaselineFrameGridData::SetIncrement ( const PMReal &  increment )

pure virtual

Set the distance between grid lines. Default is 12pts(0.1667 in).

Parameters

increment

IN the distance.

virtual void IBaselineFrameGridData::SetRelativeOption ( IBaselineFrameGridData::RelativeOption &  relativeOption )

pure virtual

Set the relative type defined as above such as kTopOfPage(top of page). Default is kTopOfInset.

Parameters

relativeType

IN the type of relative to.

virtual void IBaselineFrameGridData::SetStartingOffset ( const PMReal &  startingOffset )

pure virtual

Set the distance between the starting point and its relative(e.g., top of page). Default is 0.

Parameters

startOffset

IN the distance.

virtual void IBaselineFrameGridData::SetUseCustomBaselineGridFlag ( const bool16 &  flag )

pure virtual

Set the flag that determining if we use custom baseline grid or not.

Parameters

flag	IN either set as kTrue or kFalse.