#include <PdfMemDocument.h>
Public Member Functions | |
PdfMemDocument () | |
PdfMemDocument (const char *pszFilename) | |
virtual | ~PdfMemDocument () |
void | Load (const char *pszFilename) |
void | Load (const char *pBuffer, long lLen) |
void | Load (const PdfRefCountedInputDevice &rDevice) |
void | Write (const char *pszFilename) |
void | Write (PdfOutputDevice *pDevice) |
void | SetPdfVersion (EPdfVersion eVersion) |
EPdfVersion | GetPdfVersion () const |
void | SetPassword (const std::string &sPassword) |
void | SetEncrypted (const std::string &userPassword, const std::string &ownerPassword, int protection=PdfEncrypt::ePdfPermissions_Print|PdfEncrypt::ePdfPermissions_Edit|PdfEncrypt::ePdfPermissions_Copy|PdfEncrypt::ePdfPermissions_EditNotes|PdfEncrypt::ePdfPermissions_FillAndSign|PdfEncrypt::ePdfPermissions_Accessible|PdfEncrypt::ePdfPermissions_DocAssembly|PdfEncrypt::ePdfPermissions_HighPrint, PdfEncrypt::EPdfEncryptAlgorithm eAlgorithm=PdfEncrypt::ePdfEncryptAlgorithm_RC4V1, PdfEncrypt::EPdfKeyLength eKeyLength=PdfEncrypt::ePdfKeyLength_40) |
void | SetEncrypted (const PdfEncrypt &pEncrypt) |
bool | GetEncrypted () const |
bool | IsLinearized () const |
const PdfVecObjects & | GetObjects () const |
PdfVecObjects & | GetObjects () |
PdfObject * | GetCatalog () |
const PdfObject * | GetCatalog () const |
const PdfObject * | GetTrailer () const |
PdfObject * | GetStructTreeRoot () const |
PdfObject * | GetMetadata () const |
PdfFont * | GetFont (PdfObject *pObject) |
const PdfMemDocument & | InsertPages (const PdfMemDocument &rDoc, int inFirstPage, int inNumPages) |
void | DeletePages (int inFirstPage, int inNumPages) |
virtual bool | IsPrintAllowed () const |
virtual bool | IsEditAllowed () const |
virtual bool | IsCopyAllowed () const |
virtual bool | IsEditNotesAllowed () const |
virtual bool | IsFillAndSignAllowed () const |
virtual bool | IsAccessibilityAllowed () const |
virtual bool | IsDocAssemblyAllowed () const |
virtual bool | IsHighPrintAllowed () const |
void | FreeObjectMemory (const PdfReference &rRef, bool bForce=false) |
void | FreeObjectMemory (PdfObject *pObj, bool bForce=false) |
PdfMemDocument is the core class for reading and manipulating PDF files and writing them back to disk.
PdfMemDocument was designed to allow easy access to the object structur of a PDF file.
PdfMemDocument should be used 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.
PoDoFo::PdfMemDocument::PdfMemDocument | ( | ) |
Construct a new (empty) PdfMemDocument
PoDoFo::PdfMemDocument::PdfMemDocument | ( | const char * | pszFilename | ) |
Construct a PdfMemDocument from an existing PDF (on disk)
pszFilename | filename of the file which is going to be parsed/opened |
This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case.
PoDoFo::PdfMemDocument::~PdfMemDocument | ( | ) | [virtual] |
Close down/destruct the PdfMemDocument
void PoDoFo::PdfMemDocument::DeletePages | ( | int | inFirstPage, | |
int | inNumPages | |||
) |
Deletes one or more pages from this document
inFirstPage | the first page number to delete (0-based) | |
inNumPages | the number of pages to delete |
void PoDoFo::PdfMemDocument::FreeObjectMemory | ( | PdfObject * | pObj, | |
bool | bForce = false | |||
) |
Tries to free all memory allocated by the given PdfObject (variables and streams) and reads it from disk again if it is requested another time.
This will only work if load on demand is used. Other- wise any call to this method will be ignored. Load on demand is currently always enabled when using PdfMemDocument. If the object is dirty if will not be free'd.
pObj | free object from memory | |
bForce | if true the object will be free'd even if IsDirty() returns true. So you will loose any changes made to this object. |
void PoDoFo::PdfMemDocument::FreeObjectMemory | ( | const PdfReference & | rRef, | |
bool | bForce = false | |||
) |
Tries to free all memory allocated by the given PdfObject (variables and streams) and reads it from disk again if it is requested another time.
This will only work if load on demand is used. Other- wise any call to this method will be ignored. Load on demand is currently always enabled when using PdfMemDocument. If the object is dirty if will not be free'd.
rRef | free all memory allocated by the object with this reference. | |
bForce | if true the object will be free'd even if IsDirty() returns true. So you will loose any changes made to this object. |
This is an overloaded member for your convinience.
const PdfObject* PoDoFo::PdfMemDocument::GetCatalog | ( | ) | const [inline] |
Get access to the internal Catalog dictionary or root object.
Reimplemented from PoDoFo::PdfDocument.
PdfObject* PoDoFo::PdfMemDocument::GetCatalog | ( | ) | [inline] |
Get access to the internal Catalog dictionary or root object.
Reimplemented from PoDoFo::PdfDocument.
bool PoDoFo::PdfMemDocument::GetEncrypted | ( | ) | const [inline] |
Creates a PdfFont object from an existing font.
pObject | a PdfObject that is a font |
PdfObject* PoDoFo::PdfMemDocument::GetMetadata | ( | ) | const [inline] |
Get access to the Metadata stream
PdfVecObjects& PoDoFo::PdfMemDocument::GetObjects | ( | ) | [inline] |
Get a reference to the sorted internal objects vector. This is an overloaded function for your convinience.
Reimplemented from PoDoFo::PdfDocument.
const PdfVecObjects& PoDoFo::PdfMemDocument::GetObjects | ( | ) | const [inline] |
Get a reference to the sorted internal objects vector.
Reimplemented from PoDoFo::PdfDocument.
EPdfVersion PoDoFo::PdfMemDocument::GetPdfVersion | ( | ) | const [inline, virtual] |
Get the PDF version of the document
Implements PoDoFo::PdfDocument.
PdfObject* PoDoFo::PdfMemDocument::GetStructTreeRoot | ( | ) | const [inline] |
Get access to the StructTreeRoot dictionary
const PdfObject* PoDoFo::PdfMemDocument::GetTrailer | ( | ) | const [inline] |
Get the trailer dictionary which can be written unmodified to a pdf file.
Reimplemented from PoDoFo::PdfDocument.
const PdfMemDocument & PoDoFo::PdfMemDocument::InsertPages | ( | const PdfMemDocument & | rDoc, | |
int | inFirstPage, | |||
int | inNumPages | |||
) |
Copies one or more pages from another PdfMemDocument to this document
rDoc | the document to append | |
inFirstPage | the first page number to copy (0-based) | |
inNumPages | the number of pages to copy |
bool PoDoFo::PdfMemDocument::IsAccessibilityAllowed | ( | ) | const [inline, virtual] |
Checks if it is allowed to extract text and graphics to support users with disabillities Every PDF consuming applications has to adhere this value!
Implements PoDoFo::PdfDocument.
bool PoDoFo::PdfMemDocument::IsCopyAllowed | ( | ) | const [inline, virtual] |
Checks if text and graphics extraction is allowed. Every PDF consuming applications has to adhere this value!
Implements PoDoFo::PdfDocument.
bool PoDoFo::PdfMemDocument::IsDocAssemblyAllowed | ( | ) | const [inline, virtual] |
Checks if it is allowed to insert, create, rotate, delete pages or add bookmarks Every PDF consuming applications has to adhere this value!
Implements PoDoFo::PdfDocument.
bool PoDoFo::PdfMemDocument::IsEditAllowed | ( | ) | const [inline, virtual] |
Checks if modifiying this document (besides annotations, form fields or changing pages) is allowed. Every PDF consuming applications has to adhere this value!
Implements PoDoFo::PdfDocument.
bool PoDoFo::PdfMemDocument::IsEditNotesAllowed | ( | ) | const [inline, virtual] |
Checks if it is allowed to add or modify annotations or form fields Every PDF consuming applications has to adhere this value!
Implements PoDoFo::PdfDocument.
bool PoDoFo::PdfMemDocument::IsFillAndSignAllowed | ( | ) | const [inline, virtual] |
Checks if it is allowed to fill in existing form or signature fields Every PDF consuming applications has to adhere this value!
Implements PoDoFo::PdfDocument.
bool PoDoFo::PdfMemDocument::IsHighPrintAllowed | ( | ) | const [inline, virtual] |
Checks if it is allowed to print a high quality version of this document Every PDF consuming applications has to adhere this value!
Implements PoDoFo::PdfDocument.
bool PoDoFo::PdfMemDocument::IsLinearized | ( | ) | const [inline, virtual] |
Returns wether this PDF document is linearized, aka weboptimized
Implements PoDoFo::PdfDocument.
bool PoDoFo::PdfMemDocument::IsPrintAllowed | ( | ) | const [inline, virtual] |
Checks if printing this document is allowed. Every PDF consuming applications has to adhere this value!
Implements PoDoFo::PdfDocument.
void PoDoFo::PdfMemDocument::Load | ( | const PdfRefCountedInputDevice & | rDevice | ) |
Load a PdfMemDocument from a PdfRefCountedInputDevice
rDevice | the input device containing the PDF |
This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case.
void PoDoFo::PdfMemDocument::Load | ( | const char * | pBuffer, | |
long | lLen | |||
) |
Load a PdfMemDocument from a buffer in memory
pBuffer | a memory area containing the PDF data | |
lLen | length of the buffer |
This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case.
void PoDoFo::PdfMemDocument::Load | ( | const char * | pszFilename | ) |
Load a PdfMemDocument from a file
pszFilename | filename of the file which is going to be parsed/opened |
This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case.
void PoDoFo::PdfMemDocument::SetEncrypted | ( | const PdfEncrypt & | pEncrypt | ) |
Encrypt the document during writing using a PdfEncrypt object
pEncrypt | an encryption object that will be owned by PdfMemDocument |
void PoDoFo::PdfMemDocument::SetEncrypted | ( | const std::string & | userPassword, | |
const std::string & | ownerPassword, | |||
int | protection = PdfEncrypt::ePdfPermissions_Print | PdfEncrypt::ePdfPermissions_Edit | PdfEncrypt::ePdfPermissions_Copy | PdfEncrypt::ePdfPermissions_EditNotes | PdfEncrypt::ePdfPermissions_FillAndSign | PdfEncrypt::ePdfPermissions_Accessible | PdfEncrypt::ePdfPermissions_DocAssembly | PdfEncrypt::ePdfPermissions_HighPrint , |
|||
PdfEncrypt::EPdfEncryptAlgorithm | eAlgorithm = PdfEncrypt::ePdfEncryptAlgorithm_RC4V1 , |
|||
PdfEncrypt::EPdfKeyLength | eKeyLength = PdfEncrypt::ePdfKeyLength_40 | |||
) |
Encrypt the document during writing.
userPassword | the user password (if empty the user does not have to enter a password to open the document) | |
ownerPassword | the owner password | |
protection | several EPdfPermissions values or'ed together to set the users permissions for this document | |
eRevision | the revision of the encryption algorithm to be used | |
eKeyLength | the length of the encryption key ranging from 40 to 128 bits (only used if eAlgorithm == ePdfEncryptAlgorithm_RC4V2) |
void PoDoFo::PdfMemDocument::SetPassword | ( | const std::string & | sPassword | ) |
If you try to open an encrypted PDF file, which requires a password to open, PoDoFo will throw a PdfError( ePdfError_InvalidPassword ) exception.
If you got such an exception, you have to set a password which should be used for opening the PDF.
The usual way will be to ask the user for the password and set the password using this method.
PdfParser will immediately continue to read the PDF file.
sPassword | a user or owner password which can be used to open an encrypted PDF file If the password is invalid, a PdfError( ePdfError_InvalidPassword ) exception is thrown! |
void PoDoFo::PdfMemDocument::SetPdfVersion | ( | EPdfVersion | eVersion | ) | [inline] |
Set the PDF Version of the document. Has to be called before Write() to have an effect.
eVersion | version of the pdf document |
void PoDoFo::PdfMemDocument::Write | ( | PdfOutputDevice * | pDevice | ) |
Writes the complete document to an output device
pDevice | write to this output device |
TODO: We will get problems here on linux, if we write to the same filename we read the document from. Because the PdfParserObjects will read there streams data from the file while we are writing it. The problem is that the stream data won't exist at this time as we truncated the file already to zero length by opening it writeable.
void PoDoFo::PdfMemDocument::Write | ( | const char * | pszFilename | ) |
Writes the complete document to a file
pszFilename | filename of the document |
This is an overloaded member function for your convinience.
TODO: We will get problems here on linux, if we write to the same filename we read the document from. Because the PdfParserObjects will read there streams data from the file while we are writing it. The problem is that the stream data won't exist at this time as we truncated the file already to zero length by opening it writeable.