GDataGDName

GDataGDName — GData name element

Stability Level

Unstable, unless otherwise indicated

Synopsis

#include <gdata/gd/gdata-gd-name.h>

                    GDataGDName;
                    GDataGDNameClass;
GDataGDName *       gdata_gd_name_new                   (const gchar *given_name,
                                                         const gchar *family_name);
gint                gdata_gd_name_compare               (const GDataGDName *a,
                                                         const GDataGDName *b);
const gchar *       gdata_gd_name_get_given_name        (GDataGDName *self);
void                gdata_gd_name_set_given_name        (GDataGDName *self,
                                                         const gchar *given_name);
const gchar *       gdata_gd_name_get_additional_name   (GDataGDName *self);
void                gdata_gd_name_set_additional_name   (GDataGDName *self,
                                                         const gchar *additional_name);
const gchar *       gdata_gd_name_get_family_name       (GDataGDName *self);
void                gdata_gd_name_set_family_name       (GDataGDName *self,
                                                         const gchar *family_name);
const gchar *       gdata_gd_name_get_prefix            (GDataGDName *self);
void                gdata_gd_name_set_prefix            (GDataGDName *self,
                                                         const gchar *prefix);
const gchar *       gdata_gd_name_get_suffix            (GDataGDName *self);
void                gdata_gd_name_set_suffix            (GDataGDName *self,
                                                         const gchar *suffix);
const gchar *       gdata_gd_name_get_full_name         (GDataGDName *self);
void                gdata_gd_name_set_full_name         (GDataGDName *self,
                                                         const gchar *full_name);

Object Hierarchy

  GObject
   +----GDataParsable
         +----GDataGDName

Properties

  "additional-name"          gchar*                : Read / Write
  "family-name"              gchar*                : Read / Write
  "full-name"                gchar*                : Read / Write
  "given-name"               gchar*                : Read / Write
  "prefix"                   gchar*                : Read / Write
  "suffix"                   gchar*                : Read / Write

Description

GDataGDName represents a "name" element from the GData specification.

Given a name such as Sir Winston Leonard Spencer-Churchill, KG, the properties of the GDataGDName should be set as follows:

"given-name"

Winston

"additional-name"

Leonard

"family-name"

Spencer-Churchill

"prefix"

Sir

"suffix"

KG

Details

GDataGDName

typedef struct _GDataGDName GDataGDName;

All the fields in the GDataGDName structure are private and should never be accessed directly.

Since 0.5.0


GDataGDNameClass

typedef struct {
} GDataGDNameClass;

All the fields in the GDataGDNameClass structure are private and should never be accessed directly.

Since 0.5.0


gdata_gd_name_new ()

GDataGDName *       gdata_gd_name_new                   (const gchar *given_name,
                                                         const gchar *family_name);

Creates a new GDataGDName. More information is available in the GData specification.

given_name :

the person's given name, or NULL

family_name :

the person's family name, or NULL

Returns :

a new GDataGDName, or NULL; unref with g_object_unref()

Since 0.5.0


gdata_gd_name_compare ()

gint                gdata_gd_name_compare               (const GDataGDName *a,
                                                         const GDataGDName *b);

Compares the two names in a strcmp() fashion. NULL values are handled gracefully, with 0 returned if both a and b are NULL, -1 if a is NULL and 1 if b is NULL.

The comparison of non-NULL values is done on the basis of the given_name, additional_name and family_name properties of the GDataGDNames.

a :

a GDataGDName, or NULL

b :

another GDataGDName, or NULL

Returns :

0 if a equals b, -1 or 1 as appropriate otherwise

Since 0.5.0


gdata_gd_name_get_given_name ()

const gchar *       gdata_gd_name_get_given_name        (GDataGDName *self);

Gets the "given-name" property.

self :

a GDataGDName

Returns :

the person's given name, or NULL

Since 0.5.0


gdata_gd_name_set_given_name ()

void                gdata_gd_name_set_given_name        (GDataGDName *self,
                                                         const gchar *given_name);

Sets the "given-name" property to given_name.

self :

a GDataGDName

given_name :

the new given name, or NULL

Since 0.5.0


gdata_gd_name_get_additional_name ()

const gchar *       gdata_gd_name_get_additional_name   (GDataGDName *self);

Gets the "additional-name" property.

self :

a GDataGDName

Returns :

the person's additional name, or NULL

Since 0.5.0


gdata_gd_name_set_additional_name ()

void                gdata_gd_name_set_additional_name   (GDataGDName *self,
                                                         const gchar *additional_name);

Sets the "additional-name" property to additional_name.

self :

a GDataGDName

additional_name :

the new additional name, or NULL

Since 0.5.0


gdata_gd_name_get_family_name ()

const gchar *       gdata_gd_name_get_family_name       (GDataGDName *self);

Gets the "family-name" property.

self :

a GDataGDName

Returns :

the person's family name, or NULL

Since 0.5.0


gdata_gd_name_set_family_name ()

void                gdata_gd_name_set_family_name       (GDataGDName *self,
                                                         const gchar *family_name);

Sets the "family-name" property to family_name.

self :

a GDataGDName

family_name :

the new family name, or NULL

Since 0.5.0


gdata_gd_name_get_prefix ()

const gchar *       gdata_gd_name_get_prefix            (GDataGDName *self);

Gets the "prefix" property.

self :

a GDataGDName

Returns :

the person's name prefix, or NULL

Since 0.5.0


gdata_gd_name_set_prefix ()

void                gdata_gd_name_set_prefix            (GDataGDName *self,
                                                         const gchar *prefix);

Sets the "prefix" property to prefix.

self :

a GDataGDName

prefix :

the new prefix, or NULL

Since 0.5.0


gdata_gd_name_get_suffix ()

const gchar *       gdata_gd_name_get_suffix            (GDataGDName *self);

Gets the "suffix" property.

self :

a GDataGDName

Returns :

the person's name suffix, or NULL

Since 0.5.0


gdata_gd_name_set_suffix ()

void                gdata_gd_name_set_suffix            (GDataGDName *self,
                                                         const gchar *suffix);

Sets the "suffix" property to suffix.

self :

a GDataGDName

suffix :

the new suffix, or NULL

Since 0.5.0


gdata_gd_name_get_full_name ()

const gchar *       gdata_gd_name_get_full_name         (GDataGDName *self);

Gets the "full-name" property.

self :

a GDataGDName

Returns :

the person's full name, or NULL

Since 0.5.0


gdata_gd_name_set_full_name ()

void                gdata_gd_name_set_full_name         (GDataGDName *self,
                                                         const gchar *full_name);

Sets the "full-name" property to full_name.

self :

a GDataGDName

full_name :

the new full name, or NULL

Since 0.5.0

Property Details

The "additional-name" property

  "additional-name"          gchar*                : Read / Write

An additional name for the person (e.g. a middle name).

For more information, see the GData specification.

Default value: NULL

Since 0.5.0


The "family-name" property

  "family-name"              gchar*                : Read / Write

The person's family name.

For more information, see the GData specification.

Default value: NULL

Since 0.5.0


The "full-name" property

  "full-name"                gchar*                : Read / Write

An unstructured representation of the person's full name. It's generally advised to use the other individual properties in preference to this one, which can fall out of synchronisation with the other properties.

For more information, see the GData specification.

Default value: NULL

Since 0.5.0


The "given-name" property

  "given-name"               gchar*                : Read / Write

The person's given name.

For more information, see the GData specification.

Default value: NULL

Since 0.5.0


The "prefix" property

  "prefix"                   gchar*                : Read / Write

An honorific prefix (e.g. Mr or Mrs).

For more information, see the GData specification.

Default value: NULL

Since 0.5.0


The "suffix" property

  "suffix"                   gchar*                : Read / Write

An honorific suffix (e.g. san or III).

For more information, see the GData specification.

Default value: NULL

Since 0.5.0