IStrokeAttributeSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: SusanCL
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// This is a high level attribute suite specifically to faciliate getting/setting of simple
// stroke attributes. It uses the IGraphicAttributeSuite to get/set appropriate data.
// 
//========================================================================================

#ifndef _IStrokeAttributeSuite_
#define _IStrokeAttributeSuite_
//========================================================================================
//________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________
 #include "GraphicStylesID.h"
 #include "ShuksanID.h"
 #include "K2Vector.h"
 
 #include "IGraphicAttributeSuite.h"
//========================================================================================
//________________________________________________________________________________________
// CLASS DECLARATIONS
//________________________________________________________________________________________

class IStrokeAttributeSuite : public IPMUnknown
 {
 //____________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_ISTROKEATTRIBUTESUITE };
 
 //____________________________________________________________________________________
 // Stroke Weight Utilities 
 //____________________________________________________________________________________
 public:
 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;
 
 //____________________________________________________________________________________
 // Stroke Type Utilities 
 //____________________________________________________________________________________
 public:
 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;

 //____________________________________________________________________________________
 // Line Cap Utilities 
 //____________________________________________________________________________________
 public:
 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;

 //____________________________________________________________________________________
 // Join Type Utilities 
 //____________________________________________________________________________________
 public:
 virtual uint16 GetJoinTypeCount (void) const = 0;
 virtual int16 GetJoinTypeValueCount (uint32 whichAttribute) const = 0;
 virtual int32 GetJoinType (uint32) const = 0;
 virtual bool16 IsJoinTypeEnabled (void) = 0;

 //____________________________________________________________________________________
 // Arrow Head Alignment Utilities 
 //____________________________________________________________________________________
 public:
 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;

 //____________________________________________________________________________________
 // Line Start Start Type Utilities 
 //____________________________________________________________________________________
 public:
 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;

 //____________________________________________________________________________________
 // Line End End Type Utilities 
 //____________________________________________________________________________________
 public:
 virtual uint16 GetLineEndImplClassCount (void) const = 0;
 virtual int16 GetLineEndImplClassValueCount (uint32 whichAttribute) const = 0;
 virtual ClassID GetLineEndImplClass (uint32) const = 0;
 virtual bool16 IsLineEndImplClassEnabled (void) = 0;

 //____________________________________________________________________________________
 // Line Corner Type Utilities 
 //____________________________________________________________________________________
 public:
 virtual uint16 GetCornerImplClassCount (void) const = 0;
 virtual int16 GetCornerImplClassValueCount (uint32 whichAttribute) const = 0;
 virtual ClassID GetCornerImplClass (uint32) const = 0;
 virtual bool16 IsCornerImplClassEnabled (void) = 0;

 //____________________________________________________________________________________
 // Line Corner Radius Utilities 
 //____________________________________________________________________________________
 public:
 virtual uint16 GetCornerRadiusCount (void) const = 0;
 virtual int16 GetCornerRadiusValueCount (uint32 whichAttribute) const = 0;
 virtual PMReal GetCornerRadius (uint32) const = 0;
 virtual bool16 IsCornerRadiusEnabled (void) = 0;

 //____________________________________________________________________________________
 // Line Miter Limit Utilities 
 //____________________________________________________________________________________
 public:
 virtual uint16 GetMiterLimitCount (void) const = 0;
 virtual int16 GetMiterLimitValueCount (uint32 whichAttribute) const = 0;
 virtual PMReal GetMiterLimit (uint32) const = 0;
 virtual bool16 IsMiterLimitEnabled (void) = 0;

 //____________________________________________________________________________________
 // Line Stroke Alignment Utilities 
 //____________________________________________________________________________________
 public:
 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;

 //____________________________________________________________________________________
 // Gap Color Utilities 
 //____________________________________________________________________________________
 public:
 virtual uint16 GetGapColorCount () const = 0;

 virtual uint16 GetGapColorValueCount (uint32 whichAttribute) const = 0;

 virtual UID GetGapColor (uint32 whichAttribute) const = 0;

 virtual bool16 IsGapColorEnabled () const = 0;

 //____________________________________________________________________________________
 // Gap Tint Utilities 
 //____________________________________________________________________________________
 public:
 virtual uint16 GetGapTintCount () const = 0;

 virtual uint16 GetGapTintValueCount (uint32 whichAttribute) const = 0;

 virtual PMReal GetGapTint (uint32 whichAttribute) const = 0;

 virtual bool16 IsGapTintEnabled () const = 0;

 //____________________________________________________________________________________
 // Arrow Head Start Scale Utilities...
 //____________________________________________________________________________________
 public:
 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;

 //____________________________________________________________________________________
 // Arrow Head End Scale Utilities...
 //____________________________________________________________________________________
 public:
 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;

 //____________________________________________________________________________________
 // Other Utilities 
 //____________________________________________________________________________________
 public:
 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;

 };

#endif // _IStrokeAttributeSuite_