qofbackend.h

Go to the documentation of this file.

/********************************************************************\
 * qofbackend.h: api for data storage backend                       *
 * This program is free software; you can redistribute it and/or    *
 * modify it under the terms of the GNU General Public License as   *
 * published by the Free Software Foundation; either version 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program is distributed in the hope that it will be useful,  *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of   *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    *
 * GNU General Public License for more details.                     *
 *                                                                  *
 * You should have received a copy of the GNU General Public License*
 * along with this program; if not, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
 *                                                                  *
\********************************************************************/
#ifndef QOF_BACKEND_H
#define QOF_BACKEND_H

#include "qofinstance.h"

#define QOF_MOD_BACKEND "qof-backend"

typedef gint32 QofErrorId;

typedef struct QofBackendProvider_s QofBackendProvider;

typedef struct QofBackend_s QofBackend;

typedef void (*QofBePercentageFunc) (const gchar * message, double percent);

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);
typedef struct QofBackendOption_s
{
    KvpValueType type;         
    const gchar *option_name;  
    const gchar *description;  
    const gchar *tooltip;      
    gpointer value;            
} QofBackendOption;

void qof_backend_prepare_frame (QofBackend * be);

void qof_backend_prepare_option (QofBackend * be, QofBackendOption * option);

KvpFrame *qof_backend_complete_frame (QofBackend * be);

typedef void (*QofBackendOptionCB) (QofBackendOption *, gpointer data);

void
qof_backend_option_foreach (KvpFrame * config, QofBackendOptionCB cb,
                            gpointer data);

void qof_backend_load_config (QofBackend * be, KvpFrame * config);

KvpFrame *qof_backend_get_config (QofBackend * be);
gboolean
qof_load_backend_library (const gchar * directory,
                          const gchar * filename, const gchar * init_fcn);

QofBackend *qof_book_get_backend (QofBook * book);

void qof_book_set_backend (QofBook * book, QofBackend *);

#endif /* QOF_BACKEND_H */

---