PsEvent Struct Reference

PsEvent Class. More...

#include <pdfix.h>

Public Member Functions
virtual PdfEventType	GetType ()=0
	Get the event type. More...
virtual PdfDoc *	GetDoc ()=0
	Get the document associated with the event. More...
virtual PdfPage *	GetPage ()=0
	Get the page associated with the event. More...
virtual PdsObject *	GetObject ()=0
	Get the object associated with the event. More...
virtual PdfFormField *	GetFormField ()=0
	Get the form field associated with the event. More...
virtual float	GetProgress () const =0
	Get the progress compelteness state associated with the event. More...
virtual PdfDocUndo *	GetUndo ()=0
	Get the PdfDocUndo associated with the event. More...
virtual int	GetName (wchar_t *buffer, int len)=0
	Get the name associated with the event. This can be for example a key of changed dictionary. More...
virtual int	GetIndex ()=0
	Get the index associated with the event. This can be for example an index key of changed array. More...

Detailed Description

PsEvent Class.

A class to handle registers a user-supplied procedures to call when the specified event occurs.

Member Function Documentation

GetDoc()

virtual PdfDoc * PsEvent::GetDoc ( )

pure virtual

Get the document associated with the event.

Returns

The PdfDoc object or null if no document is accociated with the event

GetFormField()

virtual PdfFormField * PsEvent::GetFormField ( )

pure virtual

Get the form field associated with the event.

Returns

The PdfFormField object or null if no form field is accociated with the event

GetIndex()

virtual int PsEvent::GetIndex ( )

pure virtual

Get the index associated with the event. This can be for example an index key of changed array.

Returns

Number of characters written into buffer of required length.

GetName()

virtual int PsEvent::GetName ( wchar_t *  buffer, int  len  )

pure virtual

Get the name associated with the event. This can be for example a key of changed dictionary.

Returns

Number of characters written into buffer of required length.

GetObject()

virtual PdsObject * PsEvent::GetObject ( )

pure virtual

Get the object associated with the event.

Returns

The PdsObject object or null if no object is accociated with the event

GetPage()

virtual PdfPage * PsEvent::GetPage ( )

pure virtual

Get the page associated with the event.

Returns

The PdfPage object or null if no page is accociated with the event

GetProgress()

virtual float PsEvent::GetProgress ( ) const

pure virtual

Get the progress compelteness state associated with the event.

Returns

The state of the process in range from 0 to 1

GetType()

virtual PdfEventType PsEvent::GetType ( )

pure virtual

Get the event type.

See also

Pdfix::CreatePdfix

Returns

The event type Event type.

GetUndo()

virtual PdfDocUndo * PsEvent::GetUndo ( )

pure virtual

Get the PdfDocUndo associated with the event.

Returns

The PdfDocUndo object or null if the event is not assiciated with an undo