qofbook.h File Reference

Encapsulate all the information about a dataset. More...

#include "qofid.h"
#include "kvp_frame.h"
#include "qofinstance.h"

Go to the source code of this file.

Data Structures
struct	_QofBook
struct	_QofBookClass
Defines
#define	QOF_TYPE_BOOK   (qof_book_get_type ())
#define	QOF_BOOK(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), QOF_TYPE_BOOK, QofBook))
#define	QOF_BOOK_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), QOF_TYPE_BOOK, QofBookClass))
#define	QOF_IS_BOOK(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), QOF_TYPE_BOOK))
#define	QOF_IS_BOOK_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), QOF_TYPE_BOOK))
#define	QOF_BOOK_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), QOF_TYPE_BOOK, QofBookClass))
#define	QOF_BOOK_RETURN_ENTITY(book, guid, e_type, c_type)
	Encapsulates all the information about a dataset manipulated by QOF. This is the top-most structure used for anchoring data.
#define	qof_book_get_guid(X)   qof_entity_get_guid (QOF_INSTANCE(X))
Typedefs
typedef struct _QofBookClass	QofBookClass
typedef void(*	QofBookDirtyCB )(QofBook *, gboolean dirty, gpointer user_data)
typedef GList	QofBookList
typedef void(*	QofBookFinalCB )(QofBook *, gpointer key, gpointer user_data)
typedef void(*	QofCollectionForeachCB )(QofCollection *, gpointer user_data)
Functions
GType	qof_book_get_type (void)
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 (const QofBook *, QofIdType)
void	qof_book_foreach_collection (const QofBook *, QofCollectionForeachCB, gpointer)
KvpFrame *	qof_book_get_slots (const QofBook *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 (const QofBook *book, const gchar *key)
gboolean	qof_book_is_readonly (const QofBook *book)
void	qof_book_mark_readonly (QofBook *book)
gboolean	qof_book_use_trading_accounts (const QofBook *book)
gboolean	qof_book_uses_autoreadonly (const QofBook *book)
gint	qof_book_get_num_days_autoreadonly (const QofBook *book)
GDate *	qof_book_get_autoreadonly_gdate (const QofBook *book)
gboolean	qof_book_shutting_down (const QofBook *book)
gboolean	qof_book_session_not_saved (const QofBook *book)
void	qof_book_mark_session_saved (QofBook *book)
void	qof_book_mark_session_dirty (QofBook *book)
time_t	qof_book_get_session_dirty_time (const QofBook *book)
void	qof_book_set_dirty_cb (QofBook *book, QofBookDirtyCB cb, gpointer user_data)
void	qof_book_kvp_changed (QofBook *book)
gint64	qof_book_get_counter (QofBook *book, const char *counter_name)
gchar *	qof_book_increment_and_format_counter (QofBook *book, const char *counter_name)
gchar *	qof_book_validate_counter_format (const gchar *format)
gchar *	qof_book_get_counter_format (const QofBook *book, const char *counter_name)
const char *	qof_book_get_string_option (const QofBook *book, const char *opt_name)
void	qof_book_set_string_option (QofBook *book, const char *opt_name, const char *opt_val)
void	qof_book_begin_edit (QofBook *book)
void	qof_book_commit_edit (QofBook *book)

---

Detailed Description

Encapsulate all the information about a dataset.

Author:

Copyright (c) 1998, 1999, 2001, 2003 Linas Vepstas <linas@linas.org>

Copyright (c) 2000 Dave Peticolas

Definition in file qofbook.h.