IProgressEventHandler Class Reference

An abstract class allowing a callback respond to events during the processing of a document. It is up to the handler to decide what actions to perform when these events are received. More...

#include <edl/iabort.h>

Inheritance diagram for IProgressEventHandler:

Public Types
enum	Event {   eEvtNone = 0 , eEvtPageWriteStart , eEvtPageWriteEnd , eEvtNodeWriteStart ,   eEvtNodeWriteEnd }
typedef void(*	ProgressEventHandlerCallbackFunc) (void *priv, Event evt, int64 pageNum)
	A callback function type for receiving events.

Public Member Functions
	~IProgressEventHandler () override=default
virtual void	handleEvent (Event evt, int64 pageNum)=0
	Handles an event.
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 EDL_API IProgressEventHandlerPtr	create (ProgressEventHandlerCallbackFunc cbFunc, void *cbPriv)
	Create the IProgressEventHandler object with a callback function.

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

Detailed Description

An abstract class allowing a callback respond to events during the processing of a document. It is up to the handler to decide what actions to perform when these events are received.

Member Typedef Documentation

ProgressEventHandlerCallbackFunc

typedef void(* IProgressEventHandler::ProgressEventHandlerCallbackFunc) (void *priv, Event evt, int64 pageNum)

A callback function type for receiving events.

Parameters

priv	A private pointer that is passed with each invocation.
evt	The event to handle.
pageNum	Optional page number, or -1 where the page number is unknown.

Member Enumeration Documentation

Event

enum IProgressEventHandler::Event

Enumerator
eEvtNone	0
eEvtPageWriteStart
eEvtPageWriteEnd
eEvtNodeWriteStart
eEvtNodeWriteEnd

Constructor & Destructor Documentation

~IProgressEventHandler()

IProgressEventHandler::~IProgressEventHandler ( )

overridedefault

Member Function Documentation

create()

EDL_API IProgressEventHandlerPtr IProgressEventHandler::create ( ProgressEventHandlerCallbackFunc cbFunc, void * cbPriv )

static

Create the IProgressEventHandler object with a callback function.

Parameters

[in]	cbFunc	A callback function that will be called on each event.
[in]	cbPriv	The parameter that will be passed to the callback function.

Returns

IProgressEventHandlerPtr The IProgressEventHandler object

handleEvent()

virtual void IProgressEventHandler::handleEvent ( Event evt, int64 pageNum )

pure virtual

Handles an event.

Parameters

evt	The event to handle.
pageNum	Optional page number, or -1 where the page number is unknown.

---

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

• edl/iabort.h