NiXPSObjects::NODocument Class Reference

#include "NODocument.h"

Inherits NiXPSObjects::NOPartWithResources.

Collaboration diagram for NiXPSObjects::NODocument:
[legend]

List of all members.

Public Member Functions

NCommon::UInt32 getNumberOfPages ()
NOPage getPage (const UInt32 pNum)
NCommon::UInt32 getPageNumberOf (const NOPage &pPage)
NOPage insertPage (const NOPage &pPage, UInt32 pPos)
NOPage createPage ()
UInt32 exportToPDF (const UTF8Char *pPDFFileName, NOProgressReporter &pProgressReporter)
UInt32 exportToPDF (UInt8 *pBuffer, const UInt32 pBufSize, UInt32 &pPDFSize, NOProgressReporter &pProgressReporter)
NOXDocumentStructure getDocumentStructure ()
bool hasDocumentStructure ()
bool searchAndReplaceText (const UTF8Char *pSearch, const UTF8Char *pReplace, NOFontVector &pMissingFonts, bool pDryRun)
NOPackage getPackage ()
NCommon::UInt32 getDocumentNumber ()
UInt32 getFonts (NOFontVector &pFonts)
UInt32 getImages (NOImageVector &pImages)
UInt32 resolveLink (const UTF8Char *pSearch, UInt16 *pPageID, UInt32 *pObjectID)

Detailed Description

Class representing a document in an XPS package.


Member Function Documentation

UInt32 NiXPSObjects::NODocument::exportToPDF ( UInt8 *  pBuffer,
const UInt32  pBufSize,
UInt32 &  pPDFSize,
NOProgressReporter pProgressReporter 
)

Exports the document to a PDF, and stores that pdf in memory

Parameters:
pBuffer the memory buffer to write to
pBufSize size of the memory buffer
pPDFSize the full size of the pdf in memory - if the operation fails due to a too small buffer, the full required size is still returned in this variable, it allows to do a second attempt with a bigger buffer
pProgressReporter This progress reporter object gets polled regularly with % update of the export process
UInt32 NiXPSObjects::NODocument::exportToPDF ( const UTF8Char *  pPDFFileName,
NOProgressReporter pProgressReporter 
)

Exports the document to a PDF file

Parameters:
pPDFFileName the path of the file to write
pProgressReporter This progress reporter object gets polled regularly with % update of the export process
NCommon::UInt32 NiXPSObjects::NODocument::getFonts ( NOFontVector pFonts  ) 

Returns the count of the number of fonts in this document and a vector with all the fonts.

Parameters:
pFonts The vector to put the fonts in
NCommon::UInt32 NiXPSObjects::NODocument::getImages ( NOImageVector pImages  ) 

Returns the count of the number of images in this document and a vector with all the images.

Parameters:
pImages The vector to put the images in
NOPage NiXPSObjects::NODocument::getPage ( const UInt32  pNum  ) 

Returns a given page represented by an NOPage object

Parameters:
pNum The location of the page to obtain
NCommon::UInt32 NiXPSObjects::NODocument::getPageNumberOf ( const NOPage pPage  ) 

Returns the page number this page has in the document

Parameters:
pPage the NOPage object representing the page of which we want to know the page number
NOPage NiXPSObjects::NODocument::insertPage ( const NOPage pPage,
UInt32  pPos 
)

Insert a page into a given location

Parameters:
pPage the NOPage object representing the page to be inserted
pPos the Postion to insert the page at
bool NiXPSObjects::NODocument::searchAndReplaceText ( const UTF8Char *  pSearch,
const UTF8Char *  pReplace,
NOFontVector pMissingFonts,
bool  pDryRun 
)

Search and replace text in a document

Parameters:
pSearch String to search for
pReplace String to replace search string with
pMissingFonts Font vector that will represent the fonts missing to do the replacement if the search and replace fails
pDryRun Do a dry run, i.e. only test the search and replace and don't actually perform the operation

The documentation for this class was generated from the following files:

Generated on Wed Mar 10 08:54:38 2010 for NiXPS Library SDK by  doxygen 1.6.1