← 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-status.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-status.xml
1
 
<refentry id="libbrasero-burn-brasero-status">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="libbrasero-burn-brasero-status.top_of_page">brasero-status</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>LIBBRASERO-BURN Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>brasero-status</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="libbrasero-burn-brasero-status.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
                    <link linkend="BraseroStatus">BraseroStatus</link>;
18
 
enum                <link linkend="BraseroStatusType">BraseroStatusType</link>;
19
 
<link linkend="BraseroStatus">BraseroStatus</link> *     <link linkend="brasero-status-new">brasero_status_new</link>                  (void);
20
 
<link linkend="void">void</link>                <link linkend="brasero-status-free">brasero_status_free</link>                 (<link linkend="BraseroStatus">BraseroStatus</link> *status);
21
 
<link linkend="BraseroBurnResult">BraseroBurnResult</link>   <link linkend="brasero-status-get-result">brasero_status_get_result</link>           (<link linkend="BraseroStatus">BraseroStatus</link> *status);
22
 
<link linkend="gdouble">gdouble</link>             <link linkend="brasero-status-get-progress">brasero_status_get_progress</link>         (<link linkend="BraseroStatus">BraseroStatus</link> *status);
23
 
<link linkend="GError">GError</link> *            <link linkend="brasero-status-get-error">brasero_status_get_error</link>            (<link linkend="BraseroStatus">BraseroStatus</link> *status);
24
 
<link linkend="gchar">gchar</link> *             <link linkend="brasero-status-get-current-action">brasero_status_get_current_action</link>   (<link linkend="BraseroStatus">BraseroStatus</link> *status);
25
 
<link linkend="void">void</link>                <link linkend="brasero-status-set-completed">brasero_status_set_completed</link>        (<link linkend="BraseroStatus">BraseroStatus</link> *status);
26
 
<link linkend="void">void</link>                <link linkend="brasero-status-set-not-ready">brasero_status_set_not_ready</link>        (<link linkend="BraseroStatus">BraseroStatus</link> *status,
27
 
                                                         <link linkend="gdouble">gdouble</link> progress,
28
 
                                                         const <link linkend="gchar">gchar</link> *current_action);
29
 
<link linkend="void">void</link>                <link linkend="brasero-status-set-error">brasero_status_set_error</link>            (<link linkend="BraseroStatus">BraseroStatus</link> *status,
30
 
                                                         <link linkend="GError">GError</link> *error);
31
 
</synopsis>
32
 
</refsynopsisdiv>
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
<refsect1 id="libbrasero-burn-brasero-status.description" role="desc">
43
 
<title role="desc.title">Description</title>
44
 
<para>
45
 
</para>
46
 
</refsect1>
47
 
 
48
 
<refsect1 id="libbrasero-burn-brasero-status.details" role="details">
49
 
<title role="details.title">Details</title>
50
 
<refsect2 id="BraseroStatus" role="struct">
51
 
<title>BraseroStatus</title>
52
 
<indexterm zone="BraseroStatus"><primary sortas="BraseroStatus">BraseroStatus</primary></indexterm><programlisting>typedef struct _BraseroStatus BraseroStatus;</programlisting>
53
 
<para>
54
 
</para></refsect2>
55
 
<refsect2 id="BraseroStatusType" role="enum">
56
 
<title>enum BraseroStatusType</title>
57
 
<indexterm zone="BraseroStatusType"><primary sortas="BraseroStatusType">BraseroStatusType</primary></indexterm><programlisting>typedef enum {
58
 
        BRASERO_STATUS_OK                       = 0,
59
 
        BRASERO_STATUS_ERROR,
60
 
        BRASERO_STATUS_QUESTION,
61
 
        BRASERO_STATUS_INFORMATION
62
 
} BraseroStatusType;
63
 
</programlisting>
64
 
<para>
65
 
</para></refsect2>
66
 
<refsect2 id="brasero-status-new" role="function">
67
 
<title>brasero_status_new ()</title>
68
 
<indexterm zone="brasero-status-new"><primary sortas="brasero_status_new">brasero_status_new</primary></indexterm><programlisting><link linkend="BraseroStatus">BraseroStatus</link> *     brasero_status_new                  (void);</programlisting>
69
 
<para>
70
 
Creates a new <link linkend="BraseroStatus"><type>BraseroStatus</type></link> structure.
71
 
Free it with <link linkend="brasero-status-free"><function>brasero_status_free()</function></link>.</para>
72
 
<para>
73
 
</para><variablelist role="params">
74
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroStatus"><type>BraseroStatus</type></link> pointer.
75
 
</simpara></listitem></varlistentry>
76
 
</variablelist></refsect2>
77
 
<refsect2 id="brasero-status-free" role="function">
78
 
<title>brasero_status_free ()</title>
79
 
<indexterm zone="brasero-status-free"><primary sortas="brasero_status_free">brasero_status_free</primary></indexterm><programlisting><link linkend="void">void</link>                brasero_status_free                 (<link linkend="BraseroStatus">BraseroStatus</link> *status);</programlisting>
80
 
<para>
81
 
Frees <link linkend="BraseroStatus"><type>BraseroStatus</type></link> structure.</para>
82
 
<para>
83
 
</para><variablelist role="params">
84
 
<varlistentry><term><parameter>status</parameter>&#160;:</term>
85
 
<listitem><simpara> a <link linkend="BraseroStatus"><type>BraseroStatus</type></link>.
86
 
</simpara></listitem></varlistentry>
87
 
</variablelist></refsect2>
88
 
<refsect2 id="brasero-status-get-result" role="function">
89
 
<title>brasero_status_get_result ()</title>
90
 
<indexterm zone="brasero-status-get-result"><primary sortas="brasero_status_get_result">brasero_status_get_result</primary></indexterm><programlisting><link linkend="BraseroBurnResult">BraseroBurnResult</link>   brasero_status_get_result           (<link linkend="BraseroStatus">BraseroStatus</link> *status);</programlisting>
91
 
<para>
92
 
After an object (see <link linkend="brasero-burn-track-get-status"><function>brasero_burn_track_get_status()</function></link>) has
93
 
been requested its status, this function returns that status.</para>
94
 
<para>
95
 
</para><variablelist role="params">
96
 
<varlistentry><term><parameter>status</parameter>&#160;:</term>
97
 
<listitem><simpara> a <link linkend="BraseroStatus"><type>BraseroStatus</type></link>.
98
 
</simpara></listitem></varlistentry>
99
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroBurnResult"><type>BraseroBurnResult</type></link>.
100
 
BRASERO_BURN_OK if the object is ready.
101
 
BRASERO_BURN_NOT_READY if some time should be given to the object before it is ready.
102
 
BRASERO_BURN_ERR if there is an error.
103
 
</simpara></listitem></varlistentry>
104
 
</variablelist></refsect2>
105
 
<refsect2 id="brasero-status-get-progress" role="function">
106
 
<title>brasero_status_get_progress ()</title>
107
 
<indexterm zone="brasero-status-get-progress"><primary sortas="brasero_status_get_progress">brasero_status_get_progress</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             brasero_status_get_progress         (<link linkend="BraseroStatus">BraseroStatus</link> *status);</programlisting>
108
 
<para>
109
 
If <link linkend="brasero-status-get-result"><function>brasero_status_get_result()</function></link> returned BRASERO_BURN_NOT_READY,
110
 
this function returns the progress regarding the operation completion.</para>
111
 
<para>
112
 
</para><variablelist role="params">
113
 
<varlistentry><term><parameter>status</parameter>&#160;:</term>
114
 
<listitem><simpara> a <link linkend="BraseroStatus"><type>BraseroStatus</type></link>.
115
 
</simpara></listitem></varlistentry>
116
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="gdouble"><type>gdouble</type></link>
117
 
</simpara></listitem></varlistentry>
118
 
</variablelist></refsect2>
119
 
<refsect2 id="brasero-status-get-error" role="function">
120
 
<title>brasero_status_get_error ()</title>
121
 
<indexterm zone="brasero-status-get-error"><primary sortas="brasero_status_get_error">brasero_status_get_error</primary></indexterm><programlisting><link linkend="GError">GError</link> *            brasero_status_get_error            (<link linkend="BraseroStatus">BraseroStatus</link> *status);</programlisting>
122
 
<para>
123
 
If <link linkend="brasero-status-get-result"><function>brasero_status_get_result()</function></link> returned BRASERO_BURN_ERR,
124
 
this function returns the error.</para>
125
 
<para>
126
 
</para><variablelist role="params">
127
 
<varlistentry><term><parameter>status</parameter>&#160;:</term>
128
 
<listitem><simpara> a <link linkend="BraseroStatus"><type>BraseroStatus</type></link>.
129
 
</simpara></listitem></varlistentry>
130
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GError"><type>GError</type></link>
131
 
</simpara></listitem></varlistentry>
132
 
</variablelist></refsect2>
133
 
<refsect2 id="brasero-status-get-current-action" role="function">
134
 
<title>brasero_status_get_current_action ()</title>
135
 
<indexterm zone="brasero-status-get-current-action"><primary sortas="brasero_status_get_current_action">brasero_status_get_current_action</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             brasero_status_get_current_action   (<link linkend="BraseroStatus">BraseroStatus</link> *status);</programlisting>
136
 
<para>
137
 
If <link linkend="brasero-status-get-result"><function>brasero_status_get_result()</function></link> returned BRASERO_BURN_NOT_READY,
138
 
this function returns a string describing the operation currently performed.
139
 
Free the string when it is not needed anymore.</para>
140
 
<para>
141
 
</para><variablelist role="params">
142
 
<varlistentry><term><parameter>status</parameter>&#160;:</term>
143
 
<listitem><simpara> a <link linkend="BraseroStatus"><type>BraseroStatus</type></link>.
144
 
</simpara></listitem></varlistentry>
145
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="gchar"><type>gchar</type></link>.
146
 
</simpara></listitem></varlistentry>
147
 
</variablelist></refsect2>
148
 
<refsect2 id="brasero-status-set-completed" role="function">
149
 
<title>brasero_status_set_completed ()</title>
150
 
<indexterm zone="brasero-status-set-completed"><primary sortas="brasero_status_set_completed">brasero_status_set_completed</primary></indexterm><programlisting><link linkend="void">void</link>                brasero_status_set_completed        (<link linkend="BraseroStatus">BraseroStatus</link> *status);</programlisting>
151
 
<para>
152
 
Sets the status for a request to BRASERO_BURN_OK.</para>
153
 
<para>
154
 
</para><variablelist role="params">
155
 
<varlistentry><term><parameter>status</parameter>&#160;:</term>
156
 
<listitem><simpara> a <link linkend="BraseroStatus"><type>BraseroStatus</type></link>.
157
 
</simpara></listitem></varlistentry>
158
 
</variablelist></refsect2>
159
 
<refsect2 id="brasero-status-set-not-ready" role="function">
160
 
<title>brasero_status_set_not_ready ()</title>
161
 
<indexterm zone="brasero-status-set-not-ready"><primary sortas="brasero_status_set_not_ready">brasero_status_set_not_ready</primary></indexterm><programlisting><link linkend="void">void</link>                brasero_status_set_not_ready        (<link linkend="BraseroStatus">BraseroStatus</link> *status,
162
 
                                                         <link linkend="gdouble">gdouble</link> progress,
163
 
                                                         const <link linkend="gchar">gchar</link> *current_action);</programlisting>
164
 
<para>
165
 
Sets the status for a request to BRASERO_BURN_NOT_READY.
166
 
Allows to set a string describing the operation currently performed
167
 
as well as the progress regarding the operation completion.</para>
168
 
<para>
169
 
</para><variablelist role="params">
170
 
<varlistentry><term><parameter>status</parameter>&#160;:</term>
171
 
<listitem><simpara> a <link linkend="BraseroStatus"><type>BraseroStatus</type></link>.
172
 
</simpara></listitem></varlistentry>
173
 
<varlistentry><term><parameter>progress</parameter>&#160;:</term>
174
 
<listitem><simpara> a <link linkend="gdouble"><type>gdouble</type></link> or -1.0.
175
 
</simpara></listitem></varlistentry>
176
 
<varlistentry><term><parameter>current_action</parameter>&#160;:</term>
177
 
<listitem><simpara> a <link linkend="gchar"><type>gchar</type></link> or NULL.
178
 
</simpara></listitem></varlistentry>
179
 
</variablelist></refsect2>
180
 
<refsect2 id="brasero-status-set-error" role="function">
181
 
<title>brasero_status_set_error ()</title>
182
 
<indexterm zone="brasero-status-set-error"><primary sortas="brasero_status_set_error">brasero_status_set_error</primary></indexterm><programlisting><link linkend="void">void</link>                brasero_status_set_error            (<link linkend="BraseroStatus">BraseroStatus</link> *status,
183
 
                                                         <link linkend="GError">GError</link> *error);</programlisting>
184
 
<para>
185
 
Sets the status for a request to BRASERO_BURN_ERR.</para>
186
 
<para>
187
 
</para><variablelist role="params">
188
 
<varlistentry><term><parameter>status</parameter>&#160;:</term>
189
 
<listitem><simpara> a <link linkend="BraseroStatus"><type>BraseroStatus</type></link>.
190
 
</simpara></listitem></varlistentry>
191
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
192
 
<listitem><simpara> a <link linkend="GError"><type>GError</type></link> or NULL.
193
 
</simpara></listitem></varlistentry>
194
 
</variablelist></refsect2>
195
 
 
196
 
</refsect1>
197
 
 
198
 
 
199
 
 
200
 
 
201
 
</refentry>