#include <PdfDocument.h>
Inheritance diagram for PoDoFo::PdfDocument:
Public Member Functions | |
virtual | ~PdfDocument () |
virtual EPdfWriteMode | GetWriteMode () const =0 |
virtual EPdfVersion | GetPdfVersion () const =0 |
virtual bool | IsLinearized () const =0 |
PdfInfo * | GetInfo () const |
PdfOutlines * | GetOutlines (bool bCreate=ePdfCreateObject) |
PdfNamesTree * | GetNamesTree (bool bCreate=ePdfCreateObject) |
PdfAcroForm * | GetAcroForm (bool bCreate=ePdfCreateObject, PdfAcroForm::EPdfAcroFormDefaulAppearance eDefaultAppearance=PdfAcroForm::ePdfAcroFormDefaultAppearance_BlackText12pt) |
PdfPagesTree * | GetPagesTree () const |
int | GetPageCount () const |
PdfPage * | GetPage (int nIndex) const |
PdfFont * | CreateFont (const char *pszFontName, const PdfEncoding *const pEncoding=PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), PdfFontCache::EFontCreationFlags eFontCreationFlags=PdfFontCache::eFontCreationFlags_AutoSelectBase14, bool bEmbedd=true) |
PdfFont * | CreateFont (const char *pszFontName, bool bBold, bool bItalic, const PdfEncoding *const pEncoding=PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), PdfFontCache::EFontCreationFlags eFontCreationFlags=PdfFontCache::eFontCreationFlags_AutoSelectBase14, bool bEmbedd=true, const char *pszFileName=NULL) |
PdfFont * | CreateFont (FT_Face face, const PdfEncoding *const pEncoding=PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), bool bEmbedd=true) |
PdfFont * | CreateDuplicateFontType1 (PdfFont *pFont, const char *pszSuffix) |
PdfFont * | CreateFontSubset (const char *pszFontName, bool bBold, bool bItalic, const PdfEncoding *const pEncoding=PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), const char *pszFileName=NULL) |
FT_Library | GetFontLibrary () const |
void | EmbedSubsetFonts () |
PdfPage * | CreatePage (const PdfRect &rSize) |
const PdfDocument & | Append (const PdfMemDocument &rDoc, bool bAppendAll=true) |
PdfRect | FillXObjectFromDocumentPage (PdfXObject *pXObj, const PdfMemDocument &rDoc, int nPage, bool bUseTrimBox) |
void | AttachFile (const PdfFileSpec &rFileSpec) |
void | AddNamedDestination (const PdfDestination &rDest, const PdfString &rsName) |
void | SetPageMode (EPdfPageMode inMode) |
EPdfPageMode | GetPageMode (void) const |
void | SetUseFullScreen (void) |
void | SetPageLayout (EPdfPageLayout inLayout) |
void | SetHideToolbar (void) |
void | SetHideMenubar (void) |
void | SetHideWindowUI (void) |
void | SetFitWindow (void) |
void | SetCenterWindow (void) |
void | SetDisplayDocTitle (void) |
void | SetPrintScaling (PdfName &inScalingType) |
void | SetBaseURI (const std::string &inBaseURI) |
void | SetLanguage (const std::string &inLanguage) |
void | SetBindingDirection (PdfName &inDirection) |
virtual bool | IsPrintAllowed () const =0 |
virtual bool | IsEditAllowed () const =0 |
virtual bool | IsCopyAllowed () const =0 |
virtual bool | IsEditNotesAllowed () const =0 |
virtual bool | IsFillAndSignAllowed () const =0 |
virtual bool | IsAccessibilityAllowed () const =0 |
virtual bool | IsDocAssemblyAllowed () const =0 |
virtual bool | IsHighPrintAllowed () const =0 |
PdfVecObjects * | GetObjects () |
const PdfVecObjects * | GetObjects () const |
Protected Member Functions | |
PdfDocument () | |
void | SetInfo (PdfInfo *pInfo) |
PdfObject * | GetCatalog () |
const PdfObject * | GetCatalog () const |
void | SetCatalog (PdfObject *pObject) |
PdfObject * | GetTrailer () |
const PdfObject * | GetTrailer () const |
void | SetTrailer (PdfObject *pObject) |
PdfObject * | GetNamedObjectFromCatalog (const char *pszName) const |
void | InitPagesTree () |
void | FixObjectReferences (PdfObject *pObject, int difference) |
void | SetViewerPreference (const PdfName &whichPref, const PdfObject &valueObj) |
void | SetViewerPreference (const PdfName &whichPref, bool inValue) |
void | Clear () |
PdfDocument provides easy access to the individual pages in the PDF file and to certain special dictionaries.
PdfDocument cannot be used directly. Use PdfMemDocument whenever you want to change the object structure of a PDF file.
When you are only creating PDF files, please use PdfStreamedDocument which is usually faster for creating PDFs.
|
Close down/destruct the PdfDocument |
|
Construct a new (empty) PdfDocument |
|
Adds a PdfDestination into the global Names tree with the specified name, optionally replacing one of the same name
|
|
Appends another PdfDocument to this document
|
|
Attach a file to the document.
|
|
Clear all internal variables And reset PdfDocument to an intial state |
|
Creates a duplicate Type1-PdfFont with a new Id
|
|
Creates a PdfFont object
|
|
Creates a PdfFont object
|
|
Creates a PdfFont object
|
|
Creates a font subset which contains only a few characters and is embedded. THIS WORKS ONLY FOR TTF FONTS!
|
|
Creates a new page object and inserts it into the internal page tree. The returned page is owned by the PdfDocument and will get deleted along with it!
|
|
Embeds all pending subset-fonts, is automatically done on Write(). Just call explicit in case PdfDocument is needed as XObject |
|
Fill an existing empty XObject from a page of another document
|
|
Recursively changes every PdfReference in the PdfObject and in any child that is either an PdfArray or a direct object. The reference is changed so that difference is added to the object number if the reference.
|
|
Get access to the AcroForm dictionary
|
|
Get access to the internal Catalog dictionary or root object.
Reimplemented in PoDoFo::PdfMemDocument. |
|
Get access to the internal Catalog dictionary or root object.
Reimplemented in PoDoFo::PdfMemDocument. |
|
Returns the font library from font cache
|
|
Get access to the internal Info dictionary You can set the author, title etc. of the document using the info dictionary.
|
|
Get a dictioary from the catalog dictionary by its name.
|
|
Get access to the Names dictionary (where all the named objects are stored) The returned PdfNamesTree object is owned by the PdfDocument.
|
|
Get access to the internal vector of objects or root object.
Reimplemented in PoDoFo::PdfMemDocument. |
|
Get access to the internal vector of objects or root object.
Reimplemented in PoDoFo::PdfMemDocument. |
|
Get access to the Outlines (Bookmarks) dictionary The returned outlines object is owned by the PdfDocument.
|
|
Get the PdfPage for a specific page in a document The returned page is owned by the PdfDocument and will get deleted along with it!
|
|
Get the total number of pages in a document
|
|
Gets the opening mode for a document
|
|
Get access to the pages tree. Better use GetPage and CreatePage methods.
|
|
Get the PDF version of the document
Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. |
|
Get access to the internal trailer dictionary or root object.
Reimplemented in PoDoFo::PdfMemDocument. |
|
Get access to the internal trailer dictionary or root object.
|
|
Get the write mode used for wirting the PDF
Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. |
|
Internal method for initializing the pages tree for this document |
|
Checks if it is allowed to extract text and graphics to support users with disabillities Every PDF consuming applications has to adhere this value!
Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. |
|
Checks if text and graphics extraction is allowed. Every PDF consuming applications has to adhere this value!
Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. |
|
Checks if it is allowed to insert, create, rotate, delete pages or add bookmarks Every PDF consuming applications has to adhere this value!
Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. |
|
Checks if modifiying this document (besides annotations, form fields or changing pages) is allowed. Every PDF consuming applications has to adhere this value!
Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. |
|
Checks if it is allowed to add or modify annotations or form fields Every PDF consuming applications has to adhere this value!
Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. |
|
Checks if it is allowed to fill in existing form or signature fields Every PDF consuming applications has to adhere this value!
Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. |
|
Checks if it is allowed to print a high quality version of this document Every PDF consuming applications has to adhere this value!
Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. |
|
Returns wether this PDF document is linearized, aka weboptimized
Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. |
|
Checks if printing this document is allowed. Every PDF consuming applications has to adhere this value!
Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. |
|
Set the document's Viewer Preferences: Set the base URI of the document TODO: DS document value! |
|
Set the document's Viewer Preferences: |
|
Set the catalog of this PdfDocument deleting the old one.
|
|
Set the document's Viewer Preferences: Center the document in the viewers window |
|
Set the document's Viewer Preferences: Display the title from the document information in the title of the viewer.
|
|
Set the document's Viewer Preferences: Fit the document in the viewers window |
|
Set the document's Viewer Preferences: Hide the menubar in the viewer |
|
Set the document's Viewer Preferences: Hide the toolbar in the viewer |
|
Set the document's Viewer Preferences: Show only the documents contents and no controll elements such as buttons and scrollbars in the viewer |
|
Set the info object containing meta information. Deletes any old info object.
|
|
Set the document's Viewer Preferences: Set the language of the document |
|
Sets the page layout for a document |
|
Sets the opening mode for a document
|
|
Set the document's Viewer Preferences: Set the default print scaling of the document TODO: DS use an enum here! |
|
Set the trailer of this PdfDocument deleting the old one.
|
|
Sets the opening mode for a document to be in full screen |
|
Low level APIs for setting a viewer preference Convinience overload.
|
|
Low level APIs for setting a viewer preference
|