InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
SnpModLayoutGridParameters Class Reference

Public Member Functions

 SnpModLayoutGridParameters (void)
 
 ~SnpModLayoutGridParameters (void)
 

Public Attributes

ICJKLayoutGridData::GridStartingPoint fStartingPoint
 
bool16 fModifyMasterPage
 
bool16 fVertical
 
int32 fNumCharsPerLine
 
int32 fNumLines
 
int32 fNumColumns
 
PMReal fColumnGapWidth
 
PMReal fMarginLeft
 
PMReal fMarginTop
 
PMReal fMarginRight
 
PMReal fMarginBottom
 
UID fFontUID
 
PMString fFontStyle
 
PMReal fTextSize
 
PMReal fCharAki
 
PMReal fLineAki
 
PMReal fCharOkuri
 
PMReal fLineOkuri
 
PMReal fHScale
 
PMReal fVScale
 
ICompositionStyle::TextAlignment fAlignment
 
Text::GridAlignmentMetric fGridAlignment
 
IDrawingStyle::CharacterHang fCharacterHang
 

Detailed Description

Keeps layout grid setup related parameters.

Constructor & Destructor Documentation

SnpModLayoutGridParameters::SnpModLayoutGridParameters (void )
inline

Constructor. Sets defaults so we can tell if something was mutated.

SnpModLayoutGridParameters::~SnpModLayoutGridParameters (void )
inline

Destructor. Does nothing.

Member Data Documentation

ICompositionStyle::TextAlignment SnpModLayoutGridParameters::fAlignment

Specifies how characters are aligned with each other in a text run.

See Also
TextAlignment
kSetCJKGridDataCmdBoss
IFilteredCJKGridCmdData
kSetCJKLayoutGridDefaultsCmdBoss
ICJKLayoutGridDefaults
IDrawingStyle::CharacterHang SnpModLayoutGridParameters::fCharacterHang

Specifies how the character hangs in a grid box.

See Also
CharacterHang
kSetCJKGridDataCmdBoss
IFilteredCJKGridCmdData
kSetCJKLayoutGridDefaultsCmdBoss
ICJKLayoutGridDefaults
PMReal SnpModLayoutGridParameters::fCharAki
PMReal SnpModLayoutGridParameters::fCharOkuri

The distance between the top of two adjacent characters in a line.

See Also
kSetCJKGridDataCmdBoss
IFilteredCJKGridCmdData
kSetCJKLayoutGridDefaultsCmdBoss
ICJKLayoutGridDefaults
PMReal SnpModLayoutGridParameters::fColumnGapWidth

The distance in between columns.

See Also
kSetColumnGutterCmdBoss
IColumnGutterCmdData
PMString SnpModLayoutGridParameters::fFontStyle
UID SnpModLayoutGridParameters::fFontUID

UID of default font family to use in the layout grid. Defaults to kInvalidUID.

See Also
kSetCJKGridDataCmdBoss
IFilteredCJKGridCmdData
kSetCJKLayoutGridDefaultsCmdBoss
ICJKLayoutGridDefaults
Text::GridAlignmentMetric SnpModLayoutGridParameters::fGridAlignment

Specifies what part of the tile and grid should be aligned to each other.

See Also
GridAlignmentMetric
kSetCJKGridDataCmdBoss
IFilteredCJKGridCmdData
kSetCJKLayoutGridDefaultsCmdBoss
ICJKLayoutGridDefaults
PMReal SnpModLayoutGridParameters::fHScale
PMReal SnpModLayoutGridParameters::fLineAki

Size of the line aki (spacing) (This is the distance from the bottom of one line to the top of the next line, and is NOT equivalent to leading.)

See Also
kSetCJKGridDataCmdBoss
IFilteredCJKGridCmdData
kSetCJKLayoutGridDefaultsCmdBoss
ICJKLayoutGridDefaults
PMReal SnpModLayoutGridParameters::fLineOkuri
PMReal SnpModLayoutGridParameters::fMarginBottom
PMReal SnpModLayoutGridParameters::fMarginLeft

"Left" margin. Inside if left page, outside if right page.

See Also
kSetPageMarginsCmdBoss
IPageMarginsCmdData
PMReal SnpModLayoutGridParameters::fMarginRight

"Right" margin. Outside if left page, inside if right page.

See Also
kSetPageMarginsCmdBoss
IPageMarginsCmdData
PMReal SnpModLayoutGridParameters::fMarginTop
bool16 SnpModLayoutGridParameters::fModifyMasterPage

Flag that indicates if you want to modify the master page.

See Also
kSetCJKLayoutGridDataCmdBoss
ICJKLayoutGridData
int32 SnpModLayoutGridParameters::fNumCharsPerLine

Number of characters per line per column in the layout grid. This affects the column height if vertical, and column width if horizontal.

See Also
kSetPageColumnsCmdBoss
IPageColumnsCmdData
int32 SnpModLayoutGridParameters::fNumColumns

Number of columns the layout grid.

See Also
kSetPageColumnsCmdBoss
IPageColumnsCmdData
int32 SnpModLayoutGridParameters::fNumLines

Number of lines in a column in the layout grid. This affects the column width if vertical, and column height if horizontal

See Also
kSetPageMarginsCmdBoss
IPageMarginsCmdData
ICJKLayoutGridData::GridStartingPoint SnpModLayoutGridParameters::fStartingPoint

Starting point of grid.

See Also
kSetCJKLayoutGridDataCmdBoss
ICJKLayoutGridData
PMReal SnpModLayoutGridParameters::fTextSize
bool16 SnpModLayoutGridParameters::fVertical

Layout grid orientation flag - kTrue if vertical.

See Also
kSetPageColumnsCmdBoss
IPageColumnsCmdData
PMReal SnpModLayoutGridParameters::fVScale