ISwatchList.h

//========================================================================================
// 
// $File$
// 
// Owner: SusanCL, Jack Kirstein
// 
// $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.
// 
// 
// Purpose of Interface:
// This is a simple interface designed to hold a list of swatches
// or ui colors stored in the workspaces (documents or app).
// The swatches can be any rendering objects such as solid colors and gradients.
// 
// Add more Find__ methods as more rendering objects are implmented.
// 
//========================================================================================

#ifndef __ISwatchList__
#define __ISwatchList__

#include "IPMUnknown.h"
#include "ColorSystemID.h"
#include "IColorData.h"
#include "IGradientFill.h"
#include "PMString.h"

class UIDList;

class ISwatchList : public IPMUnknown
{
 public:
 enum {kDefaultIID = IID_ISWATCHLIST};
 
 virtual void Init() = 0;
 
 virtual UIDRef FindSwatch(const PMString& name) const = 0;

 virtual UIDRef FindSwatch(const int32& colorSpace, const ColorArray& colorArray ) const = 0;

 virtual UIDRef FindSwatch( IColorData* colorData ) const = 0;

 virtual UIDRef FindSwatch( IGradientFill* gradient ) const = 0;

 virtual int32 SwatchLocation (const UID& swatchUID ) const = 0;
 
 virtual int32 VisibleSwatchLocation (const UID& swatch) const = 0;

 virtual int32 GetNumSwatches() const = 0;
 
 virtual int32 GetNumVisibleSwatches() const = 0;
 
 virtual int32 GetNumNamedSwatches() const = 0;
 
 virtual UIDRef GetNthSwatch(int32 index) const = 0;
 
 virtual UIDRef GetNthVisibleSwatch(int32 index) const = 0;

 virtual UIDRef GetNthNamedSwatch(int32 index) const = 0;
 
 virtual void AddSwatch(const UID& swatch ) = 0;
 
 virtual void RemoveSwatch(const UID& swatch) = 0;

 virtual void RemoveSwatch(const UIDList* itemList) = 0;

 virtual void Move(int32 fromIndex, int32 toIndex ) = 0;
 
 virtual void SortVisibleSwatchesByName () = 0;
 
 virtual UID GetBlackSwatchUID () const = 0;
 virtual UID GetPaperSwatchUID () const = 0;
 virtual UID GetRegistrationSwatchUID () const = 0;
 virtual UID GetNoneSwatchUID () const = 0;
 
 enum {kNotFound = -1};
};

#endif