~ubuntu-branches/ubuntu/trusty/glib2.0/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gio/html/GCharsetConverter.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-09 11:28:22 UTC
  • mfrom: (3.4.8 experimental)
  • Revision ID: james.westby@ubuntu.com-20100309112822-j4n0v3xbtsup8s97
Tags: 2.23.5-1ubuntu1
* Resync on Debian
* debian/patches/01_gettext-desktopfiles.patch:
  - updated to use gettext for X-GNOME-Fullname too
* debian/patches/71_gio_launch_handler.patch:
  - new gio default launch handle feature required for wncksync
* debian/control.in, 
  debian/patches/80-gtester-subunit.patch:
  - gtester-report subunit support
* debian/libglib2.0-0.symbols:
  - updated the symbols list for the gio launcher handler
* debian/rules:
  - don't break build on test suite errors, debian recently activated this but
    the build breaks even when there is no error in the testsuite

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GCharsetConverter</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
7
7
<link rel="home" href="index.html" title="GIO Reference Manual">
8
8
<link rel="up" href="conversion.html" title="Data conversion">
9
9
<link rel="prev" href="GConverter.html" title="GConverter">
10
 
<link rel="next" href="gio-GZlibCompressor.html" title="GZlibCompressor">
11
 
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
 
10
<link rel="next" href="GZlibCompressor.html" title="GZlibCompressor">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="pt01.html" title="Part I. GIO Overview">
14
14
<link rel="chapter" href="ch01.html" title="Introduction">
48
48
<td><a accesskey="u" href="conversion.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
49
49
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
50
50
<th width="100%" align="center">GIO Reference Manual</th>
51
 
<td><a accesskey="n" href="gio-GZlibCompressor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
51
<td><a accesskey="n" href="GZlibCompressor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
52
52
</tr>
53
53
<tr><td colspan="5" class="shortcuts">
54
54
<a href="#GCharsetConverter.synopsis" class="shortcut">Top</a>
55
 
                   | 
56
 
                  <a href="#GCharsetConverter.description" class="shortcut">Description</a>
57
 
                   | 
58
 
                  <a href="#GCharsetConverter.object-hierarchy" class="shortcut">Object Hierarchy</a>
59
 
                   | 
60
 
                  <a href="#GCharsetConverter.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
61
 
                   | 
62
 
                  <a href="#GCharsetConverter.properties" class="shortcut">Properties</a>
 
55
                 | 
 
56
                <a href="#GCharsetConverter.description" class="shortcut">Description</a>
 
57
                 | 
 
58
                <a href="#GCharsetConverter.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
59
                 | 
 
60
                <a href="#GCharsetConverter.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
61
                 | 
 
62
                <a href="#GCharsetConverter.properties" class="shortcut">Properties</a>
63
63
</td></tr>
64
64
</table>
65
65
<div class="refentry" title="GCharsetConverter">
74
74
<div class="refsynopsisdiv" title="Synopsis">
75
75
<a name="GCharsetConverter.synopsis"></a><h2>Synopsis</h2>
76
76
<pre class="synopsis">
 
77
 
77
78
#include &lt;gio/gio.h&gt;
78
79
 
79
80
                    <a class="link" href="GCharsetConverter.html#GCharsetConverter-struct" title="GCharsetConverter">GCharsetConverter</a>;
80
 
<a class="link" href="GCharsetConverter.html" title="GCharsetConverter"><span class="returnvalue">GCharsetConverter</span></a> * <a class="link" href="GCharsetConverter.html#g-charset-converter-new" title="g_charset_converter_new ()">g_charset_converter_new</a>             (const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *to_charset,
81
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *from_charset,
82
 
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> **error);
83
 
<span class="returnvalue">void</span>                <a class="link" href="GCharsetConverter.html#g-charset-converter-set-use-fallback" title="g_charset_converter_set_use_fallback ()">g_charset_converter_set_use_fallback</a>
84
 
                                                        (<a class="link" href="GCharsetConverter.html" title="GCharsetConverter"><span class="returnvalue">GCharsetConverter</span></a> *converter,
85
 
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> use_fallback);
86
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GCharsetConverter.html#g-charset-converter-get-use-fallback" title="g_charset_converter_get_use_fallback ()">g_charset_converter_get_use_fallback</a>
87
 
                                                        (<a class="link" href="GCharsetConverter.html" title="GCharsetConverter"><span class="returnvalue">GCharsetConverter</span></a> *converter);
88
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="GCharsetConverter.html#g-charset-converter-get-num-fallbacks" title="g_charset_converter_get_num_fallbacks ()">g_charset_converter_get_num_fallbacks</a>
89
 
                                                        (<a class="link" href="GCharsetConverter.html" title="GCharsetConverter"><span class="returnvalue">GCharsetConverter</span></a> *converter);
 
81
<a class="link" href="GCharsetConverter.html" title="GCharsetConverter">GCharsetConverter</a> * <a class="link" href="GCharsetConverter.html#g-charset-converter-new" title="g_charset_converter_new ()">g_charset_converter_new</a>             (const <a
 
82
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
83
>gchar</a> *to_charset,
 
84
                                                         const <a
 
85
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
86
>gchar</a> *from_charset,
 
87
                                                         <a
 
88
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
89
>GError</a> **error);
 
90
void                <a class="link" href="GCharsetConverter.html#g-charset-converter-set-use-fallback" title="g_charset_converter_set_use_fallback ()">g_charset_converter_set_use_fallback</a>
 
91
                                                        (<a class="link" href="GCharsetConverter.html" title="GCharsetConverter">GCharsetConverter</a> *converter,
 
92
                                                         <a
 
93
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 
94
>gboolean</a> use_fallback);
 
95
<a
 
96
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 
97
>gboolean</a>            <a class="link" href="GCharsetConverter.html#g-charset-converter-get-use-fallback" title="g_charset_converter_get_use_fallback ()">g_charset_converter_get_use_fallback</a>
 
98
                                                        (<a class="link" href="GCharsetConverter.html" title="GCharsetConverter">GCharsetConverter</a> *converter);
 
99
<a
 
100
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
 
101
>guint</a>               <a class="link" href="GCharsetConverter.html#g-charset-converter-get-num-fallbacks" title="g_charset_converter_get_num_fallbacks ()">g_charset_converter_get_num_fallbacks</a>
 
102
                                                        (<a class="link" href="GCharsetConverter.html" title="GCharsetConverter">GCharsetConverter</a> *converter);
90
103
</pre>
91
104
</div>
92
105
<div class="refsect1" title="Object Hierarchy">
93
106
<a name="GCharsetConverter.object-hierarchy"></a><h2>Object Hierarchy</h2>
94
107
<pre class="synopsis">
95
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
108
  GObject
96
109
   +----GCharsetConverter
97
110
</pre>
98
111
</div>
105
118
<div class="refsect1" title="Properties">
106
119
<a name="GCharsetConverter.properties"></a><h2>Properties</h2>
107
120
<pre class="synopsis">
108
 
  "<a class="link" href="GCharsetConverter.html#GCharsetConverter--from-charset" title='The "from-charset" property'>from-charset</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
109
 
  "<a class="link" href="GCharsetConverter.html#GCharsetConverter--to-charset" title='The "to-charset" property'>to-charset</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
110
 
  "<a class="link" href="GCharsetConverter.html#GCharsetConverter--use-fallback" title='The "use-fallback" property'>use-fallback</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
 
121
  "<a class="link" href="GCharsetConverter.html#GCharsetConverter--from-charset" title='The "from-charset" property'>from-charset</a>"             <a
 
122
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
123
>gchar</a>*                : Read / Write / Construct Only
 
124
  "<a class="link" href="GCharsetConverter.html#GCharsetConverter--to-charset" title='The "to-charset" property'>to-charset</a>"               <a
 
125
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
126
>gchar</a>*                : Read / Write / Construct Only
 
127
  "<a class="link" href="GCharsetConverter.html#GCharsetConverter--use-fallback" title='The "use-fallback" property'>use-fallback</a>"             <a
 
128
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 
129
>gboolean</a>              : Read / Write / Construct
111
130
</pre>
112
131
</div>
113
132
<div class="refsect1" title="Description">
115
134
<p>
116
135
<a class="link" href="GCharsetConverter.html" title="GCharsetConverter"><span class="type">GCharsetConverter</span></a> is an implementation of <a class="link" href="GConverter.html" title="GConverter"><span class="type">GConverter</span></a> based on
117
136
GIConv.</p>
 
137
<p>
 
138
</p>
118
139
</div>
119
140
<div class="refsect1" title="Details">
120
141
<a name="GCharsetConverter.details"></a><h2>Details</h2>
123
144
<pre class="programlisting">typedef struct _GCharsetConverter GCharsetConverter;</pre>
124
145
<p>
125
146
Conversions between character sets.</p>
 
147
<p>
 
148
</p>
126
149
</div>
127
150
<hr>
128
151
<div class="refsect2" title="g_charset_converter_new ()">
129
152
<a name="g-charset-converter-new"></a><h3>g_charset_converter_new ()</h3>
130
 
<pre class="programlisting"><a class="link" href="GCharsetConverter.html" title="GCharsetConverter"><span class="returnvalue">GCharsetConverter</span></a> * g_charset_converter_new             (const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *to_charset,
131
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *from_charset,
132
 
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> **error);</pre>
 
153
<pre class="programlisting"><a class="link" href="GCharsetConverter.html" title="GCharsetConverter">GCharsetConverter</a> * g_charset_converter_new             (const <a
 
154
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
155
>gchar</a> *to_charset,
 
156
                                                         const <a
 
157
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
158
>gchar</a> *from_charset,
 
159
                                                         <a
 
160
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
161
>GError</a> **error);</pre>
133
162
<p>
134
163
Creates a new <a class="link" href="GCharsetConverter.html" title="GCharsetConverter"><span class="type">GCharsetConverter</span></a>.</p>
 
164
<p>
 
165
</p>
135
166
<div class="variablelist"><table border="0">
136
167
<col align="left" valign="top">
137
168
<tbody>
147
178
</tr>
148
179
<tr>
149
180
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
150
 
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.
 
181
<td> <a
 
182
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
183
><span class="type">GError</span></a> for error reporting, or <a
 
184
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
185
><code class="literal">NULL</code></a> to ignore.
151
186
</td>
152
187
</tr>
153
188
<tr>
154
189
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
155
 
<td> a new <a class="link" href="GCharsetConverter.html" title="GCharsetConverter"><span class="type">GCharsetConverter</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.
 
190
<td> a new <a class="link" href="GCharsetConverter.html" title="GCharsetConverter"><span class="type">GCharsetConverter</span></a> or <a
 
191
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
192
><code class="literal">NULL</code></a> on error.
156
193
 
157
194
</td>
158
195
</tr>
163
200
<hr>
164
201
<div class="refsect2" title="g_charset_converter_set_use_fallback ()">
165
202
<a name="g-charset-converter-set-use-fallback"></a><h3>g_charset_converter_set_use_fallback ()</h3>
166
 
<pre class="programlisting"><span class="returnvalue">void</span>                g_charset_converter_set_use_fallback
167
 
                                                        (<a class="link" href="GCharsetConverter.html" title="GCharsetConverter"><span class="returnvalue">GCharsetConverter</span></a> *converter,
168
 
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> use_fallback);</pre>
 
203
<pre class="programlisting">void                g_charset_converter_set_use_fallback
 
204
                                                        (<a class="link" href="GCharsetConverter.html" title="GCharsetConverter">GCharsetConverter</a> *converter,
 
205
                                                         <a
 
206
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 
207
>gboolean</a> use_fallback);</pre>
169
208
<p>
170
209
Sets the <a class="link" href="GCharsetConverter.html#GCharsetConverter--use-fallback" title='The "use-fallback" property'><span class="type">"use-fallback"</span></a> property.</p>
 
210
<p>
 
211
</p>
171
212
<div class="variablelist"><table border="0">
172
213
<col align="left" valign="top">
173
214
<tbody>
178
219
</tr>
179
220
<tr>
180
221
<td><p><span class="term"><em class="parameter"><code>use_fallback</code></em> :</span></p></td>
181
 
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to use fallbacks
 
222
<td> <a
 
223
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
224
><code class="literal">TRUE</code></a> to use fallbacks
182
225
</td>
183
226
</tr>
184
227
</tbody>
188
231
<hr>
189
232
<div class="refsect2" title="g_charset_converter_get_use_fallback ()">
190
233
<a name="g-charset-converter-get-use-fallback"></a><h3>g_charset_converter_get_use_fallback ()</h3>
191
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_charset_converter_get_use_fallback
192
 
                                                        (<a class="link" href="GCharsetConverter.html" title="GCharsetConverter"><span class="returnvalue">GCharsetConverter</span></a> *converter);</pre>
 
234
<pre class="programlisting"><a
 
235
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 
236
>gboolean</a>            g_charset_converter_get_use_fallback
 
237
                                                        (<a class="link" href="GCharsetConverter.html" title="GCharsetConverter">GCharsetConverter</a> *converter);</pre>
193
238
<p>
194
239
Gets the <a class="link" href="GCharsetConverter.html#GCharsetConverter--use-fallback" title='The "use-fallback" property'><span class="type">"use-fallback"</span></a> property.</p>
 
240
<p>
 
241
</p>
195
242
<div class="variablelist"><table border="0">
196
243
<col align="left" valign="top">
197
244
<tbody>
202
249
</tr>
203
250
<tr>
204
251
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
205
 
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if fallbacks are used by <em class="parameter"><code>converter</code></em>
 
252
<td> <a
 
253
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
254
><code class="literal">TRUE</code></a> if fallbacks are used by <em class="parameter"><code>converter</code></em>
206
255
 
207
256
</td>
208
257
</tr>
213
262
<hr>
214
263
<div class="refsect2" title="g_charset_converter_get_num_fallbacks ()">
215
264
<a name="g-charset-converter-get-num-fallbacks"></a><h3>g_charset_converter_get_num_fallbacks ()</h3>
216
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               g_charset_converter_get_num_fallbacks
217
 
                                                        (<a class="link" href="GCharsetConverter.html" title="GCharsetConverter"><span class="returnvalue">GCharsetConverter</span></a> *converter);</pre>
 
265
<pre class="programlisting"><a
 
266
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
 
267
>guint</a>               g_charset_converter_get_num_fallbacks
 
268
                                                        (<a class="link" href="GCharsetConverter.html" title="GCharsetConverter">GCharsetConverter</a> *converter);</pre>
218
269
<p>
219
270
Gets the number of fallbacks that <em class="parameter"><code>converter</code></em> has applied so far.</p>
 
271
<p>
 
272
</p>
220
273
<div class="variablelist"><table border="0">
221
274
<col align="left" valign="top">
222
275
<tbody>
240
293
<a name="GCharsetConverter.property-details"></a><h2>Property Details</h2>
241
294
<div class="refsect2" title='The "from-charset" property'>
242
295
<a name="GCharsetConverter--from-charset"></a><h3>The <code class="literal">"from-charset"</code> property</h3>
243
 
<pre class="programlisting">  "from-charset"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
296
<pre class="programlisting">  "from-charset"             <a
 
297
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
298
>gchar</a>*                : Read / Write / Construct Only</pre>
244
299
<p>The character encoding to convert from.</p>
245
300
<p>Default value: NULL</p>
246
301
</div>
247
302
<hr>
248
303
<div class="refsect2" title='The "to-charset" property'>
249
304
<a name="GCharsetConverter--to-charset"></a><h3>The <code class="literal">"to-charset"</code> property</h3>
250
 
<pre class="programlisting">  "to-charset"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
305
<pre class="programlisting">  "to-charset"               <a
 
306
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
307
>gchar</a>*                : Read / Write / Construct Only</pre>
251
308
<p>The character encoding to convert to.</p>
252
309
<p>Default value: NULL</p>
253
310
</div>
254
311
<hr>
255
312
<div class="refsect2" title='The "use-fallback" property'>
256
313
<a name="GCharsetConverter--use-fallback"></a><h3>The <code class="literal">"use-fallback"</code> property</h3>
257
 
<pre class="programlisting">  "use-fallback"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
 
314
<pre class="programlisting">  "use-fallback"             <a
 
315
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 
316
>gboolean</a>              : Read / Write / Construct</pre>
258
317
<p>Use fallback (of form \&lt;hexval&gt;) for invalid bytes.</p>
259
318
<p>Default value: FALSE</p>
260
319
</div>
262
321
</div>
263
322
<div class="footer">
264
323
<hr>
265
 
          Generated by GTK-Doc V1.13</div>
 
324
          Generated by GTK-Doc V1.11</div>
266
325
</body>
267
 
</html>
 
 
b'\\ No newline at end of file'
 
326
</html>