InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ISectionCmdData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Tommy Donovan
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 __ISECTIONCMDDATA__
25 #define __ISECTIONCMDDATA__
26 
27 #include "IPMUnknown.h"
28 #include "ISection.h"
29 
30 class PMString;
31 
38 {
39 public:
40  enum { kDefaultIID = IID_ISECTIONCMDDATA };
41 
52  virtual void Set(const UIDRef& sectionList,
53  UID startPageUID = kInvalidUID,
54  int32 startPageNumber = 1,
55  const PMString *name = nil,
56  const PMString *marker = nil,
57  ClassID styleProviderClassID = kInvalidClass,
58  bool16 bContinueFromPrevSection = kTrue,
59  int32 offsetFromPrevSection = 0) = 0;
60 
64  virtual const UIDRef& GetSectionList() = 0;
65 
69  virtual UID GetStartPageUID() = 0;
70 
74  virtual int32 GetStartPageNumber() = 0;
75 
79  virtual const PMString& GetName() = 0;
80 
84  virtual const PMString& GetMarker() = 0;
85 
90  virtual void GetStyleInfo(ClassID* styleProviderClassID) = 0;
91 
95  virtual bool16 GetContinueFromPrevSection() = 0;
96 
100  virtual int32 GetOffsetFromPrevSection() = 0;
101 
107  virtual const bool16& GetPageNumberIncludeSectionPrefix() = 0;
108 
112  virtual void SetPageNumberIncludeSectionPrefix(const bool16& includeSectionPrefix) = 0;
113 
117  virtual const PMString& GetNamedLayout() = 0;
118 
122  virtual void SetNamedLayout(const PMString* pNamedLayout) = 0;
123 
130 
136  virtual void SetPaginationOption(ISection::PaginationOption option) = 0;
137 
142  virtual UID GetPaginationMaster() = 0;
143 
148  virtual void SetPaginationMaster(UID masterUID) = 0;
149 
153  virtual const bool16& GetNotifyFlag() = 0;
154 
158  virtual void SetNotifyFlag(const bool16& notify = kTrue) = 0;
159 
163  virtual void CopyFrom(ISection* section) = 0;
164 
168  virtual void SetStartPageUID(const UID startPageUID) = 0;
169 
170 };
171 
172 
173 #endif // __ISECTIONCMDDATA__