GnuCash  4.12-74-g36b33262ad+
Macros | Typedefs

QOF entity type identification system. More...

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

Go to the source code of this file.


#define QOF_ID_NONE   NULL
#define QOF_ID_NULL   "null"
#define QOF_ID_BOOK   "Book"
#define QOF_ID_SESSION   "Session"
#define QSTRCMP   g_strcmp0
#define QOF_CHECK_TYPE(obj, type)
 return TRUE if object is of the given type More...
#define QOF_CHECK_CAST(obj, e_type, c_type)
 cast object to the indicated type, print error message if its bad More...


typedef const gchar * QofIdType
 QofIdType declaration.
typedef const gchar * QofIdTypeConst
 QofIdTypeConst declaration.


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, QofInstance *ent)
 Add an entity to a QOF_TYPE_COLLECT. More...
void qof_collection_remove_entity (QofInstance *ent)
gint qof_collection_compare (QofCollection *target, QofCollection *merge)
 Compare two secondary collections. More...
QofCollection * qof_collection_from_glist (QofIdType type, const GList *glist)
 Create a secondary collection from a GList. More...

Collections of Entities

QofCollection declaration

datagpointer, place where object class can hang arbitrary data
typedef void(* QofInstanceForeachCB) (QofInstance *, gpointer user_data)
 Callback type for qof_collection_foreach.
QofCollection * qof_collection_new (QofIdType type)
 create a new collection of entities of type
guint qof_collection_count (const QofCollection *col)
 return the number of entities in the collection. More...
void qof_collection_destroy (QofCollection *col)
 destroy the collection More...
QofIdType qof_collection_get_type (const QofCollection *)
 return the type that the collection stores
QofInstance * qof_collection_lookup_entity (const QofCollection *, const GncGUID *)
 Find the entity going only from its guid.
void qof_collection_foreach (const QofCollection *, QofInstanceForeachCB, gpointer user_data)
 Call the callback for each entity in the collection. More...
gpointer qof_collection_get_data (const QofCollection *col)
 Store and retrieve arbitrary object-defined data. More...
void qof_collection_set_data (QofCollection *col, gpointer user_data)
gboolean qof_collection_is_dirty (const QofCollection *col)
 Return value of 'dirty' flag on collection.

Detailed Description

QOF entity type identification system.

Copyright (C) 2000 Dave Peticolas
Copyright (C) 2003 Linas Vepstas

Definition in file qofid.h.