qofbook.h

Go to the documentation of this file.
00001 /********************************************************************\
00002  * qofbook.h -- Encapsulate all the information about a dataset.    *
00003  * This program is free software; you can redistribute it and/or    *
00004  * modify it under the terms of the GNU General Public License as   *
00005  * published by the Free Software Foundation; either version 2 of   *
00006  * the License, or (at your option) any later version.              *
00007  *                                                                  *
00008  * This program is distributed in the hope that it will be useful,  *
00009  * but WITHOUT ANY WARRANTY; without even the implied warranty of   *
00010  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    *
00011  * GNU General Public License for more details.                     *
00012  *                                                                  *
00013  * You should have received a copy of the GNU General Public License*
00014  * along with this program; if not, contact:                        *
00015  *                                                                  *
00016  * Free Software Foundation           Voice:  +1-617-542-5942       *
00017  * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
00018  * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
00019  *                                                                  *
00020 \********************************************************************/
00039 #ifndef QOF_BOOK_H
00040 #define QOF_BOOK_H
00041 
00042 #include "qof.h"
00043 #include "kvp_frame.h"
00044 
00051 #define QOF_BOOK_LOOKUP_ENTITY(book,guid,e_type,c_type) ({  \
00052   QofEntity *val = NULL;                                    \
00053   if (guid && book) {                                       \
00054     QofCollection *col;                                     \
00055     col = qof_book_get_collection (book, e_type);           \
00056     val = qof_collection_lookup_entity (col, guid);         \
00057   }                                                         \
00058   (c_type *) val;                                           \
00059 })
00060 
00062 typedef struct _QofBook QofBook;
00063 
00065 typedef GList QofBookList;
00066 
00067 typedef void (*QofBookFinalCB) (QofBook *, gpointer key, gpointer user_data);
00068 
00070 gboolean qof_book_register (void);
00071 
00074 QofBook *qof_book_new (void);
00075 
00078 void qof_book_destroy (QofBook * book);
00079 
00085 void qof_book_mark_closed (QofBook * book);
00086 
00100 QofCollection *qof_book_get_collection (QofBook *, QofIdType);
00101 
00103 typedef void (*QofCollectionForeachCB) (QofCollection *, gpointer user_data);
00104 void qof_book_foreach_collection (QofBook *, QofCollectionForeachCB,
00105                                   gpointer);
00106 
00114 #define qof_book_get_slots(book) qof_instance_get_slots(QOF_INSTANCE(book))
00115 
00126 void qof_book_set_data (QofBook * book, const gchar * key, gpointer data);
00127 
00132 void qof_book_set_data_fin (QofBook * book, const gchar * key, gpointer data,
00133                             QofBookFinalCB);
00134 
00136 gpointer qof_book_get_data (QofBook * book, const gchar * key);
00137 
00139 gboolean qof_book_shutting_down (QofBook * book);
00140 
00149 gboolean qof_book_not_saved (QofBook * book);
00150 
00156 void qof_book_mark_saved (QofBook * book);
00157 
00160 void qof_book_kvp_changed (QofBook * book);
00161 
00165 gboolean qof_book_equal (QofBook * book_1, QofBook * book_2);
00166 
00170 gint64 qof_book_get_counter (QofBook * book, const gchar *counter_name);
00171 
00173 #endif /* QOF_BOOK_H */

Generated on Fri Sep 15 14:24:56 2006 for QOF by  doxygen 1.4.7