/usr/include/qof/qofevent.h is in libqof-dev 0.8.8-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | /********************************************************************
* qofevent.h -- QOF event handling interface *
* Copyright 2000 Dave Peticolas <dave@krondo.com> *
* Copyright 2006 Neil Williams <linux@codehelp.co.uk> *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License as *
* published by the Free Software Foundation; either version 2 of *
* the License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License*
* along with this program; if not, contact: *
* *
* Free Software Foundation Voice: +1-617-542-5942 *
* 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
* Boston, MA 02110-1301, USA gnu@gnu.org *
* *
********************************************************************/
/** @addtogroup Event
@{
*/
/** @file qofevent.h
@brief QOF event handling interface
@author Copyright 2000 Dave Peticolas <dave@krondo.com>
@author Copyright 2006 Neil Williams <linux@codehelp.co.uk>
*/
#ifndef QOF_EVENT_H
#define QOF_EVENT_H
#include "qof.h"
/** Define the type of events allowed. */
typedef gint QofEventId;
/** \brief Allow application-specific events to be created.
Used together with QOF_EVENT_BASE to simplify creation
of application events without interfering with any new
events added within QOF.
\verbatim
#define APP_EVENT_A QOF_MAKE_EVENT(QOF_EVENT_BASE+0)
#define APP_EVENT_B QOF_MAKE_EVENT(QOF_EVENT_BASE+1)
\endverbatim
*/
#define QOF_MAKE_EVENT(x) (1<<(x))
/** Allow scope for more defaults in future. Additional
event identifiers must be based on this when using QOF_MAKE_EVENT(). */
#define QOF_EVENT_BASE 8
/** \name 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.
@{
*/
/** init value - invalid. */
#define QOF_EVENT_NONE (0)
/** an entity has been created. */
#define QOF_EVENT_CREATE QOF_MAKE_EVENT(0)
/** \brief an entity is about to be modified.
In addition to previous usage, can used for
::QofUndo so that the original state
of an entity can be stored before modification
to allow the change to be undone and then redone.
*/
#define QOF_EVENT_MODIFY QOF_MAKE_EVENT(1)
/** an entity is about to be destroyed. */
#define QOF_EVENT_DESTROY QOF_MAKE_EVENT(2)
#define QOF_EVENT_ADD QOF_MAKE_EVENT(3)
#define QOF_EVENT_REMOVE QOF_MAKE_EVENT(4)
/** \brief an entity has been modified.
Added for QofUndo so that the altered state
of an entity can be stored to allow the change
to be undone and then redone.
\since 0.7.0
*/
#define QOF_EVENT_COMMIT QOF_MAKE_EVENT(5)
#define QOF_EVENT__LAST QOF_MAKE_EVENT(QOF_EVENT_BASE-1)
#define QOF_EVENT_ALL (0xff)
/** @} */
/** \brief Handler invoked when an event is generated.
@param ent: Entity generating the event
@param event_type: The id of the event, including additional identifiers and
the older defaults.
@param handler_data: data supplied when handler was registered.
@param event_data: data to be supplied when handler is invoked.
*/
typedef void (*QofEventHandler) (QofEntity * ent, QofEventId event_type,
gpointer handler_data, gpointer event_data);
/** \brief Register a handler for events.
@param handler: handler to register
@param handler_data: data provided when handler is invoked
@return id identifying handler
*/
gint qof_event_register_handler (QofEventHandler handler,
gpointer handler_data);
/** \brief Unregister an event handler.
@param handler_id: the id of the handler to unregister
*/
void qof_event_unregister_handler (gint handler_id);
/** \brief Invoke all registered event handlers using the given arguments.
Certain default events are used by QOF:
- QOF_EVENT_DEFAULT_CREATE events should be generated \b after
the object has been created and registered in the book.
- QOF_EVENT_DEFAULT_MODIFY events should be generated whenever
any data member or submember (i.e., splits) is changed.
- QOF_EVENT_DEFAULT_DESTROY events should be called \b before
the object has been destroyed or removed book.
Any other events are entirely the concern of the application.
\note QofEventHandler routines do \b NOT support generating
events from a GUID and QofIdType - you must specify a genuine QofEntity.
@param entity: the entity generating the event
@param event_type: the name of the event.
@param event_data: Data to be passed to the event handler just for
this one event. Can be NULL.
*/
void qof_event_gen (QofEntity * entity, QofEventId event_type,
gpointer event_data);
/** \brief Suspend all engine events.
*
* This function may be called multiple times. To resume event generation,
* an equal number of calls to qof_event_resume
* must be made.
*/
void qof_event_suspend (void);
/** Resume engine event generation. */
void qof_event_resume (void);
#endif
/** @} */
|