plugin_event.h File Reference

#include "config.h"
#include "plugin_type.h"
#include "plugin_unknown.h"

Include dependency graph for plugin_event.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	EventParmsPaginate_t
	Pagination event, could be triggered when start and finished. More...
struct	EventRenderEnd_t
	Render event. More...
struct	EventMarkerReady_t
	Marker(tree) generation done event. More...
struct	EventSearchEnd_t
	Search finishing event. More...
union	PluginEventAttrs
	Put all above events into together. More...
struct	IPluginEventBroadcaster
	Universal Document Shell Plugin Document Event Broadcaster interface. Through IPluginEventBroadcaster, listeners can receive notification from plugin. More...
Typedefs
typedef void(*	EventFunc )(IPluginUnknown *thiz_sender, unsigned long handler_id, const PluginEvent plugin_event, void *user_data, const PluginEventAttrs *plugin_data)
	Define the callback function prototype.
Enumerations
enum	PluginEvent {   EVENT_PAGINATE_START, EVENT_PAGINATE_END, EVENT_RENDERING_END, EVENT_MARKER_READY,   EVENT_MARKER_OUT_OF_DATE, EVENT_SEARCH_END, EVENT_SEARCH_ABORTED, EVENT_PRERENDERING_START,   EVENT_PRERENDERING_END }
	Type definition of plugin events. More...
enum	PluginRenderStatus {   RENDER_PENDING = -1, RENDER_DONE, RENDER_OUT_OF_MEMORY, RENDER_INVALID_PAGE,   RENDER_FAIL, RENDER_BEYOND_LAST_PAGE, RENDER_BEYOND_FIRST_PAGE }
	Define render status here. More...

---

Typedef Documentation

typedef void(* EventFunc)(IPluginUnknown *thiz_sender, unsigned long handler_id, const PluginEvent plugin_event, void *user_data, const PluginEventAttrs *plugin_data)

Define the callback function prototype.

Parameters:

	thiz_sender	The IPluginUnknown pointer of the object which sends the event.
	handler_id	Because UDS can register same event with same function pointer twice, we use handler_id to distinguish them.
	plugin_event	The event which is sent by thiz_sender.
	user_data	User specified data.
	plugin_data	The data coming from plugin library. It would be used as parameters when broadcasting the event.

Definition at line 134 of file plugin_event.h.

---

Enumeration Type Documentation

enum PluginEvent

Type definition of plugin events.

Copyright (C) 2008 iRex Technologies B.V. All rights reserved.

Enumerator:

EVENT_PAGINATE_START	Pagination starting Event
EVENT_PAGINATE_END	Pagination ending Event
EVENT_RENDERING_END	Rendering ending Event
EVENT_MARKER_READY	Marker(tree) ready Event
EVENT_MARKER_OUT_OF_DATE	Marker(tree) Out-Of-Date Event
EVENT_SEARCH_END	Search ending Event
EVENT_SEARCH_ABORTED	Search aborted Event
EVENT_PRERENDERING_START	Pre rendering started Event
EVENT_PRERENDERING_END	Pre rendering ended Event

Definition at line 41 of file plugin_event.h.

{
    EVENT_PAGINATE_START,             /**< Pagination starting Event */
    EVENT_PAGINATE_END,               /**< Pagination ending Event */
    EVENT_RENDERING_END,              /**< Rendering ending Event */
    EVENT_MARKER_READY,               /**< Marker(tree) ready Event */
    EVENT_MARKER_OUT_OF_DATE,         /**< Marker(tree) Out-Of-Date Event */
    EVENT_SEARCH_END,                 /**< Search ending Event */
    EVENT_SEARCH_ABORTED,             /**< Search aborted Event */
    EVENT_PRERENDERING_START,         /**< Pre rendering started Event */
    EVENT_PRERENDERING_END            /**< Pre rendering ended Event */
} PluginEvent;

enum PluginRenderStatus

Define render status here.

Enumerator:

RENDER_PENDING	Job pending
RENDER_DONE	Render finished.
RENDER_OUT_OF_MEMORY	Out of memory.
RENDER_INVALID_PAGE	Invalid page.
RENDER_FAIL	Render fails.
RENDER_BEYOND_LAST_PAGE	Requested page is after the document's end
RENDER_BEYOND_FIRST_PAGE	Requested page is before the document's start

Definition at line 57 of file plugin_event.h.

{
    RENDER_PENDING = -1,                /**< Job pending      */
    RENDER_DONE,                        /**< Render finished. */
    RENDER_OUT_OF_MEMORY,               /**< Out of memory.   */
    RENDER_INVALID_PAGE,                /**< Invalid page.    */
    RENDER_FAIL,                        /**< Render fails.    */
    RENDER_BEYOND_LAST_PAGE,            /**< Requested page is after the document's end */
    RENDER_BEYOND_FIRST_PAGE            /**< Requested page is before the document's start */
} PluginRenderStatus;