| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>Text: GSF Reference Manual</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> |
| 7 |
<link rel="home" href="index.html" title="GSF Reference Manual"> |
| 8 |
<link rel="up" href="parsers.html" title="Stream Parsers"> |
| 9 |
<link rel="prev" href="parsers.html" title="Stream Parsers"> |
| 10 |
<link rel="next" href="gsf-XML-and-libxml.html" title="XML and libxml"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.34.0 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 14 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 15 |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| 16 |
<td width="100%" align="left" class="shortcuts"> |
| 17 |
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| 18 |
<a href="#gsf-Text.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| 19 |
<a href="#gsf-Text.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> |
| 20 |
<a href="#gsf-Text.properties" class="shortcut">Properties</a></span> |
| 21 |
</td> |
| 22 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 23 |
<td><a accesskey="u" href="parsers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| 24 |
<td><a accesskey="p" href="parsers.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 25 |
<td><a accesskey="n" href="gsf-XML-and-libxml.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 26 |
</tr></table> |
| 27 |
<div class="refentry"> |
| 28 |
<a name="gsf-Text"></a><div class="titlepage"></div> |
| 29 |
<div class="refnamediv"><table width="100%"><tr> |
| 30 |
<td valign="top"> |
| 31 |
<h2><span class="refentrytitle"><a name="gsf-Text.top_of_page"></a>Text</span></h2> |
| 32 |
<p>Text</p> |
| 33 |
</td> |
| 34 |
<td class="gallery_image" valign="top" align="right"></td> |
| 35 |
</tr></table></div> |
| 36 |
<div class="refsect1"> |
| 37 |
<a name="gsf-Text.functions"></a><h2>Functions</h2> |
| 38 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 39 |
<colgroup> |
| 40 |
<col width="150px" class="functions_proto_type"> |
| 41 |
<col class="functions_proto_name"> |
| 42 |
</colgroup> |
| 43 |
<tbody> |
| 44 |
<tr> |
| 45 |
<td class="function_type"> |
| 46 |
<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * |
| 47 |
</td> |
| 48 |
<td class="function_name"> |
| 49 |
<a class="link" href="gsf-Text.html#gsf-input-textline-new" title="gsf_input_textline_new ()">gsf_input_textline_new</a> <span class="c_punctuation">()</span> |
| 50 |
</td> |
| 51 |
</tr> |
| 52 |
<tr> |
| 53 |
<td class="function_type">unsigned <span class="returnvalue">char</span> * |
| 54 |
</td> |
| 55 |
<td class="function_name"> |
| 56 |
<a class="link" href="gsf-Text.html#gsf-input-textline-ascii-gets" title="gsf_input_textline_ascii_gets ()">gsf_input_textline_ascii_gets</a> <span class="c_punctuation">()</span> |
| 57 |
</td> |
| 58 |
</tr> |
| 59 |
<tr> |
| 60 |
<td class="function_type"> |
| 61 |
<span class="returnvalue">guint8</span> * |
| 62 |
</td> |
| 63 |
<td class="function_name"> |
| 64 |
<a class="link" href="gsf-Text.html#gsf-input-textline-utf8-gets" title="gsf_input_textline_utf8_gets ()">gsf_input_textline_utf8_gets</a> <span class="c_punctuation">()</span> |
| 65 |
</td> |
| 66 |
</tr> |
| 67 |
<tr> |
| 68 |
<td class="function_type"> |
| 69 |
<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> * |
| 70 |
</td> |
| 71 |
<td class="function_name"> |
| 72 |
<a class="link" href="gsf-Text.html#gsf-output-iconv-new" title="gsf_output_iconv_new ()">gsf_output_iconv_new</a> <span class="c_punctuation">()</span> |
| 73 |
</td> |
| 74 |
</tr> |
| 75 |
<tr> |
| 76 |
<td class="function_type"> |
| 77 |
<span class="returnvalue">gboolean</span> |
| 78 |
</td> |
| 79 |
<td class="function_name"> |
| 80 |
<a class="link" href="gsf-Text.html#gsf-output-csv-write-eol" title="gsf_output_csv_write_eol ()">gsf_output_csv_write_eol</a> <span class="c_punctuation">()</span> |
| 81 |
</td> |
| 82 |
</tr> |
| 83 |
<tr> |
| 84 |
<td class="function_type"> |
| 85 |
<span class="returnvalue">gboolean</span> |
| 86 |
</td> |
| 87 |
<td class="function_name"> |
| 88 |
<a class="link" href="gsf-Text.html#gsf-output-csv-write-field" title="gsf_output_csv_write_field ()">gsf_output_csv_write_field</a> <span class="c_punctuation">()</span> |
| 89 |
</td> |
| 90 |
</tr> |
| 91 |
</tbody> |
| 92 |
</table></div> |
| 93 |
</div> |
| 94 |
<div class="refsect1"> |
| 95 |
<a name="gsf-Text.properties"></a><h2>Properties</h2> |
| 96 |
<div class="informaltable"><table class="informaltable" border="0"> |
| 97 |
<colgroup> |
| 98 |
<col width="150px" class="properties_type"> |
| 99 |
<col width="300px" class="properties_name"> |
| 100 |
<col width="200px" class="properties_flags"> |
| 101 |
</colgroup> |
| 102 |
<tbody> |
| 103 |
<tr> |
| 104 |
<td class="property_type"> |
| 105 |
<span class="type">char</span> *</td> |
| 106 |
<td class="property_name"><a class="link" href="gsf-Text.html#GsfOutputIconv--fallback" title="The “fallback” property">fallback</a></td> |
| 107 |
<td class="property_flags">Read / Write</td> |
| 108 |
</tr> |
| 109 |
<tr> |
| 110 |
<td class="property_type"> |
| 111 |
<span class="type">char</span> *</td> |
| 112 |
<td class="property_name"><a class="link" href="gsf-Text.html#GsfOutputIconv--input-charset" title="The “input-charset” property">input-charset</a></td> |
| 113 |
<td class="property_flags">Read / Write / Construct Only</td> |
| 114 |
</tr> |
| 115 |
<tr> |
| 116 |
<td class="property_type"> |
| 117 |
<span class="type">char</span> *</td> |
| 118 |
<td class="property_name"><a class="link" href="gsf-Text.html#GsfOutputIconv--output-charset" title="The “output-charset” property">output-charset</a></td> |
| 119 |
<td class="property_flags">Read / Write / Construct Only</td> |
| 120 |
</tr> |
| 121 |
<tr> |
| 122 |
<td class="property_type"> |
| 123 |
<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</td> |
| 124 |
<td class="property_name"><a class="link" href="gsf-Text.html#GsfOutputIconv--sink" title="The “sink” property">sink</a></td> |
| 125 |
<td class="property_flags">Read / Write / Construct Only</td> |
| 126 |
</tr> |
| 127 |
<tr> |
| 128 |
<td class="property_type"> |
| 129 |
<span class="type">char</span> *</td> |
| 130 |
<td class="property_name"><a class="link" href="gsf-Text.html#GsfOutputCsv--eol" title="The “eol” property">eol</a></td> |
| 131 |
<td class="property_flags">Read / Write / Construct</td> |
| 132 |
</tr> |
| 133 |
<tr> |
| 134 |
<td class="property_type"> |
| 135 |
<span class="type">char</span> *</td> |
| 136 |
<td class="property_name"><a class="link" href="gsf-Text.html#GsfOutputCsv--quote" title="The “quote” property">quote</a></td> |
| 137 |
<td class="property_flags">Read / Write / Construct</td> |
| 138 |
</tr> |
| 139 |
<tr> |
| 140 |
<td class="property_type"><a class="link" href="gsf-Text.html#GsfOutputCsvQuotingMode" title="enum GsfOutputCsvQuotingMode"><span class="type">GsfOutputCsvQuotingMode</span></a></td> |
| 141 |
<td class="property_name"><a class="link" href="gsf-Text.html#GsfOutputCsv--quoting-mode" title="The “quoting-mode” property">quoting-mode</a></td> |
| 142 |
<td class="property_flags">Read / Write / Construct</td> |
| 143 |
</tr> |
| 144 |
<tr> |
| 145 |
<td class="property_type"><span class="type">gboolean</span></td> |
| 146 |
<td class="property_name"><a class="link" href="gsf-Text.html#GsfOutputCsv--quoting-on-whitespace" title="The “quoting-on-whitespace” property">quoting-on-whitespace</a></td> |
| 147 |
<td class="property_flags">Read / Write</td> |
| 148 |
</tr> |
| 149 |
<tr> |
| 150 |
<td class="property_type"> |
| 151 |
<span class="type">char</span> *</td> |
| 152 |
<td class="property_name"><a class="link" href="gsf-Text.html#GsfOutputCsv--quoting-triggers" title="The “quoting-triggers” property">quoting-triggers</a></td> |
| 153 |
<td class="property_flags">Read / Write</td> |
| 154 |
</tr> |
| 155 |
<tr> |
| 156 |
<td class="property_type"> |
| 157 |
<span class="type">char</span> *</td> |
| 158 |
<td class="property_name"><a class="link" href="gsf-Text.html#GsfOutputCsv--separator" title="The “separator” property">separator</a></td> |
| 159 |
<td class="property_flags">Read / Write / Construct</td> |
| 160 |
</tr> |
| 161 |
<tr> |
| 162 |
<td class="property_type"> |
| 163 |
<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</td> |
| 164 |
<td class="property_name"><a class="link" href="gsf-Text.html#GsfOutputCsv--sink" title="The “sink” property">sink</a></td> |
| 165 |
<td class="property_flags">Read / Write</td> |
| 166 |
</tr> |
| 167 |
</tbody> |
| 168 |
</table></div> |
| 169 |
</div> |
| 170 |
<a name="GsfInputTextline"></a><a name="GsfOutputIconv"></a><a name="GsfOutputCsv"></a><div class="refsect1"> |
| 171 |
<a name="gsf-Text.other"></a><h2>Types and Values</h2> |
| 172 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 173 |
<colgroup> |
| 174 |
<col width="150px" class="other_proto_type"> |
| 175 |
<col class="other_proto_name"> |
| 176 |
</colgroup> |
| 177 |
<tbody> |
| 178 |
<tr> |
| 179 |
<td class="datatype_keyword"> </td> |
| 180 |
<td class="function_name"><a class="link" href="gsf-Text.html#GsfInputTextline-struct" title="GsfInputTextline">GsfInputTextline</a></td> |
| 181 |
</tr> |
| 182 |
<tr> |
| 183 |
<td class="datatype_keyword"> </td> |
| 184 |
<td class="function_name"><a class="link" href="gsf-Text.html#GsfOutputIconv-struct" title="GsfOutputIconv">GsfOutputIconv</a></td> |
| 185 |
</tr> |
| 186 |
<tr> |
| 187 |
<td class="datatype_keyword"> </td> |
| 188 |
<td class="function_name"><a class="link" href="gsf-Text.html#GsfOutputCsv-struct" title="GsfOutputCsv">GsfOutputCsv</a></td> |
| 189 |
</tr> |
| 190 |
<tr> |
| 191 |
<td class="datatype_keyword">enum</td> |
| 192 |
<td class="function_name"><a class="link" href="gsf-Text.html#GsfOutputCsvQuotingMode" title="enum GsfOutputCsvQuotingMode">GsfOutputCsvQuotingMode</a></td> |
| 193 |
</tr> |
| 194 |
</tbody> |
| 195 |
</table></div> |
| 196 |
</div> |
| 197 |
<div class="refsect1"> |
| 198 |
<a name="gsf-Text.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| 199 |
<pre class="screen"> GObject |
| 200 |
<span class="lineart">├──</span> <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> |
| 201 |
<span class="lineart">│</span> <span class="lineart">╰──</span> GsfInputTextline |
| 202 |
<span class="lineart">╰──</span> <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> |
| 203 |
<span class="lineart">├──</span> GsfOutputCsv |
| 204 |
<span class="lineart">╰──</span> GsfOutputIconv |
| 205 |
</pre> |
| 206 |
</div> |
| 207 |
<div class="refsect1"> |
| 208 |
<a name="gsf-Text.description"></a><h2>Description</h2> |
| 209 |
</div> |
| 210 |
<div class="refsect1"> |
| 211 |
<a name="gsf-Text.functions_details"></a><h2>Functions</h2> |
| 212 |
<div class="refsect2"> |
| 213 |
<a name="gsf-input-textline-new"></a><h3>gsf_input_textline_new ()</h3> |
| 214 |
<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * |
| 215 |
gsf_input_textline_new (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *source</code></em>);</pre> |
| 216 |
<div class="note">This adds a reference to <em class="parameter"><code>source</code></em>.</div> |
| 217 |
<div class="refsect3"> |
| 218 |
<a name="gsf-input-textline-new.parameters"></a><h4>Parameters</h4> |
| 219 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 220 |
<colgroup> |
| 221 |
<col width="150px" class="parameters_name"> |
| 222 |
<col class="parameters_description"> |
| 223 |
<col width="200px" class="parameters_annotations"> |
| 224 |
</colgroup> |
| 225 |
<tbody><tr> |
| 226 |
<td class="parameter_name"><p>source</p></td> |
| 227 |
<td class="parameter_description"><p>in some combination of ascii and utf8</p></td> |
| 228 |
<td class="parameter_annotations"> </td> |
| 229 |
</tr></tbody> |
| 230 |
</table></div> |
| 231 |
</div> |
| 232 |
<div class="refsect3"> |
| 233 |
<a name="gsf-input-textline-new.returns"></a><h4>Returns</h4> |
| 234 |
<p>a new file. </p> |
| 235 |
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| 236 |
</div> |
| 237 |
</div> |
| 238 |
<hr> |
| 239 |
<div class="refsect2"> |
| 240 |
<a name="gsf-input-textline-ascii-gets"></a><h3>gsf_input_textline_ascii_gets ()</h3> |
| 241 |
<pre class="programlisting">unsigned <span class="returnvalue">char</span> * |
| 242 |
gsf_input_textline_ascii_gets (<em class="parameter"><code><a class="link" href="gsf-Text.html#GsfInputTextline"><span class="type">GsfInputTextline</span></a> *textline</code></em>);</pre> |
| 243 |
<p>A utility routine to read things line by line from the underlying source. |
| 244 |
Trailing newlines and carriage returns are stripped, and the resultant buffer |
| 245 |
can be edited.</p> |
| 246 |
<div class="refsect3"> |
| 247 |
<a name="gsf-input-textline-ascii-gets.parameters"></a><h4>Parameters</h4> |
| 248 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 249 |
<colgroup> |
| 250 |
<col width="150px" class="parameters_name"> |
| 251 |
<col class="parameters_description"> |
| 252 |
<col width="200px" class="parameters_annotations"> |
| 253 |
</colgroup> |
| 254 |
<tbody><tr> |
| 255 |
<td class="parameter_name"><p>textline</p></td> |
| 256 |
<td class="parameter_description"><p><a class="link" href="gsf-Text.html#GsfInputTextline"><span class="type">GsfInputTextline</span></a></p></td> |
| 257 |
<td class="parameter_annotations"> </td> |
| 258 |
</tr></tbody> |
| 259 |
</table></div> |
| 260 |
</div> |
| 261 |
<div class="refsect3"> |
| 262 |
<a name="gsf-input-textline-ascii-gets.returns"></a><h4>Returns</h4> |
| 263 |
<p>the string read, or <code class="literal">NULL</code> on eof. </p> |
| 264 |
<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| 265 |
</div> |
| 266 |
</div> |
| 267 |
<hr> |
| 268 |
<div class="refsect2"> |
| 269 |
<a name="gsf-input-textline-utf8-gets"></a><h3>gsf_input_textline_utf8_gets ()</h3> |
| 270 |
<pre class="programlisting"><span class="returnvalue">guint8</span> * |
| 271 |
gsf_input_textline_utf8_gets (<em class="parameter"><code><a class="link" href="gsf-Text.html#GsfInputTextline"><span class="type">GsfInputTextline</span></a> *textline</code></em>);</pre> |
| 272 |
<p>A utility routine to read things line by line from the underlying source. |
| 273 |
Trailing newlines and carriage returns are stripped, and the resultant buffer |
| 274 |
can be edited.</p> |
| 275 |
<div class="refsect3"> |
| 276 |
<a name="gsf-input-textline-utf8-gets.parameters"></a><h4>Parameters</h4> |
| 277 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 278 |
<colgroup> |
| 279 |
<col width="150px" class="parameters_name"> |
| 280 |
<col class="parameters_description"> |
| 281 |
<col width="200px" class="parameters_annotations"> |
| 282 |
</colgroup> |
| 283 |
<tbody><tr> |
| 284 |
<td class="parameter_name"><p>textline</p></td> |
| 285 |
<td class="parameter_description"><p><a class="link" href="gsf-Text.html#GsfInputTextline"><span class="type">GsfInputTextline</span></a></p></td> |
| 286 |
<td class="parameter_annotations"> </td> |
| 287 |
</tr></tbody> |
| 288 |
</table></div> |
| 289 |
</div> |
| 290 |
<div class="refsect3"> |
| 291 |
<a name="gsf-input-textline-utf8-gets.returns"></a><h4>Returns</h4> |
| 292 |
<p>the string read, or <code class="literal">NULL</code> on eof. </p> |
| 293 |
<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| 294 |
</div> |
| 295 |
</div> |
| 296 |
<hr> |
| 297 |
<div class="refsect2"> |
| 298 |
<a name="gsf-output-iconv-new"></a><h3>gsf_output_iconv_new ()</h3> |
| 299 |
<pre class="programlisting"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> * |
| 300 |
gsf_output_iconv_new (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>, |
| 301 |
<em class="parameter"><code><span class="type">char</span> const *dst</code></em>, |
| 302 |
<em class="parameter"><code><span class="type">char</span> const *src</code></em>);</pre> |
| 303 |
<p>Adds a reference to <em class="parameter"><code>sink</code></em> |
| 304 |
.</p> |
| 305 |
<div class="refsect3"> |
| 306 |
<a name="gsf-output-iconv-new.parameters"></a><h4>Parameters</h4> |
| 307 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 308 |
<colgroup> |
| 309 |
<col width="150px" class="parameters_name"> |
| 310 |
<col class="parameters_description"> |
| 311 |
<col width="200px" class="parameters_annotations"> |
| 312 |
</colgroup> |
| 313 |
<tbody> |
| 314 |
<tr> |
| 315 |
<td class="parameter_name"><p>sink</p></td> |
| 316 |
<td class="parameter_description"><p>The underlying data source.</p></td> |
| 317 |
<td class="parameter_annotations"> </td> |
| 318 |
</tr> |
| 319 |
<tr> |
| 320 |
<td class="parameter_name"><p>dst</p></td> |
| 321 |
<td class="parameter_description"><p>The target character set.</p></td> |
| 322 |
<td class="parameter_annotations"> </td> |
| 323 |
</tr> |
| 324 |
<tr> |
| 325 |
<td class="parameter_name"><p>src</p></td> |
| 326 |
<td class="parameter_description"><p>The source character set.</p></td> |
| 327 |
<td class="parameter_annotations"> </td> |
| 328 |
</tr> |
| 329 |
</tbody> |
| 330 |
</table></div> |
| 331 |
</div> |
| 332 |
<div class="refsect3"> |
| 333 |
<a name="gsf-output-iconv-new.returns"></a><h4>Returns</h4> |
| 334 |
<p> a new GsfOutput object or <code class="literal">NULL</code>.</p> |
| 335 |
</div> |
| 336 |
</div> |
| 337 |
<hr> |
| 338 |
<div class="refsect2"> |
| 339 |
<a name="gsf-output-csv-write-eol"></a><h3>gsf_output_csv_write_eol ()</h3> |
| 340 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 341 |
gsf_output_csv_write_eol (<em class="parameter"><code><a class="link" href="gsf-Text.html#GsfOutputCsv"><span class="type">GsfOutputCsv</span></a> *csv</code></em>);</pre> |
| 342 |
</div> |
| 343 |
<hr> |
| 344 |
<div class="refsect2"> |
| 345 |
<a name="gsf-output-csv-write-field"></a><h3>gsf_output_csv_write_field ()</h3> |
| 346 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 347 |
gsf_output_csv_write_field (<em class="parameter"><code><a class="link" href="gsf-Text.html#GsfOutputCsv"><span class="type">GsfOutputCsv</span></a> *csv</code></em>, |
| 348 |
<em class="parameter"><code><span class="type">char</span> const *field</code></em>, |
| 349 |
<em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre> |
| 350 |
</div> |
| 351 |
</div> |
| 352 |
<div class="refsect1"> |
| 353 |
<a name="gsf-Text.other_details"></a><h2>Types and Values</h2> |
| 354 |
<div class="refsect2"> |
| 355 |
<a name="GsfInputTextline-struct"></a><h3>GsfInputTextline</h3> |
| 356 |
<pre class="programlisting">typedef struct _GsfInputTextline GsfInputTextline;</pre> |
| 357 |
</div> |
| 358 |
<hr> |
| 359 |
<div class="refsect2"> |
| 360 |
<a name="GsfOutputIconv-struct"></a><h3>GsfOutputIconv</h3> |
| 361 |
<pre class="programlisting">typedef struct _GsfOutputIconv GsfOutputIconv;</pre> |
| 362 |
</div> |
| 363 |
<hr> |
| 364 |
<div class="refsect2"> |
| 365 |
<a name="GsfOutputCsv-struct"></a><h3>GsfOutputCsv</h3> |
| 366 |
<pre class="programlisting">typedef struct _GsfOutputCsv GsfOutputCsv;</pre> |
| 367 |
</div> |
| 368 |
<hr> |
| 369 |
<div class="refsect2"> |
| 370 |
<a name="GsfOutputCsvQuotingMode"></a><h3>enum GsfOutputCsvQuotingMode</h3> |
| 371 |
<p>Controls when to add quotes around fields.</p> |
| 372 |
<div class="refsect3"> |
| 373 |
<a name="GsfOutputCsvQuotingMode.members"></a><h4>Members</h4> |
| 374 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 375 |
<colgroup> |
| 376 |
<col width="300px" class="enum_members_name"> |
| 377 |
<col class="enum_members_description"> |
| 378 |
<col width="200px" class="enum_members_annotations"> |
| 379 |
</colgroup> |
| 380 |
<tbody> |
| 381 |
<tr> |
| 382 |
<td class="enum_member_name"><p><a name="GSF-OUTPUT-CSV-QUOTING-MODE-NEVER:CAPS"></a>GSF_OUTPUT_CSV_QUOTING_MODE_NEVER</p></td> |
| 383 |
<td class="enum_member_description"> |
| 384 |
<p>never add quotes around fields</p> |
| 385 |
</td> |
| 386 |
<td class="enum_member_annotations"> </td> |
| 387 |
</tr> |
| 388 |
<tr> |
| 389 |
<td class="enum_member_name"><p><a name="GSF-OUTPUT-CSV-QUOTING-MODE-AUTO:CAPS"></a>GSF_OUTPUT_CSV_QUOTING_MODE_AUTO</p></td> |
| 390 |
<td class="enum_member_description"> |
| 391 |
<p>add quotes around fields when needed</p> |
| 392 |
</td> |
| 393 |
<td class="enum_member_annotations"> </td> |
| 394 |
</tr> |
| 395 |
<tr> |
| 396 |
<td class="enum_member_name"><p><a name="GSF-OUTPUT-CSV-QUOTING-MODE-ALWAYS:CAPS"></a>GSF_OUTPUT_CSV_QUOTING_MODE_ALWAYS</p></td> |
| 397 |
<td class="enum_member_description"> |
| 398 |
<p>always add quotes around fields</p> |
| 399 |
</td> |
| 400 |
<td class="enum_member_annotations"> </td> |
| 401 |
</tr> |
| 402 |
</tbody> |
| 403 |
</table></div> |
| 404 |
</div> |
| 405 |
</div> |
| 406 |
</div> |
| 407 |
<div class="refsect1"> |
| 408 |
<a name="gsf-Text.property-details"></a><h2>Property Details</h2> |
| 409 |
<div class="refsect2"> |
| 410 |
<a name="GsfOutputIconv--fallback"></a><h3>The <code class="literal">“fallback”</code> property</h3> |
| 411 |
<pre class="programlisting"> “fallback” <span class="type">char</span> *</pre> |
| 412 |
<p>Either NULL or a UTF-8 string (representable in the target encoding) |
| 413 |
to convert and output in place of characters that cannot be represented |
| 414 |
in the target encoding. NULL means use \u1234 or \U12345678 format.</p> |
| 415 |
<p>Owner: GsfOutputIconv</p> |
| 416 |
<p>Flags: Read / Write</p> |
| 417 |
<p>Default value: NULL</p> |
| 418 |
</div> |
| 419 |
<hr> |
| 420 |
<div class="refsect2"> |
| 421 |
<a name="GsfOutputIconv--input-charset"></a><h3>The <code class="literal">“input-charset”</code> property</h3> |
| 422 |
<pre class="programlisting"> “input-charset” <span class="type">char</span> *</pre> |
| 423 |
<p>The character set to convert from.</p> |
| 424 |
<p>Owner: GsfOutputIconv</p> |
| 425 |
<p>Flags: Read / Write / Construct Only</p> |
| 426 |
<p>Default value: "UTF-8"</p> |
| 427 |
</div> |
| 428 |
<hr> |
| 429 |
<div class="refsect2"> |
| 430 |
<a name="GsfOutputIconv--output-charset"></a><h3>The <code class="literal">“output-charset”</code> property</h3> |
| 431 |
<pre class="programlisting"> “output-charset” <span class="type">char</span> *</pre> |
| 432 |
<p>The character set to convert to.</p> |
| 433 |
<p>Owner: GsfOutputIconv</p> |
| 434 |
<p>Flags: Read / Write / Construct Only</p> |
| 435 |
<p>Default value: "UTF-8"</p> |
| 436 |
</div> |
| 437 |
<hr> |
| 438 |
<div class="refsect2"> |
| 439 |
<a name="GsfOutputIconv--sink"></a><h3>The <code class="literal">“sink”</code> property</h3> |
| 440 |
<pre class="programlisting"> “sink” <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</pre> |
| 441 |
<p>Where the converted data is written.</p> |
| 442 |
<p>Owner: GsfOutputIconv</p> |
| 443 |
<p>Flags: Read / Write / Construct Only</p> |
| 444 |
</div> |
| 445 |
<hr> |
| 446 |
<div class="refsect2"> |
| 447 |
<a name="GsfOutputCsv--eol"></a><h3>The <code class="literal">“eol”</code> property</h3> |
| 448 |
<pre class="programlisting"> “eol” <span class="type">char</span> *</pre> |
| 449 |
<p>The end-of-line marker.</p> |
| 450 |
<p>Owner: GsfOutputCsv</p> |
| 451 |
<p>Flags: Read / Write / Construct</p> |
| 452 |
<p>Default value: "\n"</p> |
| 453 |
</div> |
| 454 |
<hr> |
| 455 |
<div class="refsect2"> |
| 456 |
<a name="GsfOutputCsv--quote"></a><h3>The <code class="literal">“quote”</code> property</h3> |
| 457 |
<pre class="programlisting"> “quote” <span class="type">char</span> *</pre> |
| 458 |
<p>The string used for quoting fields.</p> |
| 459 |
<p>Owner: GsfOutputCsv</p> |
| 460 |
<p>Flags: Read / Write / Construct</p> |
| 461 |
<p>Default value: "\""</p> |
| 462 |
</div> |
| 463 |
<hr> |
| 464 |
<div class="refsect2"> |
| 465 |
<a name="GsfOutputCsv--quoting-mode"></a><h3>The <code class="literal">“quoting-mode”</code> property</h3> |
| 466 |
<pre class="programlisting"> “quoting-mode” <a class="link" href="gsf-Text.html#GsfOutputCsvQuotingMode" title="enum GsfOutputCsvQuotingMode"><span class="type">GsfOutputCsvQuotingMode</span></a></pre> |
| 467 |
<p>When to quote fields.</p> |
| 468 |
<p>Owner: GsfOutputCsv</p> |
| 469 |
<p>Flags: Read / Write / Construct</p> |
| 470 |
<p>Default value: GSF_OUTPUT_CSV_QUOTING_MODE_NEVER</p> |
| 471 |
</div> |
| 472 |
<hr> |
| 473 |
<div class="refsect2"> |
| 474 |
<a name="GsfOutputCsv--quoting-on-whitespace"></a><h3>The <code class="literal">“quoting-on-whitespace”</code> property</h3> |
| 475 |
<pre class="programlisting"> “quoting-on-whitespace” <span class="type">gboolean</span></pre> |
| 476 |
<p>Does initial or terminal whitespace force quoting?.</p> |
| 477 |
<p>Owner: GsfOutputCsv</p> |
| 478 |
<p>Flags: Read / Write</p> |
| 479 |
<p>Default value: TRUE</p> |
| 480 |
</div> |
| 481 |
<hr> |
| 482 |
<div class="refsect2"> |
| 483 |
<a name="GsfOutputCsv--quoting-triggers"></a><h3>The <code class="literal">“quoting-triggers”</code> property</h3> |
| 484 |
<pre class="programlisting"> “quoting-triggers” <span class="type">char</span> *</pre> |
| 485 |
<p>Characters that cause field quoting.</p> |
| 486 |
<p>Owner: GsfOutputCsv</p> |
| 487 |
<p>Flags: Read / Write</p> |
| 488 |
<p>Default value: NULL</p> |
| 489 |
</div> |
| 490 |
<hr> |
| 491 |
<div class="refsect2"> |
| 492 |
<a name="GsfOutputCsv--separator"></a><h3>The <code class="literal">“separator”</code> property</h3> |
| 493 |
<pre class="programlisting"> “separator” <span class="type">char</span> *</pre> |
| 494 |
<p>The field separator.</p> |
| 495 |
<p>Owner: GsfOutputCsv</p> |
| 496 |
<p>Flags: Read / Write / Construct</p> |
| 497 |
<p>Default value: ","</p> |
| 498 |
</div> |
| 499 |
<hr> |
| 500 |
<div class="refsect2"> |
| 501 |
<a name="GsfOutputCsv--sink"></a><h3>The <code class="literal">“sink”</code> property</h3> |
| 502 |
<pre class="programlisting"> “sink” <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</pre> |
| 503 |
<p>Where the formatted output is written.</p> |
| 504 |
<p>Owner: GsfOutputCsv</p> |
| 505 |
<p>Flags: Read / Write</p> |
| 506 |
</div> |
| 507 |
</div> |
| 508 |
</div> |
| 509 |
<div class="footer"> |
| 510 |
<hr>Generated by GTK-Doc V1.34.0</div> |
| 511 |
</body> |
| 512 |
</html> |