qofbook.h

Go to the documentation of this file.

/********************************************************************\
 * qofbook.h -- Encapsulate all the information about a dataset.    *
 * 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_BOOK_H
#define QOF_BOOK_H

#include <glib.h>
#ifdef __cplusplus
class GncOptionDB;
#else
typedef struct GncOptionDB GncOptionDB;
#endif
/* We only want a few things exported to Guile */
#ifndef SWIG

typedef struct _QofBookClass  QofBookClass;
#ifndef __KVP_VALUE
typedef struct KvpValueImpl KvpValue;
#define __KVP_VALUE
#endif

#include "qofid.h"
#include "qofinstance.h"
#include "qofbackend.h"

#ifdef __cplusplus
extern "C"
{
#endif

/* --- type macros --- */
#define QOF_TYPE_BOOK            (qof_book_get_type ())
#define QOF_BOOK(o)              \
     (G_TYPE_CHECK_INSTANCE_CAST ((o), QOF_TYPE_BOOK, QofBook))
#define QOF_BOOK_CLASS(k)        \
     (G_TYPE_CHECK_CLASS_CAST((k), QOF_TYPE_BOOK, QofBookClass))
#define QOF_IS_BOOK(o)           \
     (G_TYPE_CHECK_INSTANCE_TYPE ((o), QOF_TYPE_BOOK))
#define QOF_IS_BOOK_CLASS(k)     \
     (G_TYPE_CHECK_CLASS_TYPE ((k), QOF_TYPE_BOOK))
#define QOF_BOOK_GET_CLASS(o)    \
     (G_TYPE_INSTANCE_GET_CLASS ((o), QOF_TYPE_BOOK, QofBookClass))

typedef void (*QofBookDirtyCB) (QofBook *, gboolean dirty, gpointer user_data);

typedef void (*GncOptionSave) (GncOptionDB*, QofBook*, gboolean);
typedef void (*GncOptionLoad) (GncOptionDB*, QofBook*);

struct _QofBookClass
{
    QofInstanceClass parent_class;
};

GType qof_book_get_type(void);

#define QOF_BOOK_RETURN_ENTITY(book,guid,e_type,c_type) {   \
  QofInstance *val = NULL;                                  \
  if ((guid != NULL) && (book != NULL)) {                   \
    const QofCollection *col;                               \
    col = qof_book_get_collection (book, e_type);           \
    val = qof_collection_lookup_entity (col, guid);         \
  }                                                         \
  return (c_type *) val;                                    \
}



typedef GList QofBookList;

typedef void (*QofBookFinalCB) (QofBook *, gpointer key, gpointer user_data);

gboolean qof_book_register (void);

QofBook * qof_book_new (void);

void qof_book_destroy (QofBook *book);

void qof_book_mark_closed (QofBook *book);

gboolean qof_book_is_open (const QofBook *book);

void qof_book_swap_books_readonly (QofBook *book, QofBook *other);

/*@ dependent @*/
QofCollection  * qof_book_get_collection (const QofBook *, QofIdType);

typedef void (*QofCollectionForeachCB) (QofCollection *, gpointer user_data);
void qof_book_foreach_collection (const QofBook *, QofCollectionForeachCB, gpointer);

void qof_book_set_data (QofBook *book, const gchar *key, gpointer data);

void qof_book_set_data_fin (QofBook *book, const gchar *key, gpointer data,
                            QofBookFinalCB);

gpointer qof_book_get_data (const QofBook *book, const gchar *key);

gboolean qof_book_is_readonly(const QofBook *book);

void qof_book_mark_readonly(QofBook *book);

gboolean qof_book_empty(const QofBook *book);

#endif /* SWIG */

gboolean qof_book_use_trading_accounts (const QofBook *book);

void qof_book_reset_num_days_autoreadonly_cache (QofBook *book);

gboolean qof_book_uses_autoreadonly (const QofBook *book);

gint qof_book_get_num_days_autoreadonly (const QofBook *book);

GDate* qof_book_get_autoreadonly_gdate (const QofBook *book);

void qof_book_set_default_invoice_report (QofBook *book, const gchar *guid,
                                          const gchar *name);

gchar * qof_book_get_default_invoice_report_guid (const QofBook *book);

gchar * qof_book_get_default_invoice_report_name (const QofBook *book);

gdouble qof_book_get_default_invoice_report_timeout (const QofBook *book);

gboolean qof_book_use_split_action_for_num_field (const QofBook *book);

gboolean qof_book_shutting_down (const QofBook *book);

gboolean qof_book_session_not_saved (const QofBook *book);

/* The following functions are not useful in scripting languages */
#ifndef SWIG

void qof_book_mark_session_saved(QofBook *book);

void qof_book_mark_session_dirty(QofBook *book);

time64 qof_book_get_session_dirty_time(const QofBook *book);

void qof_book_set_dirty_cb(QofBook *book, QofBookDirtyCB cb, gpointer user_data);

gint64 qof_book_get_counter (QofBook *book, const char *counter_name);

gchar *qof_book_increment_and_format_counter (QofBook *book, const char *counter_name);

gchar * qof_book_normalize_counter_format(const gchar *format, gchar **err_msg);

char *qof_book_get_counter_format (const QofBook *book,
                                   const char *counter_name);

const char* qof_book_get_string_option(const QofBook* book, const char* opt_name);
void qof_book_set_string_option(QofBook* book, const char* opt_name, const char* opt_val);
const GncGUID* qof_book_get_guid_option(QofBook* book, GSList* path);
void qof_book_option_frame_delete (QofBook *book, const char* opt_name);

GHashTable *qof_book_get_features (QofBook *book);
void qof_book_unset_feature (QofBook *book, const gchar *key);
void qof_book_set_feature (QofBook *book, const gchar *key, const gchar *descr);

void qof_book_begin_edit(QofBook *book);
void qof_book_commit_edit(QofBook *book);

/* Access functions for options. */
void qof_book_load_options (QofBook *book, GncOptionLoad load_cb,
                            GncOptionDB *odb);
void qof_book_save_options (QofBook *book, GncOptionSave save_cb,
                            GncOptionDB* odb, gboolean clear);
void qof_book_set_option (QofBook *book, KvpValue *value, GSList *path);

KvpValue* qof_book_get_option (QofBook *book, GSList *path);

void qof_book_options_delete (QofBook *book, GSList *path);
#define qof_book_get_guid(X) qof_entity_get_guid (QOF_INSTANCE(X))

#ifdef __cplusplus
}
#endif

#endif /* SWIG */
#endif /* QOF_BOOK_H */