qofbook.h

Go to the documentation of this file.

/********************************************************************\
 * qofbook.h -- Encapsulate all the information about a dataset.    *
 * 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                   *
 *                                                                  *
\********************************************************************/
#ifndef QOF_BOOK_H
#define QOF_BOOK_H

#include "qof.h"

#define QOF_BOOK_LOOKUP_ENTITY(book,guid,e_type,c_type) ({  \
  QofEntity *val = NULL;                                    \
  if (guid && book) {                                       \
    QofCollection *col;                                     \
    col = qof_book_get_collection (book, e_type);           \
    val = qof_collection_lookup_entity (col, guid);         \
  }                                                         \
  (c_type *) val;                                           \
})

typedef struct _QofBook QofBook;

typedef GList QofBookList;

typedef void (*QofBookFinalCB) (QofBook *, gpointer key, gpointer user_data);

gboolean qof_book_register (void);

QofBook *qof_book_new (void);

void qof_book_destroy (QofBook * book);

void qof_book_mark_closed (QofBook * book);

QofCollection *qof_book_get_collection (QofBook *, QofIdType);

typedef void (*QofCollectionForeachCB) (QofCollection *, gpointer user_data);
void qof_book_foreach_collection (QofBook *, QofCollectionForeachCB,
                                  gpointer);

#define qof_book_get_slots(book) qof_instance_get_slots(QOF_INSTANCE(book))

void qof_book_set_data (QofBook * book, const gchar * key, gpointer data);

void qof_book_set_data_fin (QofBook * book, const gchar * key, gpointer data,
                            QofBookFinalCB);

gpointer qof_book_get_data (QofBook * book, const gchar * key);

gboolean qof_book_shutting_down (QofBook * book);

gboolean qof_book_not_saved (QofBook * book);

void qof_book_mark_saved (QofBook * book);

void qof_book_kvp_changed (QofBook * book);

gboolean qof_book_equal (QofBook * book_1, QofBook * book_2);

gint64 qof_book_get_counter (QofBook * book, const gchar *counter_name);

#endif /* QOF_BOOK_H */

---