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       [email protected]                   *
 *                                                                  *
\********************************************************************/
#ifndef QOF_INSTANCE_H
#define QOF_INSTANCE_H

typedef struct _QofInstanceClass QofInstanceClass;
typedef struct QofInstance_s QofInstance;

typedef struct _QofBook       QofBook;

#include "qofid.h"
#include "guid.h"
#include "gnc-date.h"
#include "kvp_frame.h"
#include "qof-gobject.h"

/* --- type macros --- */
#define QOF_TYPE_INSTANCE            (qof_instance_get_type ())
#define QOF_INSTANCE(o)              \
     (G_TYPE_CHECK_INSTANCE_CAST ((o), QOF_TYPE_INSTANCE, QofInstance))
#define QOF_INSTANCE_CLASS(k)        \
     (G_TYPE_CHECK_CLASS_CAST((k), QOF_TYPE_INSTANCE, QofInstanceClass))
#define QOF_IS_INSTANCE(o)           \
     (G_TYPE_CHECK_INSTANCE_TYPE ((o), QOF_TYPE_INSTANCE))
#define QOF_IS_INSTANCE_CLASS(k)     \
     (G_TYPE_CHECK_CLASS_TYPE ((k), QOF_TYPE_INSTANCE))
#define QOF_INSTANCE_GET_CLASS(o)    \
     (G_TYPE_INSTANCE_GET_CLASS ((o), QOF_TYPE_INSTANCE, QofInstanceClass))

struct QofInstance_s
{
    GObject object;

    QofIdType        e_type;               
    /* kvp_data is a key-value pair database for storing arbirtary
     * information associated with this instance.
     * See src/engine/kvp_doc.txt for a list and description of the
     * important keys. */
    KvpFrame *kvp_data;
};

struct _QofInstanceClass
{
    GObjectClass parent_class;

    /* Returns a displayable string to represent this object */
    gchar* (*get_display_name)(const QofInstance*);

    /* Does this object refer to a specific object */
    gboolean (*refers_to_object)(const QofInstance* inst, const QofInstance* ref);

    /* Returns a list of my type of object which refers to an object */
    GList* (*get_typed_referring_object_list)(const QofInstance* inst, const QofInstance* ref);
};

GType qof_instance_get_type(void);

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

/*@ dependent @*/
QofBook *qof_instance_get_book (gconstpointer);

void qof_instance_set_book (gconstpointer inst, QofBook *book);

void qof_instance_copy_book (gpointer ptr1, gconstpointer ptr2);

gboolean qof_instance_books_equal (gconstpointer ptr1, gconstpointer ptr2);

/*@ dependent @*/
const GncGUID * qof_instance_get_guid (gconstpointer);

/*@ dependent @*/
const GncGUID * qof_entity_get_guid (gconstpointer);

/*@ dependent @*/
QofCollection* qof_instance_get_collection (gconstpointer inst);

gint qof_instance_guid_compare(const gconstpointer ptr1, const gconstpointer ptr2);

gint qof_instance_get_editlevel (gconstpointer ptr);

int qof_instance_version_cmp (const QofInstance *left, const QofInstance *right);

gboolean qof_instance_get_destroying (gconstpointer ptr);

gboolean qof_instance_get_dirty_flag (gconstpointer ptr);

void qof_instance_print_dirty (const QofInstance *entity, gpointer dummy);

#define qof_instance_is_dirty qof_instance_get_dirty
gboolean qof_instance_get_dirty (QofInstance *);

gboolean qof_instance_get_infant(const QofInstance *inst);

void qof_instance_get (const QofInstance *inst, const gchar *first_param, ...);

void qof_instance_set (QofInstance *inst, const gchar *first_param, ...);

guint32 qof_instance_get_idata (gconstpointer inst);

gchar* qof_instance_get_display_name(const QofInstance* inst);

GList* qof_instance_get_referring_object_list(const QofInstance* inst);

gboolean qof_instance_refers_to_object(const QofInstance* inst, const QofInstance* ref);

GList* qof_instance_get_typed_referring_object_list(const QofInstance* inst, const QofInstance* ref);

GList* qof_instance_get_referring_object_list_from_collection(const QofCollection* coll, const QofInstance* ref);

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