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>GDataGDWhen: 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="ch09.html" title="GData API">
<link rel="prev" href="GDataGDReminder.html" title="GDataGDReminder">
<link rel="next" href="GDataGDWhere.html" title="GDataGDWhere">
<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="#GDataGDWhen.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GDataGDWhen.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GDataGDWhen.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GDataGDWhen.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="ch09.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataGDReminder.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataGDWhere.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataGDWhen"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataGDWhen.top_of_page"></a>GDataGDWhen</span></h2>
<p>GDataGDWhen — GData when element</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataGDWhen.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="GDataGDWhen.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">
<a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="returnvalue">GDataGDWhen</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataGDWhen.html#gdata-gd-when-new" title="gdata_gd_when_new ()">gdata_gd_when_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataGDWhen.html#gdata-gd-when-get-start-time" title="gdata_gd_when_get_start_time ()">gdata_gd_when_get_start_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataGDWhen.html#gdata-gd-when-set-start-time" title="gdata_gd_when_set_start_time ()">gdata_gd_when_set_start_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataGDWhen.html#gdata-gd-when-get-end-time" title="gdata_gd_when_get_end_time ()">gdata_gd_when_get_end_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataGDWhen.html#gdata-gd-when-set-end-time" title="gdata_gd_when_set_end_time ()">gdata_gd_when_set_end_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataGDWhen.html#gdata-gd-when-is-date" title="gdata_gd_when_is_date ()">gdata_gd_when_is_date</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataGDWhen.html#gdata-gd-when-set-is-date" title="gdata_gd_when_set_is_date ()">gdata_gd_when_set_is_date</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="GDataGDWhen.html#gdata-gd-when-get-value-string" title="gdata_gd_when_get_value_string ()">gdata_gd_when_get_value_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataGDWhen.html#gdata-gd-when-set-value-string" title="gdata_gd_when_set_value_string ()">gdata_gd_when_set_value_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataGDWhen.html#gdata-gd-when-get-reminders" title="gdata_gd_when_get_reminders ()">gdata_gd_when_get_reminders</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataGDWhen.html#gdata-gd-when-add-reminder" title="gdata_gd_when_add_reminder ()">gdata_gd_when_add_reminder</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataGDWhen.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#gint64"><span class="type">gint64</span></a></td>
<td class="property_name"><a class="link" href="GDataGDWhen.html#GDataGDWhen--end-time" title="The “end-time” property">end-time</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GDataGDWhen.html#GDataGDWhen--is-date" title="The “is-date” property">is-date</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td>
<td class="property_name"><a class="link" href="GDataGDWhen.html#GDataGDWhen--start-time" title="The “start-time” property">start-time</a></td>
<td class="property_flags">Read / Write</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="GDataGDWhen.html#GDataGDWhen--value-string" title="The “value-string” property">value-string</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataGDWhen.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGDWhen.html#GDATA-GD-EVENT-STATUS-CANCELED:CAPS" title="GDATA_GD_EVENT_STATUS_CANCELED">GDATA_GD_EVENT_STATUS_CANCELED</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGDWhen.html#GDATA-GD-EVENT-STATUS-CONFIRMED:CAPS" title="GDATA_GD_EVENT_STATUS_CONFIRMED">GDATA_GD_EVENT_STATUS_CONFIRMED</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGDWhen.html#GDATA-GD-EVENT-STATUS-TENTATIVE:CAPS" title="GDATA_GD_EVENT_STATUS_TENTATIVE">GDATA_GD_EVENT_STATUS_TENTATIVE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGDWhen.html#GDATA-GD-EVENT-VISIBILITY-CONFIDENTIAL:CAPS" title="GDATA_GD_EVENT_VISIBILITY_CONFIDENTIAL">GDATA_GD_EVENT_VISIBILITY_CONFIDENTIAL</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGDWhen.html#GDATA-GD-EVENT-VISIBILITY-DEFAULT:CAPS" title="GDATA_GD_EVENT_VISIBILITY_DEFAULT">GDATA_GD_EVENT_VISIBILITY_DEFAULT</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGDWhen.html#GDATA-GD-EVENT-VISIBILITY-PRIVATE:CAPS" title="GDATA_GD_EVENT_VISIBILITY_PRIVATE">GDATA_GD_EVENT_VISIBILITY_PRIVATE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGDWhen.html#GDATA-GD-EVENT-VISIBILITY-PUBLIC:CAPS" title="GDATA_GD_EVENT_VISIBILITY_PUBLIC">GDATA_GD_EVENT_VISIBILITY_PUBLIC</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGDWhen.html#GDATA-GD-EVENT-TRANSPARENCY-OPAQUE:CAPS" title="GDATA_GD_EVENT_TRANSPARENCY_OPAQUE">GDATA_GD_EVENT_TRANSPARENCY_OPAQUE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGDWhen.html#GDATA-GD-EVENT-TRANSPARENCY-TRANSPARENT:CAPS" title="GDATA_GD_EVENT_TRANSPARENCY_TRANSPARENT">GDATA_GD_EVENT_TRANSPARENCY_TRANSPARENT</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataGDWhen.html#GDataGDWhen-struct" title="GDataGDWhen">GDataGDWhen</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataGDWhen.html#GDataGDWhenClass" title="GDataGDWhenClass">GDataGDWhenClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataGDWhen.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> GDataGDWhen
</pre>
</div>
<div class="refsect1">
<a name="GDataGDWhen.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GDataGDWhen implements
 <a class="link" href="GDataComparable.html" title="GDataComparable">GDataComparable</a>.</p>
</div>
<div class="refsect1">
<a name="GDataGDWhen.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gdata/gd/gdata-gd-when.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GDataGDWhen.description"></a><h2>Description</h2>
<p><a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a> represents a "when" element from the</p>
<a class="ulink" href="http://code.google.com/apis/gdata/docs/2.0/elements.html#gdWhen" target="_top">GData specification</a>.

</div>
<div class="refsect1">
<a name="GDataGDWhen.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-gd-when-new"></a><h3>gdata_gd_when_new ()</h3>
<pre class="programlisting"><a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="returnvalue">GDataGDWhen</span></a> *
gdata_gd_when_new (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> start_time</code></em>,
                   <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> end_time</code></em>,
                   <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> is_date</code></em>);</pre>
<p>Creates a new <a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a>. More information is available in the <a class="ulink" href="http://code.google.com/apis/gdata/docs/2.0/elements.html#gdWhen" target="_top">GData specification</a>.</p>
<div class="refsect3">
<a name="gdata-gd-when-new.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>start_time</p></td>
<td class="parameter_description"><p>when the event starts or (for zero-duration events) when it occurs</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_time</p></td>
<td class="parameter_description"><p>when the event ends, or <code class="code">-1</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>is_date</p></td>
<td class="parameter_description"><p><a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>start_time</code></em>
and <em class="parameter"><code>end_time</code></em>
specify dates rather than times, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-gd-when-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-gd-when-get-start-time"></a><h3>gdata_gd_when_get_start_time ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>
gdata_gd_when_get_start_time (<em class="parameter"><code><a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataGDWhen.html#GDataGDWhen--start-time" title="The “start-time” property"><span class="type">“start-time”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-gd-when-get-start-time.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="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-gd-when-get-start-time.returns"></a><h4>Returns</h4>
<p> the UNIX timestamp for the start time of the event</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-gd-when-set-start-time"></a><h3>gdata_gd_when_set_start_time ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_gd_when_set_start_time (<em class="parameter"><code><a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a> *self</code></em>,
                              <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> start_time</code></em>);</pre>
<p>Sets the <a class="link" href="GDataGDWhen.html#GDataGDWhen--start-time" title="The “start-time” property"><span class="type">“start-time”</span></a> property to <em class="parameter"><code>start_time</code></em>
.</p>
<div class="refsect3">
<a name="gdata-gd-when-set-start-time.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="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_time</p></td>
<td class="parameter_description"><p>the new start time</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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-gd-when-get-end-time"></a><h3>gdata_gd_when_get_end_time ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>
gdata_gd_when_get_end_time (<em class="parameter"><code><a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataGDWhen.html#GDataGDWhen--end-time" title="The “end-time” property"><span class="type">“end-time”</span></a> property.</p>
<p>If the end time is unset, <code class="code">-1</code> will be returned.</p>
<div class="refsect3">
<a name="gdata-gd-when-get-end-time.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="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-gd-when-get-end-time.returns"></a><h4>Returns</h4>
<p> the UNIX timestamp for the end time of the event, or</p>
<code class="code">-1</code>
</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-gd-when-set-end-time"></a><h3>gdata_gd_when_set_end_time ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_gd_when_set_end_time (<em class="parameter"><code><a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a> *self</code></em>,
                            <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> end_time</code></em>);</pre>
<p>Sets the <a class="link" href="GDataGDWhen.html#GDataGDWhen--end-time" title="The “end-time” property"><span class="type">“end-time”</span></a> property to <em class="parameter"><code>end_time</code></em>
.</p>
<p>Set <em class="parameter"><code>end_time</code></em>
 to <code class="code">-1</code> to unset the property.</p>
<div class="refsect3">
<a name="gdata-gd-when-set-end-time.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="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_time</p></td>
<td class="parameter_description"><p>the new end time, or <code class="code">-1</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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-gd-when-is-date"></a><h3>gdata_gd_when_is_date ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdata_gd_when_is_date (<em class="parameter"><code><a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataGDWhen.html#GDataGDWhen--is-date" title="The “is-date” property"><span class="type">“is-date”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-gd-when-is-date.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="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-gd-when-is-date.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <a class="link" href="GDataGDWhen.html#GDataGDWhen--start-time" title="The “start-time” property"><span class="type">“start-time”</span></a> and <a class="link" href="GDataGDWhen.html#GDataGDWhen--end-time" title="The “end-time” property"><span class="type">“end-time”</span></a> are dates rather than times, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</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-gd-when-set-is-date"></a><h3>gdata_gd_when_set_is_date ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_gd_when_set_is_date (<em class="parameter"><code><a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a> *self</code></em>,
                           <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> is_date</code></em>);</pre>
<p>Sets the <a class="link" href="GDataGDWhen.html#GDataGDWhen--is-date" title="The “is-date” property"><span class="type">“is-date”</span></a> property to <em class="parameter"><code>is_date</code></em>
.</p>
<div class="refsect3">
<a name="gdata-gd-when-set-is-date.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="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>is_date</p></td>
<td class="parameter_description"><p><a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <a class="link" href="GDataGDWhen.html#GDataGDWhen--start-time" title="The “start-time” property"><span class="type">“start-time”</span></a> and <a class="link" href="GDataGDWhen.html#GDataGDWhen--end-time" title="The “end-time” property"><span class="type">“end-time”</span></a> should be dates rather than times, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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-gd-when-get-value-string"></a><h3>gdata_gd_when_get_value_string ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_gd_when_get_value_string (<em class="parameter"><code><a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataGDWhen.html#GDataGDWhen--value-string" title="The “value-string” property"><span class="type">“value-string”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-gd-when-get-value-string.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="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-gd-when-get-value-string.returns"></a><h4>Returns</h4>
<p> the value string, 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>
<hr>
<div class="refsect2">
<a name="gdata-gd-when-set-value-string"></a><h3>gdata_gd_when_set_value_string ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_gd_when_set_value_string (<em class="parameter"><code><a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a> *self</code></em>,
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value_string</code></em>);</pre>
<p>Sets the <a class="link" href="GDataGDWhen.html#GDataGDWhen--value-string" title="The “value-string” property"><span class="type">“value-string”</span></a> property to <em class="parameter"><code>value_string</code></em>
.</p>
<p>Set <em class="parameter"><code>value_string</code></em>
 to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset the property.</p>
<div class="refsect3">
<a name="gdata-gd-when-set-value-string.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="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value_string</p></td>
<td class="parameter_description"><p>the new value string, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</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-gd-when-get-reminders"></a><h3>gdata_gd_when_get_reminders ()</h3>
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
gdata_gd_when_get_reminders (<em class="parameter"><code><a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a> *self</code></em>);</pre>
<p>Returns a list of the <a class="link" href="GDataGDReminder.html" title="GDataGDReminder"><span class="type">GDataGDReminder</span></a>s which are associated with this <a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a>.</p>
<div class="refsect3">
<a name="gdata-gd-when-get-reminders.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="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-gd-when-get-reminders.returns"></a><h4>Returns</h4>
<p>a <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of <a class="link" href="GDataGDReminder.html" title="GDataGDReminder"><span class="type">GDataGDReminder</span></a>s, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GData.GDReminder][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</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-gd-when-add-reminder"></a><h3>gdata_gd_when_add_reminder ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_gd_when_add_reminder (<em class="parameter"><code><a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a> *self</code></em>,
                            <em class="parameter"><code><a class="link" href="GDataGDReminder.html" title="GDataGDReminder"><span class="type">GDataGDReminder</span></a> *reminder</code></em>);</pre>
<p>Adds a reminder to the <a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a>'s list of reminders and increments its reference count.</p>
<p>Duplicate reminders will not be added to the list.</p>
<div class="refsect3">
<a name="gdata-gd-when-add-reminder.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="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>reminder</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataGDReminder.html" title="GDataGDReminder"><span class="type">GDataGDReminder</span></a> to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataGDWhen.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDATA-GD-EVENT-STATUS-CANCELED:CAPS"></a><h3>GDATA_GD_EVENT_STATUS_CANCELED</h3>
<pre class="programlisting">#define GDATA_GD_EVENT_STATUS_CANCELED "http://schemas.google.com/g/2005#event.canceled"
</pre>
<p>The event has been canceled.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GD-EVENT-STATUS-CONFIRMED:CAPS"></a><h3>GDATA_GD_EVENT_STATUS_CONFIRMED</h3>
<pre class="programlisting">#define GDATA_GD_EVENT_STATUS_CONFIRMED "http://schemas.google.com/g/2005#event.confirmed"
</pre>
<p>The event has been planned and confirmed.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GD-EVENT-STATUS-TENTATIVE:CAPS"></a><h3>GDATA_GD_EVENT_STATUS_TENTATIVE</h3>
<pre class="programlisting">#define GDATA_GD_EVENT_STATUS_TENTATIVE "http://schemas.google.com/g/2005#event.tentative"
</pre>
<p>The event has been planned, but only tentatively scheduled.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GD-EVENT-VISIBILITY-CONFIDENTIAL:CAPS"></a><h3>GDATA_GD_EVENT_VISIBILITY_CONFIDENTIAL</h3>
<pre class="programlisting">#define GDATA_GD_EVENT_VISIBILITY_CONFIDENTIAL "http://schemas.google.com/g/2005#event.confidential"
</pre>
<p>The event is visible to only certain people.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GD-EVENT-VISIBILITY-DEFAULT:CAPS"></a><h3>GDATA_GD_EVENT_VISIBILITY_DEFAULT</h3>
<pre class="programlisting">#define GDATA_GD_EVENT_VISIBILITY_DEFAULT "http://schemas.google.com/g/2005#event.default"
</pre>
<p>The event's visibility is inherited from the preferences of its owner.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GD-EVENT-VISIBILITY-PRIVATE:CAPS"></a><h3>GDATA_GD_EVENT_VISIBILITY_PRIVATE</h3>
<pre class="programlisting">#define GDATA_GD_EVENT_VISIBILITY_PRIVATE "http://schemas.google.com/g/2005#event.private"
</pre>
<p>The event is visible to very few people.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GD-EVENT-VISIBILITY-PUBLIC:CAPS"></a><h3>GDATA_GD_EVENT_VISIBILITY_PUBLIC</h3>
<pre class="programlisting">#define GDATA_GD_EVENT_VISIBILITY_PUBLIC "http://schemas.google.com/g/2005#event.public"
</pre>
<p>The event is visible to most people.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GD-EVENT-TRANSPARENCY-OPAQUE:CAPS"></a><h3>GDATA_GD_EVENT_TRANSPARENCY_OPAQUE</h3>
<pre class="programlisting">#define GDATA_GD_EVENT_TRANSPARENCY_OPAQUE "http://schemas.google.com/g/2005#event.opaque"
</pre>
<p>The event consumes time in calendars; its time will be marked as busy in a free/busy search.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GD-EVENT-TRANSPARENCY-TRANSPARENT:CAPS"></a><h3>GDATA_GD_EVENT_TRANSPARENCY_TRANSPARENT</h3>
<pre class="programlisting">#define GDATA_GD_EVENT_TRANSPARENCY_TRANSPARENT "http://schemas.google.com/g/2005#event.transparent"
</pre>
<p>The event does not consume time in calendars; its time will be not marked as busy in a free/busy search.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataGDWhen-struct"></a><h3>GDataGDWhen</h3>
<pre class="programlisting">typedef struct _GDataGDWhen GDataGDWhen;</pre>
<p>All the fields in the <a class="link" href="GDataGDWhen.html" title="GDataGDWhen"><span class="type">GDataGDWhen</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataGDWhenClass"></a><h3>GDataGDWhenClass</h3>
<pre class="programlisting">typedef struct {
} GDataGDWhenClass;
</pre>
<p>All the fields in the <a class="link" href="GDataGDWhen.html#GDataGDWhenClass" title="GDataGDWhenClass"><span class="type">GDataGDWhenClass</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="GDataGDWhen.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GDataGDWhen--end-time"></a><h3>The <code class="literal">“end-time”</code> property</h3>
<pre class="programlisting">  “end-time”                 <a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre>
<p>The title of a person within the when.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/gdata/docs/2.0/elements.html#gdWhen" target="_top">GData specification</a>.
<p>Flags: Read / Write</p>
<p>Allowed values: &gt;= -1</p>
<p>Default value: -1</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="GDataGDWhen--is-date"></a><h3>The <code class="literal">“is-date”</code> property</h3>
<pre class="programlisting">  “is-date”                  <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>A programmatic value that identifies the type of when.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/gdata/docs/2.0/elements.html#gdWhen" target="_top">GData specification</a>.
<p>Flags: Read / Write</p>
<p>Default value: FALSE</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="GDataGDWhen--start-time"></a><h3>The <code class="literal">“start-time”</code> property</h3>
<pre class="programlisting">  “start-time”               <a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre>
<p>The name of the when.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/gdata/docs/2.0/elements.html#gdWhen" target="_top">GData specification</a>.
<p>Flags: Read / Write</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</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="GDataGDWhen--value-string"></a><h3>The <code class="literal">“value-string”</code> property</h3>
<pre class="programlisting">  “value-string”             <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>A simple string value used to name this when. It allows UIs to display a label such as "Work", "Volunteer",
"Professional Society", etc.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/gdata/docs/2.0/elements.html#gdWhen" target="_top">GData specification</a>.
<p>Flags: Read / Write</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>