QofBackend_s Struct Reference
[Object: Dynamic Object Class Framework]


Detailed Description

Definition at line 286 of file qofbackend-p.h.

Data Fields

void(* session_begin )(QofBackend *be, QofSession *session, const char *book_id, gboolean ignore_lock, gboolean create_if_nonexistent)
void(* session_end )(QofBackend *)
void(* destroy_backend )(QofBackend *)
void(* load )(QofBackend *, QofBook *)
void(* begin )(QofBackend *, QofInstance *)
void(* commit )(QofBackend *, QofInstance *)
void(* rollback )(QofBackend *, QofInstance *)
gpointer(* compile_query )(QofBackend *, QofQuery *)
void(* free_query )(QofBackend *, gpointer)
void(* run_query )(QofBackend *, gpointer)
void(* sync )(QofBackend *, QofBook *)
void(* load_config )(QofBackend *, KvpFrame *)
KvpFrame *(* get_config )(QofBackend *)
gint64(* counter )(QofBackend *, const char *counter_name)
gboolean(* events_pending )(QofBackend *)
gboolean(* process_events )(QofBackend *)
QofBePercentageFunc percentage
QofBackendProviderprovider
gboolean(* save_may_clobber_data )(QofBackend *)
QofBackendError last_err
char * error_msg
KvpFramebackend_configuration
gint config_count
char * fullpath
void(* price_lookup )(QofBackend *, gpointer)
void(* export )(QofBackend *, QofBook *)


Field Documentation

void(* QofBackend_s::export)(QofBackend *, QofBook *)
 

Deprecated:
Export should really _NOT_ be here, but is left here for now. I'm not sure where this should be going to. It should be removed ASAP. This is a temporary hack-around until period-closing is fully implemented.

char* QofBackend_s::fullpath
 

Each backend resolves a fully-qualified file path. This holds the filepath and communicates it to the frontends.

Definition at line 340 of file qofbackend-p.h.

void(* QofBackend_s::price_lookup)(QofBackend *, gpointer)
 

Deprecated:
price_lookup should be removed during the redesign of the SQL backend... prices can now be queried using the generic query mechanism.
Note the correct signature for this call is void (*price_lookup) (QofBackend *, GNCPriceLookup *); we use gpointer to avoid an unwanted include file dependency.

gboolean(* QofBackend_s::save_may_clobber_data)(QofBackend *)
 

Detect if the sync operation will overwrite data

File based backends tend to consider the original file as 'stale' immediately the data finishes loading. New data only exists in memory and the data in the file is completely replaced when qof_session_save is called. e.g. this routine can be used to detect if a Save As... operation would overwrite a possibly unrelated file. Not all file backends use this function.

Returns:
TRUE if the user may need to be warned about possible data loss, otherwise FALSE.


The documentation for this struct was generated from the following file:
Generated on Fri May 12 18:00:35 2006 for QOF by  doxygen 1.4.4