PsEvent Struct Reference

PsEvent Class. More...

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 PdfAnnot *	GetAnnot ()=0
	Get the annotation associated with the event. More...
virtual PdfFormField *	GetFormField ()=0
	Get the form field associated with the event. More...
virtual double	GetProgress ()=0
	Get the progress compelteness state associated with the event. More...

Detailed Description

PsEvent Class.

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

Member Function Documentation

GetAnnot()

virtual PdfAnnot* PsEvent::GetAnnot ( )

pure virtual

Get the annotation associated with the event.

Returns

The PdfAnnot object or null if no annotation is accociated with the event

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

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 double PsEvent::GetProgress ( )

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.