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

Public Types

enum  { kDefaultIID = IID_IGRIDRELATEDSTYLE }
 

Public Member Functions

virtual void SetNumOfJidori (int16 num)=0
 
virtual int16 GetNumOfJidori () const =0
 
virtual void SetNumOfGyoudori (int16 num)=0
 
virtual int16 GetNumOfGyoudori () const =0
 
virtual void SetIsParaGyoudori (bool16 val)=0
 
virtual bool16 GetIsParaGyoudori () const =0
 
virtual void SetGridAlignmentMetric (Text::GridAlignmentMetric where)=0
 
virtual Text::GridAlignmentMetric GetGridAlignmentMetric () const =0
 
virtual void SetAlignOnlyFirstLine (bool16 val)=0
 
virtual bool16 GetAlignOnlyFirstLine () const =0
 
virtual void SetScaleAffectsLineHeight (bool16 val)=0
 
virtual bool16 GetScaleAffectsLineHeight () const =0
 
virtual void SetCJKGridTracking (bool16 val)=0
 
virtual bool16 GetCJKGridTracking () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual bool16 IGridRelatedStyle::GetAlignOnlyFirstLine () const
pure virtual
 Grid alignment SetAlignOnlyFirstLine, controls whether or not only the first line in the paragraph should align to the grid.

Returns
whether or not only the first line in the paragraph should align to the grid.
virtual bool16 IGridRelatedStyle::GetCJKGridTracking () const
pure virtual

Returns whether or not tracking set in CJK grid should affect non-Roman char spacing and aki.

Returns
kTrue means CJK tracking is ON.
virtual Text::GridAlignmentMetric IGridRelatedStyle::GetGridAlignmentMetric () const
pure virtual
 Grid alignment metric, controls which pt in the line should align to that pt in the grid line.

Returns
which pt in the line should align to that pt in the grid line.
virtual bool16 IGridRelatedStyle::GetIsParaGyoudori () const
pure virtual
 Paragraph Gyoudori (CJKGrid-based hard paragraph height), controls if the gyoudori setting is for single lines (kFalse) or whole paragraphs (kTrue).

Returns
if the gyoudori setting is for single lines (kFalse) or whole paragraphs (kTrue)
virtual int16 IGridRelatedStyle::GetNumOfGyoudori () const
pure virtual
 Gyoudori (CJKGrid-based hard line height), controls how many grid lines the text should occupy.

Returns
how many grid lines the text should occupy
virtual int16 IGridRelatedStyle::GetNumOfJidori () const
pure virtual
 Jidori (CJKGrid-based range tracking), controls how many grid squares the text should occupy.

Returns
how many grid squares the text should occupy
virtual bool16 IGridRelatedStyle::GetScaleAffectsLineHeight () const
pure virtual

Returns whether or not scale effects line height (which is how the grid scales).

Returns
kTrue means scale does effect line height.
virtual void IGridRelatedStyle::SetAlignOnlyFirstLine (bool16 val)
pure virtual
 Grid alignment SetAlignOnlyFirstLine, controls whether or not only the first line in the paragraph should align to the grid.

Parameters
valIN new value for this attribute
virtual void IGridRelatedStyle::SetCJKGridTracking (bool16 val)
pure virtual
 Controls whether or not tracking set in CJK grid should affect non-Roman char spacing and aki.

Parameters
valIN new value for this attribute, kTrue means CJK tracking is ON.
virtual void IGridRelatedStyle::SetGridAlignmentMetric (Text::GridAlignmentMetric where)
pure virtual
 Grid alignment metric, controls which pt in the line should align to that pt in the grid line.

Parameters
whereIN new value for this attribute
virtual void IGridRelatedStyle::SetIsParaGyoudori (bool16 val)
pure virtual
 Gyoudori (CJKGrid-based hard paragraph height), controls if the gyoudori setting is for single lines (kFalse) or whole paragraphs (kTrue).

Parameters
valIN new value for this attribute
virtual void IGridRelatedStyle::SetNumOfGyoudori (int16 num)
pure virtual
 Gyoudori (CJKGrid-based hard line height), controls how many grid lines the text line should occupy.

Parameters
numIN new value for this attribute
virtual void IGridRelatedStyle::SetNumOfJidori (int16 num)
pure virtual
 Jidori (CJKGrid-based range tracking), controls how many grid squares the text should occupy.

Parameters
numIN new value for this attribute
virtual void IGridRelatedStyle::SetScaleAffectsLineHeight (bool16 val)
pure virtual
 Controls whether or not scale effects line height (which is how the grid scales).

Parameters
valIN new value for this attribute, kTrue means scale does effect line height.