JawsMako::IPDFPageInserter Class Reference

An instance of the JawsMako PDFPageInserter class. More...

#include <pdfpage.h>

Inheritance diagram for JawsMako::IPDFPageInserter:

Public Member Functions
virtual uint32	getNumPages ()=0
	Return the number of pages in the document.
virtual void	insert (const IInputStreamPtr &inputStream, uint32 destPageIndex, uint32 sourcePageIndex, uint32 numPages, const U8String &password=U8String(), uint32 permissions=0)=0
	Insert a range of pages from a given input stream.
virtual void	insertFrom (const IInputStreamPtr &inputStream, uint32 destPageIndex, uint32 sourcePageIndex, const U8String &password=U8String(), uint32 permissions=0)=0
	Insert a range of pages from a given input stream.
virtual void	insertTo (const IInputStreamPtr &inputStream, uint32 destPageIndex, uint32 sourcePageIndex, const U8String &password=U8String(), uint32 permissions=0)=0
	Insert a range of pages from a given input stream.
virtual void	save (const IOutputStreamPtr &outputStream)=0
	Save into a given output stream.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static JAWSMAKO_API IPDFPageInserterPtr	create (const IJawsMakoPtr &jawsMako, const IInputStreamPtr &inputStream, const U8String &password=U8String(), uint32 permissions=0, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
	Create an IPDFPageInserter interface.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

An instance of the JawsMako PDFPageInserter class.

Member Function Documentation

create()

static JAWSMAKO_API IPDFPageInserterPtr JawsMako::IPDFPageInserter::create ( const IJawsMakoPtr & jawsMako, const IInputStreamPtr & inputStream, const U8String & password = U8String(), uint32 permissions = 0, const IProgressMonitorPtr & progressMonitor = IProgressMonitorPtr() )

static

Create an IPDFPageInserter interface.

The IPDFPageInserter interface allows insertion of pages into a PDF.

Parameters

jawsMako	The IJawsMako object.
inputStream	The input PDF stream.
password	The password to use. Assumed to be UTF-8.
permissions	The allowed permissions.

If allowed permissions is set to IDOMStandardPDFSecurityInfo::eEverythingAllowed then no checking for assembly permissions will be performed.

Otherwise, the parameter is the or'd combination of IDOMStandardPDFSecurity::ePermissionsFlags that is checked against the permissions defined in the input PDF. If an operation corresponds to a flag set in the parameter, then output will be allowed to continue. Otherwise, an IError exception with the error code JM_ERR_ASSEMBLY_WRITE_FORBIDDEN will be thrown.

If the source has no permissions information the output will proceed regardless.

The default is 0.

Parameters

progressMonitor

A smart pointer to an IProgressMonitor object which can be NULL if no such object was passed in.

Returns

IPDFPageInserterPtr A smart pointer to the IPDFPageInserter object.

getNumPages()

virtual uint32 JawsMako::IPDFPageInserter::getNumPages ( )

pure virtual

Return the number of pages in the document.

Returns

uint32 The number of pages in the document.

insert()

virtual void JawsMako::IPDFPageInserter::insert ( const IInputStreamPtr & inputStream, uint32 destPageIndex, uint32 sourcePageIndex, uint32 numPages, const U8String & password = U8String(), uint32 permissions = 0 )

pure virtual

Insert a range of pages from a given input stream.

Pages are numbered starting at zero. An exception will be thrown if an invalid index or page range is specified.

Parameters

inputStream	The input stream.
destPageIndex	The page index of the destination to insert the pages into.
sourcePageIndex	The page index of the source to insert the pages from.
numPages	The number of pages to insert.
password	The password to use. Assumed to be UTF-8.
permissions	The allowed permissions.

insertFrom()

virtual void JawsMako::IPDFPageInserter::insertFrom ( const IInputStreamPtr & inputStream, uint32 destPageIndex, uint32 sourcePageIndex, const U8String & password = U8String(), uint32 permissions = 0 )

pure virtual

Insert a range of pages from a given input stream.

A convenience function. Equivalent to insert(destPageIndex, sourcePageIndex, sourceNumPages);

Pages are numbered starting at zero. An exception will be thrown if an invalid index is specified.

Parameters

inputStream	The input stream.
destPageIndex	The page index of the destination to insert the pages into.
sourcePageIndex	The page index of the source to insert the pages from.
password	The password to use. Assumed to be UTF-8.
permissions	The allowed permissions.

insertTo()

virtual void JawsMako::IPDFPageInserter::insertTo ( const IInputStreamPtr & inputStream, uint32 destPageIndex, uint32 sourcePageIndex, const U8String & password = U8String(), uint32 permissions = 0 )

pure virtual

Insert a range of pages from a given input stream.

A convenience function. Equivalent to insert(destPageIndex, 0, sourcePageIndex + 1);

Pages are numbered starting at zero. An exception will be thrown if an invalid index is specified.

Parameters

inputStream	The input stream.
destPageIndex	The page index of the destination to insert the pages into.
sourcePageIndex	The final page index of the source to insert the pages from.
password	The password to use. Assumed to be UTF-8.
permissions	The allowed permissions.

save()

virtual void JawsMako::IPDFPageInserter::save ( const IOutputStreamPtr & outputStream )

pure virtual

Save into a given output stream.

Parameters

outputStream

The output stream.

---

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

• pdfpage.h