IGradientAttributeSuite.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.
// 
//========================================================================================

#ifndef __IGradientAttributeSuite__
#define __IGradientAttributeSuite__

#include "IPMUnknown.h"
#include "IGraphicAttrMessage.h"

#include "GraphicTypes.h"
#include "PMPoint.h"
#include "K2Vector.h"

#include "GradientFillID.h"

const PMReal kDefaultGradientAngle = 0.0;
const PMReal kDefaultGradientLength = 0.0;

const PMPoint kDefaultGradientCenter = PMPoint (0,0);
const PMReal kDefaultGradientRadius = 0.0;
const PMReal kDefaultGradientHiliteLength = 0.0;
const PMReal kDefaultGradientHiliteAngle = 0.0;

const PMReal kInvalidRealNumberValue = -1.0;

//________________________________________________________________________________________
// Class definition
//________________________________________________________________________________________
class IGraphicStyleAttributeBossList;


class IGradientAttributeSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IGRADIENTATTRIBUTESUITE };
 
 //________________________________________________________________________________________
 // Data Types
 //________________________________________________________________________________________
 enum AttributeType
 {
 kUnknownAttrType = -1,
 
 // Fill attributes

 kFillAngle = 0,
 kFillLength,
 kFillCenter,
 kFIllRadius,
 kFIllHiliteAngle,
 kFIllHiliteLength,
 
 // Stroke attributes

 kStrokeAngle,
 kStrokeLength,
 kStrokeCenter,
 kStrokeRadius,
 kStrokeHiliteAngle,
 kStrokeHiliteLength,
 
 kMaxNumberAttrTypes
 };
 
public:
 //________________________________________________________________________________
 // Return the attribute count specified by the Attribute Class ID and the attribute type
 //________________________________________________________________________________

 virtual uint16 GetAttributeCount (ClassID attributeClassID) = 0;
 virtual uint16 GetAttributeValueCount (ClassID attributeClassID, uint32 index) = 0;
 virtual uint16 GetAttributeCount (AttributeType attributeType) = 0;
 
 //________________________________________________________________________________
 // Attribute value accessors
 //________________________________________________________________________________

 virtual const IPMUnknown* QueryAttribute (uint32 index, ClassID attributeClass, const PMIID& interfaceIID = IID_IUNKNOWN) = 0;

 virtual IPMUnknown* CreateAttributeCopy (uint32 index, ClassID attributeClass, const PMIID& interfaceIID = IID_IUNKNOWN) = 0;
 
 virtual ErrorCode CopyIntoAttribute (uint32 index, IPMUnknown* iSourceAttribute) = 0;
 
 //________________________________________________________________________________
 // Returns the nth specific attribute value
 //________________________________________________________________________________

 virtual PMReal GetRealNumberAttributeValue (uint32 index, AttributeType attributeType) = 0;
 virtual PMPoint GetPointAttributeValue (uint32 index, AttributeType attributeType) = 0;

 virtual bool16 IsAttributeUnique (ClassID attributeClass) = 0;
 virtual bool16 IsAttributeUnique (AttributeType attributeType) = 0;

 virtual ErrorCode ApplyAttribute (ClassID attributeClass, const IPMUnknown* iAttribute) = 0;

 virtual ErrorCode ApplyAttributes (IGraphicStyleAttributeBossList* iAttributeList) = 0;

 virtual ErrorCode ApplyGradientVector (const PMPoint& startPoint, const PMPoint& endPoint) = 0;

 virtual ErrorCode ApplyDefaultAttributes (GradientType gradientType) = 0;

};

DECLARE_BASE_TYPE(IGradientAttributeSuite::AttributeType);

#endif // __IGradientAttributeSuite__