IGridAttributesPrefsData Class Reference

#include <IGridAttributesPrefsData.h>

Inheritance diagram for IGridAttributesPrefsData:

Public Types
enum	{ kDefaultIID = IID_IGRIDATTRIBUTESPREFSDATA }

Public Member Functions
virtual void	Set (UIDRef docref, const IGridAttributesPrefs::TextDirection direction, const IGridAttributesPrefs::FrameType type, const int32 charPerLine, const PMReal gridVScale, const PMReal gridHScale, const PMReal charAki, const PMReal lineAki)=0
virtual void	SetDocument (UIDRef docref)=0
virtual UIDRef	GetDocument () const =0
virtual void	SetCharPerLine (const int32 charPerLine)=0
virtual int32	GetCharPerLine () const =0
virtual void	SetGridVScale (const PMReal vScale)=0
virtual PMReal	GetGridVScale () const =0
virtual void	SetGridHScale (const PMReal hScale)=0
virtual PMReal	GetGridHScale () const =0
virtual void	SetGridCharAki (const PMReal charAki)=0
virtual PMReal	GetGridCharAki () const =0
virtual void	SetGridLineAki (const PMReal lineAki)=0
virtual PMReal	GetGridLineAki () const =0
virtual void	SetDirection (const IGridAttributesPrefs::TextDirection direction)=0
virtual IGridAttributesPrefs::TextDirection	GetDirection () const =0
virtual IGridAttributesPrefs::FrameType	GetFrameGridType () const =0
virtual void	SetFrameGridType (const IGridAttributesPrefs::FrameType type)=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

This interface is used to cache data for creating document or document styles related commands including kInCopyNewDocCmdBoss, kDocEditPresetCmdBoss, kSaveDocumentPresetDataCmdBoss, kSetGridAttributesPrefsCmdBoss

Member Enumeration Documentation

anonymous enum

Define the default IID for IGridAttributesPrefsData.

Member Function Documentation

virtual int32 IGridAttributesPrefsData::GetCharPerLine ( ) const

pure virtual

Get the Text Area Grid Character per Line

Returns

the character per Line

virtual IGridAttributesPrefs::TextDirection IGridAttributesPrefsData::GetDirection ( ) const

pure virtual

Set the Grid Direction

Returns

the grid Direction

virtual UIDRef IGridAttributesPrefsData::GetDocument ( ) const

pure virtual

Get the document UIDRef

Returns

UIDRef of document

virtual IGridAttributesPrefs::FrameType IGridAttributesPrefsData::GetFrameGridType ( ) const

pure virtual

Get the Frame Grid Type

Returns

the Frame Grid Type

virtual PMReal IGridAttributesPrefsData::GetGridCharAki ( ) const

pure virtual

Set the Grid Character Spacing

Returns

the grid Character Spacing

virtual PMReal IGridAttributesPrefsData::GetGridHScale ( ) const

pure virtual

Set the Grid Horizontal Scale

Returns

the grid horizontal Scale

virtual PMReal IGridAttributesPrefsData::GetGridLineAki ( ) const

pure virtual

Set the Grid Line Spacing

Returns

the grid Line Spacing

virtual PMReal IGridAttributesPrefsData::GetGridVScale ( ) const

pure virtual

Set the Grid Vertical Scale

Returns

the grid vertical Scale

virtual void IGridAttributesPrefsData::SetCharPerLine ( const int32  charPerLine )

pure virtual

Set the Text Area Grid Character per Line

Parameters

charPerLine

the character per Line

Returns

void.

virtual void IGridAttributesPrefsData::SetDirection ( const IGridAttributesPrefs::TextDirection  direction )

pure virtual

Set the Grid Driection

Parameters

direction

the Grid Direction

Returns

void.

virtual void IGridAttributesPrefsData::SetDocument ( UIDRef  docref )

pure virtual

SetDocument indicating the document to set the IGridAttributesPrefs. not setting the document means to set the IGridAttributesPrefs in session workspace

Parameters

docref

refers to the document to set the IGridAttributesPrefs .

Returns

void.

virtual void IGridAttributesPrefsData::SetFrameGridType ( const IGridAttributesPrefs::FrameType  type )

pure virtual

Set the Frame Grid Type

Parameters

direction

the Frame Grid Type

Returns

void.

virtual void IGridAttributesPrefsData::SetGridCharAki ( const PMReal  charAki )

pure virtual

Set the Grid Character Spacing

Parameters

charAki

the Grid Character Spacing

Returns

void.

virtual void IGridAttributesPrefsData::SetGridHScale ( const PMReal  hScale )

pure virtual

Set the Grid Horizontal Scale

Parameters

hScale

the grid horizontal scale

Returns

void.

virtual void IGridAttributesPrefsData::SetGridLineAki ( const PMReal  lineAki )

pure virtual

Set the Grid Line Spacing

Parameters

charAki

the Grid Line Spacing

Returns

void.

virtual void IGridAttributesPrefsData::SetGridVScale ( const PMReal  vScale )

pure virtual

Set the Grid Vertical Scale

Parameters

vScale

the grid vertical Scale

Returns

void.