IGradientMetaData.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 metadata interface.
// 
//========================================================================================

#ifndef __IGradientMetaData__
#define __IGradientMetaData__

#include "IPMUnknown.h"
#include "IColorData.h"

#include "GradientFillID.h"

class IGradientMetaData : public IPMUnknown
{
public:
 
 enum {kDefaultIID = IID_IGRADIENTMETADATA_OBSOLETE};


 virtual void SetGradientFillType (const GradientType& gradType) = 0;
 virtual void SetNumberOfStop(int16 gradColorNum) = 0;
 virtual void SetNthGradientColorMetaData(int16 index, IColorData* colorData) = 0;
 virtual void SetNthStopPosition(int16 index, PMReal boundValue) = 0;
 virtual void SetNthGradientMidPoint(int16 index, PMReal midPoint) = 0;

 virtual void InsertGradientColorMetaData(int16 index, IColorData* colorData) = 0;
 virtual void ClearAll() = 0;

 virtual void GetColorData(K2Vector<IColorData*>* colorDataList) = 0;
 virtual IColorData* GetNthColorData(int16 at) = 0;
 virtual GradientType GetGradientFillType() const = 0;
 virtual int16 GetNumberOfStop() = 0;
 
 virtual PMReal GetNthStopPosition(int16 index) const = 0;
 virtual PMReal GetNthGradientMidPoint(int16 index) const = 0;

 virtual void RemoveNthColorData(int16 at) = 0;
};

#endif // __IGradientMetaData__