Customer
[Business]


Files

file  gncCustomer.h
 Core Customer Interface.

Data Structures

struct  GncCustomer

Create/Destroy Functions

GncCustomergncCustomerCreate (QofBook *book)
void gncCustomerDestroy (GncCustomer *customer)
void gncCustomerBeginEdit (GncCustomer *customer)
void gncCustomerCommitEdit (GncCustomer *customer)

Set Functions

void gncCustomerSetID (GncCustomer *customer, const char *id)
void gncCustomerSetName (GncCustomer *customer, const char *name)
void gncCustomerSetNotes (GncCustomer *customer, const char *notes)
void gncCustomerSetTerms (GncCustomer *customer, GncBillTerm *term)
void gncCustomerSetTaxIncluded (GncCustomer *customer, GncTaxIncluded taxincl)
void gncCustomerSetActive (GncCustomer *customer, gboolean active)
void gncCustomerSetDiscount (GncCustomer *customer, gnc_numeric discount)
void gncCustomerSetCredit (GncCustomer *customer, gnc_numeric credit)
void gncCustomerSetCurrency (GncCustomer *customer, gnc_commodity *currency)
void gncCustomerSetTaxTableOverride (GncCustomer *customer, gboolean override)
void gncCustomerSetTaxTable (GncCustomer *customer, GncTaxTable *table)
void gncCustomerAddJob (GncCustomer *customer, GncJob *job)
void gncCustomerRemoveJob (GncCustomer *customer, GncJob *job)

Get Functions

const char * gncCustomerGetID (const GncCustomer *customer)
const char * gncCustomerGetName (const GncCustomer *customer)
GncAddressgncCustomerGetAddr (const GncCustomer *customer)
GncAddressgncCustomerGetShipAddr (const GncCustomer *customer)
const char * gncCustomerGetNotes (const GncCustomer *customer)
GncBillTermgncCustomerGetTerms (const GncCustomer *customer)
GncTaxIncluded gncCustomerGetTaxIncluded (const GncCustomer *customer)
gboolean gncCustomerGetActive (const GncCustomer *customer)
gnc_numeric gncCustomerGetDiscount (const GncCustomer *customer)
gnc_numeric gncCustomerGetCredit (const GncCustomer *customer)
gnc_commoditygncCustomerGetCurrency (const GncCustomer *customer)
gboolean gncCustomerGetTaxTableOverride (const GncCustomer *customer)
GncTaxTablegncCustomerGetTaxTable (const GncCustomer *customer)
GList * gncCustomerGetJoblist (const GncCustomer *customer, gboolean show_all)
#define gncCustomerLookup(book, guid)   QOF_BOOK_LOOKUP_ENTITY((book),(guid),GNC_ID_CUSTOMER, GncCustomer)

Defines

#define GNC_ID_CUSTOMER   "gncCustomer"
#define GNC_TYPE_CUSTOMER   (gnc_customer_get_type ())
#define GNC_CUSTOMER(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_CUSTOMER, GncCustomer))
#define GNC_CUSTOMER_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_CUSTOMER, GncCustomerClass))
#define GNC_IS_CUSTOMER(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_CUSTOMER))
#define GNC_IS_CUSTOMER_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_CUSTOMER))
#define GNC_CUSTOMER_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_CUSTOMER, GncCustomerClass))
#define CUSTOMER_ID   "id"
#define CUSTOMER_NAME   "name"
#define CUSTOMER_ADDR   "addr"
#define CUSTOMER_SHIPADDR   "shipaddr"
#define CUSTOMER_NOTES   "notes"
#define CUSTOMER_DISCOUNT   "amount of discount"
#define CUSTOMER_CREDIT   "amount of credit"
#define CUSTOMER_TT_OVER   "tax table override"
#define CUSTOMER_TAX_INC   "customer_tax_included"
#define CUSTOMER_TERMS   "customer_terms"
#define CUSTOMER_ACTIVE   "customer_is_active"
#define CUSTOMER_SLOTS   "customer_values"
#define gncCustomerGetGUID(x)   qof_instance_get_guid(QOF_INSTANCE(x))
#define gncCustomerRetGUID(x)   (x ? *(qof_instance_get_guid(QOF_INSTANCE(x))) : *(guid_null()))
#define gncCustomerGetBook(x)   qof_instance_get_book(QOF_INSTANCE(x))
#define gncCustomerLookupDirect(g, b)   gncCustomerLookup((b), &(g))

Typedefs

typedef _gncCustomer GncCustomer
typedef _gncCustomerClass GncCustomerClass

Functions

GType gnc_customer_get_type (void)
gboolean gncCustomerIsDirty (GncCustomer *customer)
int gncCustomerCompare (const GncCustomer *a, const GncCustomer *b)


Define Documentation

#define gncCustomerGetGUID (  )     qof_instance_get_guid(QOF_INSTANCE(x))

Deprecated:
functions, should be removed

Definition at line 156 of file gncCustomer.h.

#define gncCustomerLookup ( book,
guid   )     QOF_BOOK_LOOKUP_ENTITY((book),(guid),GNC_ID_CUSTOMER, GncCustomer)

Return a pointer to the instance gncCustomer that is identified by the guid, and is residing in the book. Returns NULL if the instance can't be found. Equivalent function prototype is GncCustomer * gncCustomerLookup (QofBook *book, const GUID *guid);

Definition at line 118 of file gncCustomer.h.


Generated on Fri Oct 10 05:06:51 2008 for GnuCash by  doxygen 1.5.2