InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
SnpLayoutGridInfo Struct Reference

Public Member Functions

 SnpLayoutGridInfo (void)
 
 ~SnpLayoutGridInfo (void)
 

Public Attributes

PMString fPageString
 
bool16 fHasLayoutGrid
 
ICJKLayoutGridData::GridStartingPoint fStartingPoint
 
bool16 fIsUsingMaster
 
PMString fMasterPageString
 
bool16 fIsGridVertical
 
PMRect fGridBounds
 
Int32List fCharsPerLine
 
int32 fNumOfLines
 
int32 fRectCount
 
SnpPMRectList fEmBoxRects
 
SnpPMRectList fICFBoxRects
 
PMReal fHCellSize
 
PMReal fVCellSize
 
PMReal fICFAdjustmentsX
 
PMReal fICFAdjustmentsY
 
UID fFontUID
 
PMString fFontStyleName
 
PMString fFontFullNativeName
 
PMReal fTextSize
 
PMReal fCharAki
 
PMReal fLineAki
 
PMReal fCharOkuri
 
PMReal fLineOkuri
 
PMReal fHScale
 
PMReal fVScale
 
ICompositionStyle::TextAlignment fTextAlignment
 
Text::GridAlignmentMetric fGridAlignment
 
IDrawingStyle::CharacterHang fCharacterHang
 

Detailed Description

Storage class for layout grid information

Constructor & Destructor Documentation

SnpLayoutGridInfo::SnpLayoutGridInfo (void )
inline

constructor - just to set defaults

SnpLayoutGridInfo::~SnpLayoutGridInfo (void )
inline

destructor - does nothing.

Member Data Documentation

IDrawingStyle::CharacterHang SnpLayoutGridInfo::fCharacterHang

Character hang option for the grid.

See Also
ICJKGridData
PMReal SnpLayoutGridInfo::fCharAki

Space between characters in the grid (in points)

See Also
ICJKGridData
PMReal SnpLayoutGridInfo::fCharOkuri

Space between the top of two consecutive characters in the grid (in points) Sum of char aki + text size * scale. The scale depends on grid direction. If vertical, use vertical scale.

See Also
ICJKGridData
Int32List SnpLayoutGridInfo::fCharsPerLine

List of characters per line in the grid.

See Also
ICJKGridManager
SnpPMRectList SnpLayoutGridInfo::fEmBoxRects

Embox of each cell in the grid. (in points)

See Also
ICJKGridManager
PMString SnpLayoutGridInfo::fFontFullNativeName

Native name of the default font used in the grid

See Also
ICJKGridData
PMString SnpLayoutGridInfo::fFontStyleName

Style name of the default font used in the grid

See Also
ICJKGridData
UID SnpLayoutGridInfo::fFontUID

Default font used in the grid.

See Also
ICJKGridData
Text::GridAlignmentMetric SnpLayoutGridInfo::fGridAlignment

Grid alignment.

See Also
ICJKGridData
PMRect SnpLayoutGridInfo::fGridBounds

Grid bounds (in points)

See Also
ICJKGridManager
bool16 SnpLayoutGridInfo::fHasLayoutGrid

Flag indicating if this page has a layout grid

PMReal SnpLayoutGridInfo::fHCellSize

Horizontal size of a cell in the grid. (in points)

See Also
ICJKGridManager
PMReal SnpLayoutGridInfo::fHScale

Horizontal scale of characters in the grid. (0.0 - 1.0)

See Also
ICJKGridData
PMReal SnpLayoutGridInfo::fICFAdjustmentsX

Horizontal ICF adjustments for each cell in the grid. (in points)

See Also
ICJKGridManager
PMReal SnpLayoutGridInfo::fICFAdjustmentsY

Vertical ICF adjustments for each cell in the grid. (in points)

See Also
ICJKGridManager
SnpPMRectList SnpLayoutGridInfo::fICFBoxRects

ICF box of each cell in the grid. (in points)

See Also
ICJKGridManager
bool16 SnpLayoutGridInfo::fIsGridVertical

Flag indicating if the grid is vertical

See Also
ICJKGridManager
bool16 SnpLayoutGridInfo::fIsUsingMaster

Flag indicating if the master page is to be used.

See Also
ICJKLayoutGridData
PMReal SnpLayoutGridInfo::fLineAki

Space between lines in the grid (in points)

See Also
ICJKGridData
PMReal SnpLayoutGridInfo::fLineOkuri

Space between the "top" of two consecutive lines in the grid (in points) Sum of line aki + text size * scale. The scale depends on grid direction. If vertical, use horizontal scale.

See Also
ICJKGridData
PMString SnpLayoutGridInfo::fMasterPageString

Stores master page as a string.

int32 SnpLayoutGridInfo::fNumOfLines

Number of text lines in the grid

See Also
ICJKGridManager
PMString SnpLayoutGridInfo::fPageString

String for the page under inspection.

int32 SnpLayoutGridInfo::fRectCount

Number of cells (one per character) in the grid.

See Also
ICJKGridManager
ICJKLayoutGridData::GridStartingPoint SnpLayoutGridInfo::fStartingPoint

Starting point of grid.

See Also
ICJKLayoutGridData
ICompositionStyle::TextAlignment SnpLayoutGridInfo::fTextAlignment

Text alignment of the body text in the grid.

See Also
ICJKGridData
PMReal SnpLayoutGridInfo::fTextSize

Default text size used in the grid (in points)

See Also
ICJKGridData
PMReal SnpLayoutGridInfo::fVCellSize

Vertical size of a cell in the grid. (in points)

See Also
ICJKGridManager
PMReal SnpLayoutGridInfo::fVScale

Vertical scale of characters in the grid. (0.0 - 1.0)

See Also
ICJKGridData