qofid.h File Reference

Detailed Description

QOF entity type identification system.

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

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

Copyright (C) 2006-2007 Neil Williams <linux@codehelp.co.uk>

Definition in file qofid.h.

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

Go to the source code of this file.

Data Structures

struct  QofEntity_s

Collections of Entities

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


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


typedef const gchar * QofIdType
typedef const gchar * QofIdTypeConst
typedef const gchar * QofLogModule
typedef struct QofEntity_s QofEntity
typedef struct QofCollection_s QofCollection


const GUID * qof_entity_get_guid (QofEntity *)
QOF Entity Initialization & Shutdown
void qof_entity_init (QofEntity *, QofIdType, QofCollection *)
void qof_entity_release (QofEntity *)
QOF_TYPE_COLLECT: Linking one entity to many of one type
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:

gboolean qof_collection_add_entity (QofCollection *coll, QofEntity *ent)
 Add an entity to a QOF_TYPE_COLLECT.
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, GList *glist)
 Create a secondary collection from a GList.

Generated on Thu Jan 31 22:50:26 2008 for QOF by  doxygen 1.5.4