QOF: qofbackend.h File Reference

QOF 0.7.5

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

Data Structures | Macros | Typedefs | Functions
qofbackend.h File Reference
Query Object Framework » Backends: Permanent storage for QOF entities.

API for data storage Backend. More...

`#include "qofinstance.h"`

Go to the source code of this file.

## Data Structures
struct | QofBackendOption_s

## Macros
#define | QOF_MOD_BACKEND "qof-backend"

## Typedefs
typedef gint32 | QofErrorId
| The ID of this error. More...
typedef struct QofBackendProvider_s | QofBackendProvider
typedef struct QofBackend_s | QofBackend
| Pseudo-object providing an interface between the framework and a persistant data store (e.g. a server, a database, or a file). More...
typedef void(* | QofBePercentageFunc) (const gchar *message, double percent)
| DOCUMENT ME!

## Functions
gboolean | qof_load_backend_library (const gchar *directory, const gchar *filename, const gchar *init_fcn)
| Load a QOF-compatible backend shared library. More...
QofBackend * | qof_book_get_backend (QofBook *book)
| Retrieve the backend used by this book.
void | qof_book_set_backend (QofBook *book, QofBackend *)
| Set the backend used by this book. More...
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)

## 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. 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. Backends are loaded using QofBackendProvider via the function specified in prov->backend_new. Before backend_new returns, you should ensure that your backend is fully configured and ready for use.
typedef struct 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. More...
KvpFrame * | qof_backend_get_config (QofBackend *be)
| Get the available configuration options. More...

## Detailed Description

API for data storage Backend.

Author
  Copyright (C) 2000-2001 Linas Vepstas linas.nosp@m.@lin.nosp@m.as.or.nosp@m.g
  Copyright 2004,2005,2006 Neil Williams linux.nosp@m.@cod.nosp@m.ehelp.nosp@m..co..nosp@m.uk

Definition in file qofbackend.h.