InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ISpreadList.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Robin_Briggs
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 
24 #ifndef __ISPREADLIST__
25 #define __ISPREADLIST__
26 
27 #include "IPMUnknown.h"
28 #include "SpreadID.h"
29 
30 class IGeometry;
31 class UIDList;
32 class IIterator;
33 
48 class ISpreadList : public IPMUnknown
49 {
50 public:
51  enum { kDefaultIID = IID_ISPREADLIST };
52 
53  enum { kAtTheEnd = -1 };
54 
61  virtual void InsertSpreads(const UIDList& spreadToInsert, int32 posForInsert) = 0;
62 
69  virtual void InsertOneSpread(const UID spreadToInsert, int32 posForInsert) = 0;
70 
71 
78  virtual void RemoveSpreads(int32 firstIndex, int32 count) = 0;
79 
85  virtual void RemoveOneSpread(int32 posForRemove) = 0;
86 
87 
98  virtual void MoveSpread(int32 from, int32 to) = 0;
99 
107  virtual IGeometry * QueryNthSpread(int32 spreadIndex) = 0;
108 
115  virtual UID GetNthSpreadUID(int32 spreadIndex) = 0;
116 
122  virtual int32 GetSpreadCount() const = 0;
123 
130  virtual int32 GetSpreadIndex(IGeometry * spread) = 0;
131 
138  virtual int32 GetSpreadIndex(UID spreadUID) = 0;
139 
140 
148  virtual IIterator *NewPageIterator() = 0;
149 };
150 
151 
152 #endif // __ISPREADLIST__
153