IDocumentLayer.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.
// 
// 
// Describes the attributes of a document wide layer
// 
//========================================================================================

#ifndef __IDOCUMENTLAYER__
#define __IDOCUMENTLAYER__

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

class PMString;

class IDocumentLayer : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IDOCUMENTLAYER };

 typedef enum {
 kDoNotIgnore = 0,
 kIgnore = 1,
 kLeaveUnchanged = 2
 } IgnoreEnum;

 virtual void GetName(PMString * pName) const = 0;

 virtual const PMString& GetName() const = 0;

 virtual void SetName(const PMString& newName) = 0;

 virtual const UID& GetColorUID() const = 0;


 virtual void SetColorUID(const UID &newColor) = 0;

 virtual bool16 IsLocked() const = 0;

 // set the lock attribute this layer

 virtual void SetLocked(bool16 active) = 0;
 

 virtual bool16 IsVisible() const = 0;
 
 virtual void SetVisible(bool16 visible) = 0;
 
 virtual bool16 IsPrintable() const= 0;
 
 virtual void SetPrintable(bool16 print) = 0;
 
 virtual bool16 IsGuideLocked() const= 0;

 virtual void SetGuideLocked(bool16 active) = 0;
 
 virtual bool16 IsGuideVisible() const= 0;
 
 virtual void SetGuideVisible(bool16 visible) = 0;
 
 virtual bool16 IsUILayer() const = 0;

 virtual void SetUILayer(bool16 uiLayer) = 0;
 
 virtual bool16 IsExpendableLayer() const = 0;

 virtual void SetExpendableLayer(bool16 expendableLayer) = 0;

 virtual void SetIgnoreTextWrapWhenNotVisible(bool16 bIgnoreWhenNotVisible) = 0;

 virtual bool16 GetIgnoreTextWrapWhenNotVisible(void) const = 0;
};

#endif