← Back to branch summary

~ubuntu-branches/ubuntu/maverick/brasero/maverick

« back to all changes in this revision

Viewing changes to docs/reference/libbrasero-burn/html/libbrasero-burn-BraseroSessionCfg.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-09-14 10:23:22 UTC
  • mto: This revision was merged to the branch mainline in revision 78.
  • Revision ID: james.westby@ubuntu.com-20100914102322-8qcbky2cb8nwk9k6
Tags: upstream-2.31.92
Import upstream version 2.31.92

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libbrasero-burn/html/libbrasero-burn-BraseroSessionCfg.html
8
8
<link rel="up" href="ch01.html" title="API Reference for Libbrasero-burn">
9
9
<link rel="prev" href="libbrasero-burn-BraseroSessionSpan.html" title="BraseroSessionSpan">
10
10
<link rel="next" href="libbrasero-burn-BraseroBurnOptions.html" title="BraseroBurnOptions">
11
 
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.15.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">
26
26
                  <a href="#libbrasero-burn-BraseroSessionCfg.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" title="BraseroSessionCfg">
 
29
<div class="refentry">
30
30
<a name="libbrasero-burn-BraseroSessionCfg"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv" title="Synopsis">
 
38
<div class="refsynopsisdiv">
39
39
<a name="libbrasero-burn-BraseroSessionCfg.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">
41
41
#include &lt;brasero-session-cfg.h&gt;
49
49
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flags</code></em>);
50
50
<span class="returnvalue">void</span>                <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-remove-flags" title="brasero_session_cfg_remove_flags ()">brasero_session_cfg_remove_flags</a>    (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
51
51
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flags</code></em>);
52
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-is-supported" title="brasero_session_cfg_is_supported ()">brasero_session_cfg_is_supported</a>    (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
53
 
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flag</code></em>);
54
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-is-compulsory" title="brasero_session_cfg_is_compulsory ()">brasero_session_cfg_is_compulsory</a>   (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
55
 
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flag</code></em>);
56
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-has-default-output-path" title="brasero_session_cfg_has_default_output_path ()">brasero_session_cfg_has_default_output_path</a>
 
52
<span class="returnvalue">gboolean</span>            <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-is-supported" title="brasero_session_cfg_is_supported ()">brasero_session_cfg_is_supported</a>    (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
 
53
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flag</code></em>);
 
54
<span class="returnvalue">gboolean</span>            <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-is-compulsory" title="brasero_session_cfg_is_compulsory ()">brasero_session_cfg_is_compulsory</a>   (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
 
55
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flag</code></em>);
 
56
<span class="returnvalue">gboolean</span>            <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-has-default-output-path" title="brasero_session_cfg_has_default_output_path ()">brasero_session_cfg_has_default_output_path</a>
57
57
                                                        (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);
58
58
<span class="returnvalue">void</span>                <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-enable" title="brasero_session_cfg_enable ()">brasero_session_cfg_enable</a>          (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);
59
59
<span class="returnvalue">void</span>                <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-disable" title="brasero_session_cfg_disable ()">brasero_session_cfg_disable</a>         (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);
60
60
</pre>
61
61
</div>
62
 
<div class="refsect1" title="Description">
 
62
<div class="refsect1">
63
63
<a name="libbrasero-burn-BraseroSessionCfg.description"></a><h2>Description</h2>
64
64
<p>
65
65
This object configures automatically a session reacting to any change
66
66
made to the various parameters.
67
67
</p>
68
68
</div>
69
 
<div class="refsect1" title="Details">
 
69
<div class="refsect1">
70
70
<a name="libbrasero-burn-BraseroSessionCfg.details"></a><h2>Details</h2>
71
 
<div class="refsect2" title="BraseroSessionCfg">
 
71
<div class="refsect2">
72
72
<a name="BraseroSessionCfg"></a><h3>BraseroSessionCfg</h3>
73
73
<pre class="programlisting">typedef struct {
74
74
        BraseroSessionSpan parent_instance;
78
78
</p>
79
79
</div>
80
80
<hr>
81
 
<div class="refsect2" title="enum BraseroSessionError">
 
81
<div class="refsect2">
82
82
<a name="BraseroSessionError"></a><h3>enum BraseroSessionError</h3>
83
83
<pre class="programlisting">typedef enum {
84
84
        BRASERO_SESSION_VALID                           = 0,
99
99
</p>
100
100
</div>
101
101
<hr>
102
 
<div class="refsect2" title="BRASERO_SESSION_IS_VALID()">
 
102
<div class="refsect2">
103
103
<a name="BRASERO-SESSION-IS-VALID:CAPS"></a><h3>BRASERO_SESSION_IS_VALID()</h3>
104
104
<pre class="programlisting">#define             BRASERO_SESSION_IS_VALID(result_MACRO)</pre>
105
105
<p>
114
114
</table></div>
115
115
</div>
116
116
<hr>
117
 
<div class="refsect2" title="brasero_session_cfg_new ()">
 
117
<div class="refsect2">
118
118
<a name="brasero-session-cfg-new"></a><h3>brasero_session_cfg_new ()</h3>
119
119
<pre class="programlisting"><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="returnvalue">BraseroSessionCfg</span></a> * brasero_session_cfg_new             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
120
120
<p>
130
130
</table></div>
131
131
</div>
132
132
<hr>
133
 
<div class="refsect2" title="brasero_session_cfg_get_error ()">
 
133
<div class="refsect2">
134
134
<a name="brasero-session-cfg-get-error"></a><h3>brasero_session_cfg_get_error ()</h3>
135
135
<pre class="programlisting"><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionError" title="enum BraseroSessionError"><span class="returnvalue">BraseroSessionError</span></a>  brasero_session_cfg_get_error      (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);</pre>
136
136
<p>
154
154
</table></div>
155
155
</div>
156
156
<hr>
157
 
<div class="refsect2" title="brasero_session_cfg_add_flags ()">
 
157
<div class="refsect2">
158
158
<a name="brasero-session-cfg-add-flags"></a><h3>brasero_session_cfg_add_flags ()</h3>
159
159
<pre class="programlisting"><span class="returnvalue">void</span>                brasero_session_cfg_add_flags       (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
160
160
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flags</code></em>);</pre>
178
178
</table></div>
179
179
</div>
180
180
<hr>
181
 
<div class="refsect2" title="brasero_session_cfg_remove_flags ()">
 
181
<div class="refsect2">
182
182
<a name="brasero-session-cfg-remove-flags"></a><h3>brasero_session_cfg_remove_flags ()</h3>
183
183
<pre class="programlisting"><span class="returnvalue">void</span>                brasero_session_cfg_remove_flags    (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
184
184
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flags</code></em>);</pre>
202
202
</table></div>
203
203
</div>
204
204
<hr>
205
 
<div class="refsect2" title="brasero_session_cfg_is_supported ()">
 
205
<div class="refsect2">
206
206
<a name="brasero-session-cfg-is-supported"></a><h3>brasero_session_cfg_is_supported ()</h3>
207
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            brasero_session_cfg_is_supported    (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
 
207
<pre class="programlisting"><span class="returnvalue">gboolean</span>            brasero_session_cfg_is_supported    (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
208
208
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flag</code></em>);</pre>
209
209
<p>
210
210
Checks whether a particular flag is supported.
224
224
</tr>
225
225
<tr>
226
226
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
227
 
<td> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>. TRUE if it is supported;
 
227
<td> a <span class="type">gboolean</span>. TRUE if it is supported;
228
228
FALSE otherwise.
229
229
</td>
230
230
</tr>
232
232
</table></div>
233
233
</div>
234
234
<hr>
235
 
<div class="refsect2" title="brasero_session_cfg_is_compulsory ()">
 
235
<div class="refsect2">
236
236
<a name="brasero-session-cfg-is-compulsory"></a><h3>brasero_session_cfg_is_compulsory ()</h3>
237
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            brasero_session_cfg_is_compulsory   (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
 
237
<pre class="programlisting"><span class="returnvalue">gboolean</span>            brasero_session_cfg_is_compulsory   (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
238
238
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flag</code></em>);</pre>
239
239
<p>
240
240
Checks whether a particular flag is compulsory.
254
254
</tr>
255
255
<tr>
256
256
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
257
 
<td> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>. TRUE if it is compulsory;
 
257
<td> a <span class="type">gboolean</span>. TRUE if it is compulsory;
258
258
FALSE otherwise.
259
259
</td>
260
260
</tr>
262
262
</table></div>
263
263
</div>
264
264
<hr>
265
 
<div class="refsect2" title="brasero_session_cfg_has_default_output_path ()">
 
265
<div class="refsect2">
266
266
<a name="brasero-session-cfg-has-default-output-path"></a><h3>brasero_session_cfg_has_default_output_path ()</h3>
267
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            brasero_session_cfg_has_default_output_path
 
267
<pre class="programlisting"><span class="returnvalue">gboolean</span>            brasero_session_cfg_has_default_output_path
268
268
                                                        (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);</pre>
269
269
<p>
270
270
This function returns whether the path returned
281
281
</tr>
282
282
<tr>
283
283
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
284
 
<td> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>. TRUE if the path(s)
 
284
<td> a <span class="type">gboolean</span>. TRUE if the path(s)
285
285
creation is handled by <em class="parameter"><code>session</code></em>, FALSE if it was
286
286
set.
287
287
</td>
290
290
</table></div>
291
291
</div>
292
292
<hr>
293
 
<div class="refsect2" title="brasero_session_cfg_enable ()">
 
293
<div class="refsect2">
294
294
<a name="brasero-session-cfg-enable"></a><h3>brasero_session_cfg_enable ()</h3>
295
295
<pre class="programlisting"><span class="returnvalue">void</span>                brasero_session_cfg_enable          (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);</pre>
296
296
<p>
306
306
</table></div>
307
307
</div>
308
308
<hr>
309
 
<div class="refsect2" title="brasero_session_cfg_disable ()">
 
309
<div class="refsect2">
310
310
<a name="brasero-session-cfg-disable"></a><h3>brasero_session_cfg_disable ()</h3>
311
311
<pre class="programlisting"><span class="returnvalue">void</span>                brasero_session_cfg_disable         (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);</pre>
312
312
<p>
322
322
</table></div>
323
323
</div>
324
324
</div>
325
 
<div class="refsect1" title="See Also">
 
325
<div class="refsect1">
326
326
<a name="libbrasero-burn-BraseroSessionCfg.see-also"></a><h2>See Also</h2>
327
327
<a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a>, <a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="BraseroBurnSession"><span class="type">BraseroBurnSession</span></a>
328
328
</div>
329
329
</div>
330
330
<div class="footer">
331
331
<hr>
332
 
          Generated by GTK-Doc V1.15</div>
 
332
          Generated by GTK-Doc V1.15.1</div>
333
333
</body>
334
334
</html>
 
 
b'\\ No newline at end of file'