gncAddress.h File Reference

an Address object More...

#include "qof.h"

Go to the source code of this file.

Defines
#define	GNC_ADDRESS_MODULE_NAME   "gncAddress"
#define	GNC_ID_ADDRESS   GNC_ADDRESS_MODULE_NAME
#define	GNC_TYPE_ADDRESS   (gnc_address_get_type ())
#define	GNC_ADDRESS(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_ADDRESS, GncAddress))
#define	GNC_ADDRESS_CLASS(k)   (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_ADDRESS, GncAddressClass))
#define	GNC_IS_ADDRESS(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_ADDRESS))
#define	GNC_IS_ADDRESS_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_ADDRESS))
#define	GNC_ADDRESS_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_ADDRESS, GncAddressClass))
#define	ADDRESS_NAME   "name"
#define	ADDRESS_ONE   "number"
#define	ADDRESS_TWO   "street"
#define	ADDRESS_THREE   "locality"
#define	ADDRESS_FOUR   "city"
#define	ADDRESS_PHONE   "phone"
#define	ADDRESS_FAX   "fax"
#define	ADDRESS_EMAIL   "email"
#define	ADDRESS_OWNER   "owner"
Typedefs
typedef struct _gncAddress	GncAddress
typedef struct _gncAddressClass	GncAddressClass
Functions
GType	gnc_address_get_type (void)
gboolean	gncAddressIsDirty (const GncAddress *addr)
int	gncAddressCompare (const GncAddress *a, const GncAddress *b)
	compare two addresses
gboolean	gncAddressEqual (const GncAddress *a, const GncAddress *b)
	Deeply compare two addresses.
Create/Destroy functions
GncAddress *	gncAddressCreate (QofBook *book, QofInstance *parent)
void	gncAddressDestroy (GncAddress *addr)
void	gncAddressBeginEdit (GncAddress *addr)
void	gncAddressCommitEdit (GncAddress *addr)
Set functions
void	gncAddressSetName (GncAddress *addr, const char *name)
void	gncAddressSetAddr1 (GncAddress *addr, const char *addr1)
void	gncAddressSetAddr2 (GncAddress *addr, const char *addr2)
void	gncAddressSetAddr3 (GncAddress *addr, const char *addr3)
void	gncAddressSetAddr4 (GncAddress *addr, const char *addr4)
void	gncAddressSetPhone (GncAddress *addr, const char *phone)
void	gncAddressSetFax (GncAddress *addr, const char *fax)
void	gncAddressSetEmail (GncAddress *addr, const char *email)
void	gncAddressClearDirty (GncAddress *address)
Get Functions
const char *	gncAddressGetName (const GncAddress *addr)
const char *	gncAddressGetAddr1 (const GncAddress *addr)
const char *	gncAddressGetAddr2 (const GncAddress *addr)
const char *	gncAddressGetAddr3 (const GncAddress *addr)
const char *	gncAddressGetAddr4 (const GncAddress *addr)
const char *	gncAddressGetPhone (const GncAddress *addr)
const char *	gncAddressGetFax (const GncAddress *addr)
const char *	gncAddressGetEmail (const GncAddress *addr)

---

Detailed Description

an Address object

Author:

Copyright (C) 2001 Derek Atkins <warlord@MIT.EDU>

Copyright (c) 2005 Neil Williams <linux@codehelp.co.uk>

Definition in file gncAddress.h.