← Back to branch summary

~ubuntu-branches/debian/jessie/glib2.0/jessie

« back to all changes in this revision

Viewing changes to docs/reference/gio/html/GCancellable.html

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo Noronha Silva
  • Date: 2009-02-15 13:00:43 UTC
  • mto: (1.4.3 upstream)
  • mto: This revision was merged to the branch mainline in revision 70.
  • Revision ID: james.westby@ubuntu.com-20090215130043-6snh45flhit8oalb
Tags: upstream-2.18.4
Import upstream version 2.18.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/html/GCancellable.html
1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html>
3
3
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GCancellable</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="GIO Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
7
<link rel="home" href="index.html" title="GIO Reference Manual">
8
8
<link rel="up" href="async.html" title="Asynchronous I/O">
9
9
<link rel="prev" href="async.html" title="Asynchronous I/O">
10
10
<link rel="next" href="GAsyncResult.html" title="GAsyncResult">
11
 
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="pt01.html" title="Part&#160;I.&#160;GIO Overview">
 
13
<link rel="part" href="pt01.html" title="Part I. GIO Overview">
14
14
<link rel="chapter" href="ch01.html" title="Introduction">
15
15
<link rel="chapter" href="ch02.html" title="Compiling GIO applications">
16
16
<link rel="chapter" href="ch03.html" title="Running GIO applications">
17
 
<link rel="chapter" href="gio-extension-points.html" title="Extending GIO">
18
 
<link rel="part" href="pt02.html" title="Part&#160;II.&#160;API Reference">
 
17
<link rel="chapter" href="extending-gio.html" title="Extending GIO">
 
18
<link rel="part" href="pt02.html" title="Part II. API Reference">
19
19
<link rel="chapter" href="file_ops.html" title="File Operations">
20
20
<link rel="chapter" href="file_mon.html" title="File System Monitoring">
21
21
<link rel="chapter" href="async.html" title="Asynchronous I/O">
25
25
<link rel="chapter" href="icons.html" title="Icons">
26
26
<link rel="chapter" href="utils.html" title="Utilities">
27
27
<link rel="chapter" href="extending.html" title="Extending GIO">
28
 
<link rel="part" href="migrating.html" title="Part&#160;III.&#160;Migrating to GIO">
 
28
<link rel="part" href="migrating.html" title="Part III. Migrating to GIO">
29
29
<link rel="chapter" href="ch14.html" title="Migrating from POSIX to GIO">
30
30
<link rel="chapter" href="ch15.html" title="Migrating from GnomeVFS to GIO">
31
31
<link rel="chapter" href="gio-hierarchy.html" title="Object Hierarchy">
32
32
<link rel="index" href="ix01.html" title="Index">
 
33
<link rel="index" href="ix02.html" title="Index of new symbols in 2.18">
33
34
</head>
34
35
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
35
36
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
40
41
<th width="100%" align="center">GIO Reference Manual</th>
41
42
<td><a accesskey="n" href="GAsyncResult.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
42
43
</tr>
43
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2722062" class="shortcut">Top</a>
44
 
                  &#160;|&#160;
45
 
                  <a href="#id2805547" class="shortcut">Description</a>
46
 
                  &#160;|&#160;
47
 
                  <a href="#id2808668" class="shortcut">Object Hierarchy</a>
48
 
                  &#160;|&#160;
49
 
                  <a href="#id2808692" class="shortcut">Signals</a></nobr></td></tr>
 
44
<tr><td colspan="5" class="shortcuts">
 
45
<a href="#GCancellable.synopsis" class="shortcut">Top</a>
 
46
                 | 
 
47
                <a href="#GCancellable.description" class="shortcut">Description</a>
 
48
                 | 
 
49
                <a href="#GCancellable.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
50
                 | 
 
51
                <a href="#GCancellable.signals" class="shortcut">Signals</a>
 
52
</td></tr>
50
53
</table>
51
54
<div class="refentry" lang="en">
52
55
<a name="GCancellable"></a><div class="titlepage"></div>
53
56
<div class="refnamediv"><table width="100%"><tr>
54
57
<td valign="top">
55
 
<h2>
56
 
<a name="id2722062"></a><span class="refentrytitle">GCancellable</span>
57
 
</h2>
58
 
<p>GCancellable &#8212; Thread-safe Operation Cancellation Stack</p>
 
58
<h2><span class="refentrytitle"><a name="GCancellable.top_of_page"></a>GCancellable</span></h2>
 
59
<p>GCancellable — Thread-safe Operation Cancellation Stack</p>
59
60
</td>
60
61
<td valign="top" align="right"></td>
61
62
</tr></table></div>
62
63
<div class="refsynopsisdiv">
63
 
<h2>Synopsis</h2>
 
64
<a name="GCancellable.synopsis"></a><h2>Synopsis</h2>
64
65
<pre class="synopsis">
65
66
 
66
67
#include &lt;gio/gio.h&gt;
67
68
 
68
 
 
69
 
                    <a class="link" href="GCancellable.html#GCancellable-struct">GCancellable</a>;
70
 
<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>*       <a class="link" href="GCancellable.html#g-cancellable-new">g_cancellable_new</a>                   (void);
71
 
<a
72
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
73
 
>gboolean</a>            <a class="link" href="GCancellable.html#g-cancellable-is-cancelled">g_cancellable_is_cancelled</a>          (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);
74
 
<a
75
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
76
 
>gboolean</a>            <a class="link" href="GCancellable.html#g-cancellable-set-error-if-cancelled">g_cancellable_set_error_if_cancelled</a>
 
69
                    <a class="link" href="GCancellable.html#GCancellable-struct" title="GCancellable">GCancellable</a>;
 
70
<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *      <a class="link" href="GCancellable.html#g-cancellable-new" title="g_cancellable_new ()">g_cancellable_new</a>                   (void);
 
71
<a
 
72
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
73
>gboolean</a>            <a class="link" href="GCancellable.html#g-cancellable-is-cancelled" title="g_cancellable_is_cancelled ()">g_cancellable_is_cancelled</a>          (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);
 
74
<a
 
75
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
76
>gboolean</a>            <a class="link" href="GCancellable.html#g-cancellable-set-error-if-cancelled" title="g_cancellable_set_error_if_cancelled ()">g_cancellable_set_error_if_cancelled</a>
77
77
                                                        (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
78
78
                                                         <a
79
79
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
80
80
>GError</a> **error);
81
 
int                 <a class="link" href="GCancellable.html#g-cancellable-get-fd">g_cancellable_get_fd</a>                (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);
82
 
<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>*       <a class="link" href="GCancellable.html#g-cancellable-get-current">g_cancellable_get_current</a>           (void);
83
 
void                <a class="link" href="GCancellable.html#g-cancellable-pop-current">g_cancellable_pop_current</a>           (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);
84
 
void                <a class="link" href="GCancellable.html#g-cancellable-push-current">g_cancellable_push_current</a>          (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);
85
 
void                <a class="link" href="GCancellable.html#g-cancellable-reset">g_cancellable_reset</a>                 (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);
86
 
void                <a class="link" href="GCancellable.html#g-cancellable-cancel">g_cancellable_cancel</a>                (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);
87
 
 
88
 
 
 
81
int                 <a class="link" href="GCancellable.html#g-cancellable-get-fd" title="g_cancellable_get_fd ()">g_cancellable_get_fd</a>                (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);
 
82
<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *      <a class="link" href="GCancellable.html#g-cancellable-get-current" title="g_cancellable_get_current ()">g_cancellable_get_current</a>           (void);
 
83
void                <a class="link" href="GCancellable.html#g-cancellable-pop-current" title="g_cancellable_pop_current ()">g_cancellable_pop_current</a>           (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);
 
84
void                <a class="link" href="GCancellable.html#g-cancellable-push-current" title="g_cancellable_push_current ()">g_cancellable_push_current</a>          (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);
 
85
void                <a class="link" href="GCancellable.html#g-cancellable-reset" title="g_cancellable_reset ()">g_cancellable_reset</a>                 (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);
 
86
void                <a class="link" href="GCancellable.html#g-cancellable-cancel" title="g_cancellable_cancel ()">g_cancellable_cancel</a>                (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);
89
87
</pre>
90
88
</div>
91
89
<div class="refsect1" lang="en">
92
 
<a name="id2808668"></a><h2>Object Hierarchy</h2>
 
90
<a name="GCancellable.object-hierarchy"></a><h2>Object Hierarchy</h2>
93
91
<pre class="synopsis">
94
 
 
95
92
  <a
96
93
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
97
94
>GObject</a>
99
96
</pre>
100
97
</div>
101
98
<div class="refsect1" lang="en">
102
 
<a name="id2808692"></a><h2>Signals</h2>
 
99
<a name="GCancellable.signals"></a><h2>Signals</h2>
103
100
<pre class="synopsis">
104
 
 
105
 
  "<a class="link" href="GCancellable.html#GCancellable-cancelled">cancelled</a>"                                      : Run Last
 
101
  "<a class="link" href="GCancellable.html#GCancellable-cancelled" title='The "cancelled" signal'>cancelled</a>"                                      : Run Last
106
102
</pre>
107
103
</div>
108
104
<div class="refsect1" lang="en">
109
 
<a name="id2805547"></a><h2>Description</h2>
 
105
<a name="GCancellable.description"></a><h2>Description</h2>
110
106
<p>
111
107
GCancellable is a thread-safe operation cancellation stack used 
112
108
throughout GIO to allow for cancellation of synchronous and
113
109
asynchronous operations.</p>
114
110
<p>
115
 
 
116
111
</p>
117
112
</div>
118
113
<div class="refsect1" lang="en">
119
 
<a name="id2805569"></a><h2>Details</h2>
 
114
<a name="GCancellable.details"></a><h2>Details</h2>
120
115
<div class="refsect2" lang="en">
121
 
<a name="id2805580"></a><h3>
122
 
<a name="GCancellable-struct"></a>GCancellable</h3>
123
 
<a class="indexterm" name="id2805592"></a><pre class="programlisting">typedef struct _GCancellable GCancellable;</pre>
 
116
<a name="GCancellable-struct"></a><h3>GCancellable</h3>
 
117
<pre class="programlisting">typedef struct _GCancellable GCancellable;</pre>
124
118
<p>
125
119
Allows actions to be cancelled.</p>
126
120
<p>
127
 
 
128
121
</p>
129
122
</div>
130
123
<hr>
131
124
<div class="refsect2" lang="en">
132
 
<a name="id2805611"></a><h3>
133
 
<a name="g-cancellable-new"></a>g_cancellable_new ()</h3>
134
 
<a class="indexterm" name="id2805624"></a><pre class="programlisting"><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>*       g_cancellable_new                   (void);</pre>
 
125
<a name="g-cancellable-new"></a><h3>g_cancellable_new ()</h3>
 
126
<pre class="programlisting"><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *      g_cancellable_new                   (void);</pre>
135
127
<p>
136
128
Creates a new <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object.
137
129
</p>
144
136
One <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> can be used in multiple consecutive
145
137
operations, but not in multiple concurrent operations.</p>
146
138
<p>
147
 
 
148
139
</p>
149
140
<div class="variablelist"><table border="0">
150
141
<col align="left" valign="top">
151
142
<tbody><tr>
152
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
143
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
153
144
<td> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a>.
154
145
</td>
155
146
</tr></tbody>
157
148
</div>
158
149
<hr>
159
150
<div class="refsect2" lang="en">
160
 
<a name="id2796690"></a><h3>
161
 
<a name="g-cancellable-is-cancelled"></a>g_cancellable_is_cancelled ()</h3>
162
 
<a class="indexterm" name="id2796701"></a><pre class="programlisting"><a
 
151
<a name="g-cancellable-is-cancelled"></a><h3>g_cancellable_is_cancelled ()</h3>
 
152
<pre class="programlisting"><a
163
153
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
164
154
>gboolean</a>            g_cancellable_is_cancelled          (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre>
165
155
<p>
166
156
Checks if a cancellable job has been cancelled.</p>
167
157
<p>
168
 
 
169
158
</p>
170
159
<div class="variablelist"><table border="0">
171
160
<col align="left" valign="top">
172
161
<tbody>
173
162
<tr>
174
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
163
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
175
164
<td> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> or NULL.
176
165
</td>
177
166
</tr>
178
167
<tr>
179
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
168
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
180
169
<td> <a
181
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
170
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
182
171
><code class="literal">TRUE</code></a> if <em class="parameter"><code>cancellable</code></em> is cancelled, 
183
172
FALSE if called with <a
184
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
173
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
185
174
><code class="literal">NULL</code></a> or if item is not cancelled. 
186
175
</td>
187
176
</tr>
190
179
</div>
191
180
<hr>
192
181
<div class="refsect2" lang="en">
193
 
<a name="id2796794"></a><h3>
194
 
<a name="g-cancellable-set-error-if-cancelled"></a>g_cancellable_set_error_if_cancelled ()</h3>
195
 
<a class="indexterm" name="id2796805"></a><pre class="programlisting"><a
 
182
<a name="g-cancellable-set-error-if-cancelled"></a><h3>g_cancellable_set_error_if_cancelled ()</h3>
 
183
<pre class="programlisting"><a
196
184
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
197
185
>gboolean</a>            g_cancellable_set_error_if_cancelled
198
186
                                                        (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
203
191
If the <em class="parameter"><code>cancelalble</code></em> is cancelled, sets the error to notify
204
192
that the operation was cancelled.</p>
205
193
<p>
206
 
 
207
194
</p>
208
195
<div class="variablelist"><table border="0">
209
196
<col align="left" valign="top">
210
197
<tbody>
211
198
<tr>
212
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
199
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
213
200
<td> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object.
214
201
</td>
215
202
</tr>
216
203
<tr>
217
 
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
204
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
218
205
<td> <a
219
206
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
220
207
><span class="type">GError</span></a> to append error state to.
221
208
</td>
222
209
</tr>
223
210
<tr>
224
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
211
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
225
212
<td> <a
226
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
213
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
227
214
><code class="literal">TRUE</code></a> if <em class="parameter"><code>cancellable</code></em> was cancelled, <a
228
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
215
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
229
216
><code class="literal">FALSE</code></a> if it was not.
230
217
</td>
231
218
</tr>
234
221
</div>
235
222
<hr>
236
223
<div class="refsect2" lang="en">
237
 
<a name="id2796934"></a><h3>
238
 
<a name="g-cancellable-get-fd"></a>g_cancellable_get_fd ()</h3>
239
 
<a class="indexterm" name="id2796946"></a><pre class="programlisting">int                 g_cancellable_get_fd                (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre>
 
224
<a name="g-cancellable-get-fd"></a><h3>g_cancellable_get_fd ()</h3>
 
225
<pre class="programlisting">int                 g_cancellable_get_fd                (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre>
240
226
<p>
241
227
Gets the file descriptor for a cancellable job. This can be used to
242
228
implement cancellable operations on Unix systems. The returned fd will
243
229
turn readable when <em class="parameter"><code>cancellable</code></em> is cancelled.</p>
244
230
<p>
245
 
 
246
231
</p>
247
232
<div class="variablelist"><table border="0">
248
233
<col align="left" valign="top">
249
234
<tbody>
250
235
<tr>
251
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
236
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
252
237
<td> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a>.
253
238
</td>
254
239
</tr>
255
240
<tr>
256
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
241
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
257
242
<td> A valid file descriptor. <code class="literal">-1</code> if the file descriptor 
258
243
is not supported, or on errors. 
259
244
</td>
263
248
</div>
264
249
<hr>
265
250
<div class="refsect2" lang="en">
266
 
<a name="id2797287"></a><h3>
267
 
<a name="g-cancellable-get-current"></a>g_cancellable_get_current ()</h3>
268
 
<a class="indexterm" name="id2797298"></a><pre class="programlisting"><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>*       g_cancellable_get_current           (void);</pre>
 
251
<a name="g-cancellable-get-current"></a><h3>g_cancellable_get_current ()</h3>
 
252
<pre class="programlisting"><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *      g_cancellable_get_current           (void);</pre>
269
253
<p>
270
254
Gets the top cancellable from the stack.</p>
271
255
<p>
272
 
 
273
256
</p>
274
257
<div class="variablelist"><table border="0">
275
258
<col align="left" valign="top">
276
259
<tbody><tr>
277
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
260
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
278
261
<td> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> from the top of the stack, or <a
279
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
262
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
280
263
><code class="literal">NULL</code></a>
281
264
if the stack is empty. 
282
265
</td>
285
268
</div>
286
269
<hr>
287
270
<div class="refsect2" lang="en">
288
 
<a name="id2797355"></a><h3>
289
 
<a name="g-cancellable-pop-current"></a>g_cancellable_pop_current ()</h3>
290
 
<a class="indexterm" name="id2797366"></a><pre class="programlisting">void                g_cancellable_pop_current           (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre>
 
271
<a name="g-cancellable-pop-current"></a><h3>g_cancellable_pop_current ()</h3>
 
272
<pre class="programlisting">void                g_cancellable_pop_current           (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre>
291
273
<p>
292
274
Pops <em class="parameter"><code>cancellable</code></em> off the cancellable stack (verifying that <em class="parameter"><code>cancellable</code></em> 
293
275
is on the top of the stack).</p>
294
276
<p>
295
 
 
296
277
</p>
297
278
<div class="variablelist"><table border="0">
298
279
<col align="left" valign="top">
299
280
<tbody><tr>
300
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
281
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
301
282
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
302
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
283
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
303
284
><code class="literal">NULL</code></a> to ignore.
304
285
</td>
305
286
</tr></tbody>
307
288
</div>
308
289
<hr>
309
290
<div class="refsect2" lang="en">
310
 
<a name="id2797445"></a><h3>
311
 
<a name="g-cancellable-push-current"></a>g_cancellable_push_current ()</h3>
312
 
<a class="indexterm" name="id2797456"></a><pre class="programlisting">void                g_cancellable_push_current          (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre>
 
291
<a name="g-cancellable-push-current"></a><h3>g_cancellable_push_current ()</h3>
 
292
<pre class="programlisting">void                g_cancellable_push_current          (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre>
313
293
<p>
314
294
Pushes <em class="parameter"><code>cancellable</code></em> onto the cancellable stack. The current
315
 
cancllable can then be recieved using <a class="link" href="GCancellable.html#g-cancellable-get-current"><code class="function">g_cancellable_get_current()</code></a>.
 
295
cancllable can then be recieved using <a class="link" href="GCancellable.html#g-cancellable-get-current" title="g_cancellable_get_current ()"><code class="function">g_cancellable_get_current()</code></a>.
316
296
</p>
317
297
<p>
318
298
This is useful when implementing cancellable operations in
322
302
This is typically called automatically by e.g. <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> operations,
323
303
so you rarely have to call this yourself.</p>
324
304
<p>
325
 
 
326
305
</p>
327
306
<div class="variablelist"><table border="0">
328
307
<col align="left" valign="top">
329
308
<tbody><tr>
330
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
309
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
331
310
<td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a
332
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
311
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
333
312
><code class="literal">NULL</code></a> to ignore.
334
313
</td>
335
314
</tr></tbody>
337
316
</div>
338
317
<hr>
339
318
<div class="refsect2" lang="en">
340
 
<a name="id2803122"></a><h3>
341
 
<a name="g-cancellable-reset"></a>g_cancellable_reset ()</h3>
342
 
<a class="indexterm" name="id2803135"></a><pre class="programlisting">void                g_cancellable_reset                 (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre>
 
319
<a name="g-cancellable-reset"></a><h3>g_cancellable_reset ()</h3>
 
320
<pre class="programlisting">void                g_cancellable_reset                 (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre>
343
321
<p>
344
322
Resets <em class="parameter"><code>cancellable</code></em> to its uncancelled state.</p>
345
323
<p>
346
 
 
347
324
</p>
348
325
<div class="variablelist"><table border="0">
349
326
<col align="left" valign="top">
350
327
<tbody><tr>
351
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
328
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
352
329
<td> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object.
353
330
</td>
354
331
</tr></tbody>
356
333
</div>
357
334
<hr>
358
335
<div class="refsect2" lang="en">
359
 
<a name="id2803198"></a><h3>
360
 
<a name="g-cancellable-cancel"></a>g_cancellable_cancel ()</h3>
361
 
<a class="indexterm" name="id2803209"></a><pre class="programlisting">void                g_cancellable_cancel                (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre>
 
336
<a name="g-cancellable-cancel"></a><h3>g_cancellable_cancel ()</h3>
 
337
<pre class="programlisting">void                g_cancellable_cancel                (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre>
362
338
<p>
363
339
Will set <em class="parameter"><code>cancellable</code></em> to cancelled, and will emit the CANCELLED
364
340
signal.
368
344
another thread than the one running an operation that was passed
369
345
the <em class="parameter"><code>cancellable</code></em>.</p>
370
346
<p>
371
 
 
372
347
</p>
373
348
<div class="variablelist"><table border="0">
374
349
<col align="left" valign="top">
375
350
<tbody><tr>
376
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
351
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
377
352
<td> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object.
378
353
</td>
379
354
</tr></tbody>
381
356
</div>
382
357
</div>
383
358
<div class="refsect1" lang="en">
384
 
<a name="id2803286"></a><h2>Signal Details</h2>
 
359
<a name="GCancellable.signal-details"></a><h2>Signal Details</h2>
385
360
<div class="refsect2" lang="en">
386
 
<a name="id2803297"></a><h3>
387
 
<a name="GCancellable-cancelled"></a>The <code class="literal">"cancelled"</code> signal</h3>
388
 
<a class="indexterm" name="id2803311"></a><pre class="programlisting">void                user_function                      (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
 
361
<a name="GCancellable-cancelled"></a><h3>The <code class="literal">"cancelled"</code> signal</h3>
 
362
<pre class="programlisting">void                user_function                      (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable,
389
363
                                                        <a
390
364
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
391
365
>gpointer</a>      user_data)        : Run Last</pre>
397
371
be emitted in the thread that tried to cancel the operation, not the
398
372
thread the is running the operation.</p>
399
373
<p>
400
 
 
401
374
</p>
402
375
<div class="variablelist"><table border="0">
403
376
<col align="left" valign="top">
404
377
<tbody>
405
378
<tr>
406
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em>&#160;:</span></p></td>
 
379
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
407
380
<td> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a>.
408
381
</td>
409
382
</tr>
410
383
<tr>
411
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
 
384
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
412
385
<td>user data set when the signal handler was connected.</td>
413
386
</tr>
414
387
</tbody>
415
388
</table></div>
416
389
</div>
417
390
</div>
418
 
<div class="refsect1" lang="en">
419
 
<a name="id2803399"></a><div class="refsect2" lang="en"><a name="id2803400"></a></div>
 
391
</div>
 
392
<div class="footer">
420
393
<hr>
421
 
<div class="refsect2" lang="en"><a name="id2803401"></a></div>
422
 
</div>
423
 
</div>
 
394
          Generated by GTK-Doc V1.11</div>
424
395
</body>
425
396
</html>