IGraphicLayerInfo.h

//========================================================================================
// 
// $File$
// 
// Owner: David Berggren
// 
// $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:
// Stores info about layers read in from a placed graphic (i.e. PSD or AI file)
// Assumes layer names are unique
// 
//========================================================================================

#ifndef __IGraphicLayerInfo__
#define __IGraphicLayerInfo__

#include "IPMUnknown.h"
#include "ImageID.h"
#include "PMString.h"

class IGraphicLayerInfo : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IGRAPHICLAYERINFO };

 typedef enum
 {
 kUnknownLinkOption = 0,

 kUseApplicationSettings,

 kKeepOverrides

 } UpdateLinkOption;

 typedef enum
 {
 kNoFlags = 0,

 kNeedsValidation = (1L << 1),

 kValidationFailed = (1L << 2),

 kValidationNewLayersAdded = (1L << 3),

 kInternalUseOnly = (1L << 28)

 } GraphicLayerFlags;

 typedef enum
 {
 kVisibilityHidden,
 kVisibilityShowing,
 kVisibilityUnknown

 } GraphicVisibilityState;

 typedef enum
 {
 kNoAttributes = 0,

 kLayerSeparator = (1L << 0),

 kLayerAdjustment = (1L << 1),

 kLayerHasFX = (1L << 2),

 kLayerIsLocked = (1L << 3),

 kLayerHasViewState = (1L << 4),

 kLayerViewStateON = (1L << 5),

 kLayerHasExportState = (1L << 6),

 kLayerExportStateON = (1L << 7),

 kLayerHasPrintState = (1L << 8),

 kLayerPrintStateON = (1L << 9),

 kLayerSectionDivider = (1L << 10),

 kLayerIsTextLayer = (1L << 11)

 } LayerAttributes;

 // ***********************
 // Set methods for interface
 // ***********************

 virtual void SetIsInitialized (bool16 bIsInitialized) = 0;
 virtual void SetUpdateLinkOption (const UpdateLinkOption newOption) = 0;
 virtual void SetGraphicLayerFlags (const GraphicLayerFlags newFlags) = 0;

 // ***********************
 // Get methods for interface
 // ***********************

 virtual bool16 GetIsInitialized () const = 0;
 virtual UpdateLinkOption GetUpdateLinkOption () const = 0;
 virtual GraphicLayerFlags GetGraphicLayerFlags () const = 0;

 // ***********************
 // Add/Remove/Copy/Utilities methods for layers
 // ***********************

 virtual void InsertLayer ( const PMString& layerName, 
 int32 layerUniqueID,
 const GraphicVisibilityState origVisState,
 int32 parentID = -1,
 const LayerAttributes layerAttributes = kNoAttributes
 ) = 0;

 virtual void AppendLayer ( const PMString& layerName, 
 int32 layerUniqueID,
 const GraphicVisibilityState origVisState,
 int32 parentID = -1,
 const LayerAttributes layerAttributes = kNoAttributes
 ) = 0;

 virtual void RemoveNthLayer (int32 layerIndex) = 0;
 virtual void RemoveLayer (int32 layerUniqueID) = 0;

 virtual void Clear() = 0;
 virtual void Copy(const IGraphicLayerInfo* srcLayerInfo) = 0;
 virtual bool16 CompareAll(const IGraphicLayerInfo* otherLayerInfo) const = 0;
 virtual bool16 CompareVisibility(const IGraphicLayerInfo* otherLayerInfo) const = 0;
 virtual bool16 ValidateGraphicLayers(const IGraphicLayerInfo* srcLayerInfo) = 0;
 virtual bool16 VisibilityChanged() const = 0;
 virtual void ResetLayerVisiblity() = 0;
 virtual void Preallocate(int32 preallocSize) = 0;

 // ***********************
 // Set methods for each layer
 // ***********************

 virtual void SetNthLayerName (int32 layerIndex, const PMString& newName) = 0;
 virtual void SetLayerName (int32 layerUniqueID, const PMString& newName) = 0;

 virtual void SetNthLayerUniqueID (int32 layerIndex, int32 newID) = 0;

 virtual void SetNthLayerOriginalVisibility (int32 layerIndex, const GraphicVisibilityState newState) = 0;
 virtual void SetLayerOriginalVisibility (int32 layerUniqueID, const GraphicVisibilityState newState) = 0;

 virtual void SetNthLayerCurrentVisibility (int32 layerIndex, const GraphicVisibilityState newState) = 0;
 virtual void SetLayerCurrentVisibility (int32 layerUniqueID, const GraphicVisibilityState newState) = 0;

 virtual void SetNthLayerParentID (int32 layerIndex, int32 newParentID) = 0;
 virtual void SetLayerParentID (int32 layerUniqueID, int32 newParentID) = 0;

 virtual void SetNthLayerAttributes (int32 layerIndex, const LayerAttributes newAttributes) = 0;
 virtual void SetLayerAttributes (int32 layerUniqueID, const LayerAttributes newAttributes) = 0;

 // ***********************
 // Get methods
 // ***********************

 virtual int32 GetNumberLayers () const = 0;

 virtual PMString GetNthLayerName (int32 layerIndex) const = 0;
 virtual PMString GetLayerName (int32 layerUniqueID) const = 0;

 virtual int32 GetNthLayerUniqueID (int32 layerIndex) const = 0;
 virtual int32 GetLayerIndex (int32 layerUniqueID) const = 0;
 
 virtual GraphicVisibilityState GetNthLayerOriginalVisibility (int32 layerIndex) const = 0;
 virtual GraphicVisibilityState GetLayerOriginalVisibility (int32 layerUniqueID) const = 0;

 virtual GraphicVisibilityState GetNthLayerCurrentVisibility (int32 layerIndex) const = 0;
 virtual GraphicVisibilityState GetLayerCurrentVisibility (int32 layerUniqueID) const = 0;

 virtual int32 GetNthLayerParentID (int32 layerIndex) const = 0;
 virtual int32 GetLayerParentID (int32 layerUniqueID) const = 0;

 virtual LayerAttributes GetNthLayerAttributes (int32 layerIndex) const = 0;
 virtual LayerAttributes GetLayerAttributes (int32 layerUniqueID) const = 0;

 virtual bool16 ValidateGraphicLayersByName(const IGraphicLayerInfo* srcLayerInfo) = 0;

 virtual void SetLayerVisibilityFromSource(const IGraphicLayerInfo* srcLayerInfo, GraphicVisibilityState newLayersState, bool16& hasNewLayers) = 0;
};

#endif