#include <IS4SPPackageBook.h>
|
| enum | PackageRC {
kPackageOK, kPackageCancelled, kPackageBadPreflight, kPackageCantCreateFolder,
kPackageCantCopyFonts, kPackageCantCopyProfiles, kPackageCantCopyLinks, kPackageCantCopyPub,
kPackageCantUpdateLinks, kPackageCantRestoreLinks, kPackageCantDoHyphExceptions, kPackageUnknownError,
kPackageIDMLError, kPackageIDMLErrorPDFError, kPackageIDMLErrorPDFAlerts, kPackagePDFAlerts,
kPackagePDFError
} |
| |
This interface is used to Package a book
- See Also
- IS4SPPackage
Identifiers that uniquely identify all packaging related messages or error messgaes while packaging. Clients also use these identifiers to know the relevant state while packaging.
| virtual bool16 IS4SPPackageBook::GetCopyFontsFlag | ( | | ) | |
| pure virtual |
The accessor for getting the preference on copying fonts
- Returns
- bool16: kTrue if copying of Fonts flag is set, kFalse otherwise
| virtual bool16 IS4SPPackageBook::GetCopyGLinksFlag | ( | | ) | |
| pure virtual |
The accessor for getting the preference on copying the links
- Returns
- bool16: kTrue if copying of link flag is set, kFalse otherwise
| virtual bool16 IS4SPPackageBook::GetCreateIDMLFlag | ( | | ) | |
| pure virtual |
The accessor for getting the preference on whether to generate IDML while packaging
- Returns
- bool16: kTrue if the flag is set, kFalse otherwise
| virtual bool16 IS4SPPackageBook::GetCreatePDFFlag | ( | | ) | |
| pure virtual |
The accessor for getting the preference on whether to genereate PDF while packaging
- Returns
- bool16: kTrue if the flag is set, kFalse otherwise
| virtual IDocument* IS4SPPackageBook::GetCurrentDocument | ( | | ) | const |
| pure virtual |
This function is used to retrieve the pointer to the document that we are currently packaging for the parent book.
- Returns
- IDocument*: returns the document pointer to package
This function is used get the list of font files to be packaged.
- Returns
- K2Vector<IDFile>* : returns the font list
| virtual bool16 IS4SPPackageBook::GetFullBookPackageFlag | ( | | ) | const |
| pure virtual |
This function is used in case if we want to package the entire book irrespective of the no. of documents selected in the Book panel.
- Returns
- bool16 : kTrue if all the documents in the book needs to be packaged, kFalse otherwise.
| virtual bool16 IS4SPPackageBook::GetHiddenLayersFlag | ( | | ) | |
| pure virtual |
The accessor for getting the preference on whether to include fonts and links from hidden document layers
- Returns
- bool16: kTrue if the flag is set, kFalse otherwise
| virtual bool16 IS4SPPackageBook::GetHyphExceptionsFlag | ( | | ) | |
| pure virtual |
The accessor for getting the preference on whether to use the document hyphenation exceptions only while packaging.
- Returns
- bool16: kTrue if the flag is set, kFalse otherwise
This function is used get the list of the graphic links to be packaged.
- Returns
- K2Vector<IDFile>* : returns the graphics links list
| virtual const IDFile* IS4SPPackageBook::GetPackageLocation | ( | | ) | |
| pure virtual |
The accessor for getting the packaging location
- Returns
- IDFile*, pointer to IDFile
| virtual IBook* IS4SPPackageBook::GetParentBook | ( | | ) | |
| pure virtual |
This function is used to retrieve the pointer to the Book that we are interested in packaging.
- Returns
- IBook*: returns the book pointer to package
| virtual K2Vector<IDFile>* IS4SPPackageBook::GetProfileFilePackageList | ( | | ) | |
| pure virtual |
This function is used get the list of ICC Profiles to be packaged.
- Returns
- K2Vector<IDFile>* : returns the profiles list
This function is used get the list of documents (pubs) in the book to be packaged.
- Returns
- K2Vector<IDFile>* : returns the profiles list
| virtual K2Vector<int32>* IS4SPPackageBook::GetSizeList | ( | | ) | |
| pure virtual |
This function is used get the size each documents in the book to be packaged.
- Returns
- K2Vector<int32>* : returns the profiles list
| virtual bool16 IS4SPPackageBook::GetUpdateGLinksFlag | ( | | ) | |
| pure virtual |
The accessor for getting the preference on updating graphic links in package
- Returns
- bool16: kTrue if the flag is set, kFalse otherwise
| virtual bool16 IS4SPPackageBook::GetViewReportFlag | ( | | ) | |
| pure virtual |
The accessor for getting the preference on whether to view the packaging report
- Returns
- bool16: kTrue if the flag is set, kFalse otherwise
| virtual bool16 IS4SPPackageBook::Init | ( | const IBook * | f_iBook | ) | |
| pure virtual |
Used to initializes the packaging API object for the given Book.
- Parameters
| const | IBook* : IN IBook pointer to be used for packaging |
- Returns
- bool16: returns KTrue,if this object is valid else kFalse
| virtual PackageRC IS4SPPackageBook::PhysicalPackage | ( | | ) | |
| pure virtual |
The function that basically does the packaging function for a book (that basically has multiple documents contained in it). It creates all necessary packaging directories and then copies all necessary files into the correspondent directories, updates all links that have to be updated in the packaged publication, while keeping links untouched in the orginal one.
- Returns
- PackageRC: One of the packaging error messages
- See Also
- PackageRC
| virtual void IS4SPPackageBook::SetCopyFontsFlag | ( | bool16 | in_flag | ) | |
| pure virtual |
The accessor for setting the preference on copying fonts
- Parameters
| bool16,: | IN kTrue to set the flag for copying of Fonts, kFalse otherwise |
| virtual void IS4SPPackageBook::SetCopyGLinksFlag | ( | bool16 | in_flag | ) | |
| pure virtual |
The accessor for setting the preference on copying linked Graphics
- Parameters
| bool16,: | IN kTrue to set the flag for copying of Linked graphics, kFalse otherwise |
| virtual void IS4SPPackageBook::SetCreateIDMLFlag | ( | bool16 | in_flag | ) | |
| pure virtual |
The accessor for setting the preference on whether to generate IDML while packaging
- Parameters
| bool16 | :IN kTrue to set the flag, kFalse otherwise |
| virtual void IS4SPPackageBook::SetCreatePDFFlag | ( | bool16 | in_flag | ) | |
| pure virtual |
The accessor for setting the preference on whether to generate PDF while packaging
- Parameters
| bool16 | :IN kTrue to set the flag, kFalse otherwise |
| virtual void IS4SPPackageBook::SetFullBookPackageFlag | ( | bool16 | in_flag | ) | |
| pure virtual |
This setter function is used in case if we want to package the entire book irrespective of the no. of documents selected in the Book panel.
- Parameters
| bool16 | : IN kTrue if all the documents in the book needs to be packaged, kFalse otherwise. |
| virtual void IS4SPPackageBook::SetHiddenLayersFlag | ( | bool16 | in_flag | ) | |
| pure virtual |
The accessor for setting the preference on whether to include fonts and links from hidden document layers
- Parameters
| bool16,: | IN kTrue to set the flag, kFalse otherwise |
| virtual void IS4SPPackageBook::SetHyphExceptionsFlag | ( | bool16 | in_flag | ) | |
| pure virtual |
The accessor for setting the preference on whether to use the document hyphenation exceptions only while packaging.
- Parameters
| bool16,: | IN kTrue to set the flag, kFalse otherwise |
| virtual void IS4SPPackageBook::SetPackageLocation | ( | const IDFile & | in_Location | ) | |
| pure virtual |
The accessor for setting the packaging location
- Parameters
| const | IDFile&: IN packaging location |
| virtual void IS4SPPackageBook::SetUpdateGLinksFlag | ( | bool16 | in_flag | ) | |
| pure virtual |
The accessor for setting the preference on updating graphic links in package
- Parameters
| bool16,: | IN kTrue to set the flag for updating the graphic links, kFalse otherwise |
| virtual void IS4SPPackageBook::SetViewReportFlag | ( | bool16 | in_flag | ) | |
| pure virtual |
The accessor for setting the preference on whether to view the packaging report
- Parameters
| bool16 | :IN kTrue to set the flag, kFalse otherwise |
| virtual void IS4SPPackageBook::ViewReport | ( | | ) | |
| pure virtual |
The function that is called when we want to the view the generated packaging report
Public Member Functions inherited from IPMUnknown
1.8.3.1 
