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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ECalClientView</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
<link rel="prev" href="ECalClient.html" title="ECalClient">
<link rel="next" href="ECalComponent.html" title="ECalComponent">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="ECalClient.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution-Data-Server Manual: Calendar Client (libecal)</th>
<td><a accesskey="n" href="ECalComponent.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ECalClientView.synopsis" class="shortcut">Top</a>
|
<a href="#ECalClientView.description" class="shortcut">Description</a>
|
<a href="#ECalClientView.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#ECalClientView.properties" class="shortcut">Properties</a>
|
<a href="#ECalClientView.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="ECalClientView"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ECalClientView.top_of_page"></a>ECalClientView</span></h2>
<p>ECalClientView</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ECalClientView.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="ECalClientView.html#ECalClientView-struct" title="struct ECalClientView">ECalClientView</a>;
struct <a class="link" href="ECalClient.html" title="ECalClient"><span class="returnvalue">_ECalClient</span></a> * <a class="link" href="ECalClientView.html#e-cal-client-view-get-client" title="e_cal_client_view_get_client ()">e_cal_client_view_get_client</a> (<em class="parameter"><code><a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ECalClientView.html#e-cal-client-view-is-running" title="e_cal_client_view_is_running ()">e_cal_client_view_is_running</a> (<em class="parameter"><code><a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ECalClientView.html#e-cal-client-view-set-fields-of-interest" title="e_cal_client_view_set_fields_of_interest ()">e_cal_client_view_set_fields_of_interest</a>
(<em class="parameter"><code><a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *fields_of_interest</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ECalClientView.html#e-cal-client-view-start" title="e_cal_client_view_start ()">e_cal_client_view_start</a> (<em class="parameter"><code><a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ECalClientView.html#e-cal-client-view-stop" title="e_cal_client_view_stop ()">e_cal_client_view_stop</a> (<em class="parameter"><code><a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ECalClientView.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----ECalClientView
</pre>
</div>
<div class="refsect1">
<a name="ECalClientView.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="ECalClientView.html#ECalClientView--client" title='The "client" property'>client</a>" <a class="link" href="ECalClient.html" title="ECalClient"><span class="type">ECalClient</span></a>* : Read / Write / Construct Only
"<a class="link" href="ECalClientView.html#ECalClientView--view" title='The "view" property'>view</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="ECalClientView.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="ECalClientView.html#ECalClientView-complete" title='The "complete" signal'>complete</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
"<a class="link" href="ECalClientView.html#ECalClientView-objects-added" title='The "objects-added" signal'>objects-added</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
"<a class="link" href="ECalClientView.html#ECalClientView-objects-modified" title='The "objects-modified" signal'>objects-modified</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
"<a class="link" href="ECalClientView.html#ECalClientView-objects-removed" title='The "objects-removed" signal'>objects-removed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
"<a class="link" href="ECalClientView.html#ECalClientView-progress" title='The "progress" signal'>progress</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="ECalClientView.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="ECalClientView.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ECalClientView-struct"></a><h3>struct ECalClientView</h3>
<pre class="programlisting">struct ECalClientView;</pre>
<p>
Contains only private data that should be read and manipulated using the
functions below.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-client-view-get-client"></a><h3>e_cal_client_view_get_client ()</h3>
<pre class="programlisting">struct <a class="link" href="ECalClient.html" title="ECalClient"><span class="returnvalue">_ECalClient</span></a> * e_cal_client_view_get_client (<em class="parameter"><code><a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view</code></em>);</pre>
<p>
Get the <a class="link" href="ECalClient.html" title="ECalClient"><span class="type">ECalClient</span></a> associated with this view.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>A <a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the associated client.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-client-view-is-running"></a><h3>e_cal_client_view_is_running ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> e_cal_client_view_is_running (<em class="parameter"><code><a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view</code></em>);</pre>
<p>
Retunrs: Whether view is running. Not running views are ignoring
all events sent from the server.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>an <a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-client-view-set-fields-of-interest"></a><h3>e_cal_client_view_set_fields_of_interest ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_cal_client_view_set_fields_of_interest
(<em class="parameter"><code><a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *fields_of_interest</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Client can instruct server to which fields it is interested in only, thus
the server can return less data over the wire. The server can still return
complete objects, this is just a hint to it that the listed fields will
be used only. The UID/RID fields are returned always. Initial views has no fields
of interest and using <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>fields_of_interest</code></em> will unset any previous
changes.
</p>
<p>
Some backends can use summary information of its cache to create artifical
objects, which will omit stored object parsing. If this cannot be done then
it will simply return object as is stored in the cache.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>An <a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fields_of_interest</code></em> :</span></p></td>
<td>List of field names in which the client is interested</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-client-view-start"></a><h3>e_cal_client_view_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_cal_client_view_start (<em class="parameter"><code><a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Starts a live query to the calendar/tasks backend.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>An <a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <span class="type">Gerror</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-client-view-stop"></a><h3>e_cal_client_view_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_cal_client_view_stop (<em class="parameter"><code><a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Stops a live query to the calendar/tasks backend.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>An <a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
</div>
<div class="refsect1">
<a name="ECalClientView.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ECalClientView--client"></a><h3>The <code class="literal">"client"</code> property</h3>
<pre class="programlisting"> "client" <a class="link" href="ECalClient.html" title="ECalClient"><span class="type">ECalClient</span></a>* : Read / Write / Construct Only</pre>
<p></p>
</div>
<hr>
<div class="refsect2">
<a name="ECalClientView--view"></a><h3>The <code class="literal">"view"</code> property</h3>
<pre class="programlisting"> "view" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Read / Write / Construct Only</pre>
<p></p>
</div>
</div>
<div class="refsect1">
<a name="ECalClientView.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ECalClientView-complete"></a><h3>The <code class="literal">"complete"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *ecalclientview,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *arg1,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
</div>
<hr>
<div class="refsect2">
<a name="ECalClientView-objects-added"></a><h3>The <code class="literal">"objects-added"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view:,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> objects,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view:</code></em> :</span></p></td>
<td>self</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>objects</code></em> :</span></p></td>
<td>. <span class="annotation">[<acronym title="Override the parsed C type with given type"><span class="acronym">type</span></acronym> GSList][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> long]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ECalClientView-objects-modified"></a><h3>The <code class="literal">"objects-modified"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view:,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> objects,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view:</code></em> :</span></p></td>
<td>self</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>objects</code></em> :</span></p></td>
<td>. <span class="annotation">[<acronym title="Override the parsed C type with given type"><span class="acronym">type</span></acronym> GSList][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> long]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ECalClientView-objects-removed"></a><h3>The <code class="literal">"objects-removed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view:,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> objects,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view:</code></em> :</span></p></td>
<td>self</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>objects</code></em> :</span></p></td>
<td>. <span class="annotation">[<acronym title="Override the parsed C type with given type"><span class="acronym">type</span></acronym> GSList][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> ECalComponentId]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ECalClientView-progress"></a><h3>The <code class="literal">"progress"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *ecalclientview,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> arg1,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg2,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|
