qofsession.h

Go to the documentation of this file.

/********************************************************************\
 * qofsession.h -- session access (connection to 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_SESSION_H
#define QOF_SESSION_H

#include "qofbackend.h"
#include "qofbook.h"
#include "qofclass.h"
#include "qofobject.h"

#define QOF_MOD_SESSION "qof-session"

/* PROTOTYPES ******************************************************/

typedef struct _QofSession QofSession;

QofSession *qof_session_new (void);

void qof_session_destroy (QofSession * session);

void 
qof_session_swap_data (QofSession * session_1, QofSession * session_2);

void qof_session_begin (QofSession * session, const gchar *book_id,
                        gboolean ignore_lock, gboolean create_if_nonexistent);

typedef void (*QofPercentageFunc) (const gchar *message, gdouble percent);
void qof_session_load (QofSession * session,
                       QofPercentageFunc percentage_func);

void 
qof_session_add_book (QofSession * session, QofBook * book);

QofBook *
qof_session_get_book (QofSession * session);

const gchar *qof_session_get_file_path (QofSession * session);

const gchar *qof_session_get_url (QofSession * session);

gboolean qof_session_not_saved (QofSession * session);

gboolean qof_session_save_may_clobber_data (QofSession * session);

void qof_session_save (QofSession * session,
                       QofPercentageFunc percentage_func);
void qof_session_end (QofSession * session);

gboolean qof_entity_copy_to_session (QofSession * new_session,
                                     QofEntity * original);

gboolean qof_entity_copy_list (QofSession * new_session, GList * entity_list);

gboolean qof_entity_copy_coll (QofSession * new_session,
                               QofCollection * entity_coll);

gboolean
qof_entity_copy_coll_r (QofSession * new_session, QofCollection * coll);

gboolean qof_entity_copy_one_r (QofSession * new_session, QofEntity * ent);

#define QOF_STDOUT "file:"

gboolean qof_session_events_pending (QofSession * session);

gboolean qof_session_process_events (QofSession * session);
void qof_session_add_close_hook (GFunc fn, gpointer data);

void qof_session_call_close_hooks (QofSession * session);

#endif /* QOF_SESSION_H */

---