IGradientFill.h

//========================================================================================
// 
// $File$
// 
// Owner: Thanh Nguyen
// 
// $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.
// 
// 
// Defines the gradient fill interface for objects that support being filled.
// 
//========================================================================================

#ifndef __IGradientFill__
#define __IGradientFill__

#include "IPMUnknown.h"
#include "IColorData.h"
#include "K2Vector.h"
#include "GradientFillID.h"
#include "GraphicTypes.h"

class IGradientFill : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IGRADIENTFILL };

public:

 virtual void SetGradientFillType (const GradientType& gradType) = 0;
 virtual void SetNumberOfStop(int16 gradColorNum) = 0;
 virtual void SetNthGradientColorUID(int16 index, UID colorUID) = 0;
 virtual void SetNthStopPosition(int16 index, PMReal boundValue) = 0;
 virtual void SetNthGradientMidPoint(int16 index, PMReal midPoint) = 0;

 virtual void SetNthMidPointRelativeLocation(int16 index, PMReal value) = 0;

 virtual void InsertGradientColorUID (int16 index, UID colorUID) = 0;

 virtual void RemoveNthGradientColorUID (int16 index) = 0;

 virtual void ClearAll() = 0;

 virtual void QueryColorData(K2Vector<IColorData*>* colorDataList) = 0;
 virtual IColorData* CreateNthColorData(int16 at) const = 0;
 virtual UID GetNthGradientColorUID(int16 index) const = 0;
 virtual GradientType GetGradientFillType() const = 0;
 virtual int16 GetNumberOfStop() const = 0;
 virtual PMReal GetNthStopPosition(int16 index) const = 0;
 virtual PMReal GetNthGradientMidPoint(int16 index) const = 0;
 virtual PMReal GetNthMidPointRelativeLocation(int16 index) const = 0;

 virtual bool16 Equals( IGradientFill* pMatch ) const = 0;

 virtual IDataBase* GetDataBase (void) = 0;
};

#endif // __IGradientFill__