NiXPSObjects::NOPackage Class Reference

#include "NOPackage.h"

Inherits NiXPSObjects::NOPartWithResources.

Collaboration diagram for NiXPSObjects::NOPackage:

[legend]

List of all members.

Public Member Functions
void	writePackageToFile (const UTF8Char *pFilename)
void	writePackageToFile ()
UInt32	writePackageToBuffer (UInt8 *pBuffer, const UInt32 pBufSize, UInt32 &pFileSize)
UInt32	exportToPDF (const UTF8Char *pPDFFileName, NOProgressReporter &pProgressReporter)
UInt32	exportToPDFWithOptions (const UTF8Char *pPDFFileName, NOProgressReporter &pProgressReporter, NOOptions &pOptions)
bool	getDirty ()
void	setDirty (bool pDirty)
bool	hasCoreProperties ()
NOCoreProperties	getCoreProperties ()
Manipulating documents in a package
NCommon::UInt32	getNumberOfDocuments ()
NCommon::UInt32	getDocumentNumberOf (const NODocument &pDoc)
NODocument	getDocument (const NCommon::UInt32 pNum)
void	addDocument (const NODocument &pDoc, NOProgressReporter &pReporter)
virtual bool	hasThumbnail ()
NOThumbnail	getThumbnail ()
NCommon::UInt32	getNumberOfPages ()
NCommon::UInt32	getFonts (NOFontVector &pFonts)
NCommon::UInt32	getImages (NOImageVector &pImages)
NCommon::UInt32	getParts (NOVector &pParts)
Static Public Member Functions
Constructing and destructing an NOPackage
static NOPackage *	readPackageFromFile (const UTF8Char *pFilename)
static NOPackage *	createFromImage (const UTF8Char *pFilename)
static NOPackage *	readPackageFromBuffer (const UTF8Char *pFilename, const UInt8 *pBuffer, const UInt32 pSize)
static NOPackage *	createPackage (bool pCreateEmptyDoc, const UTF8Char *pName=0)
static void	destroyPackage (NOPackage *pXPSPackage)

---

Detailed Description

Use an NOPackage to read an XPS-file from disk and access or manipulate the content of the package.

---

Member Function Documentation

NOPackage * NiXPSObjects::NOPackage::createFromImage

(

const UTF8Char *

pFilename

)

[static]

Create an XPS package from an image

Parameters:

pFilename

Full path to the image to create the file from

NOPackage * NiXPSObjects::NOPackage::createPackage	(	bool	pCreateEmptyDoc,
		const UTF8Char *	pName = 0
	)			[static]

Creates an empty package.

Parameters:

pCreateEmptyDoc

Create an empty document in the package

void NiXPSObjects::NOPackage::destroyPackage

(

NOPackage *

pXPSPackage

)

[static]

Destroy a package. You need to call this to dispose of a package and all the resources it keeps.

Parameters:

pXPSPackage

Package to destroy

UInt32 NiXPSObjects::NOPackage::exportToPDF	(	const UTF8Char *	pPDFFileName,
		NOProgressReporter &	pProgressReporter
	)

Exports the package to a PDF file. All pages from all documents will be put into one document

Parameters:

	pPDFFileName	the path of the file to write
	pProgressReporter	This progress reporter object gets polled regularly with % update of the export process

UInt32 NiXPSObjects::NOPackage::exportToPDFWithOptions	(	const UTF8Char *	pPDFFileName,
		NOProgressReporter &	pProgressReporter,
		NOOptions &	pOptions
	)

Exports the package to a PDF file. All pages from all documents will be put into one document

Parameters:

	pPDFFileName	the path of the file to write
	pProgressReporter	This progress reporter object gets polled regularly with % update of the export process

NODocument NiXPSObjects::NOPackage::getDocument

(

const NCommon::UInt32

pNum

)

Returns the NODocument at postion pNum.

Parameters:

pNum

The document position

NCommon::UInt32 NiXPSObjects::NOPackage::getDocumentNumberOf

(

const NODocument &

pDoc

)

Returns the document number of a given NODocument in this xps package

Parameters:

pDoc

The NODocument that the library needs to find the Document Number of.

NOPackage * NiXPSObjects::NOPackage::readPackageFromBuffer	(	const UTF8Char *	pFilename,
		const UInt8 *	pBuffer,
		const UInt32	pSize
	)			[static]

Reads a package from a file.

Parameters:

	pFilename	The name of the XPS-file.
	pBuffer	Memory buffer holding the XPS file. The library does not take ownership, so make sure the buffer is kept alive.
	pSize	Size of the file in memory.

NOPackage * NiXPSObjects::NOPackage::readPackageFromFile

(

const UTF8Char *

pFilename

)

[static]

Reads a package from a file.

Parameters:

pFilename

Full path to the XPS-file to read.

void NiXPSObjects::NOPackage::writePackageToFile

(

const UTF8Char *

pFilename

)

Writes the package to a file

Parameters:

pFilename

Full path to the XPS-file to write.

---

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

• NOPackage.h
• NOPackage.cpp