Vendor
[Business]

Files
file	gncVendor.h
	Vendor Interface.
Set Functions
void	gncVendorSetID (GncVendor *vendor, const char *id)
void	gncVendorSetName (GncVendor *vendor, const char *name)
void	gncVendorSetNotes (GncVendor *vendor, const char *notes)
void	gncVendorSetTerms (GncVendor *vendor, GncBillTerm *terms)
void	gncVendorSetTaxIncluded (GncVendor *vendor, GncTaxIncluded taxincl)
void	gncVendorSetCurrency (GncVendor *vendor, gnc_commodity *currency)
void	gncVendorSetActive (GncVendor *vendor, gboolean active)
void	gncVendorSetTaxTableOverride (GncVendor *vendor, gboolean override)
void	gncVendorSetTaxTable (GncVendor *vendor, GncTaxTable *table)
Get Functions
const char *	gncVendorGetID (const GncVendor *vendor)
const char *	gncVendorGetName (const GncVendor *vendor)
GncAddress *	gncVendorGetAddr (const GncVendor *vendor)
const char *	gncVendorGetNotes (const GncVendor *vendor)
GncBillTerm *	gncVendorGetTerms (const GncVendor *vendor)
GncTaxIncluded	gncVendorGetTaxIncluded (const GncVendor *vendor)
gnc_commodity *	gncVendorGetCurrency (const GncVendor *vendor)
gboolean	gncVendorGetActive (const GncVendor *vendor)
gboolean	gncVendorGetTaxTableOverride (const GncVendor *vendor)
GncTaxTable *	gncVendorGetTaxTable (const GncVendor *vendor)
Defines
#define	GNC_ID_VENDOR   "gncVendor"
#define	GNC_TYPE_VENDOR   (gnc_vendor_get_type ())
#define	GNC_VENDOR(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_VENDOR, GncVendor))
#define	GNC_VENDOR_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_VENDOR, GncVendorClass))
#define	GNC_IS_VENDOR(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_VENDOR))
#define	GNC_IS_VENDOR_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_VENDOR))
#define	GNC_VENDOR_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_VENDOR, GncVendorClass))
#define	gncVendorLookup(book, guid)   QOF_BOOK_LOOKUP_ENTITY((book),(guid),GNC_ID_VENDOR, GncVendor)
#define	VENDOR_ID   "id"
#define	VENDOR_NAME   "name"
#define	VENDOR_ADDR   "addr"
#define	VENDOR_NOTES   "vendor_notes"
#define	VENDOR_TERMS   "vendor_terms"
#define	VENDOR_TAX_INC   "vendor_tax_included"
#define	VENDOR_ACTIVE   "vendor_is_active"
#define	VENDOR_TAX_OVERRIDE   "override_tax_table"
#define	VENDOR_TAX_TABLE   "vendor_tax_table"
#define	gncVendorGetBook(X)   qof_instance_get_book (QOF_INSTANCE(X))
#define	gncVendorGetGUID(X)   qof_instance_get_guid (QOF_INSTANCE(X))
#define	gncVendorRetGUID(X)   (X ? *(qof_instance_get_guid (QOF_INSTANCE(X))) : *(guid_null()))
#define	gncVendorLookupDirect(G, B)   gncVendorLookup((B),&(G))
Typedefs
typedef _gncVendor	GncVendor
typedef _gncVendorClass	GncVendorClass
Functions
GType	gnc_vendor_get_type (void)
GncVendor *	gncVendorCreate (QofBook *book)
void	gncVendorDestroy (GncVendor *vendor)
void	gncVendorAddJob (GncVendor *vendor, GncJob *job)
void	gncVendorRemoveJob (GncVendor *vendor, GncJob *job)
void	gncVendorBeginEdit (GncVendor *vendor)
void	gncVendorCommitEdit (GncVendor *vendor)
GList *	gncVendorGetJoblist (const GncVendor *vendor, gboolean show_all)
gboolean	gncVendorIsDirty (const GncVendor *vendor)
int	gncVendorCompare (const GncVendor *a, const GncVendor *b)

---

Define Documentation

#define gncVendorGetBook

(

X

)

qof_instance_get_book (QOF_INSTANCE(X))

deprecated functions

Definition at line 129 of file gncVendor.h.

#define gncVendorLookup	(	book,
		guid		)	QOF_BOOK_LOOKUP_ENTITY((book),(guid),GNC_ID_VENDOR, GncVendor)

Return a pointer to the instance gncVendor 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 GncVendor * gncVendorLookup (QofBook *book, const GUID *guid);

Definition at line 115 of file gncVendor.h.

---

Function Documentation

GList* gncVendorGetJoblist	(	const GncVendor *	vendor,
		gboolean	show_all
	)

XXX should be renamed to RetJobList to be consistent with other usage, since caller must free the copied list

Definition at line 487 of file gncVendor.c.

{
  if (!vendor) return NULL;

  if (show_all) {
    return (g_list_copy (vendor->jobs));
  } else {
    GList *list = NULL, *iterator;
    for (iterator = vendor->jobs; iterator; iterator=iterator->next) {
      GncJob *j = iterator->data;
      if (gncJobGetActive (j))
        list = g_list_append (list, j);
    }
    return list;
  }
}

---