Private interfaces, not meant to be used by applications.
Let the sytem know about a new provider of backends. This function is typically called by the provider library at library load time. This function allows the backend library to tell QOF infrastructure that it can handle URL's of a certain type. Note that a single backend library may register more than one provider, if it is capable of handling more than one URL access method.
Definition at line 59 of file qofsession.c.
61 provider_list = g_slist_prepend (provider_list, prov);
guint32 qof_book_get_idata |
( |
QofBook * |
book | ) |
|
get the book tag number
used for kvp management in sql backends.
Definition at line 295 of file qofbook.c.
gchar qof_book_get_open_marker |
( |
QofBook * |
book | ) |
|
Allow backends to see if the book is open
- Returns
- 'y' if book is open, otherwise 'n'.
Definition at line 275 of file qofbook.c.
gint32 qof_book_get_version |
( |
QofBook * |
book | ) |
|
get the book version
used for tracking multiuser updates in backends.
- Returns
- -1 if no book exists, 0 if the book is new, otherwise the book version number.
Definition at line 285 of file qofbook.c.
gboolean qof_book_register |
( |
void |
| ) |
|
Register books with the framework
Definition at line 376 of file qofbook.c.
379 {QOF_PARAM_GUID, QOF_TYPE_GUID,
385 {NULL, NULL, NULL, NULL, NULL},
void qof_class_register(QofIdTypeConst obj_name, QofSortFunc default_sort_function, const QofParam *params)
registers a new object class with the Qof subsystem.
KvpFrame * qof_instance_get_slots(QofInstance *inst)
gpointer(* QofAccessFunc)(gpointer object, const QofParam *param)
const GUID * qof_entity_get_guid(QofEntity *ent)
Set the backend used by this book.
qof_book_set_backend() is used by backends to initialize the pointers in the book structure to something that contains actual data. These routines should not be used otherwise. (Its somewhat questionable if the backends should even be doing this much, but for backwards compatibility, we leave these here.)
Should only be used within a backend itself.
Definition at line 170 of file qofbook.c.
174 ENTER (
"book=%p be=%p", book, be);
#define LEAVE(format, args...)
#define ENTER(format, args...)
Take entity, remove it from whatever collection its currently in, and place it in a new collection. To be used only for moving entity from one book to another.
Definition at line 168 of file qofid.c.
174 g_return_if_fail (col->e_type == ent->e_type);
175 qof_collection_remove_entity (ent);
176 g_hash_table_insert (col->hash_of_entities, &ent->guid, ent);
177 qof_collection_mark_dirty (col);
178 ent->collection = col;
gboolean guid_equal(const GUID *guid_1, const GUID *guid_2)
const GUID * guid_null(void)
reset value of dirty flag
Definition at line 339 of file qofid.c.
343 col->is_dirty = FALSE;
Set the ID of the entity, over-riding the previous ID. Very dangerous, use only for file i/o work.
Definition at line 92 of file qofid.c.
98 col = ent->collection;
99 qof_collection_remove_entity (ent);
gboolean guid_equal(const GUID *guid_1, const GUID *guid_2)
struct QofCollection_s QofCollection
void qof_collection_insert_entity(QofCollection *col, QofEntity *ent)
void qof_object_book_begin |
( |
QofBook * |
book | ) |
|
To be called from within the book
Definition at line 60 of file qofobject.c.
67 for (l = object_modules; l; l = l->next)
75 book_list = g_list_prepend (book_list, book);
#define LEAVE(format, args...)
void(* book_begin)(QofBook *)
#define ENTER(format, args...)
gboolean qof_object_compliance |
( |
QofIdTypeConst |
type_name, |
|
|
gboolean |
warn |
|
) |
| |
check an object can be created and supports iteration
- Parameters
-
type_name | object to check |
warn | If called only once per operation, pass TRUE to log objects that fail the compliance check. To prevent repeated log messages when calling more than once, pass FALSE. |
- Returns
- TRUE if object can be created and supports iteration, else FALSE.
Definition at line 155 of file qofobject.c.
164 PINFO (
" Object type %s is not fully QOF compliant",
#define PINFO(format, args...)
const QofObject * qof_object_lookup(QofIdTypeConst name)
gpointer(* create)(QofBook *)
void(* foreach)(QofCollection *, QofEntityForeachCB, gpointer)