InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IGridAttributesPrefs Class Referenceabstract
Inheritance diagram for IGridAttributesPrefs:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IGRIDATTRIBUTESPREFERENCES }
 
enum  TextDirection { kHorizontal = 0, kVertical }
 
enum  FrameType { kFrameTypeCJKGrid = 0, kFrameTypePlain }
 

Public Member Functions

virtual void SetCharPerLine (const int32 cpl)=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 IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Enumeration Documentation

anonymous enum

Define the default IID for IGridAttributesPrefs.

Member Function Documentation

virtual int32 IGridAttributesPrefs::GetCharPerLine () const
pure virtual

Get the Text Area Grid Character per Line

Returns
the character per Line
virtual IGridAttributesPrefs::TextDirection IGridAttributesPrefs::GetDirection () const
pure virtual

Set the Grid Direction

Returns
the grid Direction
virtual IGridAttributesPrefs::FrameType IGridAttributesPrefs::GetFrameGridType () const
pure virtual

Get the Frame Grid Type

Returns
the Frame Grid Type
virtual PMReal IGridAttributesPrefs::GetGridCharAki () const
pure virtual

Set the Grid Character Spacing

Returns
the grid Character Spacing
virtual PMReal IGridAttributesPrefs::GetGridHScale () const
pure virtual

Set the Grid Horizontal Scale

Returns
the grid horizontal Scale
virtual PMReal IGridAttributesPrefs::GetGridLineAki () const
pure virtual

Set the Grid Line Spacing

Returns
the grid Line Spacing
virtual PMReal IGridAttributesPrefs::GetGridVScale () const
pure virtual

Set the Grid Vertical Scale

Returns
the grid vertical Scale
virtual void IGridAttributesPrefs::SetCharPerLine (const int32 cpl)
pure virtual

Set the Text Area Grid Character per Line

Parameters
charPerLinethe character per Line
Returns
void.
virtual void IGridAttributesPrefs::SetDirection (const IGridAttributesPrefs::TextDirection direction)
pure virtual

Set the Grid Driection

Parameters
directionthe Grid Direction
Returns
void.
virtual void IGridAttributesPrefs::SetFrameGridType (const IGridAttributesPrefs::FrameType type)
pure virtual

Set the Frame Grid Type

Parameters
directionthe Frame Grid Type
Returns
void.
virtual void IGridAttributesPrefs::SetGridCharAki (const PMReal charAki)
pure virtual

Set the Grid Character Spacing

Parameters
charAkithe Grid Character Spacing
Returns
void.
virtual void IGridAttributesPrefs::SetGridHScale (const PMReal hScale)
pure virtual

Set the Grid Horizontal Scale

Parameters
hScalethe grid horizontal scale
Returns
void.
virtual void IGridAttributesPrefs::SetGridLineAki (const PMReal lineAki)
pure virtual

Set the Grid Line Spacing

Parameters
charAkithe Grid Line Spacing
Returns
void.
virtual void IGridAttributesPrefs::SetGridVScale (const PMReal vScale)
pure virtual

Set the Grid Vertical Scale

Parameters
vScalethe grid vertical Scale
Returns
void.