← Back to branch summary

~ubuntu-branches/ubuntu/quantal/evolution-data-server/quantal

« back to all changes in this revision

Viewing changes to docs/reference/camel/html/camel-camel-operation.html

  • Committer: Package Import Robot
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2012-07-03 22:41:23 UTC
  • mfrom: (1.1.100)
  • Revision ID: package-import@ubuntu.com-20120703224123-90dydkyfyvff8s0s
Tags: 3.5.3.1-0ubuntu1
* New upstream release 3.5.3.1.
* debian/control:
  - Drop libgconf2-dev from Build-Depends.
  - Bump versions for glib, goa, and libsoup in Build-Depends.
  - Add a Build-Depends on libgcr-3-dev (>= 3.4)
  - Rename packages following upstream SONAME changes.
  - Add Depends on libgnome-keyring-dev to libedataserver1.2-dev.
* debian/rules:
  - Update mkshlibs arguments for libcamel-1.2-38 instead of -33; as it was
    renamed in control due to the soname change.
  - Strip out -Bsymbolic-functions from LDFLAGS.
* Renamed install files in debian/:
  - libcamel-1.2-33.install => libcamel-1.2-38.install
  - libebackend-1.2-2.install => libebackend-1.2-4.install
  - libebook-1.2-13.install => libebook-1.2-17.install
  - libecal-1.2-11.install => libecal-1.2-15.install
  - libedata-book-1.2-13.install => libedata-book-1.2-15.install
  - libedata-cal-1.2-15.install => libedata-cal-1.2-18.install
  - libedataserver-1.2-16.install => libedataserver-1.2-17.install
  - libedataserverui-3.0-1.install => libedataserverui-3.0-4.install
* debian/patches/google_tests_fpic.patch: build tests with -fPIC; otherwise
  build fails.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/html/camel-camel-operation.html
38
38
<div class="refsynopsisdiv">
39
39
<a name="camel-camel-operation.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">struct              <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation">CamelOperation</a>;
41
 
<a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="returnvalue">GCancellable</span></a> *      <a class="link" href="camel-camel-operation.html#camel-operation-new" title="camel_operation_new ()">camel_operation_new</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
 
41
<span class="returnvalue">GCancellable</span> *      <a class="link" href="camel-camel-operation.html#camel-operation-new" title="camel_operation_new ()">camel_operation_new</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
42
42
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-operation.html#camel-operation-cancel-all" title="camel_operation_cancel_all ()">camel_operation_cancel_all</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
43
 
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-operation.html#camel-operation-push-message" title="camel_operation_push_message ()">camel_operation_push_message</a>        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
44
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
 
43
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-operation.html#camel-operation-push-message" title="camel_operation_push_message ()">camel_operation_push_message</a>        (<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
44
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
45
45
                                                         <em class="parameter"><code>...</code></em>);
46
 
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-operation.html#camel-operation-pop-message" title="camel_operation_pop_message ()">camel_operation_pop_message</a>         (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>);
47
 
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-operation.html#camel-operation-progress" title="camel_operation_progress ()">camel_operation_progress</a>            (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
48
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> percent</code></em>);
 
46
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-operation.html#camel-operation-pop-message" title="camel_operation_pop_message ()">camel_operation_pop_message</a>         (<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>);
 
47
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-operation.html#camel-operation-progress" title="camel_operation_progress ()">camel_operation_progress</a>            (<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
48
                                                         <em class="parameter"><code><span class="type">gint</span> percent</code></em>);
49
49
</pre>
50
50
</div>
51
51
<div class="refsect1">
64
64
<hr>
65
65
<div class="refsect2">
66
66
<a name="camel-operation-new"></a><h3>camel_operation_new ()</h3>
67
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="returnvalue">GCancellable</span></a> *      camel_operation_new                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
67
<pre class="programlisting"><span class="returnvalue">GCancellable</span> *      camel_operation_new                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
68
68
<p>
69
69
Create a new camel operation handle.  Camel operation handles can
70
70
be used in a multithreaded application (or a single operation
91
91
<hr>
92
92
<div class="refsect2">
93
93
<a name="camel-operation-push-message"></a><h3>camel_operation_push_message ()</h3>
94
 
<pre class="programlisting"><span class="returnvalue">void</span>                camel_operation_push_message        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
95
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
 
94
<pre class="programlisting"><span class="returnvalue">void</span>                camel_operation_push_message        (<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
95
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
96
96
                                                         <em class="parameter"><code>...</code></em>);</pre>
97
97
<p>
98
98
Call this function to describe an operation being performed.
101
101
</p>
102
102
<p>
103
103
This function only works if <em class="parameter"><code>cancellable</code></em> is a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a> cast as a
104
 
<a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>.  If <em class="parameter"><code>cancellable</code></em> is a plain <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the
 
104
<span class="type">GCancellable</span>.  If <em class="parameter"><code>cancellable</code></em> is a plain <span class="type">GCancellable</span> or <code class="literal">NULL</code>, the
105
105
function does nothing and returns silently.
106
106
</p>
107
107
<div class="variablelist"><table border="0">
109
109
<tbody>
110
110
<tr>
111
111
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
112
 
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
112
<td>a <span class="type">GCancellable</span> or <code class="literal">NULL</code>
113
113
</td>
114
114
</tr>
115
115
<tr>
126
126
<hr>
127
127
<div class="refsect2">
128
128
<a name="camel-operation-pop-message"></a><h3>camel_operation_pop_message ()</h3>
129
 
<pre class="programlisting"><span class="returnvalue">void</span>                camel_operation_pop_message         (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>);</pre>
 
129
<pre class="programlisting"><span class="returnvalue">void</span>                camel_operation_pop_message         (<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>);</pre>
130
130
<p>
131
131
Pops the most recently pushed message.
132
132
</p>
133
133
<p>
134
134
This function only works if <em class="parameter"><code>cancellable</code></em> is a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a> cast as a
135
 
<a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>.  If <em class="parameter"><code>cancellable</code></em> is a plain <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the
 
135
<span class="type">GCancellable</span>.  If <em class="parameter"><code>cancellable</code></em> is a plain <span class="type">GCancellable</span> or <code class="literal">NULL</code>, the
136
136
function does nothing and returns silently.
137
137
</p>
138
138
<div class="variablelist"><table border="0">
139
139
<col align="left" valign="top">
140
140
<tbody><tr>
141
141
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
142
 
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>
 
142
<td>a <span class="type">GCancellable</span>
143
143
</td>
144
144
</tr></tbody>
145
145
</table></div>
147
147
<hr>
148
148
<div class="refsect2">
149
149
<a name="camel-operation-progress"></a><h3>camel_operation_progress ()</h3>
150
 
<pre class="programlisting"><span class="returnvalue">void</span>                camel_operation_progress            (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
151
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> percent</code></em>);</pre>
 
150
<pre class="programlisting"><span class="returnvalue">void</span>                camel_operation_progress            (<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
151
                                                         <em class="parameter"><code><span class="type">gint</span> percent</code></em>);</pre>
152
152
<p>
153
153
Report progress on the current operation.  <em class="parameter"><code>percent</code></em> reports the current
154
154
percentage of completion, which should be in the range of 0 to 100.
155
155
</p>
156
156
<p>
157
157
This function only works if <em class="parameter"><code>cancellable</code></em> is a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a> cast as a
158
 
<a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>.  If <em class="parameter"><code>cancellable</code></em> is a plain <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the
 
158
<span class="type">GCancellable</span>.  If <em class="parameter"><code>cancellable</code></em> is a plain <span class="type">GCancellable</span> or <code class="literal">NULL</code>, the
159
159
function does nothing and returns silently.
160
160
</p>
161
161
<div class="variablelist"><table border="0">
163
163
<tbody>
164
164
<tr>
165
165
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
166
 
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
166
<td>a <span class="type">GCancellable</span> or <code class="literal">NULL</code>
167
167
</td>
168
168
</tr>
169
169
<tr>