← Back to branch summary

~mfisch/brasero/update-to-3.8.0

« back to all changes in this revision

Viewing changes to docs/reference/libbrasero-burn/html/libbrasero-burn-brasero-status.html

  • Committer: Matthew Fischer
  • Date: 2013-05-26 19:48:27 UTC
  • mfrom: (1.1.56)
  • Revision ID: matthew.fischer@canonical.com-20130526194827-9bx3owseaxxa3o2i
https://launchpad.net/bugs/1184409
* New upstream release (LP: #1184409)
  - Documentation fixes
  - Translation updates
  - Add a question mark to a question
  - Support notification filtering
  - Remove nonexisting options from the man page
  - Fix while loop in `brasero_libisofs_write_image_to_fd_thread
* Refreshed patches
* 99_fix-mp3-projects.patch: Removed, already applied upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libbrasero-burn/html/libbrasero-burn-brasero-status.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>brasero-status</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="Libbrasero-burn Reference Manual">
8
8
<link rel="up" href="ch01.html" title="API Reference for Libbrasero-burn">
9
9
<link rel="prev" href="libbrasero-burn-brasero-tags.html" title="brasero-tags">
10
10
<link rel="next" href="libbrasero-burn-brasero-enums.html" title="brasero-enums">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (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">
41
41
enum                <a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatusType" title="enum BraseroStatusType">BraseroStatusType</a>;
42
42
<a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="returnvalue">BraseroStatus</span></a> *     <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-new" title="brasero_status_new ()">brasero_status_new</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
43
43
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-get-result" title="brasero_status_get_result ()">brasero_status_get_result</a>           (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);
44
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-get-progress" title="brasero_status_get_progress ()">brasero_status_get_progress</a>         (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);
45
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *            <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-get-error" title="brasero_status_get_error ()">brasero_status_get_error</a>            (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);
46
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-get-current-action" title="brasero_status_get_current_action ()">brasero_status_get_current_action</a>   (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);
 
44
<span class="returnvalue">gdouble</span>             <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-get-progress" title="brasero_status_get_progress ()">brasero_status_get_progress</a>         (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);
 
45
<span class="returnvalue">GError</span> *            <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-get-error" title="brasero_status_get_error ()">brasero_status_get_error</a>            (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);
 
46
<span class="returnvalue">gchar</span> *             <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-get-current-action" title="brasero_status_get_current_action ()">brasero_status_get_current_action</a>   (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);
47
47
<span class="returnvalue">void</span>                <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-set-completed" title="brasero_status_set_completed ()">brasero_status_set_completed</a>        (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);
48
48
<span class="returnvalue">void</span>                <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-set-not-ready" title="brasero_status_set_not_ready ()">brasero_status_set_not_ready</a>        (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>,
49
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>,
50
 
                                                         <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> *current_action</code></em>);
 
49
                                                         <em class="parameter"><code><span class="type">gdouble</span> progress</code></em>,
 
50
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *current_action</code></em>);
51
51
<span class="returnvalue">void</span>                <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-set-error" title="brasero_status_set_error ()">brasero_status_set_error</a>            (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</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>);
 
52
                                                         <em class="parameter"><code><span class="type">GError</span> *error</code></em>);
53
53
</pre>
54
54
</div>
55
55
<div class="refsect1">
77
77
</pre>
78
78
<p>
79
79
</p>
 
80
<div class="variablelist"><table border="0" class="variablelist">
 
81
<colgroup>
 
82
<col align="left" valign="top">
 
83
<col>
 
84
</colgroup>
 
85
<tbody>
 
86
<tr>
 
87
<td><p><a name="BRASERO-STATUS-OK:CAPS"></a><span class="term"><code class="literal">BRASERO_STATUS_OK</code></span></p></td>
 
88
<td>
 
89
</td>
 
90
</tr>
 
91
<tr>
 
92
<td><p><a name="BRASERO-STATUS-ERROR:CAPS"></a><span class="term"><code class="literal">BRASERO_STATUS_ERROR</code></span></p></td>
 
93
<td>
 
94
</td>
 
95
</tr>
 
96
<tr>
 
97
<td><p><a name="BRASERO-STATUS-QUESTION:CAPS"></a><span class="term"><code class="literal">BRASERO_STATUS_QUESTION</code></span></p></td>
 
98
<td>
 
99
</td>
 
100
</tr>
 
101
<tr>
 
102
<td><p><a name="BRASERO-STATUS-INFORMATION:CAPS"></a><span class="term"><code class="literal">BRASERO_STATUS_INFORMATION</code></span></p></td>
 
103
<td>
 
104
</td>
 
105
</tr>
 
106
</tbody>
 
107
</table></div>
80
108
</div>
81
109
<hr>
82
110
<div class="refsect2">
127
155
<hr>
128
156
<div class="refsect2">
129
157
<a name="brasero-status-get-progress"></a><h3>brasero_status_get_progress ()</h3>
130
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             brasero_status_get_progress         (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);</pre>
 
158
<pre class="programlisting"><span class="returnvalue">gdouble</span>             brasero_status_get_progress         (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);</pre>
131
159
<p>
132
160
If <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-get-result" title="brasero_status_get_result ()"><code class="function">brasero_status_get_result()</code></a> returned BRASERO_BURN_NOT_READY,
133
161
this function returns the progress regarding the operation completion.
144
172
</tr>
145
173
<tr>
146
174
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
147
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>
 
175
<td>a <span class="type">gdouble</span>
148
176
</td>
149
177
</tr>
150
178
</tbody>
153
181
<hr>
154
182
<div class="refsect2">
155
183
<a name="brasero-status-get-error"></a><h3>brasero_status_get_error ()</h3>
156
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *            brasero_status_get_error            (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);</pre>
 
184
<pre class="programlisting"><span class="returnvalue">GError</span> *            brasero_status_get_error            (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);</pre>
157
185
<p>
158
186
If <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-get-result" title="brasero_status_get_result ()"><code class="function">brasero_status_get_result()</code></a> returned BRASERO_BURN_ERR,
159
187
this function returns the error.
170
198
</tr>
171
199
<tr>
172
200
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
173
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
 
201
<td>a <span class="type">GError</span>
174
202
</td>
175
203
</tr>
176
204
</tbody>
179
207
<hr>
180
208
<div class="refsect2">
181
209
<a name="brasero-status-get-current-action"></a><h3>brasero_status_get_current_action ()</h3>
182
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             brasero_status_get_current_action   (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);</pre>
 
210
<pre class="programlisting"><span class="returnvalue">gchar</span> *             brasero_status_get_current_action   (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>);</pre>
183
211
<p>
184
212
If <a class="link" href="libbrasero-burn-brasero-status.html#brasero-status-get-result" title="brasero_status_get_result ()"><code class="function">brasero_status_get_result()</code></a> returned BRASERO_BURN_NOT_READY,
185
213
this function returns a string describing the operation currently performed.
197
225
</tr>
198
226
<tr>
199
227
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
200
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>.</td>
 
228
<td>a <span class="type">gchar</span>.</td>
201
229
</tr>
202
230
</tbody>
203
231
</table></div>
224
252
<div class="refsect2">
225
253
<a name="brasero-status-set-not-ready"></a><h3>brasero_status_set_not_ready ()</h3>
226
254
<pre class="programlisting"><span class="returnvalue">void</span>                brasero_status_set_not_ready        (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>,
227
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>,
228
 
                                                         <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> *current_action</code></em>);</pre>
 
255
                                                         <em class="parameter"><code><span class="type">gdouble</span> progress</code></em>,
 
256
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *current_action</code></em>);</pre>
229
257
<p>
230
258
Sets the status for a request to BRASERO_BURN_NOT_READY.
231
259
Allows to set a string describing the operation currently performed
243
271
</tr>
244
272
<tr>
245
273
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
246
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> or -1.0.</td>
 
274
<td>a <span class="type">gdouble</span> or -1.0.</td>
247
275
</tr>
248
276
<tr>
249
277
<td><p><span class="term"><em class="parameter"><code>current_action</code></em> :</span></p></td>
250
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> or NULL.</td>
 
278
<td>a <span class="type">gchar</span> or NULL.</td>
251
279
</tr>
252
280
</tbody>
253
281
</table></div>
256
284
<div class="refsect2">
257
285
<a name="brasero-status-set-error"></a><h3>brasero_status_set_error ()</h3>
258
286
<pre class="programlisting"><span class="returnvalue">void</span>                brasero_status_set_error            (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-status.html#BraseroStatus" title="BraseroStatus"><span class="type">BraseroStatus</span></a> *status</code></em>,
259
 
                                                         <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>
 
287
                                                         <em class="parameter"><code><span class="type">GError</span> *error</code></em>);</pre>
260
288
<p>
261
289
Sets the status for a request to BRASERO_BURN_ERR.
262
290
</p>
272
300
</tr>
273
301
<tr>
274
302
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
275
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or NULL.</td>
 
303
<td>a <span class="type">GError</span> or NULL.</td>
276
304
</tr>
277
305
</tbody>
278
306
</table></div>
281
309
</div>
282
310
<div class="footer">
283
311
<hr>
284
 
          Generated by GTK-Doc V1.18</div>
 
312
          Generated by GTK-Doc V1.18.1</div>
285
313
</body>
286
314
</html>
 
 
b'\\ No newline at end of file'