qofevent.h File Reference

Detailed Description

QOF event handling interface.

Author:: Copyright 2000 Dave Peticolas <dave@krondo.com>
Copyright 2006 Neil Williams <linux@codehelp.co.uk>

Definition in file qofevent.h.

#include "qof.h"

Go to the source code of this file.

Defines

#define QOF_MAKE_EVENT(x)   (1<<(x))

Allow application-specific events to be created.

#define QOF_EVENT_BASE   8

Default events for backwards compatibility.

These defaults merely replicate previous behaviour, any process can define their own events.

Note:
events 6, and 7 are "undefined" as of v0.6.3 for future libqof1 or libqof2 usage.

#define QOF_EVENT_NONE   (0)

#define QOF_EVENT_CREATE   QOF_MAKE_EVENT(0)

#define QOF_EVENT_MODIFY   QOF_MAKE_EVENT(1)

an entity is about to be modified.

#define QOF_EVENT_DESTROY   QOF_MAKE_EVENT(2)

#define QOF_EVENT_ADD   QOF_MAKE_EVENT(3)

#define QOF_EVENT_REMOVE   QOF_MAKE_EVENT(4)

#define QOF_EVENT_COMMIT   QOF_MAKE_EVENT(5)

an entity has been modified.

#define QOF_EVENT__LAST   QOF_MAKE_EVENT(QOF_EVENT_BASE-1)

#define QOF_EVENT_ALL   (0xff)

Typedefs

typedef gint QofEventId

typedef void(* QofEventHandler )(QofEntity *ent, QofEventId event_type, gpointer handler_data, gpointer event_data)

Handler invoked when an event is generated.

Functions

gint qof_event_register_handler (QofEventHandler handler, gpointer handler_data)

Register a handler for events.

void qof_event_unregister_handler (gint handler_id)

Unregister an event handler.

void qof_event_gen (QofEntity *entity, QofEventId event_type, gpointer event_data)

Invoke all registered event handlers using the given arguments.

void qof_event_suspend (void)

Suspend all engine events.

void qof_event_resume (void)

Generated on Thu Jan 31 22:50:26 2008 for QOF by

1.5.4


Defines
#define	QOF_MAKE_EVENT(x) (1<<(x))
	Allow application-specific events to be created.
#define	QOF_EVENT_BASE 8
Default events for backwards compatibility.
These defaults merely replicate previous behaviour, any process can define their own events. Note: events 6, and 7 are "undefined" as of v0.6.3 for future libqof1 or libqof2 usage.
#define	QOF_EVENT_NONE (0)
#define	QOF_EVENT_CREATE QOF_MAKE_EVENT(0)
#define	QOF_EVENT_MODIFY QOF_MAKE_EVENT(1)
	an entity is about to be modified.
#define	QOF_EVENT_DESTROY QOF_MAKE_EVENT(2)
#define	QOF_EVENT_ADD QOF_MAKE_EVENT(3)
#define	QOF_EVENT_REMOVE QOF_MAKE_EVENT(4)
#define	QOF_EVENT_COMMIT QOF_MAKE_EVENT(5)
	an entity has been modified.
#define	QOF_EVENT__LAST QOF_MAKE_EVENT(QOF_EVENT_BASE-1)
#define	QOF_EVENT_ALL (0xff)
Typedefs
typedef gint	QofEventId
typedef void(*	QofEventHandler )(QofEntity *ent, QofEventId event_type, gpointer handler_data, gpointer event_data)
	Handler invoked when an event is generated.
Functions
gint	qof_event_register_handler (QofEventHandler handler, gpointer handler_data)
	Register a handler for events.
void	qof_event_unregister_handler (gint handler_id)
	Unregister an event handler.
void	qof_event_gen (QofEntity *entity, QofEventId event_type, gpointer event_data)
	Invoke all registered event handlers using the given arguments.
void	qof_event_suspend (void)
	Suspend all engine events.
void	qof_event_resume (void)