Vendor

Files
file	gncVendor.h
	Vendor Interface.

Macros
#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	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 struct _gncVendor	GncVendor
typedef struct _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)
int	gncVendorCompare (const GncVendor *a, const GncVendor *b)
gboolean	gncVendorEqual (const GncVendor *a, const GncVendor *b)
gboolean	gncVendorIsDirty (const GncVendor *vendor)

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)

Detailed Description

Macro Definition Documentation

#define gncVendorGetBook

(

X

)

qof_instance_get_book (QOF_INSTANCE(X))

deprecated functions

Definition at line 130 of file gncVendor.h.

Function Documentation

int gncVendorCompare	(	const GncVendor *	a,
		const GncVendor *	b
	)

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

Definition at line 801 of file gncVendor.c.

{
    if (!a && !b) return 0;
    if (!a && b) return 1;
    if (a && !b) return -1;

    return(strcmp(a->name, b->name));
}

gboolean gncVendorEqual	(	const GncVendor *	a,
		const GncVendor *	b
	)

Test support function, used by test-dbi-business-stuff.c

Definition at line 810 of file gncVendor.c.

{
    if (a == NULL && b == NULL) return TRUE;
    if (a == NULL ||  b == NULL) return FALSE;

    g_return_val_if_fail(GNC_IS_VENDOR(a), FALSE);
    g_return_val_if_fail(GNC_IS_VENDOR(b), FALSE);

    if (g_strcmp0(a->id, b->id) != 0)
    {
        PWARN("IDs differ: %s vs %s", a->id, b->id);
        return FALSE;
    }

    if (g_strcmp0(a->name, b->name) != 0)
    {
        PWARN("Names differ: %s vs %s", a->name, b->name);
        return FALSE;
    }

    if (g_strcmp0(a->notes, b->notes) != 0)
    {
        PWARN("Notes differ");
        return FALSE;
    }

    if (!gncBillTermEqual(a->terms, b->terms))
    {
        PWARN("BillTerms differ");
        return FALSE;
    }

    if (!gncAddressEqual(a->addr, b->addr))
    {
        PWARN("Addresses differ");
        return FALSE;
    }

    if (!gnc_commodity_equal(a->currency, b->currency))
    {
        PWARN("Currencies differ");
        return FALSE;
    }

    if (!gncTaxTableEqual(a->taxtable, b->taxtable))
    {
        PWARN("Tax tables differ");
        return FALSE;
    }

    if (a->taxtable_override != b->taxtable_override)
    {
        PWARN("Tax table override flags differ");
        return FALSE;
    }

    if (a->taxincluded != b->taxincluded)
    {
        PWARN("Tax included flags differ");
        return FALSE;
    }

    if (a->active != b->active)
    {
        PWARN("Active flags differ");
        return FALSE;
    }

//    GList *         jobs;
    return TRUE;
}