GDataGDWhere

## GDataGDWhere GDataGDWhere — GData where element |

## Stability Level

Unstable, unless otherwise indicated

## Synopsis

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

                        GDataGDWhere;
                        GDataGDWhereClass;
    GDataGDWhere *      gdata_gd_where_new                  (const gchar *relation_type,
                                                             const gchar *value_string,
                                                             const gchar *label);
    gint                gdata_gd_where_compare              (const GDataGDWhere *a,
                                                             const GDataGDWhere *b);
    const gchar *       gdata_gd_where_get_relation_type    (GDataGDWhere *self);
    void                gdata_gd_where_set_relation_type    (GDataGDWhere *self,
                                                             const gchar *relation_type);
    const gchar *       gdata_gd_where_get_value_string     (GDataGDWhere *self);
    void                gdata_gd_where_set_value_string     (GDataGDWhere *self,
                                                             const gchar *value_string);
    const gchar *       gdata_gd_where_get_label            (GDataGDWhere *self);
    void                gdata_gd_where_set_label            (GDataGDWhere *self,
                                                             const gchar *label);

## Object Hierarchy

      GObject
       +----GDataParsable
             +----GDataGDWhere

## Properties

      "label"                    gchar*                : Read / Write
      "relation-type"            gchar*                : Read / Write
      "value-string"             gchar*                : Read / Write

## Description

GDataGDWhere represents a "where" element from the GData specification.

## Details

### GDataGDWhere

    typedef struct _GDataGDWhere GDataGDWhere;

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

Since 0.2.0

### GDataGDWhereClass

    typedef struct {
    } GDataGDWhereClass;

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

Since 0.4.0

### gdata_gd_where_new ()

    GDataGDWhere *      gdata_gd_where_new                  (const gchar *relation_type,
                                                             const gchar *value_string,
                                                             const gchar *label);

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

Currently, entryLink functionality is not implemented in GDataGDWhere.

`relation_type` : | the relationship between the item and this place, or `NULL`. [allow-none]
`value_string` : | a string to represent the place, or `NULL`. [allow-none]
`label` : | a human-readable label for the place, or `NULL`. [allow-none]
Returns : | a new GDataGDWhere; unref with `g_object_unref()`

Since 0.2.0

### gdata_gd_where_compare ()

    gint                gdata_gd_where_compare              (const GDataGDWhere *a,
                                                             const GDataGDWhere *b);

Compares the two places 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 `label` and `value_string` properties of the GDataGDWheres.

`a` : | a GDataGDWhere, or `NULL`
`b` : | another GDataGDWhere, or `NULL`
Returns : | `0` if `a` equals `b`, `-1` or `1` as appropriate otherwise

Since 0.4.0

### gdata_gd_where_get_relation_type ()

    const gchar *       gdata_gd_where_get_relation_type    (GDataGDWhere *self);

Gets the "relation-type" property.

`self` : | a GDataGDWhere
Returns : | the relation type, or `NULL`

Since 0.4.0

### gdata_gd_where_set_relation_type ()

    void                gdata_gd_where_set_relation_type    (GDataGDWhere *self,
                                                             const gchar *relation_type);

Sets the "relation-type" property to `relation_type`.

Set `relation_type` to `NULL` to unset the property.

`self` : | a GDataGDWhere
`relation_type` : | the new relation type, or `NULL`. [allow-none]

Since 0.4.0

### gdata_gd_where_get_value_string ()

    const gchar *       gdata_gd_where_get_value_string     (GDataGDWhere *self);

Gets the "value-string" property.

`self` : | a GDataGDWhere
Returns : | the value string, or `NULL`

Since 0.4.0

### gdata_gd_where_set_value_string ()

    void                gdata_gd_where_set_value_string     (GDataGDWhere *self,
                                                             const gchar *value_string);

Sets the "value-string" property to `value_string`.

Set `value_string` to `NULL` to unset the property.

`self` : | a GDataGDWhere
`value_string` : | the new value string, or `NULL`. [allow-none]

Since 0.4.0

### gdata_gd_where_get_label ()

    const gchar *       gdata_gd_where_get_label            (GDataGDWhere *self);

Gets the "label" property.

`self` : | a GDataGDWhere
Returns : | the label, or `NULL`

Since 0.4.0

### gdata_gd_where_set_label ()

    void                gdata_gd_where_set_label            (GDataGDWhere *self,
                                                             const gchar *label);

Sets the "label" property to `label`.

Set `label` to `NULL` to unset the property.

`self` : | a GDataGDWhere
`label` : | the new label, or `NULL`. [allow-none]

Since 0.4.0

## Property Details

### The `"label"` property

      "label"                    gchar*                : Read / Write

Specifies a user-readable label to distinguish this location from other locations.

For more information, see the GData specification.

Default value: NULL

Since 0.4.0

### The `"relation-type"` property

      "relation-type"            gchar*                : Read / Write

Specifies the relationship between the containing entity and the contained location.

For more information, see the GData specification.

Default value: NULL

Since 0.4.0

### The `"value-string"` property

      "value-string"             gchar*                : Read / Write

A simple string value that can be used as a representation of this location.

For more information, see the GData specification.

Default value: NULL

Since 0.4.0