PoDoFo::PdfPagesTree Class Reference

#include <PdfPagesTree.h>

Inheritance diagram for PoDoFo::PdfPagesTree:

List of all members.

Public Member Functions
	PdfPagesTree (PdfVecObjects *pParent)
	PdfPagesTree (PdfObject *pPagesRoot)
virtual	~PdfPagesTree ()
int	GetTotalNumberOfPages () const
PdfPage *	GetPage (int nIndex)
PdfPage *	GetPage (const PdfReference &ref)
void	InsertPage (int nAfterPageNumber, PdfObject *pPage)
void	InsertPage (int nAfterPageNumber, PdfPage *pPage)
PdfPage *	CreatePage (const PdfRect &rSize)
void	DeletePage (int inPageNumber)
void	ClearCache ()

---

Detailed Description

Class for managing the tree of Pages in a PDF document Don't use this class directly. Use PdfDocument instead.

See also:

PdfDocument

---

Constructor & Destructor Documentation

PoDoFo::PdfPagesTree::PdfPagesTree

(

PdfVecObjects *

pParent

)

Construct a new PdfPagesTree

PoDoFo::PdfPagesTree::PdfPagesTree

(

PdfObject *

pPagesRoot

)

Construct a PdfPagesTree from the root /Pages object

Parameters:

pPagesRoot

pointer to page tree dictionary

PoDoFo::PdfPagesTree::~PdfPagesTree

(

)

[virtual]

Close/down destruct a PdfPagesTree

---

Member Function Documentation

void PoDoFo::PdfPagesTree::ClearCache

(

)

[inline]

Clear internal cache of PdfPage objects. All references to PdfPage object will become invalid when calling this method. All PdfPages will be deleted.

You normally will never have to call this method. It is only useful if one modified the page nodes of the pagestree manually.

PdfPage * PoDoFo::PdfPagesTree::CreatePage

(

const PdfRect &

rSize

)

Creates a new page object and inserts it into the internal page tree. The returned page is owned by the pages tree and will get deleted along with it!

Parameters:

rSize

a PdfRect specifying the size of the page (i.e the /MediaBox key) in PDF units

Returns:

a pointer to a PdfPage object

void PoDoFo::PdfPagesTree::DeletePage

(

int

inPageNumber

)

Delete the specified page object from the internal pages tree. It does NOT remove any PdfObjects from memory - just the reference from the tree

Parameters:

inPageNumber

the page number (0-based) to be removed

The PdfPage object refering to this page will be deleted by this call! Empty page nodes will also be deleted.

See also:

PdfMemDocument::DeletePages

PdfPage * PoDoFo::PdfPagesTree::GetPage

(

const PdfReference &

ref

)

Return a PdfPage for the specified Page reference. The returned page is owned by the pages tree and deleted along with it.

Parameters:

ref

the reference of the pages object

Returns:

a pointer to the requested page

PdfPage * PoDoFo::PdfPagesTree::GetPage

(

int

nIndex

)

Return a PdfPage for the specified Page index The returned page is owned by the pages tree and deleted along with it.

Parameters:

nIndex

page index, 0-based

Returns:

a pointer to the requested page

int PoDoFo::PdfPagesTree::GetTotalNumberOfPages

(

)

const

Return the number of pages in the entire tree

Returns:

number of pages

void PoDoFo::PdfPagesTree::InsertPage	(	int	nAfterPageNumber,
		PdfPage *	pPage
	)

Inserts an existing page object into the internal page tree. after the specified page number

Parameters:

	nAfterPageNumber	an integer specifying after what page may be one of the special values from EPdfPageInsertionPoint. Pages are 0 based.
	pPage	a PdfPage to be inserted, the PdfPage will not get owned by the PdfPagesTree

void PoDoFo::PdfPagesTree::InsertPage	(	int	nAfterPageNumber,
		PdfObject *	pPage
	)

Inserts an existing page object into the internal page tree. after the specified page number

Parameters:

	nAfterPageNumber	an integer specifying after what page may be one of the special values from EPdfPageInsertionPoint. Pages are 0 based.
	pPage	musst be a PdfObject with type /Page

---