/usr/share/gtk-doc/html/zeitgeist-1.0/ZeitgeistTimeRange.html is in libzeitgeist-doc 0.3.18-1ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ZeitgeistTimeRange: API Documentation for the Zeitgeist Client Library</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="API Documentation for the Zeitgeist Client Library">
<link rel="up" href="ch01.html" title="Classes">
<link rel="prev" href="ZeitgeistSubject.html" title="ZeitgeistSubject">
<link rel="next" href="ch02.html" title="Utility Functions">
<meta name="generator" content="GTK-Doc V1.24 (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="#ZeitgeistTimeRange.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ZeitgeistTimeRange.object-hierarchy" class="shortcut">Object Hierarchy</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ZeitgeistSubject.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ZeitgeistTimeRange"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ZeitgeistTimeRange.top_of_page"></a>ZeitgeistTimeRange</span></h2>
<p>ZeitgeistTimeRange — Immutable representation of an interval in time, marked by a beginning and an end</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ZeitgeistTimeRange.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">
<span class="returnvalue">gint64</span>
</td>
<td class="function_name">
<a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-get-end" title="zeitgeist_time_range_get_end ()">zeitgeist_time_range_get_end</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-get-end-iso8601" title="zeitgeist_time_range_get_end_iso8601 ()">zeitgeist_time_range_get_end_iso8601</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint64</span>
</td>
<td class="function_name">
<a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-get-start" title="zeitgeist_time_range_get_start ()">zeitgeist_time_range_get_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-get-start-iso8601" title="zeitgeist_time_range_get_start_iso8601 ()">zeitgeist_time_range_get_start_iso8601</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> *
</td>
<td class="function_name">
<a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-new" title="zeitgeist_time_range_new ()">zeitgeist_time_range_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> *
</td>
<td class="function_name">
<a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-new-anytime" title="zeitgeist_time_range_new_anytime ()">zeitgeist_time_range_new_anytime</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> *
</td>
<td class="function_name">
<a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-new-from-now" title="zeitgeist_time_range_new_from_now ()">zeitgeist_time_range_new_from_now</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a>*
</td>
<td class="function_name">
<a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-new-from-variant" title="zeitgeist_time_range_new_from_variant ()">zeitgeist_time_range_new_from_variant</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> *
</td>
<td class="function_name">
<a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-new-to-now" title="zeitgeist_time_range_new_to_now ()">zeitgeist_time_range_new_to_now</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GVariant</span> *
</td>
<td class="function_name">
<a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-to-variant" title="zeitgeist_time_range_to_variant ()">zeitgeist_time_range_to_variant</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ZeitgeistTimeRange.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">struct</td>
<td class="function_name"><a class="link" href="ZeitgeistTimeRange.html#ZeitgeistTimeRange-struct" title="struct ZeitgeistTimeRange">ZeitgeistTimeRange</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ZeitgeistTimeRange.html#ZeitgeistTimeRangeClass" title="struct ZeitgeistTimeRangeClass">ZeitgeistTimeRangeClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ZeitgeistTimeRange.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> ZeitgeistTimeRange
</pre>
</div>
<div class="refsect1">
<a name="ZeitgeistTimeRange.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <zeitgeist.h>
</pre>
</div>
<div class="refsect1">
<a name="ZeitgeistTimeRange.description"></a><h2>Description</h2>
<p><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> is a light, immutable, encapsulation of an interval
in time, marked by a beginning and an end.</p>
<p>Time ranges are sub classes of <span class="type">GInitiallyUnowned</span> which means that
you may pass them directly to methods provided by the Zeitgeist library
and forget about them. The callee will own the floating reference.</p>
</div>
<div class="refsect1">
<a name="ZeitgeistTimeRange.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="zeitgeist-time-range-get-end"></a><h3>zeitgeist_time_range_get_end ()</h3>
<pre class="programlisting"><span class="returnvalue">gint64</span>
zeitgeist_time_range_get_end (<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.7.8.2.4"></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>time_range</p></td>
<td class="parameter_description"><p>The time range to inspect</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.7.8.2.5"></a><h4>Returns</h4>
<p> The ending timestamp of the time range in miiliseconds since the
Unix Epoch</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-time-range-get-end-iso8601"></a><h3>zeitgeist_time_range_get_end_iso8601 ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
zeitgeist_time_range_get_end_iso8601 (<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>);</pre>
<p>Converts the a timestamp to a human readable format. Eg. 1970-01-01T00:00:00Z
or 2010-04-09T07:24:08.082000Z. Note that the timezone of the formatted
string will always be UTC disregarding locale.</p>
<div class="refsect3">
<a name="id-1.2.7.8.3.5"></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>time_range</p></td>
<td class="parameter_description"><p>The time range to extract the end timestamp from</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.7.8.3.6"></a><h4>Returns</h4>
<p> A newly allocated string containing the timestamp formatted
according to ISO-8601. Free with <code class="function">g_free()</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-time-range-get-start"></a><h3>zeitgeist_time_range_get_start ()</h3>
<pre class="programlisting"><span class="returnvalue">gint64</span>
zeitgeist_time_range_get_start (<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.7.8.4.4"></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>time_range</p></td>
<td class="parameter_description"><p>The time range to inspect</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.7.8.4.5"></a><h4>Returns</h4>
<p> The starting timestamp of the time range in miiliseconds since the
Unix Epoch</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-time-range-get-start-iso8601"></a><h3>zeitgeist_time_range_get_start_iso8601 ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
zeitgeist_time_range_get_start_iso8601
(<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>);</pre>
<p>Converts the a timestamp to a human readable format. Eg. 1970-01-01T00:00:00Z
or 2010-04-09T07:24:08.082000Z. Note that the timezone of the formatted
string will always be UTC disregarding locale.</p>
<div class="refsect3">
<a name="id-1.2.7.8.5.5"></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>time_range</p></td>
<td class="parameter_description"><p>The time range to extract the start timestamp from</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.7.8.5.6"></a><h4>Returns</h4>
<p> A newly allocated string containing the timestamp formatted
according to ISO-8601. Free with <code class="function">g_free()</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-time-range-new"></a><h3>zeitgeist_time_range_new ()</h3>
<pre class="programlisting"><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> *
zeitgeist_time_range_new (<em class="parameter"><code><span class="type">gint64</span> start_msec</code></em>,
<em class="parameter"><code><span class="type">gint64</span> end_msec</code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.7.8.6.4"></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_msec</p></td>
<td class="parameter_description"><p>Starting timestamp in number of milliseconds since the Unix Epoch</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_msec</p></td>
<td class="parameter_description"><p>Ending timestamp in number of milliseconds since the Unix Epoch</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.7.8.6.5"></a><h4>Returns</h4>
<p> A newly allocated <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a>. Free with <code class="function">g_object_unref()</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-time-range-new-anytime"></a><h3>zeitgeist_time_range_new_anytime ()</h3>
<pre class="programlisting"><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> *
zeitgeist_time_range_new_anytime (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.7.8.7.4"></a><h4>Returns</h4>
<p> A new time range starting from the beginning of the Unix Epoch
stretching to the end of time</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-time-range-new-from-now"></a><h3>zeitgeist_time_range_new_from_now ()</h3>
<pre class="programlisting"><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> *
zeitgeist_time_range_new_from_now (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.7.8.8.4"></a><h4>Returns</h4>
<p> A new time range starting from the moment of invocation to the end
of time</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-time-range-new-from-variant"></a><h3>zeitgeist_time_range_new_from_variant ()</h3>
<pre class="programlisting"><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a>*
zeitgeist_time_range_new_from_variant (<em class="parameter"><code><span class="type">GVariant</span> *time_range</code></em>);</pre>
<p>Create a <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> from a <span class="type">GVariant</span></p>
<div class="refsect3">
<a name="id-1.2.7.8.9.5"></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>time_range</p></td>
<td class="parameter_description"><p>A <span class="type">GVariant</span> with signature
<span class="type">ZEITGEIST_TIME_RANGE_VARIANT_SIGNATURE</span>. If <em class="parameter"><code>time_range</code></em>
is
a floating reference this method will assume ownership of it</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.7.8.9.6"></a><h4>Returns</h4>
<p> A floating reference to a newly created <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-time-range-new-to-now"></a><h3>zeitgeist_time_range_new_to_now ()</h3>
<pre class="programlisting"><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> *
zeitgeist_time_range_new_to_now (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.7.8.10.4"></a><h4>Returns</h4>
<p> A new time range starting from the beginning of the Unix Epoch
ending at the moment of invocation</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-time-range-to-variant"></a><h3>zeitgeist_time_range_to_variant ()</h3>
<pre class="programlisting"><span class="returnvalue">GVariant</span> *
zeitgeist_time_range_to_variant (<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.7.8.11.4"></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>time_range</p></td>
<td class="parameter_description"><p>A <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a>. If the reference is floating this method
will assume ownership of it</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.7.8.11.5"></a><h4>Returns</h4>
<p> A floating reference to a <span class="type">GVariant</span> with signature
<span class="type">ZEITGEIST_TIME_RANGE_VARIANT_SIGNATURE</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="ZeitgeistTimeRange.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ZeitgeistTimeRange-struct"></a><h3>struct ZeitgeistTimeRange</h3>
<pre class="programlisting">struct ZeitgeistTimeRange;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ZeitgeistTimeRangeClass"></a><h3>struct ZeitgeistTimeRangeClass</h3>
<pre class="programlisting">struct ZeitgeistTimeRangeClass {
GInitiallyUnownedClass parent_class;
};
</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|