mirror of
https://github.com/Gnucash/gnucash.git
synced 2025-02-25 18:55:30 -06:00
0b8a944f30
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@11964 57a11ea4-9604-0410-9ed3-97b8803252fd
119 lines
4.2 KiB
C
119 lines
4.2 KiB
C
/********************************************************************
|
|
* 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 *
|
|
* 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
|
|
* Boston, MA 02110-1301, USA gnu@gnu.org *
|
|
* *
|
|
********************************************************************/
|
|
|
|
/** @addtogroup Event
|
|
@{
|
|
*/
|
|
/** @file gnc-event.h
|
|
@brief engine event handling interface
|
|
@author Copyright 2000 Dave Peticolas <dave@krondo.com>
|
|
*/
|
|
|
|
#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;
|
|
|
|
|
|
/** GNCEngineEventHandler
|
|
|
|
* Handler invoked when an engine event occurs.
|
|
*
|
|
* @param entity: GUID of entity generating event
|
|
* @param type: QofIdType of the entity generating the event
|
|
* @param event_type: one of the single-bit GNCEngineEventTypes, not a combination
|
|
* @param user_data: user_data supplied when handler was registered.
|
|
*/
|
|
typedef void (*GNCEngineEventHandler) (GUID *entity, QofIdType type,
|
|
GNCEngineEventType event_type,
|
|
gpointer user_data);
|
|
|
|
/** gnc_engine_register_event_handler
|
|
|
|
* Register a handler for engine events.
|
|
*
|
|
* @param handler: handler to register
|
|
* @param user_data: data provided when handler is invoked
|
|
*
|
|
* @return id identifying handler
|
|
*/
|
|
gint gnc_engine_register_event_handler (GNCEngineEventHandler handler,
|
|
gpointer user_data);
|
|
|
|
/** gnc_engine_unregister_event_handler
|
|
|
|
* Unregister an engine event handler.
|
|
*
|
|
* @param handler_id: the id of the handler to unregister
|
|
*/
|
|
void gnc_engine_unregister_event_handler (gint handler_id);
|
|
|
|
/** gnc_engine_generate_event
|
|
|
|
* Invoke all registered event handlers using the given arguments.
|
|
*
|
|
* GNC_EVENT_CREATE events should be generated after the object
|
|
* has been created and registered in the engine entity table.
|
|
* GNC_EVENT_MODIFY events should be generated whenever any data
|
|
* member or submember (i.e., splits) is changed.
|
|
* GNC_EVENT_DESTROY events should be called before the object
|
|
* has been destroyed or removed from the entity table.
|
|
*
|
|
* @param entity: the GUID of the entity generating the event
|
|
* @param event_type: the type of event -- this should be one of the
|
|
* single-bit GNCEngineEventType values, not a combination.
|
|
*/
|
|
void gnc_engine_gen_event (QofEntity *entity,
|
|
GNCEngineEventType event_type);
|
|
/** gnc_engine_suspend_events
|
|
|
|
* Suspend all engine events. This function may be
|
|
* called multiple times. To resume event generation,
|
|
* an equal number of calls to gnc_engine_resume_events
|
|
* must be made.
|
|
*/
|
|
void gnc_engine_suspend_events (void);
|
|
|
|
/** gnc_engine_resume_events
|
|
|
|
* Resume engine event generation.
|
|
*/
|
|
void gnc_engine_resume_events (void);
|
|
|
|
#endif
|
|
/** @} */
|