Copyright 2004-2005 Neil Williams <linux@codehelp.co.uk>
Definition in file qofbackend.h.
#include "qofinstance.h"
Go to the source code of this file.
Data Structures | |
| struct | QofBackendOption_s |
Backend Configuration using KVP | |
| The backend uses qof_backend_get_config to pass back a KvpFrame of QofBackendOption that includes the translated strings that serve as description and tooltip for that option. i.e. backends need to run gettext in the init function. qof_backend_prepare_frame, qof_backend_prepare_option and qof_backend_complete_frame are intended to be used by the backend itself to create the options.
qof_backend_get_config, qof_backend_option_foreach and qof_backend_load_config are intended for either the backend or the frontend to retrieve the option data from the frame or set new data. | |
| typedef QofBackendOption_s | QofBackendOption |
| typedef void(* | QofBackendOptionCB )(QofBackendOption *, gpointer data) |
| void | qof_backend_prepare_frame (QofBackend *be) |
| void | qof_backend_prepare_option (QofBackend *be, QofBackendOption *option) |
| KvpFrame * | qof_backend_complete_frame (QofBackend *be) |
| void | qof_backend_option_foreach (KvpFrame *config, QofBackendOptionCB cb, gpointer data) |
| void | qof_backend_load_config (QofBackend *be, KvpFrame *config) |
| Load configuration options specific to this backend. | |
| KvpFrame * | qof_backend_get_config (QofBackend *be) |
| Get the available configuration options. | |
Allow access to the begin routine for this backend. | |
| QOF_BEGIN_EDIT and QOF_COMMIT_EDIT_PART1 and part2 rely on calling QofBackend *be->begin and be->commit. This means the QofBackend struct becomes part of the public API. These function replaces those calls to allow the macros to be used when QOF is built as a library. | |
| void | qof_backend_run_begin (QofBackend *be, QofInstance *inst) |
| gboolean | qof_backend_begin_exists (QofBackend *be) |
| void | qof_backend_run_commit (QofBackend *be, QofInstance *inst) |
| gboolean | qof_backend_commit_exists (QofBackend *be) |
Defines | |
| #define | QOF_MOD_BACKEND "qof-backend" |
Typedefs | |
| typedef QofBackendProvider_s | QofBackendProvider |
| typedef QofBackend_s | QofBackend |
| Pseudo-object providing an interface between the engine and a persistant data store (e.g. a server, a database, or a file). | |
| typedef void(* | QofBePercentageFunc )(const char *message, double percent) |
| DOCUMENT ME! | |
Enumerations | |
| enum | QofBackendError { ERR_BACKEND_NO_ERR = 0, ERR_BACKEND_NO_HANDLER, ERR_BACKEND_NO_BACKEND, ERR_BACKEND_BAD_URL, ERR_BACKEND_NO_SUCH_DB, ERR_BACKEND_CANT_CONNECT, ERR_BACKEND_CONN_LOST, ERR_BACKEND_LOCKED, ERR_BACKEND_READONLY, ERR_BACKEND_TOO_NEW, ERR_BACKEND_DATA_CORRUPT, ERR_BACKEND_SERVER_ERR, ERR_BACKEND_ALLOC, ERR_BACKEND_PERM, ERR_BACKEND_MODIFIED, ERR_BACKEND_MOD_DESTROY, ERR_BACKEND_MISC, ERR_QSF_INVALID_OBJ, ERR_QSF_INVALID_MAP, ERR_QSF_BAD_OBJ_GUID, ERR_QSF_BAD_QOF_VERSION, ERR_QSF_BAD_MAP, ERR_QSF_NO_MAP, ERR_QSF_WRONG_MAP, ERR_QSF_MAP_NOT_OBJ, ERR_QSF_OVERFLOW, ERR_QSF_OPEN_NOT_MERGE, ERR_FILEIO_FILE_BAD_READ = 1000, ERR_FILEIO_FILE_EMPTY, ERR_FILEIO_FILE_LOCKERR, ERR_FILEIO_FILE_NOT_FOUND, ERR_FILEIO_FILE_TOO_OLD, ERR_FILEIO_UNKNOWN_FILE_TYPE, ERR_FILEIO_PARSE_ERROR, ERR_FILEIO_BACKUP_ERROR, ERR_FILEIO_WRITE_ERROR, ERR_NETIO_SHORT_READ = 2000, ERR_NETIO_WRONG_CONTENT_TYPE, ERR_NETIO_NOT_GNCXML, ERR_SQL_MISSING_DATA = 3000, ERR_SQL_DB_TOO_OLD, ERR_SQL_DB_BUSY, ERR_RPC_HOST_UNK = 4000, ERR_RPC_CANT_BIND, ERR_RPC_CANT_ACCEPT, ERR_RPC_NO_CONNECTION, ERR_RPC_BAD_VERSION, ERR_RPC_FAILED, ERR_RPC_NOT_ADDED } |
| The errors that can be reported to the GUI & other front-end users. More... | |
Functions | |
| gboolean | qof_load_backend_library (const char *directory, const char *filename, const char *init_fcn) |
| Load a QOF-compatible backend shared library. | |
| QofBackend * | qof_book_get_backend (QofBook *book) |
| Retrieve the backend used by this book. | |
| void | qof_book_set_backend (QofBook *book, QofBackend *) |
1.4.5