00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00101 #ifndef QOF_SESSION_H
00102 #define QOF_SESSION_H
00103
00104 #include "qofbackend.h"
00105 #include "qofbook.h"
00106 #include "qofclass.h"
00107 #include "qofobject.h"
00108
00109 #define QOF_MOD_SESSION "qof-session"
00110
00111
00112
00113 typedef struct _QofSession QofSession;
00114
00115 QofSession *qof_session_new (void);
00116 void qof_session_destroy (QofSession * session);
00117
00121 void qof_session_swap_data (QofSession * session_1, QofSession * session_2);
00122
00150 void qof_session_begin (QofSession * session, const char *book_id,
00151 gboolean ignore_lock, gboolean create_if_nonexistent);
00152
00166 typedef void (*QofPercentageFunc) (const gchar *message, double percent);
00167 void qof_session_load (QofSession * session,
00168 QofPercentageFunc percentage_func);
00169
00175 QofBackendError qof_session_get_error (QofSession * session);
00176 const gchar *qof_session_get_error_message (QofSession * session);
00177
00188 QofBackendError qof_session_pop_error (QofSession * session);
00198 void qof_session_add_book (QofSession * session, QofBook * book);
00199
00200 QofBook *qof_session_get_book (QofSession * session);
00201
00216 const gchar *qof_session_get_file_path (QofSession * session);
00217
00218 const gchar *qof_session_get_url (QofSession * session);
00219
00224 gboolean qof_session_not_saved (QofSession * session);
00225
00227 gboolean qof_session_save_may_clobber_data (QofSession * session);
00228
00235 void qof_session_save (QofSession * session,
00236 QofPercentageFunc percentage_func);
00245 void qof_session_end (QofSession * session);
00246
00294 gboolean qof_entity_copy_to_session (QofSession * new_session,
00295 QofEntity * original);
00296
00315 gboolean qof_entity_copy_list (QofSession * new_session, GList * entity_list);
00316
00330 gboolean qof_entity_copy_coll (QofSession * new_session,
00331 QofCollection * entity_coll);
00332
00361 gboolean
00362 qof_entity_copy_coll_r (QofSession * new_session, QofCollection * coll);
00363
00383 gboolean qof_entity_copy_one_r (QofSession * new_session, QofEntity * ent);
00384
00403 #define QOF_STDOUT "file:"
00404
00412 gboolean qof_session_events_pending (QofSession * session);
00413
00418 gboolean qof_session_process_events (QofSession * session);
00427 void qof_session_add_close_hook (GFunc fn, gpointer data);
00428
00433 void qof_session_call_close_hooks (QofSession * session);
00434
00435 #endif
00436