1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>ZeitgeistTimeRange</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
<link rel="home" href="index.html" title="Zeitgeist Reference Manual">
8
<link rel="up" href="ch01.html" title="Classes">
9
<link rel="prev" href="ZeitgeistSubject.html" title="ZeitgeistSubject">
10
<link rel="next" href="ch02.html" title="Utility Functions">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="ZeitgeistSubject.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">Zeitgeist Reference Manual</th>
21
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#ZeitgeistTimeRange.synopsis" class="shortcut">Top</a>
26
<a href="#ZeitgeistTimeRange.description" class="shortcut">Description</a>
28
<a href="#ZeitgeistTimeRange.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#ZeitgeistTimeRange.properties" class="shortcut">Properties</a>
33
<div class="refentry">
34
<a name="ZeitgeistTimeRange"></a><div class="titlepage"></div>
35
<div class="refnamediv"><table width="100%"><tr>
37
<h2><span class="refentrytitle"><a name="ZeitgeistTimeRange.top_of_page"></a>ZeitgeistTimeRange</span></h2>
38
<p>ZeitgeistTimeRange — Immutable representation of an interval in time, marked by a beginning and an end</p>
40
<td valign="top" align="right"></td>
42
<div class="refsynopsisdiv">
43
<a name="ZeitgeistTimeRange.synopsis"></a><h2>Synopsis</h2>
44
<pre class="synopsis">#define <a class="link" href="ZeitgeistTimeRange.html#ZEITGEIST-TYPE-TIME-RANGE:CAPS" title="ZEITGEIST_TYPE_TIME_RANGE">ZEITGEIST_TYPE_TIME_RANGE</a>
45
<a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * <a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-to-variant" title="zeitgeist_time_range_to_variant ()">zeitgeist_time_range_to_variant</a> (<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *self</code></em>);
46
<a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> * <a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-intersect" title="zeitgeist_time_range_intersect ()">zeitgeist_time_range_intersect</a> (<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *self</code></em>,
47
<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>);
48
<a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> * <a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-new" title="zeitgeist_time_range_new ()">zeitgeist_time_range_new</a> (<em class="parameter"><code><span class="type">gint64</span> start_msec</code></em>,
49
<em class="parameter"><code><span class="type">gint64</span> end_msec</code></em>);
50
<a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> * <a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-new-anytime" title="zeitgeist_time_range_new_anytime ()">zeitgeist_time_range_new_anytime</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
51
<a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> * <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> (<em class="parameter"><code><span class="type">void</span></code></em>);
52
<a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> * <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> (<em class="parameter"><code><span class="type">void</span></code></em>);
53
<a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> * <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>
54
(<em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>,
55
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
56
<span class="returnvalue">gint64</span> <a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-get-start" title="zeitgeist_time_range_get_start ()">zeitgeist_time_range_get_start</a> (<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *self</code></em>);
57
<span class="returnvalue">gint64</span> <a class="link" href="ZeitgeistTimeRange.html#zeitgeist-time-range-get-end" title="zeitgeist_time_range_get_end ()">zeitgeist_time_range_get_end</a> (<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *self</code></em>);
58
struct <a class="link" href="ZeitgeistTimeRange.html#ZeitgeistTimeRange-struct" title="struct ZeitgeistTimeRange">ZeitgeistTimeRange</a>;
59
struct <a class="link" href="ZeitgeistTimeRange.html#ZeitgeistTimeRangeClass" title="struct ZeitgeistTimeRangeClass">ZeitgeistTimeRangeClass</a>;
62
<div class="refsect1">
63
<a name="ZeitgeistTimeRange.object-hierarchy"></a><h2>Object Hierarchy</h2>
64
<pre class="synopsis">
65
<a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
66
+----ZeitgeistTimeRange
69
<div class="refsect1">
70
<a name="ZeitgeistTimeRange.properties"></a><h2>Properties</h2>
71
<pre class="synopsis">
72
"<a class="link" href="ZeitgeistTimeRange.html#ZeitgeistTimeRange--end" title='The "end" property'>end</a>" <span class="type">gint64</span> : Read
73
"<a class="link" href="ZeitgeistTimeRange.html#ZeitgeistTimeRange--start" title='The "start" property'>start</a>" <span class="type">gint64</span> : Read
76
<div class="refsect1">
77
<a name="ZeitgeistTimeRange.description"></a><h2>Description</h2>
80
<p>A light, immutable, encapsulation of an interval in time, marked by a beginning and an end.</p>
84
<div class="refsect1">
85
<a name="ZeitgeistTimeRange.details"></a><h2>Details</h2>
86
<div class="refsect2">
87
<a name="ZEITGEIST-TYPE-TIME-RANGE:CAPS"></a><h3>ZEITGEIST_TYPE_TIME_RANGE</h3>
88
<pre class="programlisting">#define ZEITGEIST_TYPE_TIME_RANGE (zeitgeist_time_range_get_type ())
91
The type for <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a>.
95
<div class="refsect2">
96
<a name="zeitgeist-time-range-to-variant"></a><h3>zeitgeist_time_range_to_variant ()</h3>
97
<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * zeitgeist_time_range_to_variant (<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *self</code></em>);</pre>
98
<div class="variablelist"><table border="0">
99
<col align="left" valign="top">
102
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
103
<td>the <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> instance</td>
106
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
107
<td>a new variant holding the time range</td>
113
<div class="refsect2">
114
<a name="zeitgeist-time-range-intersect"></a><h3>zeitgeist_time_range_intersect ()</h3>
115
<pre class="programlisting"><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> * zeitgeist_time_range_intersect (<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *self</code></em>,
116
<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>);</pre>
118
Check whether two time ranges are intersecting.
120
<div class="variablelist"><table border="0">
121
<col align="left" valign="top">
124
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
125
<td>the <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> instance</td>
128
<td><p><span class="term"><em class="parameter"><code>time_range</code></em> :</span></p></td>
129
<td> . the second time range to compare with. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
133
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
134
<td>a new time range representing the intersection</td>
140
<div class="refsect2">
141
<a name="zeitgeist-time-range-new"></a><h3>zeitgeist_time_range_new ()</h3>
142
<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>,
143
<em class="parameter"><code><span class="type">gint64</span> end_msec</code></em>);</pre>
144
<div class="variablelist"><table border="0">
145
<col align="left" valign="top">
148
<td><p><span class="term"><em class="parameter"><code>start_msec</code></em> :</span></p></td>
149
<td> . starting timestamp in number of milliseconds since the Unix Epoch. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
153
<td><p><span class="term"><em class="parameter"><code>end_msec</code></em> :</span></p></td>
154
<td> . ending timestamp in number of milliseconds since the Unix Epoch. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
158
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
159
<td>a newly allocated ZeitgeistTimeRange. Free with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>
166
<div class="refsect2">
167
<a name="zeitgeist-time-range-new-anytime"></a><h3>zeitgeist_time_range_new_anytime ()</h3>
168
<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>
169
<div class="variablelist"><table border="0">
170
<col align="left" valign="top">
172
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
173
<td>a new time range starting from the beginning of the Unix Epoch stretching to the end of time</td>
178
<div class="refsect2">
179
<a name="zeitgeist-time-range-new-to-now"></a><h3>zeitgeist_time_range_new_to_now ()</h3>
180
<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>
181
<div class="variablelist"><table border="0">
182
<col align="left" valign="top">
184
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
185
<td>a new time range starting from the beggining of the Unix Epoch ending a the moment of invocation</td>
190
<div class="refsect2">
191
<a name="zeitgeist-time-range-new-from-now"></a><h3>zeitgeist_time_range_new_from_now ()</h3>
192
<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>
193
<div class="variablelist"><table border="0">
194
<col align="left" valign="top">
196
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
197
<td>a new time range starting from the moment of invocation to the end of time</td>
202
<div class="refsect2">
203
<a name="zeitgeist-time-range-new-from-variant"></a><h3>zeitgeist_time_range_new_from_variant ()</h3>
204
<pre class="programlisting"><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> * zeitgeist_time_range_new_from_variant
205
(<em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>,
206
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
208
Create a <span class="type">TimeRange</span> from a variant.
210
<div class="variablelist"><table border="0">
211
<col align="left" valign="top">
214
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
215
<td> . a variant representing a <span class="type">TimeRange</span>. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
219
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
220
<td>location to store the error occuring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. <span class="annotation">[<acronym title="Typed errors. Similar to throws in Java."><span class="acronym">error-domains</span></acronym> ZeitgeistDataModelError]</span>
224
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
225
<td>a new time range starting from the moment of invocation to the end of time</td>
231
<div class="refsect2">
232
<a name="zeitgeist-time-range-get-start"></a><h3>zeitgeist_time_range_get_start ()</h3>
233
<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> *self</code></em>);</pre>
235
Get and return the current value of the <a class="link" href="ZeitgeistTimeRange.html#ZeitgeistTimeRange--start" title='The "start" property'><span class="type">"start"</span></a> property.
237
<div class="variablelist"><table border="0">
238
<col align="left" valign="top">
241
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
242
<td>the <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> instance to query</td>
245
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
246
<td>the value of the <a class="link" href="ZeitgeistTimeRange.html#ZeitgeistTimeRange--start" title='The "start" property'><span class="type">"start"</span></a> property</td>
252
<div class="refsect2">
253
<a name="zeitgeist-time-range-get-end"></a><h3>zeitgeist_time_range_get_end ()</h3>
254
<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> *self</code></em>);</pre>
256
Get and return the current value of the <a class="link" href="ZeitgeistTimeRange.html#ZeitgeistTimeRange--end" title='The "end" property'><span class="type">"end"</span></a> property.
258
<div class="variablelist"><table border="0">
259
<col align="left" valign="top">
262
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
263
<td>the <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> instance to query</td>
266
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
267
<td>the value of the <a class="link" href="ZeitgeistTimeRange.html#ZeitgeistTimeRange--end" title='The "end" property'><span class="type">"end"</span></a> property</td>
273
<div class="refsect2">
274
<a name="ZeitgeistTimeRange-struct"></a><h3>struct ZeitgeistTimeRange</h3>
275
<pre class="programlisting">struct ZeitgeistTimeRange;</pre>
277
Immutable representation of an interval in time, marked by a beginning and an end
281
<p>A light, immutable, encapsulation of an interval in time, marked by a beginning and an end.</p>
286
<div class="refsect2">
287
<a name="ZeitgeistTimeRangeClass"></a><h3>struct ZeitgeistTimeRangeClass</h3>
288
<pre class="programlisting">struct ZeitgeistTimeRangeClass {
289
GObjectClass parent_class;
293
The class structure for <a class="link" href="ZeitgeistTimeRange.html#ZEITGEIST-TYPE-TIME-RANGE:CAPS" title="ZEITGEIST_TYPE_TIME_RANGE"><code class="literal">ZEITGEIST_TYPE_TIME_RANGE</code></a>. All the fields in this structure are private and should never be accessed directly.
295
<div class="variablelist"><table border="0">
296
<col align="left" valign="top">
298
<td><p><span class="term"><a href="../gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="ZeitgeistTimeRangeClass.parent-class"></a>parent_class</code></em>;</span></p></td>
299
<td>the parent class structure</td>
304
<div class="refsect1">
305
<a name="ZeitgeistTimeRange.property-details"></a><h2>Property Details</h2>
306
<div class="refsect2">
307
<a name="ZeitgeistTimeRange--end"></a><h3>The <code class="literal">"end"</code> property</h3>
308
<pre class="programlisting"> "end" <span class="type">gint64</span> : Read</pre>
310
<p>Default value: 0</p>
313
<div class="refsect2">
314
<a name="ZeitgeistTimeRange--start"></a><h3>The <code class="literal">"start"</code> property</h3>
315
<pre class="programlisting"> "start" <span class="type">gint64</span> : Read</pre>
317
<p>Default value: 0</p>
323
Generated by GTK-Doc V1.18</div>
b'\\ No newline at end of file'