Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GDataGenerator: GData Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch07.html" title="Atom API">
<link rel="prev" href="GDataCategory.html" title="GDataCategory">
<link rel="next" href="GDataLink.html" title="GDataLink">
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GDataGenerator.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GDataGenerator.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GDataGenerator.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GDataGenerator.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch07.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataCategory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataLink.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataGenerator"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataGenerator.top_of_page"></a>GDataGenerator</span></h2>
<p>GDataGenerator — Atom generator element</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataGenerator.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GDataGenerator.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataGenerator.html#gdata-generator-get-name" title="gdata_generator_get_name ()">gdata_generator_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataGenerator.html#gdata-generator-get-uri" title="gdata_generator_get_uri ()">gdata_generator_get_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataGenerator.html#gdata-generator-get-version" title="gdata_generator_get_version ()">gdata_generator_get_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataGenerator.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataGenerator.html#GDataGenerator--name" title="The “name” property">name</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataGenerator.html#GDataGenerator--uri" title="The “uri” property">uri</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataGenerator.html#GDataGenerator--version" title="The “version” property">version</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataGenerator.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataGenerator.html#GDataGenerator-struct" title="GDataGenerator">GDataGenerator</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataGenerator.html#GDataGeneratorClass" title="GDataGeneratorClass">GDataGeneratorClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataGenerator.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a class="link" href="GDataParsable.html" title="GDataParsable">GDataParsable</a>
        <span class="lineart">╰──</span> GDataGenerator
</pre>
</div>
<div class="refsect1">
<a name="GDataGenerator.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GDataGenerator implements
 <a class="link" href="GDataComparable.html" title="GDataComparable">GDataComparable</a>.</p>
</div>
<div class="refsect1">
<a name="GDataGenerator.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gdata/atom/gdata-generator.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GDataGenerator.description"></a><h2>Description</h2>
<p><a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> represents a "generator" element from the</p>
<a class="ulink" href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php" target="_top">Atom specification</a>.

</div>
<div class="refsect1">
<a name="GDataGenerator.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-generator-get-name"></a><h3>gdata_generator_get_name ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_generator_get_name (<em class="parameter"><code><a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataGenerator.html#GDataGenerator--name" title="The “name” property"><span class="type">“name”</span></a> property. The name will be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or non-empty.</p>
<div class="refsect3">
<a name="gdata-generator-get-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-generator-get-name.returns"></a><h4>Returns</h4>
<p>the generator's name. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.4.0">0.4.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-generator-get-uri"></a><h3>gdata_generator_get_uri ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_generator_get_uri (<em class="parameter"><code><a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataGenerator.html#GDataGenerator--uri" title="The “uri” property"><span class="type">“uri”</span></a> property. The URI will be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or non-empty.</p>
<div class="refsect3">
<a name="gdata-generator-get-uri.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-generator-get-uri.returns"></a><h4>Returns</h4>
<p>the generator's URI, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.4.0">0.4.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-generator-get-version"></a><h3>gdata_generator_get_version ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_generator_get_version (<em class="parameter"><code><a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataGenerator.html#GDataGenerator--version" title="The “version” property"><span class="type">“version”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-generator-get-version.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-generator-get-version.returns"></a><h4>Returns</h4>
<p> the generator's version, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.4.0">0.4.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataGenerator.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDataGenerator-struct"></a><h3>GDataGenerator</h3>
<pre class="programlisting">typedef struct _GDataGenerator GDataGenerator;</pre>
<p>All the fields in the <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> structure are private and should never be accessed directly.</p>
</div>
<hr>
<div class="refsect2">
<a name="GDataGeneratorClass"></a><h3>GDataGeneratorClass</h3>
<pre class="programlisting">typedef struct {
} GDataGeneratorClass;
</pre>
<p>All the fields in the <a class="link" href="GDataGenerator.html#GDataGeneratorClass" title="GDataGeneratorClass"><span class="type">GDataGeneratorClass</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.4.0">0.4.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataGenerator.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GDataGenerator--name"></a><h3>The <code class="literal">“name”</code> property</h3>
<pre class="programlisting">  “name”                     <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>A human-readable name for the generating agent.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php#element.generator" target="_top">
Atom specification</a>.
<p>Flags: Read</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.4.0">0.4.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataGenerator--uri"></a><h3>The <code class="literal">“uri”</code> property</h3>
<pre class="programlisting">  “uri”                      <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>An IRI reference that is relevant to the agent.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php#element.generator" target="_top">
Atom specification</a>.
<p>Flags: Read</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.4.0">0.4.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataGenerator--version"></a><h3>The <code class="literal">“version”</code> property</h3>
<pre class="programlisting">  “version”                  <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Indicates the version of the generating agent.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php#element.generator" target="_top">
Atom specification</a>.
<p>Flags: Read</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.4.0">0.4.0</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26.1</div>
</body>
</html>