![]() | InDesign SDK 20.5 |
#include <IStrokeAttributeSuite.h>

Public Types | |
| enum | { kDefaultIID = IID_ISTROKEATTRIBUTESUITE } |
Public Member Functions | |
| virtual uint16 | GetStrokeWeightCount (void) const =0 |
| virtual int16 | GetStrokeWeightValueCount (uint32 whichAttribute) const =0 |
| virtual PMReal | GetStrokeWeight (uint32 whichAttribute) const =0 |
| virtual bool16 | IsStrokeWeightEnabled (void)=0 |
| virtual uint16 | GetVisibleStrokeWeightCount (void)=0 |
| virtual PMReal | GetVisibleStrokeWeight (uint32 whichAttribute)=0 |
| virtual uint16 | GetLineImplCount (void) const =0 |
| virtual int16 | GetLineImplValueCount (uint32 whichAttribute) const =0 |
| virtual void | GetLineImpl (uint32 whichAttribute, ClassID &implClass, UID &implUID) const =0 |
| virtual bool16 | IsLineImplEnabled (ClassID=kInvalidClass)=0 |
| virtual uint16 | GetLineCapCount (void) const =0 |
| virtual int16 | GetLineCapValueCount (uint32 whichAttribute) const =0 |
| virtual int32 | GetLineCap (uint32 whichAttribute) const =0 |
| virtual bool16 | IsLineCapEnabled (void)=0 |
| virtual uint16 | GetJoinTypeCount (void) const =0 |
| virtual int16 | GetJoinTypeValueCount (uint32 whichAttribute) const =0 |
| virtual int32 | GetJoinType (uint32) const =0 |
| virtual bool16 | IsJoinTypeEnabled (void)=0 |
| virtual uint16 | GetArrowHeadAlignmentCount (void) const =0 |
| virtual int16 | GetArrowHeadAlignmentValueCount (uint32 whichAttribute) const =0 |
| virtual int32 | GetArrowHeadAlignment (uint32 whichAttribute) const =0 |
| virtual bool16 | IsArrowHeadAlignmentEnabled (void)=0 |
| virtual uint16 | GetLineStartImplClassCount (void) const =0 |
| virtual int16 | GetLineStartImplClassValueCount (uint32 whichAttribute) const =0 |
| virtual ClassID | GetLineStartImplClass (uint32 whichAttribute) const =0 |
| virtual bool16 | IsLineStartImplClassEnabled (void)=0 |
| virtual uint16 | GetLineEndImplClassCount (void) const =0 |
| virtual int16 | GetLineEndImplClassValueCount (uint32 whichAttribute) const =0 |
| virtual ClassID | GetLineEndImplClass (uint32) const =0 |
| virtual bool16 | IsLineEndImplClassEnabled (void)=0 |
| virtual uint16 | GetCornerImplClassCount (void) const =0 |
| virtual int16 | GetCornerImplClassValueCount (uint32 whichAttribute) const =0 |
| virtual ClassID | GetCornerImplClass (uint32) const =0 |
| virtual bool16 | IsCornerImplClassEnabled (void)=0 |
| virtual uint16 | GetCornerRadiusCount (void) const =0 |
| virtual int16 | GetCornerRadiusValueCount (uint32 whichAttribute) const =0 |
| virtual PMReal | GetCornerRadius (uint32) const =0 |
| virtual bool16 | IsCornerRadiusEnabled (void)=0 |
| virtual uint16 | GetMiterLimitCount (void) const =0 |
| virtual int16 | GetMiterLimitValueCount (uint32 whichAttribute) const =0 |
| virtual PMReal | GetMiterLimit (uint32) const =0 |
| virtual bool16 | IsMiterLimitEnabled (void)=0 |
| virtual uint16 | GetStrokeAlignmentCount () const =0 |
| virtual int16 | GetStrokeAlignmentValueCount (uint32 whichAttribute) const =0 |
| virtual int32 | GetStrokeAlignment (uint32 whichAttribute) const =0 |
| virtual bool16 | GetStrokeAlignmentsEnabledFlags (bool16 *centerAlign=nil, bool16 *insideAlign=nil, bool16 *outsideAlign=nil) const =0 |
| virtual int32 | GetDefaultStrokeAlignment () const =0 |
| virtual uint16 | GetGapColorCount () const =0 |
| virtual uint16 | GetGapColorValueCount (uint32 whichAttribute) const =0 |
| virtual UID | GetGapColor (uint32 whichAttribute) const =0 |
| virtual bool16 | IsGapColorEnabled () const =0 |
| virtual uint16 | GetGapTintCount () const =0 |
| virtual uint16 | GetGapTintValueCount (uint32 whichAttribute) const =0 |
| virtual PMReal | GetGapTint (uint32 whichAttribute) const =0 |
| virtual bool16 | IsGapTintEnabled () const =0 |
| virtual uint16 | GetArrowHeadStartScaleCount (void) const =0 |
| virtual int16 | GetArrowHeadStartScaleValueCount (uint32 whichAttribute) const =0 |
| virtual PMReal | GetArrowHeadStartScale (uint32 whichAttribute) const =0 |
| virtual bool16 | IsArrowHeadStartScaleEnabled (void)=0 |
| virtual uint16 | GetArrowHeadEndScaleCount (void) const =0 |
| virtual int16 | GetArrowHeadEndScaleValueCount (uint32 whichAttribute) const =0 |
| virtual PMReal | GetArrowHeadEndScale (uint32 whichAttribute) const =0 |
| virtual bool16 | IsArrowHeadEndScaleEnabled (void)=0 |
| virtual ErrorCode | ApplyStrokeWeight (const PMReal &strokeWeight)=0 |
| virtual ErrorCode | ApplyLineImpl (const ClassID &implClass, UID const &implUID=kInvalidUID)=0 |
| virtual ErrorCode | ApplyLineCap (const int32 &lineCap)=0 |
| virtual ErrorCode | ApplyJoinType (const int32 &joinType)=0 |
| virtual ErrorCode | ApplyArrowHeadAlignment (const int32 &arrowHeadAlignment)=0 |
| virtual ErrorCode | ApplyLineStartImplClass (const ClassID &implClass)=0 |
| virtual ErrorCode | ApplyLineEndImplClass (const ClassID &implClass)=0 |
| virtual ErrorCode | ApplyCornerImplClass (const ClassID &implClass)=0 |
| virtual ErrorCode | ApplyCornerRadius (const PMReal &radius)=0 |
| virtual ErrorCode | ApplyMiterLimit (const PMReal &miterLimit)=0 |
| virtual ErrorCode | ApplyStrokeAlignment (int32 strokeAlignment)=0 |
| virtual ErrorCode | ApplyGapColor (UID const &gapColorUID)=0 |
| virtual ErrorCode | ApplyGapTint (PMReal const &tint)=0 |
| virtual ErrorCode | ApplyArrowHeadStartScale (const PMReal &arrowHeadScaleFactor)=0 |
| virtual ErrorCode | ApplyArrowHeadEndScale (const PMReal &arrowHeadScaleFactor)=0 |
Public Member Functions inherited from IPMUnknown | |
| virtual IPMUnknown * | QueryInterface (PMIID interfaceID) const =0 |
| virtual void | AddRef () const =0 |
| virtual void | Release () const =0 |
This is a high level attribute suite interface specifically to faciliate getting/setting of various stroke attributes. It uses the IGraphicAttributeSuite to get/set appropriate data. Each attribute type has four methods:
| pure virtual |
Apply the specified line cap to the selection.
| arrowHeadAlignment | the arrow head alignment to apply. |
| pure virtual |
Apply the specified arrow head scale factor to the end arrow head
| arrowHeadScaleFactor | The scaling to be applied to the end arrow head (1%..1000%)..Default scaling is 100% |
| pure virtual |
Apply the specified arrow head scale factor to the start arrow head
| arrowHeadScaleFactor | The scaling to be applied to the start arrow head (1%..1000%)..Default scaling is 100% |
| pure virtual |
Apply the specified corner type to the selection.
| implClass | the corner type to apply. |
| pure virtual |
Apply the specified corner radius to the selection.
| radius | the corner radius to apply. |
| pure virtual |
Apply the specified gap color UID to the selection
| gapColorUID | The UID for the swatch to apply |
| pure virtual |
Apply the specified gap color tint to the selection
| tint | The tint to apply (0%..100%) |
| pure virtual |
Apply the specified join type to the selection.
| joinType | the join type to apply. |
| pure virtual |
Apply the specified line cap to the selection.
| lineCap | the line cap to apply. |
| pure virtual |
Apply the specified line end implementation class to the selection.
| implClass | the line end implementation class to apply. |
| pure virtual |
Apply the specified line impelementation class and UID to the selection.
| implClass | line impelmentation class ID to apply. |
| implUID | line impelmentation UID to apply. implUID should not be kInvalidUID for custom line implementation class. |
| pure virtual |
Apply the specified line start implementation class to the selection.
| implClass | the line start implementation class to apply. |
| pure virtual |
Apply the specified miter limit to the selection.
| miterLimit | the miter limit to apply. |
| pure virtual |
Apply the specified stroke alignment to the selection
| strokeAlignment | The alignment to apply. |
| pure virtual |
Apply the specified strokeWeight to the selection.
| strokeWeight | stroke to apply. |
| pure virtual |
Returns the nth arrow head alignment specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the number of arrow head alignments.
| pure virtual |
Returns the number of nth arrow head alignments specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the arrow head end scale for the nth arrowheadendscale attribute
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the number of unique arrow head end scale count in the selection.
| pure virtual |
Returns the number of nth arrow head end scale value count specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the arrow head start scale for the nth arrowheadstartscale attribute
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the number of unique arrowheadstartscale attribute count in the selection.
| pure virtual |
Returns the number of nth arrowheadstartscale value count specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the nth corner implmentation class specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the number of corner implmentation classes.
| pure virtual |
Returns the number of nth corner implmentation classes specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the nth corner radius specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the number of corner radius.
| pure virtual |
Returns the number of nth corner radius specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns default stroke alignment.
| pure virtual |
Returns the nth gap colors specified by whichAttribute.
| whichAttribute | The nth attribute index starting from 0. |
| pure virtual |
Returns the number of gap colors in the selection.
| pure virtual |
Returns the number of nth gap color specified by whichAttribute.
| whichAttribute | The nth attribute index starting from 0. |
| pure virtual |
Returns the nth gap tint specified by whichAttribute.
| whichAttribute | The nth attribute index starting from 0. |
| pure virtual |
Returns the number of gap tints in the selection.
| pure virtual |
Returns the number of nth gap tints specified by whichAttribute.
| whichAttribute | The nth attribute index starting from 0. |
| pure virtual |
Returns the nth join type specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the number of join types.
| pure virtual |
Returns the number of nth join types specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the nth line cap specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the number of line caps.
| pure virtual |
Returns the number of nth line caps specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the nth line end implmentation class specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the number of line end implmentation classes.
| pure virtual |
Returns the number of nth line end implmentation classes specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the nth line implementation class and the associated UID for a custom line style. implUID is kInvalidUID for a predefined line implementation class.
| whichAttribute | the nth attribute index starting from 0. |
| implClass | the nth line implementation class ID. |
| implUID | the nth line implemenation UID. |
| pure virtual |
Returns the number of line implementation classes.
| pure virtual |
Returns the number of nth line implementation classes specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the nth line start implmentation class specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the number of line start implmentation classes.
| pure virtual |
Returns the number of nth line start implmentation classes specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the nth miter limit specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the number of miter limits.
| pure virtual |
Returns the number of nth miter limits specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the nth stroke alignment specified by whichAttribute.
| whichAttribute | The nth attribute index starting from 0. |
| pure virtual |
Returns the number of stroke alignments in the selection.
| pure virtual |
Returns kTrue if the stroke alignment attribute is currently enabled. Otherwise returns kFalse. 3 parameters returns if each alignment (center, inside and outside) is enabled. For most cases we don't care as they are in the same state as stroke alignment attribute.
| centerAlign | - When non-nil, returns kTrue if center alignment is enabled, otherwise kFalse. |
| insideAlign | - When non-nil, returns kTrue if center alignment is enabled, otherwise kFalse. |
| outsideAlign | - When non-nil, returns kTrue if center alignment is enabled, otherwise kFalse. |
| pure virtual |
Returns the number of nth stroke alignment specified by whichAttribute.
| whichAttribute | The nth attribute index starting from 0. |
| pure virtual |
Returns the nth stroke weight in the selection specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the number of unique stroke weight count in the selection.
| pure virtual |
Returns the number of nth stroke weight value count specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the nth visible stroke weight in the selection specified by whichAttribute.
| whichAttribute | the nth attribute index starting from 0. |
| pure virtual |
Returns the number of none-zero stroke weight in the selection.
| pure virtual |
Returns kTrue if the arrow head alignment is currently enabled. Otherwise returns kFalse.
| pure virtual |
Returns kTrue if the arrow head end scale attribute is currently enabled.
Otherwise returns kFalse.
| pure virtual |
Returns kTrue if the arrow head start scale attribute is currently enabled.
Otherwise returns kFalse.
| pure virtual |
Returns kTrue if the corner type attribute is currently enabled. Otherwise returns kFalse.
| pure virtual |
Returns kTrue if the corner radius attribute is currently enabled. Otherwise returns kFalse.
| pure virtual |
Returns kTrue if the gap color attribute is currently enabled. Otherwise returns kFalse.
| pure virtual |
Returns kTrue if the gap tint attribute is currently enabled. Otherwise returns kFalse.
| pure virtual |
Returns kTrue if the join type is currently enabled. Otherwise returns kFalse.
| pure virtual |
Returns kTrue if the line cap is currently enabled. Otherwise returns kFalse.
| pure virtual |
Returns kTrue if the line end attribute is currently enabled. Otherwise returns kFalse.
| pure virtual |
Returns kTrue if the given line implementation is currently enabled. Otherwise returns kFalse.
| line | implementation class to query. |
| pure virtual |
Returns kTrue if the line start attribute is currently enabled. Otherwise returns kFalse.
| pure virtual |
Returns kTrue if the miter limit attribute is currently enabled. Otherwise returns kFalse.
| pure virtual |
Returns kTrue if the stroke weight attribute is currently enabled. Otherwise returns kFalse.