GnuCash  4.6-313-gb6cbc9786+
Files | Data Structures | Macros | Functions

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 GncGUIDqof_instance_get_guid (gconstpointer)
 Return the GncGUID of this instance.
 
const GncGUIDqof_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 470 of file qofinstance.cpp.

471 {
472  return ent ? qof_instance_get_guid(ent) : guid_null();
473 }
const GncGUID * qof_instance_get_guid(gconstpointer inst)
Return the GncGUID of this instance.
const GncGUID * guid_null(void)
Returns a GncGUID which is guaranteed to never reference any entity.
Definition: guid.cpp:131

◆ qof_instance_books_equal()

gboolean qof_instance_books_equal ( gconstpointer  ptr1,
gconstpointer  ptr2 
)

See if two QofInstances share the same book.

Definition at line 558 of file qofinstance.cpp.

559 {
560  const QofInstancePrivate *priv1, *priv2;
561 
562  g_return_val_if_fail(QOF_IS_INSTANCE(ptr1), FALSE);
563  g_return_val_if_fail(QOF_IS_INSTANCE(ptr2), FALSE);
564 
565  priv1 = GET_PRIVATE(ptr1);
566  priv2 = GET_PRIVATE(ptr2);
567 
568  return (priv1->book == priv2->book);
569 }

◆ qof_instance_copy_book()

void qof_instance_copy_book ( gpointer  ptr1,
gconstpointer  ptr2 
)

Copy the book from one QofInstances to another.

Definition at line 549 of file qofinstance.cpp.

550 {
551  g_return_if_fail(QOF_IS_INSTANCE(ptr1));
552  g_return_if_fail(QOF_IS_INSTANCE(ptr2));
553 
554  GET_PRIVATE(ptr1)->book = GET_PRIVATE(ptr2)->book;
555 }

◆ 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
ptrThe 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 644 of file qofinstance.cpp.

645 {
646  g_return_val_if_fail(QOF_IS_INSTANCE(ptr), FALSE);
647  return GET_PRIVATE(ptr)->do_free;
648 }

◆ 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
ptrThe 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 658 of file qofinstance.cpp.

659 {
660  g_return_val_if_fail(QOF_IS_INSTANCE(ptr), FALSE);
661  return GET_PRIVATE(ptr)->dirty;
662 }

◆ 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 791 of file qofinstance.cpp.

792 {
793  g_return_val_if_fail( inst != NULL, NULL );
794 
795  if ( QOF_INSTANCE_GET_CLASS(inst)->get_display_name != NULL )
796  {
797  return QOF_INSTANCE_GET_CLASS(inst)->get_display_name(inst);
798  }
799  else
800  {
801  /* Not implemented - return default string */
802  return g_strdup_printf("Object %s %p",
804  inst);
805  }
806 }
QofCollection * qof_instance_get_collection(gconstpointer ptr)
Return the collection this instance belongs to.
QofIdType qof_collection_get_type(const QofCollection *col)
return the type that the collection stores
Definition: qofid.cpp:76

◆ 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 768 of file qofinstance.cpp.

769 {
770  if (!inst)
771  {
772  return 0;
773  }
774  g_return_val_if_fail(QOF_IS_INSTANCE(inst), 0);
775  return GET_PRIVATE(inst)->idata;
776 }

◆ 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 841 of file qofinstance.cpp.

842 {
844 
845  g_return_val_if_fail( inst != NULL, NULL );
846 
847  /* scan all collections */
848  data.inst = inst;
849  data.list = NULL;
850 
851  qof_book_foreach_collection(qof_instance_get_book(inst),
852  get_referring_object_helper,
853  &data);
854  return data.list;
855 }
QofBook * qof_instance_get_book(gconstpointer inst)
Return the book pointer.

◆ 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 869 of file qofinstance.cpp.

870 {
872 
873  g_return_val_if_fail( coll != NULL, NULL );
874  g_return_val_if_fail( ref != NULL, NULL );
875 
876  data.inst = ref;
877  data.list = NULL;
878 
879  qof_collection_foreach(coll, get_typed_referring_object_instance_helper, &data);
880  return data.list;
881 }
void qof_collection_foreach(const QofCollection *col, QofInstanceForeachCB cb_func, gpointer user_data)
Call the callback for each entity in the collection.
Definition: qofid.cpp:323

◆ 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 884 of file qofinstance.cpp.

885 {
886  g_return_val_if_fail( inst != NULL, NULL );
887  g_return_val_if_fail( ref != NULL, NULL );
888 
889  if ( QOF_INSTANCE_GET_CLASS(inst)->get_typed_referring_object_list != NULL )
890  {
891  return QOF_INSTANCE_GET_CLASS(inst)->get_typed_referring_object_list(inst, ref);
892  }
893  else
894  {
895  /* Not implemented - by default, loop through all objects of this object's type and check
896  them individually. */
897  QofCollection* coll;
898 
899  coll = qof_instance_get_collection(inst);
901  }
902 }
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. ...
QofCollection * qof_instance_get_collection(gconstpointer ptr)
Return the collection this instance belongs to.

◆ 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 505 of file qofinstance.cpp.

506 {
507  const QofInstancePrivate *priv1, *priv2;
508 
509  g_return_val_if_fail(QOF_IS_INSTANCE(ptr1), -1);
510  g_return_val_if_fail(QOF_IS_INSTANCE(ptr2), 1);
511 
512  priv1 = GET_PRIVATE(ptr1);
513  priv2 = GET_PRIVATE(ptr2);
514 
515  return guid_compare(&priv1->guid, &priv2->guid);
516 }
GncGUID guid
GncGUID for the entity.
Definition: qofinstance.cpp:77

◆ 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 629 of file qofinstance.cpp.

630 {
631  QofInstancePrivate *lpriv, *rpriv;
632 
633  if (!left && !right) return 0;
634  if (!left) return -1;
635  if (!right) return +1;
636 
637  lpriv = GET_PRIVATE(left);
638  rpriv = GET_PRIVATE(right);
639  return lpriv->last_update < rpriv->last_update ? -1 :
640  lpriv->last_update > rpriv->last_update ? 1 : 0;
641 }