← Back to branch summary

~ubuntu-branches/ubuntu/karmic/libgsf/karmic

« back to all changes in this revision

Viewing changes to doc/html/gsf-Text.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2006-06-30 15:46:51 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20060630154651-3wyy7y8c2zj7l5e0
Tags: 1.14.1-2ubuntu1
* Sync with Debian:
  Remaining Ubuntu Changes
  + Call intltool-update -p at build time to get a .pot file 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/gsf-Text.html
8
8
<link rel="up" href="parsers.html" title="Stream Parsers">
9
9
<link rel="prev" href="parsers.html" title="Stream Parsers">
10
10
<link rel="next" href="gsf-XML-and-libxml.html" title="XML and libxml">
11
 
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="intro.html" title="Part&#160;I.&#160;GSF: Introduction">
14
14
<link rel="part" href="history.html" title="Part&#160;II.&#160;GSF: History">
117
117
<div class="refsect1" lang="en">
118
118
<a name="details"></a><h2>Details</h2>
119
119
<div class="refsect2" lang="en">
120
 
<a name="id2540289"></a><h3>
 
120
<a name="id2542622"></a><h3>
121
121
<a name="GsfInputTextline-struct"></a>GsfInputTextline</h3>
122
 
<a class="indexterm" name="id2540302"></a><pre class="programlisting">typedef struct _GsfInputTextline GsfInputTextline;</pre>
 
122
<a class="indexterm" name="id2542634"></a><pre class="programlisting">typedef struct _GsfInputTextline GsfInputTextline;</pre>
123
123
<p>
124
124
 
125
125
</p>
126
126
</div>
127
127
<hr>
128
128
<div class="refsect2" lang="en">
129
 
<a name="id2540317"></a><h3>
 
129
<a name="id2542649"></a><h3>
130
130
<a name="gsf-input-textline-new"></a>gsf_input_textline_new ()</h3>
131
 
<a class="indexterm" name="id2540329"></a><pre class="programlisting"><a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>*   gsf_input_textline_new          (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *source);</pre>
 
131
<a class="indexterm" name="id2542662"></a><pre class="programlisting"><a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>*   gsf_input_textline_new          (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *source);</pre>
132
132
<p>
133
133
</p>
134
134
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
156
156
</div>
157
157
<hr>
158
158
<div class="refsect2" lang="en">
159
 
<a name="id2540398"></a><h3>
 
159
<a name="id2542731"></a><h3>
160
160
<a name="gsf-input-textline-ascii-gets"></a>gsf_input_textline_ascii_gets ()</h3>
161
 
<a class="indexterm" name="id2540412"></a><pre class="programlisting">unsigned char* gsf_input_textline_ascii_gets
 
161
<a class="indexterm" name="id2542744"></a><pre class="programlisting">unsigned char* gsf_input_textline_ascii_gets
162
162
                                            (<a href="gsf-Text.html#GsfInputTextline">GsfInputTextline</a> *textline);</pre>
163
163
<p>
164
164
A utility routine to read things line by line from the underlying source.
187
187
</div>
188
188
<hr>
189
189
<div class="refsect2" lang="en">
190
 
<a name="id2540485"></a><h3>
 
190
<a name="id2542818"></a><h3>
191
191
<a name="gsf-input-textline-utf8-gets"></a>gsf_input_textline_utf8_gets ()</h3>
192
 
<a class="indexterm" name="id2540498"></a><pre class="programlisting">guint8*     gsf_input_textline_utf8_gets    (<a href="gsf-Text.html#GsfInputTextline">GsfInputTextline</a> *textline);</pre>
 
192
<a class="indexterm" name="id2542831"></a><pre class="programlisting">guint8*     gsf_input_textline_utf8_gets    (<a href="gsf-Text.html#GsfInputTextline">GsfInputTextline</a> *textline);</pre>
193
193
<p>
194
194
A utility routine to read things line by line from the underlying source.
195
195
Trailing newlines and carriage returns are stripped, and the resultant buffer
217
217
</div>
218
218
<hr>
219
219
<div class="refsect2" lang="en">
220
 
<a name="id2540570"></a><h3>
 
220
<a name="id2542902"></a><h3>
221
221
<a name="GsfOutputIconv-struct"></a>GsfOutputIconv</h3>
222
 
<a class="indexterm" name="id2540583"></a><pre class="programlisting">typedef struct _GsfOutputIconv GsfOutputIconv;</pre>
 
222
<a class="indexterm" name="id2542916"></a><pre class="programlisting">typedef struct _GsfOutputIconv GsfOutputIconv;</pre>
223
223
<p>
224
224
 
225
225
</p>
226
226
</div>
227
227
<hr>
228
228
<div class="refsect2" lang="en">
229
 
<a name="id2540599"></a><h3>
 
229
<a name="id2542931"></a><h3>
230
230
<a name="gsf-output-iconv-new"></a>gsf_output_iconv_new ()</h3>
231
 
<a class="indexterm" name="id2540611"></a><pre class="programlisting"><a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>*  gsf_output_iconv_new            (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *sink,
 
231
<a class="indexterm" name="id2542944"></a><pre class="programlisting"><a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>*  gsf_output_iconv_new            (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *sink,
232
232
                                             char const *dst,
233
233
                                             char const *src);</pre>
234
234
<p>
268
268
</div>
269
269
<hr>
270
270
<div class="refsect2" lang="en">
271
 
<a name="id2540721"></a><h3>
 
271
<a name="id2543054"></a><h3>
272
272
<a name="GsfOutputCsv-struct"></a>GsfOutputCsv</h3>
273
 
<a class="indexterm" name="id2540734"></a><pre class="programlisting">typedef struct _GsfOutputCsv GsfOutputCsv;</pre>
 
273
<a class="indexterm" name="id2543066"></a><pre class="programlisting">typedef struct _GsfOutputCsv GsfOutputCsv;</pre>
274
274
<p>
275
275
 
276
276
</p>
277
277
</div>
278
278
<hr>
279
279
<div class="refsect2" lang="en">
280
 
<a name="id2540749"></a><h3>
 
280
<a name="id2543081"></a><h3>
281
281
<a name="gsf-output-csv-write-eol"></a>gsf_output_csv_write_eol ()</h3>
282
 
<a class="indexterm" name="id2540762"></a><pre class="programlisting">gboolean    gsf_output_csv_write_eol        (<a href="gsf-Text.html#GsfOutputCsv">GsfOutputCsv</a> *csv);</pre>
 
282
<a class="indexterm" name="id2543094"></a><pre class="programlisting">gboolean    gsf_output_csv_write_eol        (<a href="gsf-Text.html#GsfOutputCsv">GsfOutputCsv</a> *csv);</pre>
283
283
<p>
284
284
 
285
285
</p>
305
305
</div>
306
306
<hr>
307
307
<div class="refsect2" lang="en">
308
 
<a name="id2540818"></a><h3>
 
308
<a name="id2543150"></a><h3>
309
309
<a name="gsf-output-csv-write-field"></a>gsf_output_csv_write_field ()</h3>
310
 
<a class="indexterm" name="id2540832"></a><pre class="programlisting">gboolean    gsf_output_csv_write_field      (<a href="gsf-Text.html#GsfOutputCsv">GsfOutputCsv</a> *csv,
 
310
<a class="indexterm" name="id2543164"></a><pre class="programlisting">gboolean    gsf_output_csv_write_field      (<a href="gsf-Text.html#GsfOutputCsv">GsfOutputCsv</a> *csv,
311
311
                                             char const *field,
312
312
                                             size_t len);</pre>
313
313
<p>
347
347
</div>
348
348
<hr>
349
349
<div class="refsect2" lang="en">
350
 
<a name="id2540931"></a><h3>
 
350
<a name="id2543263"></a><h3>
351
351
<a name="GsfOutputCsvQuotingMode"></a>enum GsfOutputCsvQuotingMode</h3>
352
 
<a class="indexterm" name="id2540945"></a><pre class="programlisting">typedef enum {
 
352
<a class="indexterm" name="id2543277"></a><pre class="programlisting">typedef enum {
353
353
        GSF_OUTPUT_CSV_QUOTING_MODE_NEVER,
354
354
        GSF_OUTPUT_CSV_QUOTING_MODE_AUTO,
355
355
        GSF_OUTPUT_CSV_QUOTING_MODE_ALWAYS
363
363
<div class="refsect1" lang="en">
364
364
<a name="property_details"></a><h2>Property Details</h2>
365
365
<div class="refsect2" lang="en">
366
 
<a name="id2540975"></a><h3>
 
366
<a name="id2543308"></a><h3>
367
367
<a name="GsfOutputIconv--fallback"></a>The "<code class="literal">fallback</code>" property</h3>
368
 
<pre class="programlisting">  "fallback"             gchararray            : Read / Write</pre>
 
368
<a class="indexterm" name="id2543322"></a><pre class="programlisting">  "fallback"             gchararray            : Read / Write</pre>
369
369
<p>
370
370
Either NULL or a UTF-8 string (representable in the target encoding)
371
371
to convert and output in place of characters that cannot be represented
377
377
</div>
378
378
<hr>
379
379
<div class="refsect2" lang="en">
380
 
<a name="id2541016"></a><h3>
 
380
<a name="id2543355"></a><h3>
381
381
<a name="GsfOutputIconv--input-charset"></a>The "<code class="literal">input-charset</code>" property</h3>
382
 
<pre class="programlisting">  "input-charset"        gchararray            : Read / Write / Construct Only</pre>
 
382
<a class="indexterm" name="id2543372"></a><pre class="programlisting">  "input-charset"        gchararray            : Read / Write / Construct Only</pre>
383
383
<p>The character set to convert from.</p>
384
384
<p>Default value: "UTF-8"</p>
385
385
</div>
386
386
<hr>
387
387
<div class="refsect2" lang="en">
388
 
<a name="id2541054"></a><h3>
 
388
<a name="id2543399"></a><h3>
389
389
<a name="GsfOutputIconv--output-charset"></a>The "<code class="literal">output-charset</code>" property</h3>
390
 
<pre class="programlisting">  "output-charset"       gchararray            : Read / Write / Construct Only</pre>
 
390
<a class="indexterm" name="id2543416"></a><pre class="programlisting">  "output-charset"       gchararray            : Read / Write / Construct Only</pre>
391
391
<p>The character set to convert to.</p>
392
392
<p>Default value: "UTF-8"</p>
393
393
</div>
394
394
<hr>
395
395
<div class="refsect2" lang="en">
396
 
<a name="id2541092"></a><h3>
 
396
<a name="id2543443"></a><h3>
397
397
<a name="GsfOutputIconv--sink"></a>The "<code class="literal">sink</code>" property</h3>
398
 
<pre class="programlisting">  "sink"                 <a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>             : Read / Write / Construct Only</pre>
 
398
<a class="indexterm" name="id2543459"></a><pre class="programlisting">  "sink"                 <a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>             : Read / Write / Construct Only</pre>
399
399
<p>Where the converted data is written.</p>
400
400
</div>
401
401
<hr>
402
402
<div class="refsect2" lang="en">
403
 
<a name="id2541127"></a><h3>
 
403
<a name="id2543484"></a><h3>
404
404
<a name="GsfOutputCsv--eol"></a>The "<code class="literal">eol</code>" property</h3>
405
 
<pre class="programlisting">  "eol"                  gchararray            : Read / Write / Construct</pre>
 
405
<a class="indexterm" name="id2543498"></a><pre class="programlisting">  "eol"                  gchararray            : Read / Write / Construct</pre>
406
406
<p>The end-of-line marker.</p>
407
407
<p>Default value: "\n"</p>
408
408
</div>
409
409
<hr>
410
410
<div class="refsect2" lang="en">
411
 
<a name="id2541163"></a><h3>
 
411
<a name="id2543525"></a><h3>
412
412
<a name="GsfOutputCsv--quote"></a>The "<code class="literal">quote</code>" property</h3>
413
 
<pre class="programlisting">  "quote"                gchararray            : Read / Write / Construct</pre>
 
413
<a class="indexterm" name="id2543541"></a><pre class="programlisting">  "quote"                gchararray            : Read / Write / Construct</pre>
414
414
<p>The string used for quoting fields.</p>
415
415
<p>Default value: "\""</p>
416
416
</div>
417
417
<hr>
418
418
<div class="refsect2" lang="en">
419
 
<a name="id2541199"></a><h3>
 
419
<a name="id2543567"></a><h3>
420
420
<a name="GsfOutputCsv--quoting-mode"></a>The "<code class="literal">quoting-mode</code>" property</h3>
421
 
<pre class="programlisting">  "quoting-mode"         <a href="gsf-Text.html#GsfOutputCsvQuotingMode">GsfOutputCsvQuotingMode</a>  : Read / Write / Construct</pre>
 
421
<a class="indexterm" name="id2543583"></a><pre class="programlisting">  "quoting-mode"         <a href="gsf-Text.html#GsfOutputCsvQuotingMode">GsfOutputCsvQuotingMode</a>  : Read / Write / Construct</pre>
422
422
<p>When to quote fields.</p>
423
423
<p>Default value: GSF_OUTPUT_CSV_QUOTING_MODE_NEVER</p>
424
424
</div>
425
425
<hr>
426
426
<div class="refsect2" lang="en">
427
 
<a name="id2541237"></a><h3>
 
427
<a name="id2543611"></a><h3>
428
428
<a name="GsfOutputCsv--quoting-triggers"></a>The "<code class="literal">quoting-triggers</code>" property</h3>
429
 
<pre class="programlisting">  "quoting-triggers"     gchararray            : Read / Write</pre>
 
429
<a class="indexterm" name="id2543628"></a><pre class="programlisting">  "quoting-triggers"     gchararray            : Read / Write</pre>
430
430
<p>Characters that cause field quoting.</p>
431
431
<p>Default value: NULL</p>
432
432
</div>
433
433
<hr>
434
434
<div class="refsect2" lang="en">
435
 
<a name="id2541275"></a><h3>
 
435
<a name="id2543655"></a><h3>
436
436
<a name="GsfOutputCsv--separator"></a>The "<code class="literal">separator</code>" property</h3>
437
 
<pre class="programlisting">  "separator"            gchararray            : Read / Write / Construct</pre>
 
437
<a class="indexterm" name="id2543671"></a><pre class="programlisting">  "separator"            gchararray            : Read / Write / Construct</pre>
438
438
<p>The field separator.</p>
439
439
<p>Default value: ","</p>
440
440
</div>
441
441
<hr>
442
442
<div class="refsect2" lang="en">
443
 
<a name="id2541312"></a><h3>
 
443
<a name="id2543698"></a><h3>
444
444
<a name="GsfOutputCsv--sink"></a>The "<code class="literal">sink</code>" property</h3>
445
 
<pre class="programlisting">  "sink"                 <a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>             : Read / Write</pre>
 
445
<a class="indexterm" name="id2543713"></a><pre class="programlisting">  "sink"                 <a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>             : Read / Write</pre>
446
446
<p>Where the compressed data is written.</p>
447
447
</div>
448
448
</div>