GDataGenerator

GDataGenerator — Atom generator element

Stability Level

Unstable, unless otherwise indicated

Synopsis

#include <gdata/atom/gdata-generator.h>

                    GDataGenerator;
                    GDataGeneratorClass;
gint                gdata_generator_compare             (const GDataGenerator *a,
                                                         const GDataGenerator *b);
const gchar *       gdata_generator_get_name            (GDataGenerator *self);
const gchar *       gdata_generator_get_uri             (GDataGenerator *self);
const gchar *       gdata_generator_get_version         (GDataGenerator *self);

Object Hierarchy

  GObject
   +----GDataParsable
         +----GDataGenerator

Properties

  "name"                     gchar*                : Read
  "uri"                      gchar*                : Read
  "version"                  gchar*                : Read

Description

GDataGenerator represents a "generator" element from the Atom specification.

Details

GDataGenerator

typedef struct _GDataGenerator GDataGenerator;

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


GDataGeneratorClass

typedef struct {
} GDataGeneratorClass;

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

Since 0.4.0


gdata_generator_compare ()

gint                gdata_generator_compare             (const GDataGenerator *a,
                                                         const GDataGenerator *b);

Compares the two generators 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 name property of the GDataGenerators.

a :

a GDataGenerator, or NULL

b :

another GDataGenerator, or NULL

Returns :

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

Since 0.4.0


gdata_generator_get_name ()

const gchar *       gdata_generator_get_name            (GDataGenerator *self);

Gets the "name" property.

self :

a GDataGenerator

Returns :

the generator's name

Since 0.4.0


gdata_generator_get_uri ()

const gchar *       gdata_generator_get_uri             (GDataGenerator *self);

Gets the "uri" property.

self :

a GDataGenerator

Returns :

the generator's URI, or NULL

Since 0.4.0


gdata_generator_get_version ()

const gchar *       gdata_generator_get_version         (GDataGenerator *self);

Gets the "version" property.

self :

a GDataGenerator

Returns :

the generator's version, or NULL

Since 0.4.0

Property Details

The "name" property

  "name"                     gchar*                : Read

A human-readable name for the generating agent.

For more information, see the Atom specification.

Default value: NULL

Since 0.4.0


The "uri" property

  "uri"                      gchar*                : Read

An IRI reference that is relevant to the agent.

For more information, see the Atom specification.

Default value: NULL

Since 0.4.0


The "version" property

  "version"                  gchar*                : Read

Indicates the version of the generating agent.

For more information, see the Atom specification.

Default value: NULL

Since 0.4.0