qofid.h File Reference


Detailed Description

QOF entity type identification system.

Author:
Copyright (C) 2000 Dave Peticolas <peticola@cs.ucdavis.edu>

Copyright (C) 2003 Linas Vepstas <linas@linas.org>

Definition in file qofid.h.

#include <string.h>
#include "guid.h"
#include "qofinstance.h"

Go to the source code of this file.

Collections of Entities

typedef void(*) QofInstanceForeachCB (QofInstance *, gpointer user_data)
QofCollectionqof_collection_new (QofIdType type)
guint qof_collection_count (const QofCollection *col)
void qof_collection_destroy (QofCollection *col)
QofIdType qof_collection_get_type (const QofCollection *)
QofInstanceqof_collection_lookup_entity (const QofCollection *, const GUID *)
void qof_collection_foreach (const QofCollection *, QofInstanceForeachCB, gpointer user_data)
gpointer qof_collection_get_data (const QofCollection *col)
void qof_collection_set_data (QofCollection *col, gpointer user_data)
gboolean qof_collection_is_dirty (const QofCollection *col)

Defines

#define QOF_ID_NONE   NULL
#define QOF_ID_NULL   "null"
#define QOF_ID_BOOK   "Book"
#define QOF_ID_SESSION   "Session"
#define QSTRCMP(da, db)
#define QOF_CHECK_TYPE(obj, type)
#define QOF_CHECK_CAST(obj, e_type, c_type)

Typedefs

typedef const gchar * QofIdType
typedef const gchar * QofIdTypeConst
typedef const gchar * QofLogModule
typedef QofCollection_s QofCollection

Functions

gboolean qof_get_alt_dirty_mode (void)
void qof_set_alt_dirty_mode (gboolean enabled)
QOF_TYPE_COLLECT: Linking one entity to many of one type
Note:
These are NOT the same as the main collections in the book.
QOF_TYPE_COLLECT is a secondary collection, used to select entities of one object type as references of another entity.
See also:
QOF_TYPE_CHOICE.


gboolean qof_collection_add_entity (QofCollection *coll, QofInstance *ent)
 Add an entity to a QOF_TYPE_COLLECT.
void qof_collection_remove_entity (QofInstance *ent)
gboolean qof_collection_merge (QofCollection *target, QofCollection *merge)
 Merge two QOF_TYPE_COLLECT of the same type.
gint qof_collection_compare (QofCollection *target, QofCollection *merge)
 Compare two secondary collections.
QofCollectionqof_collection_from_glist (QofIdType type, const GList *glist)
 Create a secondary collection from a GList.


Generated on Sun Sep 7 05:07:48 2008 for GnuCash by  doxygen 1.5.2