qofevent.h

Go to the documentation of this file.

/********************************************************************
 * 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                   *
 *                                                                  *
 ********************************************************************/

#ifndef QOF_EVENT_H
#define QOF_EVENT_H

#include "qof.h"

#ifdef __cplusplus
extern "C"
{
#endif

typedef gint QofEventId;

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

#define QOF_EVENT_BASE 8

#define QOF_EVENT_NONE     (0)
#define QOF_EVENT_CREATE   QOF_MAKE_EVENT(0)
#define QOF_EVENT_MODIFY   QOF_MAKE_EVENT(1)
#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__LAST    QOF_MAKE_EVENT(QOF_EVENT_BASE-1)
#define QOF_EVENT_ALL      (0xff)

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

gint qof_event_register_handler (QofEventHandler handler, gpointer handler_data);

void qof_event_unregister_handler (gint handler_id);

void qof_event_gen (QofInstance *entity, QofEventId event_type,
                    gpointer event_data);

void qof_event_suspend (void);

void qof_event_resume (void);

#ifdef __cplusplus
}
#endif

#endif