InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPSDLayerCompInfo.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: David Berggren
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //
23 // Purpose:
24 // Stores info about layers comp information from a placed PSD (native Photoshop) graphic
25 //
26 //========================================================================================
27 
28 #ifndef __IPSDLayerCompInfo__
29 #define __IPSDLayerCompInfo__
30 
31 #include "IPMUnknown.h"
32 #include "KeyValuePair.h"
33 #include "K2Vector.h"
34 #include "PSFilterID.h"
35 #include "PMString.h"
36 
40 typedef KeyValuePair<long, bool16> LayerVisibilityPair;
44 typedef K2Vector<LayerVisibilityPair> LayerVisibilityList;
45 
50 class IPSDLayerCompInfo : public IPMUnknown
51 {
52 public:
53  enum { kDefaultIID = IID_IPSDLAYERCOMPINFO };
54 
58  enum {
61  kCustomLayerCompID = -2,
62 
65  kLastDocStateCompID = -1
66  };
67 
70  virtual void Clear ( ) = 0;
75  virtual void Copy(const IPSDLayerCompInfo* srcCompInfo) = 0;
81  virtual void Preallocate ( int32 numberComps ) = 0;
91  virtual void InsertLayerComp ( const PMString& layerCompName,
92  const PMString& layerCompComment,
93  int32 layerCompID,
94  LayerVisibilityList& layerVisibilityList
95  ) = 0;
105  virtual void AppendLayerComp ( const PMString& layerCompName,
106  const PMString& layerCompComment,
107  int32 layerCompID,
108  LayerVisibilityList& layerVisibilityList
109  ) = 0;
113  virtual void RemoveLayerComp ( int32 layerCompID ) = 0;
119  virtual bool16 ValidateLayerComp(const IPSDLayerCompInfo* srcCompInfo) = 0;
124  virtual bool16 LayerCompChanged() const = 0;
125 
129  virtual void SetOriginalLastAppliedCompID ( int32 layerCompID ) = 0;
133  virtual void SetCurrentLastAppliedCompID ( int32 layerCompID ) = 0;
134 
139  virtual int32 GetNumberLayerComps( ) const = 0;
140 
145  virtual PMString GetLayerCompName ( int32 layerCompID ) const = 0;
150  virtual PMString GetNthLayerCompName ( int32 index ) const = 0;
155  virtual PMString GetLayerCompComment ( int32 layerCompID ) const = 0;
160  virtual PMString GetNthLayerCompComment ( int32 index ) const = 0;
166  virtual LayerVisibilityList GetLayerCompVisibilityList ( int32 layerCompID ) const = 0;
172  virtual LayerVisibilityList GetNthLayerCompVisibilityList ( int32 index ) const = 0;
177  virtual int32 GetLayerCompIndex ( int32 layerCompID ) const = 0;
182  virtual int32 GetNthLayerCompID ( int32 index ) const = 0;
183 
188  virtual int32 GetOriginalLastAppliedCompID ( ) const = 0;
193  virtual int32 GetCurrentLastAppliedCompID ( ) const = 0;
194 };
195 
196 #endif