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

Public Types

enum  { kDefaultIID = IID_IPARARULESADORNMENTDATA }
 

Public Member Functions

virtual void SetLineCharacteristics (bool16 above, UID color, const PMReal &tint, const PMReal &weight, bool16 overprint, const ICompositionStyle::StrokeType &strokeType, UID gapColor, const PMReal &gapTint, bool16 gapOverprint)=0
 
virtual void AddLineSegment (const PMPoint &position, const PMReal &length)=0
 
virtual void SetTransform (const PMMatrix &mat)=0
 
virtual void SetNoLine ()=0
 
virtual int32 GetNumSegments () const =0
 
virtual const PMPointGetNthPosition (int32 n) const =0
 
virtual const PMRealGetNthLength (int32 n) const =0
 
virtual const PMRealGetWeight () const =0
 
virtual bool16 GetOverprint () const =0
 
virtual const PMRealGetTint () const =0
 
virtual UID GetColor () const =0
 
virtual
ICompositionStyle::StrokeType 
GetStrokeType () const =0
 
virtual bool16 GetAbove () const =0
 
virtual bool16 GetGapOverprint () const =0
 
virtual const PMRealGetGapTint () const =0
 
virtual UID GetGapColor () const =0
 
virtual PMReal GetRuleOffset () const =0
 
virtual const PMMatrixGetTransform () 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 void IParaRulesAdornmentData::AddLineSegment (const PMPointposition,
const PMReallength 
)
pure virtual

Paragraph rules can comprise multiple line segments.

Parameters
positionis the relative position of the line from the line's beginning & baseline.
lengthis the length in points of the line segment.
virtual void IParaRulesAdornmentData::SetLineCharacteristics (bool16 above,
UID color,
const PMRealtint,
const PMRealweight,
bool16 overprint,
const ICompositionStyle::StrokeTypestrokeType,
UID gapColor,
const PMRealgapTint,
bool16 gapOverprint 
)
pure virtual

Master "set" routine for paragraph rule data. This routine fills out the data for a paragraph rule text adornment.

Parameters
abovemeans kTrue = above, kFalse = below.
coloris the color.
tintis the line's tint.
weightis the line's stroke weight.
overprintspecifies if the line overprints.
strokeTypeis a stroke Type object.
gapColoris the color of the gap for dashed lines.
gapTintis the tint of the gap in dashed lines.
gapOverprintspecifies if the gap color should overprint.
virtual void IParaRulesAdornmentData::SetTransform (const PMMatrixmat)
pure virtual

Set a transform for the line. ONLY used to back out from the wax run to the wax line because we only have implemented wax run adornments, but this is really designed to be on a line.

Parameters
matis the inverse matrix from the wax run to the wax line.