← Back to branch summary

~ubuntu-branches/debian/wheezy/brasero/wheezy

« back to all changes in this revision

Viewing changes to docs/reference/libbrasero-burn/xml/brasero-session-cfg.xml

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Henriksson
  • Date: 2009-12-14 22:35:03 UTC
  • mfrom: (1.2.17 upstream)
  • Revision ID: james.westby@ubuntu.com-20091214223503-aa2l0jrjl85ar2ue
Tags: 2.28.3-1
New upstream bugfix release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libbrasero-burn/xml/brasero-session-cfg.xml
1
 
<refentry id="libbrasero-burn-BraseroSessionCfg">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="libbrasero-burn-BraseroSessionCfg.top_of_page">BraseroSessionCfg</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>LIBBRASERO-BURN Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>BraseroSessionCfg</refname>
10
 
<refpurpose>Configure automatically a <link linkend="BraseroBurnSession"><type>BraseroBurnSession</type></link> object</refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="libbrasero-burn-BraseroSessionCfg.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
 
18
 
#include &lt;brasero-session-cfg.h&gt;
19
 
 
20
 
                    <link linkend="BraseroSessionCfg">BraseroSessionCfg</link>;
21
 
#define             <link linkend="BRASERO-DRIVE-PROPERTIES-FLAGS--CAPS">BRASERO_DRIVE_PROPERTIES_FLAGS</link>
22
 
enum                <link linkend="BraseroSessionError">BraseroSessionError</link>;
23
 
#define             <link linkend="BRASERO-SESSION-IS-VALID--CAPS">BRASERO_SESSION_IS_VALID</link>            (result_MACRO)
24
 
<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> * <link linkend="brasero-session-cfg-new">brasero_session_cfg_new</link>             (void);
25
 
<link linkend="BraseroSessionError">BraseroSessionError</link>  <link linkend="brasero-session-cfg-get-error">brasero_session_cfg_get_error</link>      (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg);
26
 
<link linkend="void">void</link>                <link linkend="brasero-session-cfg-add-flags">brasero_session_cfg_add_flags</link>       (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg,
27
 
                                                         <link linkend="BraseroBurnFlag">BraseroBurnFlag</link> flags);
28
 
<link linkend="void">void</link>                <link linkend="brasero-session-cfg-remove-flags">brasero_session_cfg_remove_flags</link>    (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg,
29
 
                                                         <link linkend="BraseroBurnFlag">BraseroBurnFlag</link> flags);
30
 
<link linkend="gboolean">gboolean</link>            <link linkend="brasero-session-cfg-is-supported">brasero_session_cfg_is_supported</link>    (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg,
31
 
                                                         <link linkend="BraseroBurnFlag">BraseroBurnFlag</link> flag);
32
 
<link linkend="gboolean">gboolean</link>            <link linkend="brasero-session-cfg-is-compulsory">brasero_session_cfg_is_compulsory</link>   (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg,
33
 
                                                         <link linkend="BraseroBurnFlag">BraseroBurnFlag</link> flag);
34
 
<link linkend="gboolean">gboolean</link>            <link linkend="brasero-session-cfg-has-default-output-path">brasero_session_cfg_has_default_output_path</link>
35
 
                                                        (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg);
36
 
<link linkend="void">void</link>                <link linkend="brasero-session-cfg-enable">brasero_session_cfg_enable</link>          (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg);
37
 
<link linkend="void">void</link>                <link linkend="brasero-session-cfg-disable">brasero_session_cfg_disable</link>         (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg);
38
 
</synopsis>
39
 
</refsynopsisdiv>
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
 
 
49
 
<refsect1 id="libbrasero-burn-BraseroSessionCfg.description" role="desc">
50
 
<title role="desc.title">Description</title>
51
 
<para>
52
 
This object configures automatically a session reacting to any change
53
 
made to the various parameters.</para>
54
 
<para>
55
 
</para>
56
 
</refsect1>
57
 
 
58
 
<refsect1 id="libbrasero-burn-BraseroSessionCfg.details" role="details">
59
 
<title role="details.title">Details</title>
60
 
<refsect2 id="BraseroSessionCfg" role="struct">
61
 
<title>BraseroSessionCfg</title>
62
 
<indexterm zone="BraseroSessionCfg"><primary sortas="BraseroSessionCfg">BraseroSessionCfg</primary></indexterm><programlisting>typedef struct {
63
 
        BraseroSessionSpan parent_instance;
64
 
} BraseroSessionCfg;
65
 
</programlisting>
66
 
<para>
67
 
</para></refsect2>
68
 
<refsect2 id="BRASERO-DRIVE-PROPERTIES-FLAGS--CAPS" role="macro">
69
 
<title>BRASERO_DRIVE_PROPERTIES_FLAGS</title>
70
 
<indexterm zone="BRASERO-DRIVE-PROPERTIES-FLAGS--CAPS"><primary sortas="BRASERO_DRIVE_PROPERTIES_FLAGS">BRASERO_DRIVE_PROPERTIES_FLAGS</primary></indexterm><programlisting>#define             BRASERO_DRIVE_PROPERTIES_FLAGS</programlisting>
71
 
<para>
72
 
</para></refsect2>
73
 
<refsect2 id="BraseroSessionError" role="enum">
74
 
<title>enum BraseroSessionError</title>
75
 
<indexterm zone="BraseroSessionError"><primary sortas="BraseroSessionError">BraseroSessionError</primary></indexterm><programlisting>typedef enum {
76
 
        BRASERO_SESSION_VALID                           = 0,
77
 
        BRASERO_SESSION_NO_CD_TEXT                      = 1,
78
 
        BRASERO_SESSION_NOT_READY,
79
 
        BRASERO_SESSION_EMPTY,
80
 
        BRASERO_SESSION_NO_INPUT_IMAGE,
81
 
        BRASERO_SESSION_UNKNOWN_IMAGE,
82
 
        BRASERO_SESSION_NO_INPUT_MEDIUM,
83
 
        BRASERO_SESSION_NO_OUTPUT,
84
 
        BRASERO_SESSION_INSUFFICIENT_SPACE,
85
 
        BRASERO_SESSION_OVERBURN_NECESSARY,
86
 
        BRASERO_SESSION_NOT_SUPPORTED,
87
 
        BRASERO_SESSION_DISC_PROTECTED
88
 
} BraseroSessionError;
89
 
</programlisting>
90
 
<para>
91
 
</para></refsect2>
92
 
<refsect2 id="BRASERO-SESSION-IS-VALID--CAPS" role="macro">
93
 
<title>BRASERO_SESSION_IS_VALID()</title>
94
 
<indexterm zone="BRASERO-SESSION-IS-VALID--CAPS"><primary sortas="BRASERO_SESSION_IS_VALID">BRASERO_SESSION_IS_VALID</primary></indexterm><programlisting>#define             BRASERO_SESSION_IS_VALID(result_MACRO)</programlisting>
95
 
<para>
96
 
</para><variablelist role="params">
97
 
<varlistentry><term><parameter>result_MACRO</parameter>&#160;:</term>
98
 
<listitem><simpara>
99
 
</simpara></listitem></varlistentry>
100
 
</variablelist></refsect2>
101
 
<refsect2 id="brasero-session-cfg-new" role="function">
102
 
<title>brasero_session_cfg_new ()</title>
103
 
<indexterm zone="brasero-session-cfg-new"><primary sortas="brasero_session_cfg_new">brasero_session_cfg_new</primary></indexterm><programlisting><link linkend="BraseroSessionCfg">BraseroSessionCfg</link> * brasero_session_cfg_new             (void);</programlisting>
104
 
<para>
105
 
Creates a new <link linkend="BraseroSessionCfg"><type>BraseroSessionCfg</type></link> object.</para>
106
 
<para>
107
 
</para><variablelist role="params">
108
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroSessionCfg"><type>BraseroSessionCfg</type></link> object.
109
 
</simpara></listitem></varlistentry>
110
 
</variablelist></refsect2>
111
 
<refsect2 id="brasero-session-cfg-get-error" role="function">
112
 
<title>brasero_session_cfg_get_error ()</title>
113
 
<indexterm zone="brasero-session-cfg-get-error"><primary sortas="brasero_session_cfg_get_error">brasero_session_cfg_get_error</primary></indexterm><programlisting><link linkend="BraseroSessionError">BraseroSessionError</link>  brasero_session_cfg_get_error      (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg);</programlisting>
114
 
<para>
115
 
This function returns the current status and if
116
 
autoconfiguration is/was successful.</para>
117
 
<para>
118
 
</para><variablelist role="params">
119
 
<varlistentry><term><parameter>cfg</parameter>&#160;:</term>
120
 
<listitem><simpara> a <link linkend="BraseroSessionCfg"><type>BraseroSessionCfg</type></link>
121
 
</simpara></listitem></varlistentry>
122
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroSessionError"><type>BraseroSessionError</type></link>.
123
 
</simpara></listitem></varlistentry>
124
 
</variablelist></refsect2>
125
 
<refsect2 id="brasero-session-cfg-add-flags" role="function">
126
 
<title>brasero_session_cfg_add_flags ()</title>
127
 
<indexterm zone="brasero-session-cfg-add-flags"><primary sortas="brasero_session_cfg_add_flags">brasero_session_cfg_add_flags</primary></indexterm><programlisting><link linkend="void">void</link>                brasero_session_cfg_add_flags       (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg,
128
 
                                                         <link linkend="BraseroBurnFlag">BraseroBurnFlag</link> flags);</programlisting>
129
 
<para>
130
 
Adds all flags from <parameter>flags</parameter> that are supported.</para>
131
 
<para>
132
 
</para><variablelist role="params">
133
 
<varlistentry><term><parameter>cfg</parameter>&#160;:</term>
134
 
<listitem><simpara> a <link linkend="BraseroSessionCfg"><type>BraseroSessionCfg</type></link>
135
 
</simpara></listitem></varlistentry>
136
 
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
137
 
<listitem><simpara> a <link linkend="BraseroBurnFlag"><type>BraseroBurnFlag</type></link>
138
 
</simpara></listitem></varlistentry>
139
 
</variablelist></refsect2>
140
 
<refsect2 id="brasero-session-cfg-remove-flags" role="function">
141
 
<title>brasero_session_cfg_remove_flags ()</title>
142
 
<indexterm zone="brasero-session-cfg-remove-flags"><primary sortas="brasero_session_cfg_remove_flags">brasero_session_cfg_remove_flags</primary></indexterm><programlisting><link linkend="void">void</link>                brasero_session_cfg_remove_flags    (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg,
143
 
                                                         <link linkend="BraseroBurnFlag">BraseroBurnFlag</link> flags);</programlisting>
144
 
<para>
145
 
Removes all flags that are not compulsory.</para>
146
 
<para>
147
 
</para><variablelist role="params">
148
 
<varlistentry><term><parameter>cfg</parameter>&#160;:</term>
149
 
<listitem><simpara> a <link linkend="BraseroSessionCfg"><type>BraseroSessionCfg</type></link>
150
 
</simpara></listitem></varlistentry>
151
 
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
152
 
<listitem><simpara> a <link linkend="BraseroBurnFlag"><type>BraseroBurnFlag</type></link>
153
 
</simpara></listitem></varlistentry>
154
 
</variablelist></refsect2>
155
 
<refsect2 id="brasero-session-cfg-is-supported" role="function">
156
 
<title>brasero_session_cfg_is_supported ()</title>
157
 
<indexterm zone="brasero-session-cfg-is-supported"><primary sortas="brasero_session_cfg_is_supported">brasero_session_cfg_is_supported</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            brasero_session_cfg_is_supported    (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg,
158
 
                                                         <link linkend="BraseroBurnFlag">BraseroBurnFlag</link> flag);</programlisting>
159
 
<para>
160
 
Checks whether a particular flag is supported.</para>
161
 
<para>
162
 
</para><variablelist role="params">
163
 
<varlistentry><term><parameter>cfg</parameter>&#160;:</term>
164
 
<listitem><simpara> a <link linkend="BraseroSessionCfg"><type>BraseroSessionCfg</type></link>
165
 
</simpara></listitem></varlistentry>
166
 
<varlistentry><term><parameter>flag</parameter>&#160;:</term>
167
 
<listitem><simpara> a <link linkend="BraseroBurnFlag"><type>BraseroBurnFlag</type></link>
168
 
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link>. TRUE if it is supported;
170
 
FALSE otherwise.
171
 
</simpara></listitem></varlistentry>
172
 
</variablelist></refsect2>
173
 
<refsect2 id="brasero-session-cfg-is-compulsory" role="function">
174
 
<title>brasero_session_cfg_is_compulsory ()</title>
175
 
<indexterm zone="brasero-session-cfg-is-compulsory"><primary sortas="brasero_session_cfg_is_compulsory">brasero_session_cfg_is_compulsory</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            brasero_session_cfg_is_compulsory   (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg,
176
 
                                                         <link linkend="BraseroBurnFlag">BraseroBurnFlag</link> flag);</programlisting>
177
 
<para>
178
 
Checks whether a particular flag is compulsory.</para>
179
 
<para>
180
 
</para><variablelist role="params">
181
 
<varlistentry><term><parameter>cfg</parameter>&#160;:</term>
182
 
<listitem><simpara> a <link linkend="BraseroSessionCfg"><type>BraseroSessionCfg</type></link>
183
 
</simpara></listitem></varlistentry>
184
 
<varlistentry><term><parameter>flag</parameter>&#160;:</term>
185
 
<listitem><simpara> a <link linkend="BraseroBurnFlag"><type>BraseroBurnFlag</type></link>
186
 
</simpara></listitem></varlistentry>
187
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link>. TRUE if it is compulsory;
188
 
FALSE otherwise.
189
 
</simpara></listitem></varlistentry>
190
 
</variablelist></refsect2>
191
 
<refsect2 id="brasero-session-cfg-has-default-output-path" role="function">
192
 
<title>brasero_session_cfg_has_default_output_path ()</title>
193
 
<indexterm zone="brasero-session-cfg-has-default-output-path"><primary sortas="brasero_session_cfg_has_default_output_path">brasero_session_cfg_has_default_output_path</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            brasero_session_cfg_has_default_output_path
194
 
                                                        (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg);</programlisting>
195
 
<para>
196
 
This function returns whether the path returned
197
 
by <link linkend="brasero-burn-session-get-output"><function>brasero_burn_session_get_output()</function></link> is an 
198
 
automatically created one.</para>
199
 
<para>
200
 
</para><variablelist role="params">
201
 
<varlistentry><term><parameter>cfg</parameter>&#160;:</term>
202
 
<listitem><simpara> a <link linkend="BraseroSessionCfg"><type>BraseroSessionCfg</type></link>
203
 
</simpara></listitem></varlistentry>
204
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link>. TRUE if the path(s)
205
 
creation is handled by <parameter>session</parameter>, FALSE if it was
206
 
set.
207
 
</simpara></listitem></varlistentry>
208
 
</variablelist></refsect2>
209
 
<refsect2 id="brasero-session-cfg-enable" role="function">
210
 
<title>brasero_session_cfg_enable ()</title>
211
 
<indexterm zone="brasero-session-cfg-enable"><primary sortas="brasero_session_cfg_enable">brasero_session_cfg_enable</primary></indexterm><programlisting><link linkend="void">void</link>                brasero_session_cfg_enable          (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg);</programlisting>
212
 
<para>
213
 
This function (re)-enables autoconfiguration</para>
214
 
<para>
215
 
</para><variablelist role="params">
216
 
<varlistentry><term><parameter>cfg</parameter>&#160;:</term>
217
 
<listitem><simpara> a <link linkend="BraseroSessionCfg"><type>BraseroSessionCfg</type></link>
218
 
</simpara></listitem></varlistentry>
219
 
</variablelist></refsect2>
220
 
<refsect2 id="brasero-session-cfg-disable" role="function">
221
 
<title>brasero_session_cfg_disable ()</title>
222
 
<indexterm zone="brasero-session-cfg-disable"><primary sortas="brasero_session_cfg_disable">brasero_session_cfg_disable</primary></indexterm><programlisting><link linkend="void">void</link>                brasero_session_cfg_disable         (<link linkend="BraseroSessionCfg">BraseroSessionCfg</link> *cfg);</programlisting>
223
 
<para>
224
 
This function disables autoconfiguration</para>
225
 
<para>
226
 
</para><variablelist role="params">
227
 
<varlistentry><term><parameter>cfg</parameter>&#160;:</term>
228
 
<listitem><simpara> a <link linkend="BraseroSessionCfg"><type>BraseroSessionCfg</type></link>
229
 
</simpara></listitem></varlistentry>
230
 
</variablelist></refsect2>
231
 
 
232
 
</refsect1>
233
 
 
234
 
 
235
 
 
236
 
<refsect1 id="libbrasero-burn-BraseroSessionCfg.see-also">
237
 
<title>See Also</title>
238
 
#BraseroBurn, <link linkend="BraseroBurnSession"><type>BraseroBurnSession</type></link>
239
 
</refsect1>
240
 
 
241
 
</refentry>