← Back to branch summary

~ubuntu-branches/ubuntu/precise/evolution-data-server/precise-proposed

« back to all changes in this revision

Viewing changes to docs/reference/calendar/libecal/html/ECalClientView.html

  • Committer: Package Import Robot
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2011-09-19 12:15:29 UTC
  • mfrom: (1.1.93 upstream)
  • Revision ID: package-import@ubuntu.com-20110919121529-nsmfnges77ec7hux
Tags: 3.1.92-0ubuntu1
https://launchpad.net/bugs/852277
https://launchpad.net/bugs/853905
https://launchpad.net/bugs/660626
* New upstream release.
  - Cannot add more than one appointment per session (LP: #852277)
  - Contacts calendar backend doesn't show events (LP: #853905)
  - Set X-Evolution-Source header consistently (LP: #660626)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/calendar/libecal/html/ECalClientView.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>ECalClientView</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
9
9
<link rel="prev" href="ECalClient.html" title="ECalClient">
10
10
<link rel="next" href="ECalComponent.html" title="ECalComponent">
11
 
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
44
44
<div class="refsynopsisdiv">
45
45
<a name="ECalClientView.synopsis"></a><h2>Synopsis</h2>
46
46
<pre class="synopsis">struct              <a class="link" href="ECalClientView.html#ECalClientView-struct" title="struct ECalClientView">ECalClientView</a>;
47
 
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>);
48
 
<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>);
 
47
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>);
 
48
<span class="returnvalue">gboolean</span>            <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>);
49
49
<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>
50
50
                                                        (<em class="parameter"><code><a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view</code></em>,
51
 
                                                         <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>,
52
 
                                                         <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>);
 
51
                                                         <em class="parameter"><code>const <span class="type">GSList</span> *fields_of_interest</code></em>,
 
52
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
53
53
<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>,
54
 
                                                         <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>);
 
54
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
55
55
<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>,
56
 
                                                         <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>);
 
56
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
57
57
</pre>
58
58
</div>
59
59
<div class="refsect1">
60
60
<a name="ECalClientView.object-hierarchy"></a><h2>Object Hierarchy</h2>
61
61
<pre class="synopsis">
62
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
62
  GObject
63
63
   +----ECalClientView
64
64
</pre>
65
65
</div>
67
67
<a name="ECalClientView.properties"></a><h2>Properties</h2>
68
68
<pre class="synopsis">
69
69
  "<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
70
 
  "<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
 
70
  "<a class="link" href="ECalClientView.html#ECalClientView--view" title='The "view" property'>view</a>"                     <span class="type">gpointer</span>              : Read / Write / Construct Only
71
71
</pre>
72
72
</div>
73
73
<div class="refsect1">
74
74
<a name="ECalClientView.signals"></a><h2>Signals</h2>
75
75
<pre class="synopsis">
76
 
  "<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>
77
 
  "<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>
78
 
  "<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>
79
 
  "<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>
80
 
  "<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>
 
76
  "<a class="link" href="ECalClientView.html#ECalClientView-complete" title='The "complete" signal'>complete</a>"                                       : <code class="literal">Run First</code>
 
77
  "<a class="link" href="ECalClientView.html#ECalClientView-objects-added" title='The "objects-added" signal'>objects-added</a>"                                  : <code class="literal">Run First</code>
 
78
  "<a class="link" href="ECalClientView.html#ECalClientView-objects-modified" title='The "objects-modified" signal'>objects-modified</a>"                               : <code class="literal">Run First</code>
 
79
  "<a class="link" href="ECalClientView.html#ECalClientView-objects-removed" title='The "objects-removed" signal'>objects-removed</a>"                                : <code class="literal">Run First</code>
 
80
  "<a class="link" href="ECalClientView.html#ECalClientView-progress" title='The "progress" signal'>progress</a>"                                       : <code class="literal">Run First</code>
81
81
</pre>
82
82
</div>
83
83
<div class="refsect1">
99
99
<hr>
100
100
<div class="refsect2">
101
101
<a name="e-cal-client-view-get-client"></a><h3>e_cal_client_view_get_client ()</h3>
102
 
<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>
 
102
<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>
103
103
<p>
104
104
Get the <a class="link" href="ECalClient.html" title="ECalClient"><span class="type">ECalClient</span></a> associated with this view.
105
105
</p>
121
121
<hr>
122
122
<div class="refsect2">
123
123
<a name="e-cal-client-view-is-running"></a><h3>e_cal_client_view_is_running ()</h3>
124
 
<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>
 
124
<pre class="programlisting"><span class="returnvalue">gboolean</span>            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>
125
125
<p>
126
126
Retunrs: Whether view is running. Not running views are ignoring
127
127
all events sent from the server.
141
141
<a name="e-cal-client-view-set-fields-of-interest"></a><h3>e_cal_client_view_set_fields_of_interest ()</h3>
142
142
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_client_view_set_fields_of_interest
143
143
                                                        (<em class="parameter"><code><a class="link" href="ECalClientView.html" title="ECalClientView"><span class="type">ECalClientView</span></a> *view</code></em>,
144
 
                                                         <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>,
145
 
                                                         <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>
 
144
                                                         <em class="parameter"><code>const <span class="type">GSList</span> *fields_of_interest</code></em>,
 
145
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
146
146
<p>
147
147
Client can instruct server to which fields it is interested in only, thus
148
148
the server can return less data over the wire. The server can still return
149
149
complete objects, this is just a hint to it that the listed fields will
150
150
be used only. The UID/RID fields are returned always. Initial views has no fields
151
 
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
 
151
of interest and using <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>fields_of_interest</code></em> will unset any previous
152
152
changes.
153
153
</p>
154
154
<p>
169
169
</tr>
170
170
<tr>
171
171
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
172
 
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
 
172
<td>A <span class="type">GError</span>
173
173
</td>
174
174
</tr>
175
175
</tbody>
179
179
<div class="refsect2">
180
180
<a name="e-cal-client-view-start"></a><h3>e_cal_client_view_start ()</h3>
181
181
<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>,
182
 
                                                         <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>
 
182
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
183
183
<p>
184
184
Starts a live query to the calendar/tasks backend.
185
185
</p>
203
203
<div class="refsect2">
204
204
<a name="e-cal-client-view-stop"></a><h3>e_cal_client_view_stop ()</h3>
205
205
<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>,
206
 
                                                         <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>
 
206
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
207
207
<p>
208
208
Stops a live query to the calendar/tasks backend.
209
209
</p>
216
216
</tr>
217
217
<tr>
218
218
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
219
 
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
 
219
<td>A <span class="type">GError</span>
220
220
</td>
221
221
</tr>
222
222
</tbody>
234
234
<hr>
235
235
<div class="refsect2">
236
236
<a name="ECalClientView--view"></a><h3>The <code class="literal">"view"</code> property</h3>
237
 
<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>
 
237
<pre class="programlisting">  "view"                     <span class="type">gpointer</span>              : Read / Write / Construct Only</pre>
238
238
<p></p>
239
239
</div>
240
240
</div>
243
243
<div class="refsect2">
244
244
<a name="ECalClientView-complete"></a><h3>The <code class="literal">"complete"</code> signal</h3>
245
245
<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,
246
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>         *arg1,
247
 
                                                        <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>
 
246
                                                        <span class="type">GError</span>         *arg1,
 
247
                                                        <span class="type">gpointer</span>        user_data)           : <code class="literal">Run First</code></pre>
248
248
<p>
249
249
</p>
250
250
<div class="variablelist"><table border="0">
265
265
<div class="refsect2">
266
266
<a name="ECalClientView-objects-added"></a><h3>The <code class="literal">"objects-added"</code> signal</h3>
267
267
<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:,
268
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        objects,
269
 
                                                        <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>
 
268
                                                        <span class="type">gpointer</span>        objects,
 
269
                                                        <span class="type">gpointer</span>        user_data)      : <code class="literal">Run First</code></pre>
270
270
<div class="variablelist"><table border="0">
271
271
<col align="left" valign="top">
272
272
<tbody>
290
290
<div class="refsect2">
291
291
<a name="ECalClientView-objects-modified"></a><h3>The <code class="literal">"objects-modified"</code> signal</h3>
292
292
<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:,
293
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        objects,
294
 
                                                        <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>
 
293
                                                        <span class="type">gpointer</span>        objects,
 
294
                                                        <span class="type">gpointer</span>        user_data)      : <code class="literal">Run First</code></pre>
295
295
<div class="variablelist"><table border="0">
296
296
<col align="left" valign="top">
297
297
<tbody>
315
315
<div class="refsect2">
316
316
<a name="ECalClientView-objects-removed"></a><h3>The <code class="literal">"objects-removed"</code> signal</h3>
317
317
<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:,
318
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        objects,
319
 
                                                        <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>
 
318
                                                        <span class="type">gpointer</span>        objects,
 
319
                                                        <span class="type">gpointer</span>        user_data)      : <code class="literal">Run First</code></pre>
320
320
<div class="variablelist"><table border="0">
321
321
<col align="left" valign="top">
322
322
<tbody>
340
340
<div class="refsect2">
341
341
<a name="ECalClientView-progress"></a><h3>The <code class="literal">"progress"</code> signal</h3>
342
342
<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,
343
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>           arg1,
344
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>          *arg2,
345
 
                                                        <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>
 
343
                                                        <span class="type">guint</span>           arg1,
 
344
                                                        <span class="type">gchar</span>          *arg2,
 
345
                                                        <span class="type">gpointer</span>        user_data)           : <code class="literal">Run First</code></pre>
346
346
<p>
347
347
</p>
348
348
<div class="variablelist"><table border="0">
363
363
</div>
364
364
<div class="footer">
365
365
<hr>
366
 
          Generated by GTK-Doc V1.17</div>
 
366
          Generated by GTK-Doc V1.18</div>
367
367
</body>
368
368
</html>
 
 
b'\\ No newline at end of file'