InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IBook.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Yeming Liu
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 __IBOOK__
25 #define __IBOOK__
26 
27 #include "BookID.h"
28 
35 class IBook : public IPMUnknown
36 {
37  public:
38  enum { kDefaultIID = IID_IBOOK };
39 
46  typedef enum { kOpenExclusive, kOpenShared} openOptions;
47 
51  virtual void Save() = 0;
52 
58  virtual void SaveAs(const IDFile& destBook) = 0;
59 
65  virtual void SaveACopy(const IDFile& destBook) = 0;
66 
71  virtual bool16 IsModified() = 0;
72 
77  virtual bool16 IsOpen() = 0;
78 
83  virtual void SetOpen(bool16 open) = 0;
84 
89  virtual UID GetMasterDoc() = 0;
90 
95  virtual void SetMasterDoc(UID doc) = 0;
96 
101  virtual IDFile GetBookFileSpec() const = 0;
102 
107  virtual void SetBookFileSpec(const IDFile& name) = 0;
108 
113  virtual PMString GetBookTitleName() const = 0;
114 
119  virtual void SetBookTitleName(const PMString& name) = 0;
120 
125  virtual bool16 IsRecovered() = 0;
126 
131  virtual bool16 IsConverted() = 0;
132 
137  virtual void SetConverted(const bool16& isConverted) = 0;
138 
143  virtual bool16 IsReadOnly() = 0;
144 
149  virtual IBook::openOptions GetOpenOption() = 0;
150 
155  virtual void SetOpenOption(IBook::openOptions option) = 0;
156 
162  virtual uint64 GetSavedTime() = 0;
163 
168  virtual void SetSavedTime(uint64 time) = 0;
169 
176  virtual bool16 GetContentAutoConvertFlag() const = 0;
177 
182  virtual void SetContentAutoConvertFlag(const bool16& bAutoConvert) = 0;
183 
190  virtual bool16 GetMergeLayersFlag() const = 0;
191 
196  virtual void SetMergeLayersFlag(const bool16& bMergeLayers) = 0;
197 
202  virtual int32 GetCreateMajorBuildNumber() const = 0;
203 
208  virtual int32 GetCreateMinorBuildNumber() const = 0;
209 
214  virtual void SetCreateMajorBuildNumber(const int32& majorNumber) = 0;
215 
220  virtual void SetCreateMinorBuildNumber(const int32& minorNumber) = 0;
221 
225  virtual IDTime GetCurrentModificationTime() const = 0;
226 };
227 
228 #endif // __IBOOK__