~ubuntu-branches/ubuntu/utopic/gimp/utopic

« back to all changes in this revision

Viewing changes to devel-docs/libgimpconfig/html/libgimpconfig-GimpConfigWriter.html

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2013-08-29 12:48:19 UTC
  • mfrom: (1.1.29) (0.4.20 saucy-proposed)
  • Revision ID: package-import@ubuntu.com-20130829124819-r4mliaiddrgv5x4g
Tags: 2.8.6-1ubuntu1
* Synchronize with Debian (LP: #1207734). Remaining changes:
  - debian/patches/02_help-message.patch,
    debian/patches/03_gimp.desktop.in.in.patch:
    + Update some strings for Ubuntu
  - debian/control:
    + Update description
  - debian/rules:
    + Set gettext domain and update translation templates

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>GimpConfigWriter</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GIMP Config Library Reference Manual">
8
8
<link rel="up" href="libgimpconfig.html" title="Part I. GIMP Config Library">
9
9
<link rel="prev" href="libgimpconfig-GimpConfig-utils.html" title="GimpConfig-utils">
99
99
possible race conditions. The temporary file is then moved to
100
100
<em class="parameter"><code>filename</code></em> when the writer is closed.
101
101
</p>
102
 
<div class="variablelist"><table border="0">
 
102
<div class="variablelist"><table border="0" class="variablelist">
 
103
<colgroup>
103
104
<col align="left" valign="top">
 
105
<col>
 
106
</colgroup>
104
107
<tbody>
105
108
<tr>
106
109
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
130
133
<div class="refsect2">
131
134
<a name="gimp-config-writer-new-fd"></a><h3>gimp_config_writer_new_fd ()</h3>
132
135
<pre class="programlisting"><a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="returnvalue">GimpConfigWriter</span></a> *  gimp_config_writer_new_fd           (<em class="parameter"><code><span class="type">gint</span> fd</code></em>);</pre>
133
 
<div class="variablelist"><table border="0">
 
136
<div class="variablelist"><table border="0" class="variablelist">
 
137
<colgroup>
134
138
<col align="left" valign="top">
 
139
<col>
 
140
</colgroup>
135
141
<tbody><tr>
136
142
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
137
143
<td>a new <a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a> or <code class="literal">NULL</code> in case of an error</td>
143
149
<div class="refsect2">
144
150
<a name="gimp-config-writer-new-string"></a><h3>gimp_config_writer_new_string ()</h3>
145
151
<pre class="programlisting"><a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="returnvalue">GimpConfigWriter</span></a> *  gimp_config_writer_new_string       (<em class="parameter"><code><span class="type">GString</span> *string</code></em>);</pre>
146
 
<div class="variablelist"><table border="0">
 
152
<div class="variablelist"><table border="0" class="variablelist">
 
153
<colgroup>
147
154
<col align="left" valign="top">
 
155
<col>
 
156
</colgroup>
148
157
<tbody><tr>
149
158
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
150
159
<td>a new <a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a> or <code class="literal">NULL</code> in case of an error</td>
162
171
It also increases the indentation level and sets a mark that
163
172
can be used by <a class="link" href="libgimpconfig-GimpConfigWriter.html#gimp-config-writer-revert" title="gimp_config_writer_revert ()"><code class="function">gimp_config_writer_revert()</code></a>.
164
173
</p>
165
 
<div class="variablelist"><table border="0">
 
174
<div class="variablelist"><table border="0" class="variablelist">
 
175
<colgroup>
166
176
<col align="left" valign="top">
 
177
<col>
 
178
</colgroup>
167
179
<tbody>
168
180
<tr>
169
181
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
192
204
Since comments have to start at the beginning of a line, this
193
205
funtion will insert a newline if necessary.
194
206
</p>
195
 
<div class="variablelist"><table border="0">
 
207
<div class="variablelist"><table border="0" class="variablelist">
 
208
<colgroup>
196
209
<col align="left" valign="top">
 
210
<col>
 
211
</colgroup>
197
212
<tbody>
198
213
<tr>
199
214
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
219
234
Appends a space followed by <em class="parameter"><code>string</code></em> to the <em class="parameter"><code>writer</code></em>. Note that string
220
235
must not contain any special characters that might need to be escaped.
221
236
</p>
222
 
<div class="variablelist"><table border="0">
 
237
<div class="variablelist"><table border="0" class="variablelist">
 
238
<colgroup>
223
239
<col align="left" valign="top">
 
240
<col>
 
241
</colgroup>
224
242
<tbody>
225
243
<tr>
226
244
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
248
266
<p>
249
267
A printf-like function for <a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a>.
250
268
</p>
251
 
<div class="variablelist"><table border="0">
 
269
<div class="variablelist"><table border="0" class="variablelist">
 
270
<colgroup>
252
271
<col align="left" valign="top">
 
272
<col>
 
273
</colgroup>
253
274
<tbody>
254
275
<tr>
255
276
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
278
299
Writes an identifier to <em class="parameter"><code>writer</code></em>. The <em class="parameter"><code>string</code></em> is *not* quoted and special
279
300
characters are *not* escaped.
280
301
</p>
281
 
<div class="variablelist"><table border="0">
 
302
<div class="variablelist"><table border="0" class="variablelist">
 
303
<colgroup>
282
304
<col align="left" valign="top">
 
305
<col>
 
306
</colgroup>
283
307
<tbody>
284
308
<tr>
285
309
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
303
327
Writes a string value to <em class="parameter"><code>writer</code></em>. The <em class="parameter"><code>string</code></em> is quoted and special
304
328
characters are escaped.
305
329
</p>
306
 
<div class="variablelist"><table border="0">
 
330
<div class="variablelist"><table border="0" class="variablelist">
 
331
<colgroup>
307
332
<col align="left" valign="top">
 
333
<col>
 
334
</colgroup>
308
335
<tbody>
309
336
<tr>
310
337
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
325
352
<pre class="programlisting"><span class="returnvalue">void</span>                gimp_config_writer_data             (<em class="parameter"><code><a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a> *writer</code></em>,
326
353
                                                         <em class="parameter"><code><span class="type">gint</span> length</code></em>,
327
354
                                                         <em class="parameter"><code>const <span class="type">guint8</span> *data</code></em>);</pre>
328
 
<div class="variablelist"><table border="0">
 
355
<div class="variablelist"><table border="0" class="variablelist">
 
356
<colgroup>
329
357
<col align="left" valign="top">
 
358
<col>
 
359
</colgroup>
330
360
<tbody><tr>
331
361
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
332
362
<td>a <a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a>
345
375
format it as a comment. Note that this function does not handle non-ASCII
346
376
characters.
347
377
</p>
348
 
<div class="variablelist"><table border="0">
 
378
<div class="variablelist"><table border="0" class="variablelist">
 
379
<colgroup>
349
380
<col align="left" valign="top">
 
381
<col>
 
382
</colgroup>
350
383
<tbody>
351
384
<tr>
352
385
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
377
410
to <a class="link" href="libgimpconfig-GimpConfigWriter.html#gimp-config-writer-open" title="gimp_config_writer_open ()"><code class="function">gimp_config_writer_open()</code></a>. This can only work if you didn't call
378
411
<a class="link" href="libgimpconfig-GimpConfigWriter.html#gimp-config-writer-close" title="gimp_config_writer_close ()"><code class="function">gimp_config_writer_close()</code></a> yet.
379
412
</p>
380
 
<div class="variablelist"><table border="0">
 
413
<div class="variablelist"><table border="0" class="variablelist">
 
414
<colgroup>
381
415
<col align="left" valign="top">
 
416
<col>
 
417
</colgroup>
382
418
<tbody><tr>
383
419
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
384
420
<td>a <a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a>
394
430
<p>
395
431
Closes an element opened with <a class="link" href="libgimpconfig-GimpConfigWriter.html#gimp-config-writer-open" title="gimp_config_writer_open ()"><code class="function">gimp_config_writer_open()</code></a>.
396
432
</p>
397
 
<div class="variablelist"><table border="0">
 
433
<div class="variablelist"><table border="0" class="variablelist">
 
434
<colgroup>
398
435
<col align="left" valign="top">
 
436
<col>
 
437
</colgroup>
399
438
<tbody><tr>
400
439
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
401
440
<td>a <a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a>
416
455
releases all resources allocated by <em class="parameter"><code>writer</code></em>. You must not access
417
456
the <em class="parameter"><code>writer</code></em> afterwards.
418
457
</p>
419
 
<div class="variablelist"><table border="0">
 
458
<div class="variablelist"><table border="0" class="variablelist">
 
459
<colgroup>
420
460
<col align="left" valign="top">
 
461
<col>
 
462
</colgroup>
421
463
<tbody>
422
464
<tr>
423
465
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>