Blame gdata/gd/gdata-gd-postal-address.h

Packit 4b6dd7
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
Packit 4b6dd7
/*
Packit 4b6dd7
 * GData Client
Packit 4b6dd7
 * Copyright (C) Philip Withnall 2009–2010 <philip@tecnocode.co.uk>
Packit 4b6dd7
 *
Packit 4b6dd7
 * GData Client is free software; you can redistribute it and/or
Packit 4b6dd7
 * modify it under the terms of the GNU Lesser General Public
Packit 4b6dd7
 * License as published by the Free Software Foundation; either
Packit 4b6dd7
 * version 2.1 of the License, or (at your option) any later version.
Packit 4b6dd7
 *
Packit 4b6dd7
 * GData Client is distributed in the hope that it will be useful,
Packit 4b6dd7
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 4b6dd7
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 4b6dd7
 * Lesser General Public License for more details.
Packit 4b6dd7
 *
Packit 4b6dd7
 * You should have received a copy of the GNU Lesser General Public
Packit 4b6dd7
 * License along with GData Client.  If not, see <http://www.gnu.org/licenses/>.
Packit 4b6dd7
 */
Packit 4b6dd7
Packit 4b6dd7
#ifndef GDATA_GD_POSTAL_ADDRESS_H
Packit 4b6dd7
#define GDATA_GD_POSTAL_ADDRESS_H
Packit 4b6dd7
Packit 4b6dd7
#include <glib.h>
Packit 4b6dd7
#include <glib-object.h>
Packit 4b6dd7
Packit 4b6dd7
#include <gdata/gdata-parsable.h>
Packit 4b6dd7
Packit 4b6dd7
G_BEGIN_DECLS
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_GD_POSTAL_ADDRESS_WORK:
Packit 4b6dd7
 *
Packit 4b6dd7
 * The relation type URI for the postal address of a workplace.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.7.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_GD_POSTAL_ADDRESS_WORK "http://schemas.google.com/g/2005#work"
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_GD_POSTAL_ADDRESS_HOME:
Packit 4b6dd7
 *
Packit 4b6dd7
 * The relation type URI for the postal address of a home.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.7.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_GD_POSTAL_ADDRESS_HOME "http://schemas.google.com/g/2005#home"
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_GD_POSTAL_ADDRESS_OTHER:
Packit 4b6dd7
 *
Packit 4b6dd7
 * The relation type URI for a miscellaneous postal address.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.7.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_GD_POSTAL_ADDRESS_OTHER "http://schemas.google.com/g/2005#other"
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_GD_MAIL_CLASS_BOTH:
Packit 4b6dd7
 *
Packit 4b6dd7
 * Parcels and letters can be sent to the address. Value for #GDataGDPostalAddress:mail-class.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.5.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_GD_MAIL_CLASS_BOTH "http://schemas.google.com/g/2005#both"
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_GD_MAIL_CLASS_LETTERS:
Packit 4b6dd7
 *
Packit 4b6dd7
 * Only letters can be sent to the address. Value for #GDataGDPostalAddress:mail-class.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.5.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_GD_MAIL_CLASS_LETTERS "http://schemas.google.com/g/2005#letters"
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_GD_MAIL_CLASS_PARCELS:
Packit 4b6dd7
 *
Packit 4b6dd7
 * Only parcels can be sent to the address. Value for #GDataGDPostalAddress:mail-class.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.5.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_GD_MAIL_CLASS_PARCELS "http://schemas.google.com/g/2005#parcels"
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_GD_MAIL_CLASS_NEITHER:
Packit 4b6dd7
 *
Packit 4b6dd7
 * Address is purely locational and cannot be used for mail. Value for #GDataGDPostalAddress:mail-class.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.5.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_GD_MAIL_CLASS_NEITHER "http://schemas.google.com/g/2005#neither"
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_GD_ADDRESS_USAGE_GENERAL:
Packit 4b6dd7
 *
Packit 4b6dd7
 * The address is for general usage. Value for #GDataGDPostalAddress:usage.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.5.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_GD_ADDRESS_USAGE_GENERAL "http://schemas.google.com/g/2005#general"
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDATA_GD_ADDRESS_USAGE_LOCAL:
Packit 4b6dd7
 *
Packit 4b6dd7
 * The address is for local usage. Value for #GDataGDPostalAddress:usage.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.5.0
Packit 4b6dd7
 */
Packit 4b6dd7
#define GDATA_GD_ADDRESS_USAGE_LOCAL "http://schemas.google.com/g/2005#local"
Packit 4b6dd7
Packit 4b6dd7
#define GDATA_TYPE_GD_POSTAL_ADDRESS		(gdata_gd_postal_address_get_type ())
Packit 4b6dd7
#define GDATA_GD_POSTAL_ADDRESS(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), GDATA_TYPE_GD_POSTAL_ADDRESS, GDataGDPostalAddress))
Packit 4b6dd7
#define GDATA_GD_POSTAL_ADDRESS_CLASS(k)	(G_TYPE_CHECK_CLASS_CAST((k), GDATA_TYPE_GD_POSTAL_ADDRESS, GDataGDPostalAddressClass))
Packit 4b6dd7
#define GDATA_IS_GD_POSTAL_ADDRESS(o)		(G_TYPE_CHECK_INSTANCE_TYPE ((o), GDATA_TYPE_GD_POSTAL_ADDRESS))
Packit 4b6dd7
#define GDATA_IS_GD_POSTAL_ADDRESS_CLASS(k)	(G_TYPE_CHECK_CLASS_TYPE ((k), GDATA_TYPE_GD_POSTAL_ADDRESS))
Packit 4b6dd7
#define GDATA_GD_POSTAL_ADDRESS_GET_CLASS(o)	(G_TYPE_INSTANCE_GET_CLASS ((o), GDATA_TYPE_GD_POSTAL_ADDRESS, GDataGDPostalAddressClass))
Packit 4b6dd7
Packit 4b6dd7
typedef struct _GDataGDPostalAddressPrivate	GDataGDPostalAddressPrivate;
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDataGDPostalAddress:
Packit 4b6dd7
 *
Packit 4b6dd7
 * All the fields in the #GDataGDPostalAddress structure are private and should never be accessed directly.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.2.0
Packit 4b6dd7
 */
Packit 4b6dd7
typedef struct {
Packit 4b6dd7
	GDataParsable parent;
Packit 4b6dd7
	GDataGDPostalAddressPrivate *priv;
Packit 4b6dd7
} GDataGDPostalAddress;
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * GDataGDPostalAddressClass:
Packit 4b6dd7
 *
Packit 4b6dd7
 * All the fields in the #GDataGDPostalAddressClass structure are private and should never be accessed directly.
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.4.0
Packit 4b6dd7
 */
Packit 4b6dd7
typedef struct {
Packit 4b6dd7
	/*< private >*/
Packit 4b6dd7
	GDataParsableClass parent;
Packit 4b6dd7
Packit 4b6dd7
	/*< private >*/
Packit 4b6dd7
	/* Padding for future expansion */
Packit 4b6dd7
	void (*_g_reserved0) (void);
Packit 4b6dd7
	void (*_g_reserved1) (void);
Packit 4b6dd7
} GDataGDPostalAddressClass;
Packit 4b6dd7
Packit 4b6dd7
GType gdata_gd_postal_address_get_type (void) G_GNUC_CONST;
Packit 4b6dd7
Packit 4b6dd7
GDataGDPostalAddress *gdata_gd_postal_address_new (const gchar *relation_type, const gchar *label,
Packit 4b6dd7
                                                   gboolean is_primary) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC;
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_address (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_address (GDataGDPostalAddress *self, const gchar *address);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_relation_type (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_relation_type (GDataGDPostalAddress *self, const gchar *relation_type);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_label (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_label (GDataGDPostalAddress *self, const gchar *label);
Packit 4b6dd7
Packit 4b6dd7
gboolean gdata_gd_postal_address_is_primary (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_is_primary (GDataGDPostalAddress *self, gboolean is_primary);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_mail_class (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_mail_class (GDataGDPostalAddress *self, const gchar *mail_class);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_usage (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_usage (GDataGDPostalAddress *self, const gchar *usage);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_agent (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_agent (GDataGDPostalAddress *self, const gchar *agent);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_house_name (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_house_name (GDataGDPostalAddress *self, const gchar *house_name);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_street (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_street (GDataGDPostalAddress *self, const gchar *street);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_po_box (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_po_box (GDataGDPostalAddress *self, const gchar *po_box);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_neighborhood (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_neighborhood (GDataGDPostalAddress *self, const gchar *neighborhood);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_city (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_city (GDataGDPostalAddress *self, const gchar *city);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_subregion (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_subregion (GDataGDPostalAddress *self, const gchar *subregion);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_region (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_region (GDataGDPostalAddress *self, const gchar *region);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_postcode (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_postcode (GDataGDPostalAddress *self, const gchar *postcode);
Packit 4b6dd7
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_country (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
const gchar *gdata_gd_postal_address_get_country_code (GDataGDPostalAddress *self) G_GNUC_PURE;
Packit 4b6dd7
void gdata_gd_postal_address_set_country (GDataGDPostalAddress *self, const gchar *country, const gchar *country_code);
Packit 4b6dd7
Packit 4b6dd7
G_END_DECLS
Packit 4b6dd7
Packit 4b6dd7
#endif /* !GDATA_GD_POSTAL_ADDRESS_H */