gnc-event.h

Go to the documentation of this file.

/********************************************************************
 * gnc-event.h -- engine event handling interface                   *
 * Copyright 2000 Dave Peticolas <dave@krondo.com>                  *
 *                                                                  *
 * 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       *
 * 59 Temple Place - Suite 330        Fax:    +1-617-542-2652       *
 * Boston, MA  02111-1307,  USA       gnu@gnu.org                   *
 *                                                                  *
 ********************************************************************/

#ifndef GNC_EVENT_H
#define GNC_EVENT_H

#include <glib.h>

#include "guid.h"
#include "qofid.h"

typedef enum
{
  GNC_EVENT_NONE    = 0,
  GNC_EVENT_CREATE  = 1 << 0,
  GNC_EVENT_MODIFY  = 1 << 1,
  GNC_EVENT_DESTROY = 1 << 2,
  GNC_EVENT_ADD     = 1 << 3,
  GNC_EVENT_REMOVE  = 1 << 4,
  GNC_EVENT_ALL     = 0xff
} GNCEngineEventType;


typedef void (*GNCEngineEventHandler) (GUID *entity, QofIdType type,
                                       GNCEngineEventType event_type,
                                       gpointer user_data);

gint gnc_engine_register_event_handler (GNCEngineEventHandler handler,
                                        gpointer user_data);

void gnc_engine_unregister_event_handler (gint handler_id);

void gnc_engine_gen_event (QofEntity *entity,
                                GNCEngineEventType event_type);
void gnc_engine_suspend_events (void);

void gnc_engine_resume_events (void);

#endif

---