Instance

Qof Instances are a derived type of QofInstance. More...

Files
file	qofinstance.h
	Object instance holds common fields that most gnucash objects use.

Data Structures
struct	QofInstance
struct	QofInstanceClass

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))
#define	qof_instance_is_dirty   qof_instance_get_dirty
	Return value of is_dirty flag.

Functions
GType	qof_instance_get_type (void)
	Return the GType of a QofInstance.
void	qof_instance_init_data (QofInstance *, QofIdType, QofBook *)
	Initialise the settings associated with an instance.
QofBook *	qof_instance_get_book (gconstpointer)
	Return the book pointer.
void	qof_instance_set_book (gconstpointer inst, QofBook *book)
	Set the book pointer.
void	qof_instance_copy_book (gpointer ptr1, gconstpointer ptr2)
	Copy the book from one QofInstances to another. More...
gboolean	qof_instance_books_equal (gconstpointer ptr1, gconstpointer ptr2)
	See if two QofInstances share the same book. More...
const GncGUID *	qof_instance_get_guid (gconstpointer)
	Return the GncGUID of this instance.
const GncGUID *	qof_entity_get_guid (gconstpointer)
QofCollection *	qof_instance_get_collection (gconstpointer inst)
	Return the collection this instance belongs to.
gint	qof_instance_guid_compare (const gconstpointer ptr1, const gconstpointer ptr2)
	Compare the GncGUID values of two instances. More...
gint	qof_instance_get_editlevel (gconstpointer ptr)
int	qof_instance_version_cmp (const QofInstance *left, const QofInstance *right)
	Compare two instances, based on their last update times. More...
gboolean	qof_instance_get_destroying (gconstpointer ptr)
	Retrieve the flag that indicates whether or not this object is about to be destroyed. More...
gboolean	qof_instance_get_dirty_flag (gconstpointer ptr)
	Retrieve the flag that indicates whether or not this object has been modified. More...
void	qof_instance_print_dirty (const QofInstance *entity, gpointer dummy)
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,...)
	Wrapper for g_object_get.
void	qof_instance_set (QofInstance *inst, const gchar *first_param,...)
	Wrapper for g_object_set Group setting multiple parameters in a single begin/commit/rollback.
guint32	qof_instance_get_idata (gconstpointer inst)
	get the instance tag number used for kvp management in sql backends. More...
gchar *	qof_instance_get_display_name (const QofInstance *inst)
	Returns a displayable name for this object. More...
GList *	qof_instance_get_referring_object_list (const QofInstance *inst)
	Returns a list of objects which refer to a specific object. More...
gboolean	qof_instance_refers_to_object (const QofInstance *inst, const QofInstance *ref)
	Does this object refer to a specific object.
GList *	qof_instance_get_typed_referring_object_list (const QofInstance *inst, const QofInstance *ref)
	Returns a list of my type of object which refers to an object. More...
GList *	qof_instance_get_referring_object_list_from_collection (const QofCollection *coll, const QofInstance *ref)
	Returns a list of objects from the collection which refer to the specific object. More...

Detailed Description

Qof Instances are a derived type of QofInstance.

The Instance adds some common features and functions that most objects will want to use.

Function Documentation

qof_entity_get_guid()

const GncGUID* qof_entity_get_guid

(

gconstpointer

)

Deprecated:

Use qof_instance_get_guid instead.

Works like qof_instance_get_guid, but returns NULL on NULL

Definition at line 467 of file qofinstance.cpp.

{
    return ent ? qof_instance_get_guid(ent) : guid_null();
}

qof_instance_books_equal()

gboolean qof_instance_books_equal	(	gconstpointer	ptr1,
		gconstpointer	ptr2
	)

See if two QofInstances share the same book.

Definition at line 555 of file qofinstance.cpp.

{
    const QofInstancePrivate *priv1, *priv2;

    g_return_val_if_fail(QOF_IS_INSTANCE(ptr1), FALSE);
    g_return_val_if_fail(QOF_IS_INSTANCE(ptr2), FALSE);

    priv1 = GET_PRIVATE(ptr1);
    priv2 = GET_PRIVATE(ptr2);

    return (priv1->book == priv2->book);
}

qof_instance_copy_book()

void qof_instance_copy_book	(	gpointer	ptr1,
		gconstpointer	ptr2
	)

Copy the book from one QofInstances to another.

Definition at line 546 of file qofinstance.cpp.

{
    g_return_if_fail(QOF_IS_INSTANCE(ptr1));
    g_return_if_fail(QOF_IS_INSTANCE(ptr2));

    GET_PRIVATE(ptr1)->book = GET_PRIVATE(ptr2)->book;
}

qof_instance_get_destroying()

gboolean qof_instance_get_destroying

(

gconstpointer

ptr

)

Retrieve the flag that indicates whether or not this object is about to be destroyed.

Parameters

ptr	The object whose flag should be retrieved.

Returns

TRUE if the object has been marked for destruction. FALSE if the object is not marked for destruction, or if a bad parameter is passed to the function.

Definition at line 641 of file qofinstance.cpp.

{
    g_return_val_if_fail(QOF_IS_INSTANCE(ptr), FALSE);
    return GET_PRIVATE(ptr)->do_free;
}

qof_instance_get_dirty_flag()

gboolean qof_instance_get_dirty_flag

(

gconstpointer

ptr

)

Retrieve the flag that indicates whether or not this object has been modified.

This is specifically the flag on the object. It does not perform any other checking which might normally be performed when testing to see if an object is dirty. If there is any question, use the qof_instance_is_dirty() function instead.

Parameters

ptr	The object whose flag should be retrieved.

Returns

TRUE if the object has been modified and not saved. FALSE if the object has not been modified, or if a bad parameter is passed to the function.

Definition at line 655 of file qofinstance.cpp.

{
    g_return_val_if_fail(QOF_IS_INSTANCE(ptr), FALSE);
    return GET_PRIVATE(ptr)->dirty;
}

qof_instance_get_display_name()

gchar* qof_instance_get_display_name

(

const QofInstance *

inst

)

Returns a displayable name for this object.

The returned string must be freed by the caller.

Definition at line 786 of file qofinstance.cpp.

{
    g_return_val_if_fail( inst != nullptr, nullptr );

    if ( QOF_INSTANCE_GET_CLASS(inst)->get_display_name != nullptr )
    {
        return QOF_INSTANCE_GET_CLASS(inst)->get_display_name(inst);
    }
    else
    {
        /* Not implemented - return default string */
        return g_strdup_printf("Object %s %p",
                               qof_collection_get_type(qof_instance_get_collection(inst)),
                               inst);
    }
}

qof_instance_get_idata()

guint32 qof_instance_get_idata

(

gconstpointer

inst

)

get the instance tag number used for kvp management in sql backends.

Definition at line 763 of file qofinstance.cpp.

{
    if (!inst)
    {
        return 0;
    }
    g_return_val_if_fail(QOF_IS_INSTANCE(inst), 0);
    return GET_PRIVATE(inst)->idata;
}

qof_instance_get_referring_object_list()

GList* qof_instance_get_referring_object_list

(

const QofInstance *

inst

)

Returns a list of objects which refer to a specific object.

The list must be freed by the caller, but the objects on the list must not.

Definition at line 836 of file qofinstance.cpp.

{
    GetReferringObjectHelperData data;

    g_return_val_if_fail( inst != nullptr, nullptr );

    /* scan all collections */
    data.inst = inst;
    data.list = nullptr;

    qof_book_foreach_collection(qof_instance_get_book(inst),
                                get_referring_object_helper,
                                &data);
    return data.list;
}

qof_instance_get_referring_object_list_from_collection()

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

Returns a list of objects from the collection which refer to the specific object.

The list must be freed by the caller but the objects on the list must not.

Definition at line 864 of file qofinstance.cpp.

{
    GetReferringObjectHelperData data;

    g_return_val_if_fail( coll != nullptr, nullptr );
    g_return_val_if_fail( ref != nullptr, nullptr );

    data.inst = ref;
    data.list = nullptr;

    qof_collection_foreach(coll, get_typed_referring_object_instance_helper, &data);
    return data.list;
}

qof_instance_get_typed_referring_object_list()

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

Returns a list of my type of object which refers to an object.

For example, when called as qof_instance_get_typed_referring_object_list(taxtable, account); it will return the list of taxtables which refer to a specific account. The result should be the same regardless of which taxtable object is used. The list must be freed by the caller but the objects on the list must not.

Definition at line 879 of file qofinstance.cpp.

{
    g_return_val_if_fail( inst != nullptr, nullptr );
    g_return_val_if_fail( ref != nullptr, nullptr );

    if ( QOF_INSTANCE_GET_CLASS(inst)->get_typed_referring_object_list != nullptr )
    {
        return QOF_INSTANCE_GET_CLASS(inst)->get_typed_referring_object_list(inst, ref);
    }
    else
    {
        /* Not implemented - by default, loop through all objects of this object's type and check
           them individually. */
        QofCollection* coll;

        coll = qof_instance_get_collection(inst);
        return qof_instance_get_referring_object_list_from_collection(coll, ref);
    }
}

qof_instance_guid_compare()

gint qof_instance_guid_compare	(	const gconstpointer	ptr1,
		const gconstpointer	ptr2
	)

Compare the GncGUID values of two instances.

This routine returns 0 if the two values are equal, <0 if the first is smaller than the second, or >0 if the second is smaller tan the first.

Definition at line 502 of file qofinstance.cpp.

{
    const QofInstancePrivate *priv1, *priv2;

    g_return_val_if_fail(QOF_IS_INSTANCE(ptr1), -1);
    g_return_val_if_fail(QOF_IS_INSTANCE(ptr2),  1);

    priv1 = GET_PRIVATE(ptr1);
    priv2 = GET_PRIVATE(ptr2);

    return guid_compare(&priv1->guid, &priv2->guid);
}

qof_instance_version_cmp()

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

Compare two instances, based on their last update times.

Returns a negative, zero or positive value, respectively, if 'left' is earlier, same as or later than 'right'. Accepts NULL pointers, NULL's are by definition earlier than any value.

Definition at line 626 of file qofinstance.cpp.

{
    QofInstancePrivate *lpriv, *rpriv;

    if (!left && !right) return 0;
    if (!left) return -1;
    if (!right) return +1;

    lpriv = GET_PRIVATE(left);
    rpriv = GET_PRIVATE(right);
    return lpriv->last_update < rpriv->last_update ? -1 :
        lpriv->last_update > rpriv->last_update ? 1 : 0;
}