ILayerList.h

//========================================================================================
// 
// $File$
// 
// Owner: Zak WIlliamson
// 
// $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 __ILAYERLIST__
#define __ILAYERLIST__

#include "IPMUnknown.h"
#include "LayerID.h"


class IDocumentLayer;
class PMString;

class ILayerList : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILAYERLIST };

 enum {
 kAtTheEnd = -1
 };
 

 virtual int32 GetCount() const = 0;

 virtual UID FindByName(const PMString& name) const = 0;
 
 virtual IDocumentLayer * QueryLayer(int32 n) const = 0;

 virtual UIDRef GetLayerUIDRef(int32 n) const = 0;

 virtual int32 GetLayerIndex(const IDocumentLayer * docLayer) const = 0;

 virtual int32 GetLayerIndex(UID layerUID) const = 0;

 virtual void Add(IDocumentLayer * docLayer, int32 pos = kAtTheEnd) = 0;

 virtual void Remove(IDocumentLayer * docLayer) = 0;

 virtual void Move(int32 from, int32 to) = 0;
 
 virtual UIDRef GetNextActiveLayer(const IDocumentLayer * docLayer) const = 0;

 virtual UIDRef GetNextActiveLayer(int32 layerIndex) const = 0;

 virtual void GenerateNewLayerName(PMString* pName, bool16 duplicate = kFalse) = 0;

 virtual UID GetLeastUsedLayerColor() = 0;
};

#endif