qofinstance.h

Go to the documentation of this file.

/********************************************************************\
 * qofinstance.h -- fields common to all object instances           *
 *                                                                  *
 * 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_INSTANCE_H
#define QOF_INSTANCE_H

#include "guid.h"
#include "qofbook.h"
#include "qofid.h"
#include "qoftime.h"
#include "kvpframe.h"

/* --- type macros --- */
/* cheesy, but will do for now, eventually should be more gtk-like, handle
 * thunks, etc.  */
#define QOF_INSTANCE(object) ((QofInstance *)(object))

typedef struct QofInstance_s QofInstance;

void qof_instance_init (QofInstance *, QofIdType, QofBook *);

void qof_instance_release (QofInstance * inst);

QofBook *qof_instance_get_book (QofInstance *);

const GUID *qof_instance_get_guid (QofInstance *);

KvpFrame *qof_instance_get_slots (QofInstance *);

QofTime *qof_instance_get_update_time (QofInstance * inst);

gint qof_instance_version_cmp (QofInstance * left, QofInstance * right);

gboolean qof_instance_is_dirty (QofInstance *);

void qof_instance_set_dirty (QofInstance * inst);

gboolean qof_instance_check_edit (QofInstance * inst);

gboolean qof_instance_do_free (QofInstance * inst);

void qof_instance_mark_free (QofInstance * inst);

QofInstance *qof_instance_create (QofIdType type, QofBook * book);

void qof_instance_gemini (QofInstance * to, QofInstance * from);

QofInstance *qof_instance_lookup_twin (QofInstance * src, QofBook * book);

/* @} */
/* @} */
#endif /* QOF_INSTANCE_H */

---