GnuCash  2.6.16
Files | Data Structures | Macros | Enumerations | Functions

Files

file  gncTaxTable.h
 Tax Table programming interface.
 

Data Structures

struct  GncAccountValue
 
struct  GncTaxTable
 
struct  GncTaxTableEntry
 

Macros

#define GNC_ID_TAXTABLE   "gncTaxTable"
 
#define GNC_TYPE_TAXTABLE   (gnc_taxtable_get_type ())
 
#define GNC_TAXTABLE(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_TAXTABLE, GncTaxTable))
 
#define GNC_TAXTABLE_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_TAXTABLE, GncTaxTableClass))
 
#define GNC_IS_TAXTABLE(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_TAXTABLE))
 
#define GNC_IS_TAXTABLE_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_TAXTABLE))
 
#define GNC_TAXTABLE_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_TAXTABLE, GncTaxTableClass))
 
#define GNC_TT_NAME   "tax table name"
 
#define GNC_TT_REFCOUNT   "reference count"
 
#define gncTaxTableGetGUID(x)   qof_instance_get_guid(QOF_INSTANCE(x))
 
#define gncTaxTableRetGUID(x)   (x ? *(qof_instance_get_guid(QOF_INSTANCE(x))) : *(guid_null()))
 
#define gncTaxTableLookupDirect(G, B)   gncTaxTableLookup((B), &(G))
 

Enumerations

enum  GncAmountType { GNC_AMT_TYPE_VALUE = 1, GNC_AMT_TYPE_PERCENT }
 
enum  GncTaxIncluded { GNC_TAXINCLUDED_YES = 1, GNC_TAXINCLUDED_NO, GNC_TAXINCLUDED_USEGLOBAL }
 

Functions

GType gnc_taxtable_get_type (void)
 
const char * gncAmountTypeToString (GncAmountType type)
 
gboolean gncAmountStringToType (const char *str, GncAmountType *type)
 
const char * gncTaxIncludedTypeToString (GncTaxIncluded type)
 
gboolean gncTaxIncludedStringToType (const char *str, GncTaxIncluded *type)
 
void gncTaxTableAddEntry (GncTaxTable *table, GncTaxTableEntry *entry)
 
void gncTaxTableRemoveEntry (GncTaxTable *table, GncTaxTableEntry *entry)
 
void gncTaxTableChanged (GncTaxTable *table)
 
void gncTaxTableBeginEdit (GncTaxTable *table)
 
void gncTaxTableCommitEdit (GncTaxTable *table)
 
gboolean gncTaxTableEqual (const GncTaxTable *a, const GncTaxTable *b)
 
int gncTaxTableCompare (const GncTaxTable *a, const GncTaxTable *b)
 
int gncTaxTableEntryCompare (const GncTaxTableEntry *a, const GncTaxTableEntry *b)
 
gboolean gncTaxTableEntryEqual (const GncTaxTableEntry *a, const GncTaxTableEntry *b)
 
GList * gncAccountValueAdd (GList *list, Account *acc, gnc_numeric value)
 
GList * gncAccountValueAddList (GList *l1, GList *l2)
 
gnc_numeric gncAccountValueTotal (GList *list)
 
void gncAccountValueDestroy (GList *list)
 

Create/Destroy Functions

GncTaxTablegncTaxTableCreate (QofBook *book)
 
void gncTaxTableDestroy (GncTaxTable *table)
 
GncTaxTableEntrygncTaxTableEntryCreate (void)
 
void gncTaxTableEntryDestroy (GncTaxTableEntry *entry)
 

Set Functions

void gncTaxTableSetName (GncTaxTable *table, const char *name)
 
void gncTaxTableIncRef (GncTaxTable *table)
 
void gncTaxTableDecRef (GncTaxTable *table)
 
void gncTaxTableEntrySetAccount (GncTaxTableEntry *entry, Account *account)
 
void gncTaxTableEntrySetType (GncTaxTableEntry *entry, GncAmountType type)
 
void gncTaxTableEntrySetAmount (GncTaxTableEntry *entry, gnc_numeric amount)
 

Get Functions

typedef GList GncTaxTableEntryList
 
GncTaxTablegncTaxTableLookupByName (QofBook *book, const char *name)
 
GList * gncTaxTableGetTables (QofBook *book)
 
const char * gncTaxTableGetName (const GncTaxTable *table)
 
GncTaxTablegncTaxTableGetParent (const GncTaxTable *table)
 
GncTaxTablegncTaxTableReturnChild (GncTaxTable *table, gboolean make_new)
 
GncTaxTableEntryList * gncTaxTableGetEntries (const GncTaxTable *table)
 
gint64 gncTaxTableGetRefcount (const GncTaxTable *table)
 
Timespec gncTaxTableLastModified (const GncTaxTable *table)
 
AccountgncTaxTableEntryGetAccount (const GncTaxTableEntry *entry)
 
GncAmountType gncTaxTableEntryGetType (const GncTaxTableEntry *entry)
 
gnc_numeric gncTaxTableEntryGetAmount (const GncTaxTableEntry *entry)
 
#define gncTaxTableGetChild(t)   gncTaxTableReturnChild((t),FALSE)
 

Detailed Description

Macro Definition Documentation

◆ GNC_TT_NAME

#define GNC_TT_NAME   "tax table name"

QOF parameter definitions

Definition at line 199 of file gncTaxTable.h.

◆ gncTaxTableGetGUID

#define gncTaxTableGetGUID (   x)    qof_instance_get_guid(QOF_INSTANCE(x))
Deprecated:
routine

Definition at line 203 of file gncTaxTable.h.

Enumeration Type Documentation

◆ GncAmountType

How to interpret the amount. You can interpret it as a VALUE or a PERCENT.

Enumerator
GNC_AMT_TYPE_VALUE 

tax is a number

GNC_AMT_TYPE_PERCENT 

tax is a percentage

Definition at line 93 of file gncTaxTable.h.

◆ GncTaxIncluded

How to interpret the TaxIncluded

Enumerator
GNC_TAXINCLUDED_YES 

tax is included

GNC_TAXINCLUDED_NO 

tax is not included

GNC_TAXINCLUDED_USEGLOBAL 

use the global setting

Definition at line 100 of file gncTaxTable.h.

Function Documentation

◆ gncAccountValueAdd()

GList* gncAccountValueAdd ( GList *  list,
Account acc,
gnc_numeric  value 
)

This will add value to the account-value for acc, creating a new list object if necessary

Definition at line 919 of file gncTaxTable.c.

920 {
921  GList *li;
922  GncAccountValue *res = NULL;
923 
924  g_return_val_if_fail (acc, list);
925  g_return_val_if_fail (gnc_numeric_check (value) == GNC_ERROR_OK, list);
926 
927  /* Try to find the account in the list */
928  for (li = list; li; li = li->next)
929  {
930  res = li->data;
931  if (res->account == acc)
932  {
933  res->value = gnc_numeric_add (res->value, value, GNC_DENOM_AUTO,
935  return list;
936  }
937  }
938  /* Nope, didn't find it. */
939 
940  res = g_new0 (GncAccountValue, 1);
941  res->account = acc;
942  res->value = value;
943  return g_list_prepend (list, res);
944 }
gnc_numeric gnc_numeric_add(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Definition: gnc-numeric.c:378
GNCNumericErrorCode gnc_numeric_check(gnc_numeric in)
Definition: gnc-numeric.c:83
#define GNC_DENOM_AUTO
Definition: gnc-numeric.h:242

◆ gncAccountValueAddList()

GList* gncAccountValueAddList ( GList *  l1,
GList *  l2 
)

Merge l2 into l1. l2 is not touched.

Definition at line 947 of file gncTaxTable.c.

948 {
949  GList *li;
950 
951  for (li = l2; li; li = li->next )
952  {
953  GncAccountValue *val = li->data;
954  l1 = gncAccountValueAdd (l1, val->account, val->value);
955  }
956 
957  return l1;
958 }
GList * gncAccountValueAdd(GList *list, Account *acc, gnc_numeric value)
Definition: gncTaxTable.c:919

◆ gncAccountValueDestroy()

void gncAccountValueDestroy ( GList *  list)

Destroy a list of accountvalues

Definition at line 974 of file gncTaxTable.c.

975 {
976  GList *node;
977  for ( node = list; node ; node = node->next)
978  g_free (node->data);
979 
980  g_list_free (list);
981 }

◆ gncAccountValueTotal()

gnc_numeric gncAccountValueTotal ( GList *  list)

return the total for this list

Definition at line 961 of file gncTaxTable.c.

962 {
963  gnc_numeric total = gnc_numeric_zero ();
964 
965  for ( ; list ; list = list->next)
966  {
967  GncAccountValue *val = list->data;
968  total = gnc_numeric_add (total, val->value, GNC_DENOM_AUTO, GNC_HOW_DENOM_LCD);
969  }
970  return total;
971 }
gnc_numeric gnc_numeric_add(gnc_numeric a, gnc_numeric b, gint64 denom, gint how)
Definition: gnc-numeric.c:378
#define GNC_DENOM_AUTO
Definition: gnc-numeric.h:242