mirror of
https://github.com/Gnucash/gnucash.git
synced 2025-02-25 18:55:30 -06:00
367a8b5f69
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@8782 57a11ea4-9604-0410-9ed3-97b8803252fd
105 lines
3.9 KiB
C
105 lines
3.9 KiB
C
/********************************************************************\
|
|
* qof-book-p.h -- private functions for QOF books. *
|
|
* *
|
|
* 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 *
|
|
* *
|
|
\********************************************************************/
|
|
|
|
/*
|
|
* HISTORY:
|
|
* Created 2001 by Rob Browning
|
|
* Copyright (c) 2001 Rob Browning
|
|
* Copyright (c) 2001,2003 Linas Vepstas <linas@linas.org>
|
|
*/
|
|
|
|
#ifndef QOF_BOOK_P_H
|
|
#define QOF_BOOK_P_H
|
|
|
|
#include "kvp_frame.h"
|
|
#include "qofbackend.h"
|
|
#include "qofbook.h"
|
|
#include "qofid.h"
|
|
|
|
struct _QofBook
|
|
{
|
|
/* Unique guid for this book. */
|
|
GUID guid;
|
|
|
|
/* The KvpFrame provides a place for top-level data associated
|
|
* with this book. */
|
|
KvpFrame *kvp_data;
|
|
|
|
/* The entity table associates the GUIDs of all the objects
|
|
* belonging to this book, with their pointers to the respective
|
|
* objects. This allows a lookup of objects based on thier guid.
|
|
*/
|
|
QofEntityTable *entity_table;
|
|
|
|
/* In order to store arbitrary data, for extensibility, add a table
|
|
* that will be used to hold arbitrary pointers.
|
|
*/
|
|
GHashTable *data_tables;
|
|
|
|
/* state flag: 'y' means 'open for editing',
|
|
* 'n' means 'book is closed'
|
|
*/
|
|
char book_open;
|
|
|
|
/* dirty/clean flag. If dirty, then this book has been modified,
|
|
* but has not yet been written out to storage (file/database)
|
|
*/
|
|
gboolean dirty;
|
|
|
|
/* version number, used for tracking multiuser updates */
|
|
gint32 version;
|
|
|
|
/* To be technically correct, backends belong to sessions and
|
|
* not books. So the pointer below "really shouldn't be here",
|
|
* except that it provides a nice convenience, avoiding a lookup
|
|
* from the session. Better solutions welcome ... */
|
|
QofBackend *backend;
|
|
|
|
/* -------------------------------------------------------------- */
|
|
/* Backend private expansion data */
|
|
guint32 idata; /* used by the sql backend for kvp management */
|
|
};
|
|
|
|
/*
|
|
* These qof_book_set_*() routines are used by backends to
|
|
* initialize the pointers in the book structure to
|
|
* something that contains actual data. These routines
|
|
* should not be used otherwise. (Its somewhat questionable
|
|
* if the backends should even be doing this much, but for
|
|
* backwards compatibility, we leave these here.)
|
|
*/
|
|
void qof_book_set_guid(QofBook *book, GUID guid);
|
|
void qof_book_set_schedxactions( QofBook *book, GList *newList );
|
|
|
|
void qof_book_set_backend (QofBook *book, QofBackend *be);
|
|
|
|
/* The qof_book_mark_saved() routine marks the book as having been
|
|
* saved (to a file, to a database). Used by backends to mark the
|
|
* notsaved flag as FALSE just after loading. Do not use otherwise!
|
|
*/
|
|
void qof_book_mark_saved(QofBook *book);
|
|
|
|
/* Register books with the engine */
|
|
gboolean qof_book_register (void);
|
|
|
|
#endif /* QOF_BOOK_P_H */
|