#include <IBook.h>
|
| enum | { kDefaultIID = IID_IBOOK } |
| |
| enum | openOptions { kOpenExclusive, kOpenShared } |
| |
This interface is used to save and manage books (kBookBoss). The syntax is similar to IDocument.
kOpenExclusive indicates opening book with a full read/write right; kOpenShared indicates opening book as a copy. Internally, we always choose kOpenShared to prevent from different users open the same book at the same time or at different platform.
| virtual IDFile IBook::GetBookFileSpec | ( | | ) | const |
| pure virtual |
Get the actual book file name in the file system. This contains the full path name.
- Returns
- IDFile of the book file.
| virtual PMString IBook::GetBookTitleName | ( | | ) | const |
| pure virtual |
Get the book title name. This name is used for the title of book panel.
- Returns
- PMString: book title name(not include full path name).
| virtual bool16 IBook::GetContentAutoConvertFlag | ( | | ) | const |
| pure virtual |
Get the flag that determine if we want to do auto convert during during repagination and synchronziation.
- Returns
- bool16: kTrue = do auto convert that override existing documents; kFalse = don't auto convert and bring up save as dialog.
| virtual int32 IBook::GetCreateMajorBuildNumber | ( | | ) | const |
| pure virtual |
Get major build number that book was created.
- Returns
- int32: major build number.
| virtual int32 IBook::GetCreateMinorBuildNumber | ( | | ) | const |
| pure virtual |
Get minor build number that book was created.
- Returns
- int32: minor build number
| virtual IDTime IBook::GetCurrentModificationTime | ( | | ) | const |
| pure virtual |
Returns the current modification time of the book.
- Returns
- the current modification time of the book.
| virtual UID IBook::GetMasterDoc | ( | | ) | |
| pure virtual |
Get UID of doc object for the current master document of the book.
- Returns
- UID of the current master/source document of the book.
| virtual bool16 IBook::GetMergeLayersFlag | ( | | ) | const |
| pure virtual |
Get the flag that determine if we want to merge identically named layers during PDF export.
- Returns
- bool16: kTrue = do merge identically named layers during PDF export; kFalse = don't merge identically named layers during PDF export.
Get the book open options(kOpenExclusive or kOpenShared).
- Returns
- IBook::OpenOptions: see definition of openOptions.
| virtual uint64 IBook::GetSavedTime | ( | | ) | |
| pure virtual |
Get originally saved time when open the book to keep track if other user have modified the book or not before this user want to save.
- Returns
- uint64: time saved before.
| virtual bool16 IBook::IsConverted | ( | | ) | |
| pure virtual |
Check if book is converted or not.
- Returns
- bool16: kTrue if it was; kFalse if it was not.
| virtual bool16 IBook::IsModified | ( | | ) | |
| pure virtual |
Check if book has been modified since the last save or open.
- Returns
- bool16. kTrue = modified; kFalse = not modified.
| virtual bool16 IBook::IsOpen | ( | | ) | |
| pure virtual |
Check if book is open or not.
- Returns
- bool16. kTrue = book is open; kFalse = book is not open
| virtual bool16 IBook::IsReadOnly | ( | | ) | |
| pure virtual |
Check if the book is a read only file or not.
- Returns
- bool16: kTrue if it is a read only; kFalse if it is not.
| virtual bool16 IBook::IsRecovered | ( | | ) | |
| pure virtual |
Check if book is recovered or not.
- Returns
- bool16: kTrue if it was; kFalse if it was not.
| virtual void IBook::Save | ( | | ) | |
| pure virtual |
| virtual void IBook::SaveACopy | ( | const IDFile & | destBook | ) | |
| pure virtual |
Save book to the IDFile provided. If there is already a file with the same name, it is first deleted. Leaves the book open and targeted to the CURRENT file.
- Parameters
| const | IDFile& destBook: The file to save to. |
| virtual void IBook::SaveAs | ( | const IDFile & | destBook | ) | |
| pure virtual |
Save book to the IDFile provided. If there is already a file with the same name, it is first deleted, leaves the book open and targeted to the SAVED-TO file.
- Parameters
| const | IDFile& destBook: The file to save to. |
| virtual void IBook::SetBookFileSpec | ( | const IDFile & | name | ) | |
| pure virtual |
Set the actual book file name when we do SaveAs
- Parameters
| const | IDFile&: name of the book file. |
| virtual void IBook::SetBookTitleName | ( | const PMString & | name | ) | |
| pure virtual |
Set the book title name.
- Parameters
| const | PMString&: name of the book title(not include full path name). |
| virtual void IBook::SetContentAutoConvertFlag | ( | const bool16 & | bAutoConvert | ) | |
| pure virtual |
Set the flag for doing auto convert or not during repagination and synchronization.
- Parameters
| bool16,: | kTrue/kFalse for auto convert or not. |
| virtual void IBook::SetConverted | ( | const bool16 & | isConverted | ) | |
| pure virtual |
Set the convertion flag.
- Parameters
| const | bool16&: pass kTrue if it was converted; kFalse if it was not. |
| virtual void IBook::SetCreateMajorBuildNumber | ( | const int32 & | majorNumber | ) | |
| pure virtual |
Set the major format number that this book is saved to.
- Parameters
| majorNumber,: | major format number. |
| virtual void IBook::SetCreateMinorBuildNumber | ( | const int32 & | minorNumber | ) | |
| pure virtual |
Set the minor format number that this book is saved to.
- Parameters
| minorNumber,: | minor format number. |
| virtual void IBook::SetMasterDoc | ( | UID | doc | ) | |
| pure virtual |
Set the document as the current master document of the book.
- Parameters
| UID,: | UID of the document.This is a UID of book content, not the UID of document itself. |
| virtual void IBook::SetMergeLayersFlag | ( | const bool16 & | bMergeLayers | ) | |
| pure virtual |
Set the flag for merging identically named layers during PDF export.
- Parameters
| bool16,: | kTrue/kFalse for merging layers or not. |
| virtual void IBook::SetOpen | ( | bool16 | open | ) | |
| pure virtual |
Set the open parameter.
- Parameters
| bool16. | Pass kTrue if it is open or kFalse if it is no. |
Set the open option of the book.
- Parameters
| virtual void IBook::SetSavedTime | ( | uint64 | time | ) | |
| pure virtual |
Set the new time.
- Parameters
| uint64,: | time that the book is saved. |
Public Member Functions inherited from IPMUnknown
1.8.3.1 
