#include <PDFDoc.h>

Public Types
enum	ActionTriggerEvent { e_action_trigger_doc_will_close = 17, e_action_trigger_doc_will_save = 18, e_action_trigger_doc_did_save = 19, e_action_trigger_doc_will_print = 20, e_action_trigger_doc_did_print = 21 }

enum	InsertFlag { e_none, e_insert_bookmark, e_insert_goto_bookmark }

enum	ExtractFlag { e_forms_only, e_annots_only, e_both, e_annots_only_no_links = 5 }

enum	SignaturesVerificationStatus { e_unsigned, e_failure, e_untrusted, e_unsupported, e_verified }

Public Member Functions
	PDFDoc ()

	PDFDoc (SDF::SDFDoc &sdfdoc)

	PDFDoc (const PDFDoc &other)

PDFDoc &	operator= (const PDFDoc &)

	PDFDoc (const UString &filepath)

	PDFDoc (const char *filepath)

	PDFDoc (Filters::Filter stream)

	PDFDoc (const UChar *buf, size_t buf_size)

	~PDFDoc ()

void	Close ()

bool	IsEncrypted ()

bool	InitSecurityHandler (void *custom_data=0)

bool	InitStdSecurityHandler (const char *password, int password_sz)

bool	InitStdSecurityHandler (const pdftron::UString &password)

bool	InitStdSecurityHandler (const std::vector< UInt8 > &password_buf)

SDF::SecurityHandler	GetSecurityHandler ()

void	SetSecurityHandler (const SDF::SecurityHandler &handler)

void	RemoveSecurity ()

bool	HasSignatures ()

SDF::SignatureHandlerId	AddSignatureHandler (const SDF::SignatureHandler &signature_handler)

SDF::SignatureHandlerId	AddStdSignatureHandler (const UString &pkcs12_keyfile, const UString &pkcs12_keypass)

SDF::SignatureHandlerId	AddStdSignatureHandler (const std::vector< unsigned char > &pkcs12_keybuffer, const UString &pkcs12_keypass)

void	RemoveSignatureHandler (const SDF::SignatureHandlerId signature_handler_id)

SDF::SignatureHandler *	GetSignatureHandler (const SDF::SignatureHandlerId signature_handler_id)

SDF::UndoManager	GetUndoManager ()

PDF::DigitalSignatureField	CreateDigitalSignatureField (const UString &in_sig_field_name="")

PDF::DigitalSignatureFieldIterator	GetDigitalSignatureFieldIterator ()

PDF::DigitalSignatureField::DocumentPermissions	GetDigitalSignaturePermissions () const

PDFDocInfo	GetDocInfo ()

PDFDocViewPrefs	GetViewPrefs ()

SDF::Obj	GetTriggerAction (PDFDoc::ActionTriggerEvent trigger)

bool	IsModified () const

bool	HasRepairedXRef () const

bool	IsLinearized () const

bool	HasDownloader ()

UInt64	GetDownloadedByteCount ()

UInt64	GetTotalRemoteByteCount ()

void	Save (const UString &path, UInt32 flags)

void	Save (const UString &path, UInt32 flags, Common::ProgressMonitor *progress)

std::vector< unsigned char >	Save (UInt32 flags)

void	Save (const char &out_buf, size_t &out_buf_size, UInt32 flags, Common::ProgressMonitor progress)

void	Save (Filters::Filter &stream, UInt32 flags)

void	SaveCustomSignature (const UChar *in_signature, const size_t in_signature_size, const DigitalSignatureField &in_field, const UString &in_path)

void	SaveCustomSignature (const UChar *in_signature, const size_t in_signature_size, const DigitalSignatureField &in_field, Filters::Filter &out_stream)

void	SaveCustomSignature (const UChar in_signature, const size_t in_signature_size, const DigitalSignatureField &in_field, const UChar &out_buf, size_t &out_buf_size)

PageIterator	GetPageIterator (UInt32 page_number=1)

Page	GetPage (UInt32 page_number)

void	PageRemove (const PageIterator &page_itr)

void	PageInsert (PageIterator &where, Page page)

void	InsertPages (int insert_before_page_number, PDFDoc &src_doc, int start_page, int end_page, enum InsertFlag flag, Common::ProgressMonitor *monitor=0)

void	InsertPages (int insert_before_page_number, PDFDoc &src_doc, const PageSet &source_page_set, enum InsertFlag flag, Common::ProgressMonitor *monitor=0)

void	MovePages (int move_before_page_number, PDFDoc &src_doc, int start_page, int end_page, enum InsertFlag flag, Common::ProgressMonitor *monitor=0)

void	MovePages (int move_before_page_number, PDFDoc &src_doc, const PageSet &source_page_set, enum InsertFlag flag, Common::ProgressMonitor *monitor=0)

void	PagePushFront (Page page)

void	PagePushBack (Page page)

std::vector< Page >	ImportPages (const std::vector< Page > &pages, bool import_bookmarks=false)

Page	PageCreate (const Rect &media_box=Rect(0, 0, 612, 792))

int	AppendTextDiff (Page page1, Page page2)

int	AppendTextDiff (PDFDoc &doc1, PDFDoc &doc2)

int	AppendTextDiff (PDFDoc &doc1, PDFDoc &doc2, TextDiffOptions *options)

class Bookmark	GetFirstBookmark ()

void	AddRootBookmark (class Bookmark root_bookmark)

SDF::Obj	GetTrailer ()

SDF::Obj	GetRoot ()

SDF::Obj	GetPages ()

int	GetPageCount ()

FieldIterator	GetFieldIterator ()

FieldIterator	GetFieldIterator (const UString &field_name)

Field	GetField (const UString &field_name)

Field	FieldCreate (const UString &field_name, Field::Type type, SDF::Obj field_value=0, SDF::Obj def_field_value=0)

Field	FieldCreate (const UString &field_name, Field::Type type, const UString &field_value, const UString &def_field_value="")

void	RefreshFieldAppearances ()

void	RefreshAnnotAppearances (const RefreshOptions *options=0)

void	FlattenAnnotations (bool forms_only=false)

SDF::Obj	GetAcroForm ()

FDF::FDFDoc	FDFExtract (enum ExtractFlag flag=e_forms_only)

FDF::FDFDoc	FDFExtract (PageSet &pages_to_extract, enum ExtractFlag flag=e_forms_only)

FDF::FDFDoc	FDFExtract (const std::vector< Annot > &annotations)

FDF::FDFDoc	FDFExtract (const std::vector< Annot > &annot_added, const std::vector< Annot > &annot_modified, const std::vector< Annot > &annot_deleted)

void	FDFMerge (FDF::FDFDoc &fdf_doc)

void	FDFUpdate (FDF::FDFDoc &fdf_doc)

Action	GetOpenAction ()

void	SetOpenAction (const Action &action)

void	AddFileAttachment (const UString &file_key, FileSpec embedded_file)

PageLabel	GetPageLabel (int page_num)

void	SetPageLabel (int page_num, PageLabel &label)

void	RemovePageLabel (int page_num)

bool	IsTagged ()

Struct::STree	GetStructTree ()

bool	HasOC () const

SDF::Obj	GetOCGs () const

OCG::Config	GetOCGConfig () const

void	AddHighlights (const UString &hilite)

SDF::Obj	CreateIndirectName (const char *name)

SDF::Obj	CreateIndirectArray ()

SDF::Obj	CreateIndirectBool (bool value)

SDF::Obj	CreateIndirectDict ()

SDF::Obj	CreateIndirectNull ()

SDF::Obj	CreateIndirectNumber (double value)

SDF::Obj	CreateIndirectString (const UChar *value, UInt32 size)

SDF::Obj	CreateIndirectString (const UString &str)

SDF::Obj	CreateIndirectStream (Filters::FilterReader &data, Filters::Filter filter_chain=Filters::Filter(0, false))

SDF::Obj	CreateIndirectStream (const char *data, const size_t data_size, Filters::Filter filter_chain=Filters::Filter(0, false))

SDF::SDFDoc &	GetSDFDoc ()

	operator SDF::SDFDoc & ()

void	Lock ()

void	Unlock ()

bool	TryLock (int milliseconds=0)

void	LockRead ()

void	UnlockRead ()

bool	TryLockRead (int milliseconds=0)

UString	GetFileName () const

void	GenerateThumbnails (UInt32 size)

void	AppendVisualDiff (Page p1, Page p2, DiffOptions *opts)

void	SaveViewerOptimized (const UString &path, const ViewerOptimizedOptions &opts)

void	SaveViewerOptimized (const char *&out_buf, size_t &out_buf_size, const ViewerOptimizedOptions &opts)

SignaturesVerificationStatus	VerifySignedDigitalSignatures (const VerificationOptions &in_opts) const

void	MergeXFDF (Filters::Filter stream, const MergeXFDFOptions *opts=0)

void	MergeXFDF (const UString &xfdf, const MergeXFDFOptions *opts=0)

ptrdiff_t	GetHandleInternal ()

Static Public Member Functions
static int	HighlightTextDiff (PDFDoc &doc1, PDFDoc &doc2, TextDiffOptions *options)

static PDFDoc *	CreateInternal (ptrdiff_t impl)

Detailed Description

PDFDoc is a high-level class describing a single PDF (Portable Document Format) document. Most applications using PDFNet will use this class to open existing PDF documents, or to create new PDF documents from scratch.

The class offers a number of entry points into the document. For example,

To access pages use pdfdoc.GetPageIterator() or pdfdoc.GetPage(page_num).
To access form fields use pdfdoc.GetFieldIterator(), pdfdoc.GetFieldIterator(name) or pdfdoc.GetField(name).
To access document's meta-data use pdfdoc.GetDocInfo().
To access the outline tree use pdfdoc.GetFirstBookmark().
To access low-level Document Catalog use pdfdoc.GetRoot(). ...

The class also offers utility methods to slit and merge PDF pages, to create new pages, to flatten forms, to change security settings, etc.

Definition at line 70 of file PDFDoc.h.

Member Enumeration Documentation

enum pdftron::PDF::PDFDoc::ActionTriggerEvent

Enumerator
e_action_trigger_doc_will_close
e_action_trigger_doc_will_save
e_action_trigger_doc_did_save
e_action_trigger_doc_will_print
e_action_trigger_doc_did_print

Definition at line 409 of file PDFDoc.h.

enum pdftron::PDF::PDFDoc::ExtractFlag

Enumerator
e_forms_only
e_annots_only
e_both
e_annots_only_no_links

Definition at line 1108 of file PDFDoc.h.

enum pdftron::PDF::PDFDoc::InsertFlag

Enumerator
e_none
e_insert_bookmark
e_insert_goto_bookmark

Definition at line 693 of file PDFDoc.h.

enum pdftron::PDF::PDFDoc::SignaturesVerificationStatus

Enumerator
e_unsigned
e_failure
e_untrusted
e_unsupported
e_verified

Definition at line 1479 of file PDFDoc.h.

Constructor & Destructor Documentation

pdftron::PDF::PDFDoc::PDFDoc ( )

Default constructor. Creates an empty new document.

pdftron::PDF::PDFDoc::PDFDoc ( SDF::SDFDoc & sdfdoc )

Create a PDF document from an existing SDF/Cos document.

Parameters

sdfdoc a pointer to the SDF document. Created PDFDoc will take the ownership of the low-level document.

Note: the SDFDoc will become invalid. If you would like to access the low level document use GetSDFDoc

pdftron::PDF::PDFDoc::PDFDoc ( const PDFDoc & other )

Create a shallow copy of another PDFDoc

Parameters

other a reference to the PDF document to clone. Created PDFDoc will retain a reference to the same low-level document as the source.

pdftron::PDF::PDFDoc::PDFDoc ( const UString & filepath )

Open an existing PDF document

Parameters

filepath - pathname to the file.

Note: Make sure to call InitSecurityHandler() after PDFDoc(...) in case a document is encrypted

pdftron::PDF::PDFDoc::PDFDoc ( const char * filepath )

pdftron::PDF::PDFDoc::PDFDoc ( Filters::Filter stream )

Open an existing PDF document

Parameters

stream - input stream containing a serialized document. The input stream may be a random-access file, memory buffer, slow HTTP connection etc.

Note: if the input stream doesn't support Seek() operation the document will load whole data stream in memory before parsing. In case of linearized PDF, the document may be parsed on-the-fly while it is being loaded in memory. Note that since MappedFile implements Seek() interface, the document does not have to be fully in memory before it is used.; Make sure to call InitSecurityHandler() after PDFDoc(...) for encrypted documents.; PDFDoc takes the ownership of the stream.

pdftron::PDF::PDFDoc::PDFDoc	(	const UChar *	buf,
		size_t	buf_size
	)

Open a SDF/Cos document from a memory buffer.

Note: the document should be fully loaded in the memory buffer.; the buffer ownership is not transfered to the document so the user should clean-up any allocated memory if necessary.

Parameters

buf	- a memory buffer containing the serialized document
buf_size	- the size of memory buffer.

pdftron::PDF::PDFDoc::~PDFDoc ( )

Destructor

Member Function Documentation

void pdftron::PDF::PDFDoc::AddFileAttachment	(	const UString &	file_key,
		FileSpec	embedded_file
	)

Associates a file attachment with the document.

The file attachment will be displayed in the user interface of a viewer application (in Acrobat this is File Attachment tab). The function differs from Annot.CreateFileAttachment() because it associates the attachment with the whole document instead of an annotation on a specific page.

Parameters

file_key	A key/name under which the attachment will be stored.
embedded_file	Embedded file stream

Note: Another way to associate a file attachment with the document is using SDF::NameTree:
* SDF::NameTree names = SDF::NameTree::Create(doc, "EmbeddedFiles");

* names.Put(file_key, file_keysz, embedded_file.GetSDFObj());

*

void pdftron::PDF::PDFDoc::AddHighlights ( const UString & hilite )

AddHighlights is used to highlight text in a document using 'Adobe's Highlight File Format' (Technical Note #5172 ). The method will parse the character offset data and modify the current document by adding new highlight annotations.

Parameters

hilite a string representing the filename for the highlight file or or a data buffer containing XML data.

Exceptions

An	exception will be thrown if the XML file is malformed or os out of sync with the document.

void pdftron::PDF::PDFDoc::AddRootBookmark ( class Bookmark root_bookmark )

Adds/links the specified Bookmark to the root level of document's outline tree.

Parameters

root_bookmark Bookmark to Add/link

Note: parameter 'root_bookmark' must not be linked (must not be belong) to a bookmark tree.

SDF::SignatureHandlerId pdftron::PDF::PDFDoc::AddSignatureHandler ( const SDF::SignatureHandler & signature_handler )

Adds a signature handler to the signature manager.

Parameters

signature_handler The signature handler instance to add to the signature manager.

Returns: A unique ID representing the SignatureHandler within the SignatureManager.

SDF::SignatureHandlerId pdftron::PDF::PDFDoc::AddStdSignatureHandler	(	const UString &	pkcs12_keyfile,
		const UString &	pkcs12_keypass
	)

Adds a standard (built-in) signature handler to the signature manager. This method will use cryptographic algorithm based on Adobe.PPKLite/adbe.pkcs7.detached filter to sign a PDF.

Parameters

pkcs12_file	The private key certificate store to use.
pkcs12_pass	The passphrase for the provided private key.

Returns: A unique ID representing the SignatureHandler within the SignatureManager.

SDF::SignatureHandlerId pdftron::PDF::PDFDoc::AddStdSignatureHandler	(	const std::vector< unsigned char > &	pkcs12_keybuffer,
		const UString &	pkcs12_keypass
	)

Adds a standard (built-in) signature handler to the signature manager. This method will use cryptographic algorithm based on Adobe.PPKLite/adbe.pkcs7.detached filter to sign a PDF.

Parameters

pkcs12_keybuffer	The private key certificate store to use (as a data buffer in an array of bytes).
pkcs12_pass	The passphrase for the provided private key.

Returns: A unique ID representing the SignatureHandler within the SignatureManager.

int pdftron::PDF::PDFDoc::AppendTextDiff	(	Page	page1,
		Page	page2
	)

Imports two external pages and highlights the differences between them. This function adds two new pages to the current document. The two input pages are typically coming from two different PDF files. Note: Each contiguous block of change is considered a single difference. A deletion immediately followed by an insertion is considered a single edit.

Parameters

page1	is the before page, the basis of the comparison (read-only)
page2	is the after page, to which the basis is compared (read-only)

Returns: the total number of differences found

int pdftron::PDF::PDFDoc::AppendTextDiff	(	PDFDoc &	doc1,
		PDFDoc &	doc2
	)

Imports two external PDFs and highlights the differences between them. This function appends alternating pages from the two input documents into the current document. Note: Each contiguous block of change is considered a single difference. A deletion immediately followed by an insertion is considered a single edit.

Parameters

doc1	is the before document, the basis of the comparison (read-only)
doc2	is the after document, to which the basis is compared (read-only)

Returns: the total number of differences found

int pdftron::PDF::PDFDoc::AppendTextDiff	(	PDFDoc &	doc1,
		PDFDoc &	doc2,
		TextDiffOptions *	options
	)

Imports two external PDFs and highlights the differences between them. This function appends alternating pages from the two input documents into the current document. Note: Each contiguous block of change is considered a single difference. A deletion immediately followed by an insertion is considered a single edit.

Parameters

doc1	is the before document, the basis of the comparison (read-only)
doc2	is the after document, to which the basis is compared (read-only)
options	processing options (optional)

Returns: the total number of differences found

void pdftron::PDF::PDFDoc::AppendVisualDiff	(	Page	p1,
		Page	p2,
		DiffOptions *	opts
	)

Generates a PDF diff of the given pages by overlaying and blending them on top of each other.

Parameters

p1	one of the two pages for comparing.
p2	the other page for comparing.
opts	options for comparison results.

void pdftron::PDF::PDFDoc::Close ( )

Close PDFDoc

PDF::DigitalSignatureField pdftron::PDF::PDFDoc::CreateDigitalSignatureField ( const UString & in_sig_field_name = "" )

Creates an unsigned digital signature form field inside the document.

Parameters

in_sig_field_name The fully-qualified name to give the digital signature field. If one is not provided, a unique name is created automatically.

Returns: A DigitalSignatureField object representing the created digital signature field.

SDF::Obj pdftron::PDF::PDFDoc::CreateIndirectArray ( )

This method creates an SDF/Cos indirect array object