Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

Object_Private
[Object: Dynamic Object Class Framework]


Detailed Description

Private interfaces, not meant to be used by applications.

Private interfaces, not meant to be used by applications.

Private interfaces, not meant to be used by applications.

Private interfaces, not meant to be used by applications.

Private interfaces, not meant to be used by applications.

Private interfaces, not meant to be used by applications.


Files

file  qofobject-p.h
 the Core Object Registration/Lookup Private Interface


Data Structures

struct  _QofBackend
struct  _QofBook
struct  QofInstance_s

Book_Private

#define qof_book_set_guid(book, guid)   qof_entity_set_guid(QOF_ENTITY(book), guid)
void qof_book_set_schedxactions (QofBook *book, GList *newList)
void qof_book_set_backend (QofBook *book, QofBackend *be)
void qof_book_mark_saved (QofBook *book)
gboolean qof_book_register (void)

Backend_Private

Pseudo-object defining how the engine can interact with different back-ends (which may be SQL databases, or network interfaces to remote GnuCash servers. In theory, file-io should be a type of backend).

The callbacks will be called at the appropriate times during a book session to allow the backend to store the data as needed.

void qof_backend_set_error (QofBackend *be, QofBackendError err)
QofBackendError qof_backend_get_error (QofBackend *be)
void qof_backend_set_message (QofBackend *be, const char *format,...)
char * qof_backend_get_message (QofBackend *be)
void qof_backend_init (QofBackend *be)

Class_Private

void qof_class_init (void)
void qof_class_shutdown (void)
QofSortFunc qof_class_get_default_sort (QofIdTypeConst obj_name)

Entity_Private

void qof_entity_set_guid (QofEntity *ent, const GUID *guid)
void qof_collection_insert_entity (QofCollection *, QofEntity *)
void qof_collection_mark_clean (QofCollection *)
void qof_collection_mark_dirty (QofCollection *)

Instance_Private

void qof_instance_mark_clean (QofInstance *)
void qof_instance_set_slots (QofInstance *, KvpFrame *)

Objects_Private

void qof_object_book_begin (QofBook *book)
void qof_object_book_end (QofBook *book)
gboolean qof_object_is_dirty (QofBook *book)
void qof_object_mark_clean (QofBook *book)


Define Documentation

#define qof_book_set_guid book,
guid   )     qof_entity_set_guid(QOF_ENTITY(book), guid)
 

Deprecated:


Function Documentation

QofBackendError qof_backend_get_error QofBackend be  ) 
 

The qof_backend_get_error() routine pops an error code off the error stack.

char* qof_backend_get_message QofBackend be  ) 
 

The qof_backend_get_message() pops the error message string from the Backend. This string should be freed with g_free().

void qof_backend_set_error QofBackend be,
QofBackendError  err
 

The qof_backend_set_error() routine pushes an error code onto the error stack. (FIXME: the stack is 1 deep in current implementation).

void qof_backend_set_message QofBackend be,
const char *  format,
  ...
 

The qof_backend_set_message() assigns a string to the backend error message.

void qof_book_mark_saved QofBook book  ) 
 

The qof_book_mark_saved() routine marks the book as having been saved (to a file, to a database). Used by backends to mark the notsaved flag as FALSE just after loading. Do not use otherwise!

gboolean qof_book_register void   ) 
 

Register books with the engine

void qof_book_set_schedxactions QofBook book,
GList *  newList
 

These qof_book_set_*() routines are 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.)

void qof_collection_insert_entity QofCollection *  ,
QofEntity * 
 

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.

void qof_collection_mark_clean QofCollection *   ) 
 

reset value of dirty flag

void qof_entity_set_guid QofEntity *  ent,
const GUID guid
 

Set the ID of the entity, over-riding teh previous ID. Very dangerous, use only for file i/o work.

void qof_instance_mark_clean QofInstance  ) 
 

reset the dirty flag

void qof_object_book_begin QofBook book  ) 
 

To be called from within the book


Generated on Sun May 23 15:41:48 2004 for QOF by doxygen 1.3.6-20040222