mirror of
https://github.com/Gnucash/gnucash.git
synced 2025-02-25 18:55:30 -06:00
Add component manager interface and .c stub.
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@3260 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Dave Peticolas
@@ -43,6 +43,7 @@ gnucash_SOURCES = \
|
||||
EuroUtils.c \
|
||||
FileDialog.c \
|
||||
Refresh.c \
|
||||
gnc-component-manager.c \
|
||||
gnc-exp-parser.c \
|
||||
gnc-ui-util.c
|
||||
|
||||
@@ -59,6 +60,7 @@ noinst_HEADERS = \
|
||||
RegWindow.h \
|
||||
SplitLedger.h \
|
||||
file-history.h \
|
||||
gnc-component-manager.h \
|
||||
gnc-exp-parser.h \
|
||||
gnc-ui.h \
|
||||
gnc-ui-common.h \
|
||||
|
||||
22
src/gnc-component-manager.c
Normal file
22
src/gnc-component-manager.c
Normal file
@@ -0,0 +1,22 @@
|
||||
/********************************************************************\
|
||||
* gnc-component-manager.h - GUI component manager interface *
|
||||
* Copyright (C) 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, write to the Free Software *
|
||||
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
|
||||
\********************************************************************/
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include "gnc-component-manager.h"
|
||||
241
src/gnc-component-manager.h
Normal file
241
src/gnc-component-manager.h
Normal file
@@ -0,0 +1,241 @@
|
||||
/********************************************************************\
|
||||
* gnc-component-manager.h - GUI component manager interface *
|
||||
* Copyright (C) 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, write to the Free Software *
|
||||
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
|
||||
\********************************************************************/
|
||||
|
||||
#ifndef __GNC_COMPONENT_MANAGER_H__
|
||||
#define __GNC_COMPONENT_MANAGER_H__
|
||||
|
||||
#include <glib.h>
|
||||
|
||||
#include "GNCId.h"
|
||||
#include "gnc-event.h"
|
||||
|
||||
|
||||
/* GNCComponentRefreshHandler
|
||||
* Handler invoked to inform the component that a refresh
|
||||
* may be needed.
|
||||
*
|
||||
* changes: if NULL, the component should perform a refresh.
|
||||
*
|
||||
* if non-NULL, changes is a GUID hash that maps
|
||||
* GUIDs to GNCEngineEventType bitmasks describing
|
||||
* which events have been received. Entities not
|
||||
* in the hash have not generated any events.
|
||||
* Entities which have been destroyed may not
|
||||
* exist.
|
||||
*
|
||||
* Note since refreshes may not occur with every change,
|
||||
* an entity may have all three change values.
|
||||
*
|
||||
* The component should use 'changes' to determine whether
|
||||
* or not a refresh is needed. The hash table must not be
|
||||
* changed.
|
||||
*
|
||||
* Notes on refreshing: when the handler is invoked any engine
|
||||
* entities used by the component may be
|
||||
* deleted. 'Refreshing' the component may
|
||||
* require closing the component.
|
||||
*
|
||||
* user_data: user_data supplied when component was registered.
|
||||
*/
|
||||
typedef gboolean (*GNCComponentRefreshHandler) (GHashTable *changes,
|
||||
gpointer user_data);
|
||||
|
||||
/* GNCComponentCloseHandler
|
||||
* Handler invoked to close the component.
|
||||
*
|
||||
* user_data: user_data supplied when component was registered.
|
||||
*
|
||||
* Notes on closing: components are not automatically unregistered
|
||||
* when the close handler is invoked. Components
|
||||
* may not ignore the handler.
|
||||
*/
|
||||
typedef void (*GNCComponentCloseHandler) (gpointer user_data);
|
||||
|
||||
|
||||
/* GNCComponentFindHandler
|
||||
* Handler invoked when searching for a component.
|
||||
*
|
||||
* find_data: find_data supplied when search was started.
|
||||
* user_data: user_data supplied when component was registered.
|
||||
*
|
||||
* Return: TRUE if the component matches the search criteria.
|
||||
*/
|
||||
typedef gboolean (*GNCComponentFindHandler) (gpointer find_data,
|
||||
gpointer user_data);
|
||||
|
||||
/* GNCComponentHandler
|
||||
* Generic handler used in iterating over components.
|
||||
*
|
||||
* class: class of component
|
||||
* id: id of component
|
||||
*/
|
||||
typedef void (*GNCComponentHandler) (const char *class, gint id);
|
||||
|
||||
/* gnc_register_gui_component
|
||||
* Register a GUI component with the manager.
|
||||
*
|
||||
* component_class: a string defining a class of components
|
||||
* certain component functions can be performed
|
||||
* on all objects in a class. For that reason,
|
||||
* components in the same class should all use
|
||||
* the same type for user_data.
|
||||
*
|
||||
* refresh_cb: refresh handler, may be NULL
|
||||
* close_cb: close handler, may be NULL
|
||||
* user_data: user_data argument for handlers
|
||||
*
|
||||
*
|
||||
* Notes: After a refresh handler is registered, the
|
||||
* component must use the API calls below to
|
||||
* inform the component manager which engine
|
||||
* entities are being 'watched', i.e., which
|
||||
* engine entities may cause the component
|
||||
* to need refreshing.
|
||||
*
|
||||
* When a component is first registered, it
|
||||
* is not watching anything, and thus will
|
||||
* not receive refresh handlers.
|
||||
*
|
||||
* Return: id of component
|
||||
*/
|
||||
gint gnc_register_gui_component (const char *component_class,
|
||||
GNCComponentRefreshHandler refresh_cb,
|
||||
GNCComponentCloseHandler close_cb,
|
||||
gpointer user_data);
|
||||
|
||||
/* gnc_gui_component_watch_entity
|
||||
* Add an entity to the list of those being watched by the component.
|
||||
* Only entities with refresh handlers should add watches.
|
||||
*
|
||||
* component_id: id of component which is watching the entity
|
||||
* entity: id of entity to watch
|
||||
* event_mask: mask which determines which kinds of events are watched
|
||||
* setting the mask to 0 turns off watching for the entity.
|
||||
*/
|
||||
void gnc_gui_component_watch_entity (gint component_id,
|
||||
GUID *entity,
|
||||
GNCEngineEventType event_mask);
|
||||
|
||||
/* gnc_gui_component_watch_entity_type
|
||||
* Watch all entities of a particular type.
|
||||
*
|
||||
* component_id: id of component which is watching the entity type
|
||||
* entity_type: type of entity to watch
|
||||
* event_mask: mask which determines which kinds of events are watched
|
||||
* setting the mask to 0 turns off watching for the entity type
|
||||
*/
|
||||
void gnc_gui_component_watch_entity_type (gint component_id,
|
||||
GNCIdType entity_type,
|
||||
GNCEngineEventType event_mask);
|
||||
|
||||
/* gnc_gui_component_clear_watches
|
||||
* Clear all watches for the component.
|
||||
*
|
||||
* component_id: id of component to clear watches for.
|
||||
*/
|
||||
void gnc_gui_component_clear_watches (gint component_id);
|
||||
|
||||
/* gnc_unregister_gui_component
|
||||
* Unregister a gui component from the manager.
|
||||
*
|
||||
* component_id: id of component to unregister
|
||||
*/
|
||||
void gnc_unregister_gui_component (gint component_id);
|
||||
|
||||
/* gnc_unregister_gui_component_by_data
|
||||
* Unregister a gui component using the user_data pointer.
|
||||
*
|
||||
* component_class: class component is in
|
||||
* user_data: user_data pointer of component to unregister
|
||||
* all components with that user_data in the
|
||||
* class are unregistered.
|
||||
*/
|
||||
void gnc_unregister_gui_component_by_data (const char *component_class,
|
||||
gpointer user_data);
|
||||
|
||||
/* gnc_suspend_gui_refresh
|
||||
* Suspend refresh handlers by the component manager.
|
||||
* This routine may be called multiple times. Each call
|
||||
* increases the suspend counter (starts at zero).
|
||||
*/
|
||||
void gnc_suspend_gui_refresh (void);
|
||||
|
||||
/* gnc_resume_gui_refresh
|
||||
* Resume refresh handlers by the component manager.
|
||||
* Each call reduces the suspend counter by one. When
|
||||
* the counter reaches zero, all changes which have
|
||||
* occured since the last refresh are collected and
|
||||
* passed to the components in refresh handlers.
|
||||
*/
|
||||
void gnc_resume_gui_refresh (void);
|
||||
|
||||
/* gnc_gui_refresh_all
|
||||
* Force all components to refresh.
|
||||
*
|
||||
* This routine may only be invoked when the suspend counter
|
||||
* is zero. It should never be mixed with the suspend/resume
|
||||
* refresh routines.
|
||||
*/
|
||||
void gnc_gui_refresh_all (void);
|
||||
|
||||
/* gnc_close_gui_component
|
||||
* Invoke the close handler for the indicated component.
|
||||
*
|
||||
* component_id: id of component to close
|
||||
*/
|
||||
void gnc_close_gui_component (gint component_id);
|
||||
|
||||
/* gnc_close_gui_component_by_data
|
||||
* Invoke the close handler for components in the given
|
||||
* class with the given user_data.
|
||||
*
|
||||
* component_class: class to close components in
|
||||
* user_data: user_data of component to close
|
||||
* all components with that user_data
|
||||
* are closed.
|
||||
*/
|
||||
void gnc_close_gui_component_by_data (const char *component_class,
|
||||
gpointer user_data);
|
||||
|
||||
/* gnc_find_gui_component
|
||||
* Search components in the specified class.
|
||||
*
|
||||
* component_class: the class to search for components in
|
||||
* find_cb: the handler used to search for the component
|
||||
* find_data: find_data passed to find_cb
|
||||
*
|
||||
* Returns: user_data of found component, or NULL if none found
|
||||
*/
|
||||
GList * gnc_find_gui_component (const char *component_class,
|
||||
GNCComponentFindHandler find_cb,
|
||||
gpointer find_data);
|
||||
|
||||
/* gnc_forall_gui_components
|
||||
* Invoke 'handler' for components in the database.
|
||||
*
|
||||
* component_class: class to iterate over, if NULL then
|
||||
* all classes are iterated over
|
||||
* handler: handler to invoke
|
||||
* iter_data: data passed to handler
|
||||
*/
|
||||
void gnc_forall_gui_components (const char *component_class,
|
||||
GNCComponentHandler handler,
|
||||
gpointer iter_data);
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user