IPDFExportController Class Reference

#include <IPDFExportController.h>

Inheritance diagram for IPDFExportController:

Public Member Functions
virtual PDFExportErr	StartUp (bool16 bExportPageItems=kFalse)=0
virtual PDFExportErr	GetNextPDFExportEvent (PDFExportEvent *nextEvent)=0
virtual PDFExportErr	ShutDown (bool16 bSaveIt=kTrue)=0
virtual PMString	GetCurrentProgressBarText ()=0
virtual bool16	MakePDFExportEvent (PDFExportEvent *exportEvent, uint32 eventType, int32 currIndex)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

IPDFExportController defines the interface for an event-driven PDF export. It is used by clients such as the PDF export command to handle the logic for the sequence of events and the set up required for each. Clients pass in an event structure that is filled in by the controller with the type of the event, the viewport to render content into, the database for the current page, and the UID of the page or spread to render.

Member Function Documentation

virtual PMString IPDFExportController::GetCurrentProgressBarText ( )

pure virtual

Returns a string describing the current state of the export, for display in a progress bar.

virtual PDFExportErr IPDFExportController::GetNextPDFExportEvent ( PDFExportEvent *  nextEvent )

pure virtual

Gets the next event of the export session.

Parameters

nextEvent

Pointer to event structure to be filled in

Returns

an error code describing the success or failure of the start up

virtual bool16 IPDFExportController::MakePDFExportEvent ( PDFExportEvent *  exportEvent, uint32  eventType, int32  currIndex  )

pure virtual

Returns a PDF export event based on the event type passed.

Parameters

exportEvent	Pointer to the event structure to be filled in.
eventType	Identifier for the type of event to get in the event.
currIndex	Index of the current page or spread being exported.

virtual PDFExportErr IPDFExportController::ShutDown ( bool16  bSaveIt = kTrue )

pure virtual

Closes down an event-driven export session and saves the document if bSaveIt is kTrue.

Parameters

bSaveIt

kTrue if the document should be saved, else kFalse

Returns

an error code describing the success or failure of the shut down

virtual PDFExportErr IPDFExportController::StartUp ( bool16  bExportPageItems = kFalse )

pure virtual

Initializes an event driven export session. Must be called prior to calling GetNextPDFExportEvent or ShutDown. If bExportPageItems is kTrue, the ItemList contains page items, and is NOT a list of pages.

Parameters

bExportPageItems

Indicates whether exporting pageitems (kTrue) or pages/spreads (kFalse)

Returns

an error code describing the success or failure of the start up