RAddress

RAddress — Address object

Synopsis




#define             R_ADDRESS_TYPE
#define             R_ADDRESS                           (obj)
#define             R_ADDRESS_CLASS                     (klass)
#define             IS_R_ADDRESS                        (obj)
#define             IS_R_ADDRESS_CLASS                  (klass)
#define             R_ADDRESS_GET_CLASS                 (kls)
enum                RAddressType;
                    RAddressPrivate;
                    RAddress;
GType               r_address_get_type                  (void);
RAddress*           r_address_new                       (void);
void                r_address_free                      (RAddress *address);
RAddress*           r_address_copy                      (RAddress *address);
gboolean            r_address_search                    (RAddress *address,
                                                         const gchar *str);
RAddressType        r_address_lookup_str2enum           (gchar *str);
gchar*              r_address_lookup_enum2str           (RAddressType type);
gchar*              r_address_lookup_enum2lbl           (RAddressType type);
gchar*              r_address_lookup_str2lbl            (gchar *str);

Object Hierarchy


  GObject
   +----RAddress

Properties


  "address-type"             gint                  : Read / Write / Construct
  "city"                     gchararray            : Read / Write / Construct
  "country"                  gchararray            : Read / Write / Construct
  "province"                 gchararray            : Read / Write / Construct
  "state"                    gchararray            : Read / Write / Construct
  "street"                   gchararray            : Read / Write / Construct
  "street-number"            gchararray            : Read / Write / Construct
  "zip"                      gchararray            : Read / Write / Construct

Description

The Address object

Details

R_ADDRESS_TYPE

#define R_ADDRESS_TYPE            (r_address_get_type())


R_ADDRESS()

#define             R_ADDRESS(obj)

obj :


R_ADDRESS_CLASS()

#define             R_ADDRESS_CLASS(klass)

klass :


IS_R_ADDRESS()

#define             IS_R_ADDRESS(obj)

obj :


IS_R_ADDRESS_CLASS()

#define             IS_R_ADDRESS_CLASS(klass)

klass :


R_ADDRESS_GET_CLASS()

#define             R_ADDRESS_GET_CLASS(kls)

kls :


enum RAddressType

typedef enum {
  R_ADDRESS_PREF = 0,    /* preferred delivery address                */
  R_ADDRESS_HOME,        /* delivery address for a residence          */
  R_ADDRESS_WORK,        /* delivery address for a place of work      */
  R_ADDRESS_PARCEL,      /* parcel delivery address (consegna pacchi) */ 
  R_ADDRESS_POSTAL,      /* postal delivery address                   */
  R_ADDRESS_INTL,        /* international delivery address            */
  R_ADDRESS_DOM,         /* domestic delivery address                 */
  R_ADDRESS_COMPANY,     /* registered office                         */
  R_ADDRESS_SUBSIDIARY,  /* subsidiary company                        */ 
  R_ADDRESS_OTHER,       /* other address type                        */
  R_ADDRESS_UNKNOWN,     /* */
  R_ADDRESS_INVALID
} RAddressType;

RAddressType is modeled on the VCard addresses's type


RAddressPrivate

typedef struct _RAddressPrivate RAddressPrivate;


RAddress

typedef struct _RAddress RAddress;


r_address_get_type ()

GType               r_address_get_type                  (void);

Returns :


r_address_new ()

RAddress*           r_address_new                       (void);

create a new RAddress

Returns :

a RAddress*

r_address_free ()

void                r_address_free                      (RAddress *address);

free the RAddress*

address :

a RAddress

r_address_copy ()

RAddress*           r_address_copy                      (RAddress *address);

copy the given RAddress

address :

a RAddress

Returns :

a new allocated RAddress

r_address_search ()

gboolean            r_address_search                    (RAddress *address,
                                                         const gchar *str);

search the string (or substring) str into the RAddress

address :

a RAddress

str :

a const gchar*

Returns :

TRUE if str was found, FALSE otherwise

r_address_lookup_str2enum ()

RAddressType        r_address_lookup_str2enum           (gchar *str);

find in the private lookup table the RAddressType associated with the given string

str :

Returns :

a RAddressType value or R_ADDRESS_UNKNOWN

r_address_lookup_enum2str ()

gchar*              r_address_lookup_enum2str           (RAddressType type);

find in the private lookup table the string associated with the given type

type :

a RAddressType

Returns :

a gchar*

r_address_lookup_enum2lbl ()

gchar*              r_address_lookup_enum2lbl           (RAddressType type);

find in the private lookup table the translated string associated with the given type

type :

a RAddressType

Returns :

a gchar*

r_address_lookup_str2lbl ()

gchar*              r_address_lookup_str2lbl            (gchar *str);

find in the private lookup table the RAddressType associated with the given string

str :

Returns :

a RAddressType value or R_ADDRESS_UNKNOWN

Property Details

The "address-type" property

  "address-type"             gint                  : Read / Write / Construct

defines the address's type. See RAddressType for valid values

Allowed values: [0,11]

Default value: 10


The "city" property

  "city"                     gchararray            : Read / Write / Construct

the address's city

Default value: NULL


The "country" property

  "country"                  gchararray            : Read / Write / Construct

the address's country (example: Italy, France, ...)

Default value: NULL


The "province" property

  "province"                 gchararray            : Read / Write / Construct

the address's province (example: Rm (Rome), Mi (Milan) , Na (Naples) ...)

Default value: NULL


The "state" property

  "state"                    gchararray            : Read / Write / Construct

the address's state (examples: UE, USA, ...)

Default value: NULL


The "street" property

  "street"                   gchararray            : Read / Write / Construct

the address's street

Default value: NULL


The "street-number" property

  "street-number"            gchararray            : Read / Write / Construct

the street number.

Default value: NULL


The "zip" property

  "zip"                      gchararray            : Read / Write / Construct

the postal code

Default value: NULL