Debian Codegraph @

doc/html/UDisksBaseJob.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>UDisksBaseJob: UDisks Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="UDisks Reference Manual">
8 <link rel="up" href="ref-daemon-jobs.html" title="Jobs">
9 <link rel="prev" href="ref-daemon-jobs.html" title="Jobs">
10 <link rel="next" href="UDisksSimpleJob.html" title="UDisksSimpleJob">
11 <meta name="generator" content="GTK-Doc V1.35.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#UDisksBaseJob.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#UDisksBaseJob.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
20 <a href="#UDisksBaseJob.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
21 <a href="#UDisksBaseJob.properties" class="shortcut">Properties</a></span>
22 </td>
23 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24 <td><a accesskey="u" href="ref-daemon-jobs.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25 <td><a accesskey="p" href="ref-daemon-jobs.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26 <td><a accesskey="n" href="UDisksSimpleJob.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27 </tr></table>
28 <div class="refentry">
29 <a name="UDisksBaseJob"></a><div class="titlepage"></div>
30 <div class="refnamediv"><table width="100%"><tr>
31 <td valign="top">
32 <h2><span class="refentrytitle"><a name="UDisksBaseJob.top_of_page"></a>UDisksBaseJob</span></h2>
33 <p>UDisksBaseJob — Base class for jobs.</p>
34 </td>
35 <td class="gallery_image" valign="top" align="right"></td>
36 </tr></table></div>
37 <div class="refsect1">
38 <a name="UDisksBaseJob.functions"></a><h2>Functions</h2>
39 <div class="informaltable"><table class="informaltable" width="100%" border="0">
40 <colgroup>
41 <col width="150px" class="functions_proto_type">
42 <col class="functions_proto_name">
43 </colgroup>
44 <tbody>
45 <tr>
46 <td class="function_type">
47 <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="returnvalue">UDisksDaemon</span></a> *
48 </td>
49 <td class="function_name">
50 <a class="link" href="UDisksBaseJob.html#udisks-base-job-get-daemon" title="udisks_base_job_get_daemon ()">udisks_base_job_get_daemon</a> <span class="c_punctuation">()</span>
51 </td>
52 </tr>
53 <tr>
54 <td class="function_type">
55 <span class="returnvalue">GCancellable</span> *
56 </td>
57 <td class="function_name">
58 <a class="link" href="UDisksBaseJob.html#udisks-base-job-get-cancellable" title="udisks_base_job_get_cancellable ()">udisks_base_job_get_cancellable</a> <span class="c_punctuation">()</span>
59 </td>
60 </tr>
61 <tr>
62 <td class="function_type">
63 <span class="returnvalue">gboolean</span>
64 </td>
65 <td class="function_name">
66 <a class="link" href="UDisksBaseJob.html#udisks-base-job-get-auto-estimate" title="udisks_base_job_get_auto_estimate ()">udisks_base_job_get_auto_estimate</a> <span class="c_punctuation">()</span>
67 </td>
68 </tr>
69 <tr>
70 <td class="function_type">
71 <span class="returnvalue">void</span>
72 </td>
73 <td class="function_name">
74 <a class="link" href="UDisksBaseJob.html#udisks-base-job-set-auto-estimate" title="udisks_base_job_set_auto_estimate ()">udisks_base_job_set_auto_estimate</a> <span class="c_punctuation">()</span>
75 </td>
76 </tr>
77 <tr>
78 <td class="function_type">
79 <span class="returnvalue">void</span>
80 </td>
81 <td class="function_name">
82 <a class="link" href="UDisksBaseJob.html#udisks-base-job-add-object" title="udisks_base_job_add_object ()">udisks_base_job_add_object</a> <span class="c_punctuation">()</span>
83 </td>
84 </tr>
85 <tr>
86 <td class="function_type">
87 <span class="returnvalue">void</span>
88 </td>
89 <td class="function_name">
90 <a class="link" href="UDisksBaseJob.html#udisks-base-job-remove-object" title="udisks_base_job_remove_object ()">udisks_base_job_remove_object</a> <span class="c_punctuation">()</span>
91 </td>
92 </tr>
93 </tbody>
94 </table></div>
95 </div>
96 <div class="refsect1">
97 <a name="UDisksBaseJob.properties"></a><h2>Properties</h2>
98 <div class="informaltable"><table class="informaltable" border="0">
99 <colgroup>
100 <col width="150px" class="properties_type">
101 <col width="300px" class="properties_name">
102 <col width="200px" class="properties_flags">
103 </colgroup>
104 <tbody>
105 <tr>
106 <td class="property_type"><span class="type">gboolean</span></td>
107 <td class="property_name"><a class="link" href="UDisksBaseJob.html#UDisksBaseJob--auto-estimate" title="The “auto-estimate” property">auto-estimate</a></td>
108 <td class="property_flags">Read / Write</td>
109 </tr>
110 <tr>
111 <td class="property_type">
112 <span class="type">GCancellable</span> *</td>
113 <td class="property_name"><a class="link" href="UDisksBaseJob.html#UDisksBaseJob--cancellable" title="The “cancellable” property">cancellable</a></td>
114 <td class="property_flags">Read / Write / Construct Only</td>
115 </tr>
116 <tr>
117 <td class="property_type">
118 <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> *</td>
119 <td class="property_name"><a class="link" href="UDisksBaseJob.html#UDisksBaseJob--daemon" title="The “daemon” property">daemon</a></td>
120 <td class="property_flags">Read / Write / Construct Only</td>
121 </tr>
122 </tbody>
123 </table></div>
124 </div>
125 <div class="refsect1">
126 <a name="UDisksBaseJob.other"></a><h2>Types and Values</h2>
127 <div class="informaltable"><table class="informaltable" width="100%" border="0">
128 <colgroup>
129 <col width="150px" class="other_proto_type">
130 <col class="other_proto_name">
131 </colgroup>
132 <tbody>
133 <tr>
134 <td class="datatype_keyword"> </td>
135 <td class="function_name"><a class="link" href="UDisksBaseJob.html#UDisksBaseJob-struct" title="UDisksBaseJob">UDisksBaseJob</a></td>
136 </tr>
137 <tr>
138 <td class="datatype_keyword">struct</td>
139 <td class="function_name"><a class="link" href="UDisksBaseJob.html#UDisksBaseJobClass" title="struct UDisksBaseJobClass">UDisksBaseJobClass</a></td>
140 </tr>
141 </tbody>
142 </table></div>
143 </div>
144 <div class="refsect1">
145 <a name="UDisksBaseJob.object-hierarchy"></a><h2>Object Hierarchy</h2>
146 <pre class="screen"> GObject
147 <span class="lineart">╰──</span> GDBusInterfaceSkeleton
148 <span class="lineart">╰──</span> <a class="link" href="UDisksJob.html#UDisksJobSkeleton">UDisksJobSkeleton</a>
149 <span class="lineart">╰──</span> UDisksBaseJob
150 <span class="lineart">├──</span> <a class="link" href="UDisksSpawnedJob.html" title="UDisksSpawnedJob">UDisksSpawnedJob</a>
151 <span class="lineart">├──</span> <a class="link" href="UDisksThreadedJob.html" title="UDisksThreadedJob">UDisksThreadedJob</a>
152 <span class="lineart">╰──</span> <a class="link" href="UDisksSimpleJob.html" title="UDisksSimpleJob">UDisksSimpleJob</a>
153 </pre>
154 </div>
155 <div class="refsect1">
156 <a name="UDisksBaseJob.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
157 <p>
158 UDisksBaseJob implements
159 GDBusInterface and <a class="link" href="UDisksJob.html" title="UDisksJob">UDisksJob</a>.</p>
160 </div>
161 <div class="refsect1">
162 <a name="UDisksBaseJob.description"></a><h2>Description</h2>
163 <p>This type provides common features needed by all job types.</p>
164 </div>
165 <div class="refsect1">
166 <a name="UDisksBaseJob.functions_details"></a><h2>Functions</h2>
167 <div class="refsect2">
168 <a name="udisks-base-job-get-daemon"></a><h3>udisks_base_job_get_daemon ()</h3>
169 <pre class="programlisting"><a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="returnvalue">UDisksDaemon</span></a> *
170 udisks_base_job_get_daemon (<em class="parameter"><code><a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a> *job</code></em>);</pre>
171 <p>Gets the <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> for <em class="parameter"><code>job</code></em>
172 .</p>
173 <div class="refsect3">
174 <a name="udisks-base-job-get-daemon.parameters"></a><h4>Parameters</h4>
175 <div class="informaltable"><table class="informaltable" width="100%" border="0">
176 <colgroup>
177 <col width="150px" class="parameters_name">
178 <col class="parameters_description">
179 <col width="200px" class="parameters_annotations">
180 </colgroup>
181 <tbody><tr>
182 <td class="parameter_name"><p>job</p></td>
183 <td class="parameter_description"><p>A <a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a>.</p></td>
184 <td class="parameter_annotations"> </td>
185 </tr></tbody>
186 </table></div>
187 </div>
188 <div class="refsect3">
189 <a name="udisks-base-job-get-daemon.returns"></a><h4>Returns</h4>
190 <p> A <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a>. Do not free, the object belongs to <em class="parameter"><code>job</code></em>
191 .</p>
192 </div>
193 </div>
194 <hr>
195 <div class="refsect2">
196 <a name="udisks-base-job-get-cancellable"></a><h3>udisks_base_job_get_cancellable ()</h3>
197 <pre class="programlisting"><span class="returnvalue">GCancellable</span> *
198 udisks_base_job_get_cancellable (<em class="parameter"><code><a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a> *job</code></em>);</pre>
199 <p>Gets the <span class="type">GCancellable</span> for <em class="parameter"><code>job</code></em>
200 .</p>
201 <div class="refsect3">
202 <a name="udisks-base-job-get-cancellable.parameters"></a><h4>Parameters</h4>
203 <div class="informaltable"><table class="informaltable" width="100%" border="0">
204 <colgroup>
205 <col width="150px" class="parameters_name">
206 <col class="parameters_description">
207 <col width="200px" class="parameters_annotations">
208 </colgroup>
209 <tbody><tr>
210 <td class="parameter_name"><p>job</p></td>
211 <td class="parameter_description"><p>A <a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a>.</p></td>
212 <td class="parameter_annotations"> </td>
213 </tr></tbody>
214 </table></div>
215 </div>
216 <div class="refsect3">
217 <a name="udisks-base-job-get-cancellable.returns"></a><h4>Returns</h4>
218 <p> A <span class="type">GCancellable</span>. Do not free, the object belongs to <em class="parameter"><code>job</code></em>
219 .</p>
220 </div>
221 </div>
222 <hr>
223 <div class="refsect2">
224 <a name="udisks-base-job-get-auto-estimate"></a><h3>udisks_base_job_get_auto_estimate ()</h3>
225 <pre class="programlisting"><span class="returnvalue">gboolean</span>
226 udisks_base_job_get_auto_estimate (<em class="parameter"><code><a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a> *job</code></em>);</pre>
227 <p>Gets whether auto-estimation is being used.</p>
228 <div class="refsect3">
229 <a name="udisks-base-job-get-auto-estimate.parameters"></a><h4>Parameters</h4>
230 <div class="informaltable"><table class="informaltable" width="100%" border="0">
231 <colgroup>
232 <col width="150px" class="parameters_name">
233 <col class="parameters_description">
234 <col width="200px" class="parameters_annotations">
235 </colgroup>
236 <tbody><tr>
237 <td class="parameter_name"><p>job</p></td>
238 <td class="parameter_description"><p>A <a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a>.</p></td>
239 <td class="parameter_annotations"> </td>
240 </tr></tbody>
241 </table></div>
242 </div>
243 <div class="refsect3">
244 <a name="udisks-base-job-get-auto-estimate.returns"></a><h4>Returns</h4>
245 <p> <code class="literal">TRUE</code> if auto-estimation is being used, <code class="literal">FALSE</code> otherwise.</p>
246 </div>
247 </div>
248 <hr>
249 <div class="refsect2">
250 <a name="udisks-base-job-set-auto-estimate"></a><h3>udisks_base_job_set_auto_estimate ()</h3>
251 <pre class="programlisting"><span class="returnvalue">void</span>
252 udisks_base_job_set_auto_estimate (<em class="parameter"><code><a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a> *job</code></em>,
253 <em class="parameter"><code><span class="type">gboolean</span> value</code></em>);</pre>
254 <p>Sets whether auto-estimation is being used.</p>
255 <div class="refsect3">
256 <a name="udisks-base-job-set-auto-estimate.parameters"></a><h4>Parameters</h4>
257 <div class="informaltable"><table class="informaltable" width="100%" border="0">
258 <colgroup>
259 <col width="150px" class="parameters_name">
260 <col class="parameters_description">
261 <col width="200px" class="parameters_annotations">
262 </colgroup>
263 <tbody>
264 <tr>
265 <td class="parameter_name"><p>job</p></td>
266 <td class="parameter_description"><p>A <a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a>.</p></td>
267 <td class="parameter_annotations"> </td>
268 </tr>
269 <tr>
270 <td class="parameter_name"><p>value</p></td>
271 <td class="parameter_description"><p><code class="literal">TRUE</code> if auto-estimation is to be use, <code class="literal">FALSE</code> otherwise.</p></td>
272 <td class="parameter_annotations"> </td>
273 </tr>
274 </tbody>
275 </table></div>
276 </div>
277 </div>
278 <hr>
279 <div class="refsect2">
280 <a name="udisks-base-job-add-object"></a><h3>udisks_base_job_add_object ()</h3>
281 <pre class="programlisting"><span class="returnvalue">void</span>
282 udisks_base_job_add_object (<em class="parameter"><code><a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a> *job</code></em>,
283 <em class="parameter"><code><a class="link" href="UDisksObject.html" title="UDisksObject"><span class="type">UDisksObject</span></a> *object</code></em>);</pre>
284 <p>Adds the object path for <em class="parameter"><code>object</code></em>
285 to the <a class="link" href="gdbus-org.freedesktop.UDisks2.Job.html#gdbus-property-org-freedesktop-UDisks2-Job.Objects" title='The "Objects" property'>Objects</a>
286 array. If the object path is already in the array, does nothing.</p>
287 <div class="refsect3">
288 <a name="udisks-base-job-add-object.parameters"></a><h4>Parameters</h4>
289 <div class="informaltable"><table class="informaltable" width="100%" border="0">
290 <colgroup>
291 <col width="150px" class="parameters_name">
292 <col class="parameters_description">
293 <col width="200px" class="parameters_annotations">
294 </colgroup>
295 <tbody>
296 <tr>
297 <td class="parameter_name"><p>job</p></td>
298 <td class="parameter_description"><p>A <a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a>.</p></td>
299 <td class="parameter_annotations"> </td>
300 </tr>
301 <tr>
302 <td class="parameter_name"><p>object</p></td>
303 <td class="parameter_description"><p>A <a class="link" href="UDisksObject.html" title="UDisksObject"><span class="type">UDisksObject</span></a>.</p></td>
304 <td class="parameter_annotations"> </td>
305 </tr>
306 </tbody>
307 </table></div>
308 </div>
309 </div>
310 <hr>
311 <div class="refsect2">
312 <a name="udisks-base-job-remove-object"></a><h3>udisks_base_job_remove_object ()</h3>
313 <pre class="programlisting"><span class="returnvalue">void</span>
314 udisks_base_job_remove_object (<em class="parameter"><code><a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a> *job</code></em>,
315 <em class="parameter"><code><a class="link" href="UDisksObject.html" title="UDisksObject"><span class="type">UDisksObject</span></a> *object</code></em>);</pre>
316 <p>Removes the object path for <em class="parameter"><code>object</code></em>
317 to the <a class="link" href="gdbus-org.freedesktop.UDisks2.Job.html#gdbus-property-org-freedesktop-UDisks2-Job.Objects" title='The "Objects" property'>Objects</a>
318 array. If the object path is not in the array, does nothing.</p>
319 <div class="refsect3">
320 <a name="udisks-base-job-remove-object.parameters"></a><h4>Parameters</h4>
321 <div class="informaltable"><table class="informaltable" width="100%" border="0">
322 <colgroup>
323 <col width="150px" class="parameters_name">
324 <col class="parameters_description">
325 <col width="200px" class="parameters_annotations">
326 </colgroup>
327 <tbody>
328 <tr>
329 <td class="parameter_name"><p>job</p></td>
330 <td class="parameter_description"><p>A <a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a>.</p></td>
331 <td class="parameter_annotations"> </td>
332 </tr>
333 <tr>
334 <td class="parameter_name"><p>object</p></td>
335 <td class="parameter_description"><p>A <a class="link" href="UDisksObject.html" title="UDisksObject"><span class="type">UDisksObject</span></a>.</p></td>
336 <td class="parameter_annotations"> </td>
337 </tr>
338 </tbody>
339 </table></div>
340 </div>
341 </div>
342 </div>
343 <div class="refsect1">
344 <a name="UDisksBaseJob.other_details"></a><h2>Types and Values</h2>
345 <div class="refsect2">
346 <a name="UDisksBaseJob-struct"></a><h3>UDisksBaseJob</h3>
347 <pre class="programlisting">typedef struct _UDisksBaseJob UDisksBaseJob;</pre>
348 <p>The <a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a> structure contains only private data and should
349 only be accessed using the provided API.</p>
350 </div>
351 <hr>
352 <div class="refsect2">
353 <a name="UDisksBaseJobClass"></a><h3>struct UDisksBaseJobClass</h3>
354 <pre class="programlisting">struct UDisksBaseJobClass {
355 UDisksJobSkeletonClass parent_class;
356 };
357 </pre>
358 <p>Class structure for <a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob"><span class="type">UDisksBaseJob</span></a>.</p>
359 <div class="refsect3">
360 <a name="UDisksBaseJobClass.members"></a><h4>Members</h4>
361 <div class="informaltable"><table class="informaltable" width="100%" border="0">
362 <colgroup>
363 <col width="300px" class="struct_members_name">
364 <col class="struct_members_description">
365 <col width="200px" class="struct_members_annotations">
366 </colgroup>
367 <tbody></tbody>
368 </table></div>
369 </div>
370 </div>
371 </div>
372 <div class="refsect1">
373 <a name="UDisksBaseJob.property-details"></a><h2>Property Details</h2>
374 <div class="refsect2">
375 <a name="UDisksBaseJob--auto-estimate"></a><h3>The <code class="literal">“auto-estimate”</code> property</h3>
376 <pre class="programlisting"> “auto-estimate” <span class="type">gboolean</span></pre>
377 <p>If <code class="literal">TRUE</code>, the <a class="link" href="UDisksJob.html#UDisksJob--expected-end-time" title="The “expected-end-time” property"><span class="type">“expected-end-time”</span></a> property will be
378 automatically updated every time the <a class="link" href="UDisksJob.html#UDisksJob--progress" title="The “progress” property"><span class="type">“progress”</span></a> property
379 is updated.</p>
380 <p>Owner: UDisksBaseJob</p>
381 <p>Flags: Read / Write</p>
382 <p>Default value: FALSE</p>
383 </div>
384 <hr>
385 <div class="refsect2">
386 <a name="UDisksBaseJob--cancellable"></a><h3>The <code class="literal">“cancellable”</code> property</h3>
387 <pre class="programlisting"> “cancellable” <span class="type">GCancellable</span> *</pre>
388 <p>The <span class="type">GCancellable</span> to use.</p>
389 <p>Owner: UDisksBaseJob</p>
390 <p>Flags: Read / Write / Construct Only</p>
391 </div>
392 <hr>
393 <div class="refsect2">
394 <a name="UDisksBaseJob--daemon"></a><h3>The <code class="literal">“daemon”</code> property</h3>
395 <pre class="programlisting"> “daemon” <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> *</pre>
396 <p>The <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> the object is for.</p>
397 <p>Owner: UDisksBaseJob</p>
398 <p>Flags: Read / Write / Construct Only</p>
399 </div>
400 </div>
401 </div>
402 <div class="footer">
403 <hr>Generated by GTK-Doc V1.35.1</div>
404 </body>
405 </html>