PoDoFo  0.9.4
Public Member Functions | List of all members
PoDoFo::PdfPagesTreeCache Class Reference

#include <PdfPagesTreeCache.h>

Public Member Functions

 PdfPagesTreeCache (int nInitialSize)
 
virtual ~PdfPagesTreeCache ()
 
virtual PdfPageGetPage (int nIndex)
 
virtual void AddPageObject (int nIndex, PdfPage *pPage)
 
virtual void AddPageObjects (int nIndex, std::vector< PdfPage * > vecPages)
 
virtual void InsertPage (int nAfterPageIndex)
 
virtual void InsertPages (int nAfterPageIndex, int nCount)
 
virtual void DeletePage (int nIndex)
 
virtual void ClearCache ()
 

Detailed Description

This class implements a cache infront of a PdfPagesTree

See also
PdfCachedPagesTree

Constructor & Destructor Documentation

PoDoFo::PdfPagesTreeCache::PdfPagesTreeCache ( int  nInitialSize)

Construct a new PdfCachedPagesTree.

Parameters
nInitialSizeinitial size of the pagestree
PoDoFo::PdfPagesTreeCache::~PdfPagesTreeCache ( )
virtual

Close/down destruct a PdfCachedPagesTree

Member Function Documentation

void PoDoFo::PdfPagesTreeCache::AddPageObject ( int  nIndex,
PdfPage pPage 
)
virtual

Add a PdfPage object to the cache

Parameters
nIndexindex of the page
pPagepage object
void PoDoFo::PdfPagesTreeCache::AddPageObjects ( int  nIndex,
std::vector< PdfPage * >  vecPages 
)
virtual

Add several PdfPage objects to the cache, replacing any existing at the given index

Parameters
nIndexzero based index of where the first page will be placed
vecPagesvector of the page objects to add
void PoDoFo::PdfPagesTreeCache::ClearCache ( )
virtual

Clear cache, i.e. remove all elements from the cache.

void PoDoFo::PdfPagesTreeCache::DeletePage ( int  nIndex)
virtual

Delete a PdfPage from the cache

Parameters
nIndexindex of the page
PdfPage * PoDoFo::PdfPagesTreeCache::GetPage ( int  nIndex)
virtual

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

Parameters
nIndexpage index, 0-based
Returns
a pointer to the requested page or NULL if it is not cached
void PoDoFo::PdfPagesTreeCache::InsertPage ( int  nAfterPageIndex)
virtual

A page was inserted into the pagestree, therefore the cache has to be updated

Parameters
nAfterPageIndexzero based index of the page we are inserting after
  • may be one of the special values from EPdfPageInsertionPoint.
void PoDoFo::PdfPagesTreeCache::InsertPages ( int  nAfterPageIndex,
int  nCount 
)
virtual

Insert several pages into the pagestree, after the given index therefore the cache has to be updated

Parameters
nAfterPageIndexzero based index of the page we are inserting after
  • may be one of the special values from EPdfPageInsertionPoint.
nCountnumber of pages that were inserted