1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>toolFileFormat</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="V_Sim API - Reference Manual">
<link rel="up" href="ch01.html" title="Core tools">
<link rel="prev" href="v-sim-toolShade.html" title="toolShade">
<link rel="next" href="ch02.html" title="Rendering methods">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="v-sim-toolShade.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">V_Sim API - Reference Manual</th>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#v-sim-toolFileFormat.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-toolFileFormat.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="toolFileFormat">
<a name="v-sim-toolFileFormat"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-toolFileFormat.top_of_page"></a>toolFileFormat</span></h2>
<p>toolFileFormat — Describes file format objects (name patterns,
description, properties...).</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-toolFileFormat.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat">ToolFileFormat</a>;
<a class="link" href="v-sim-toolFileFormat.html#ToolFileFormatIter" title="ToolFileFormatIter">ToolFileFormatIter</a>;
#define <a class="link" href="v-sim-toolFileFormat.html#TOOL-FILE-FORMAT-ERROR:CAPS" title="TOOL_FILE_FORMAT_ERROR">TOOL_FILE_FORMAT_ERROR</a>
<a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-getQuark" title="tool_file_format_getQuark ()">tool_file_format_getQuark</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
enum <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormatErrorFlag" title="enum ToolFileFormatErrorFlag">ToolFileFormatErrorFlag</a>;
<a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="returnvalue">ToolFileFormat</span></a>* <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-new" title="tool_file_format_new ()">tool_file_format_new</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *descr</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **patterns</code></em>);
<a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="returnvalue">ToolFileFormat</span></a>* <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-newRestricted" title="tool_file_format_newRestricted ()">tool_file_format_newRestricted</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *descr</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **patterns</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-free" title="tool_file_format_free ()">tool_file_format_free</a> (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>);
<a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="returnvalue">ToolFileFormat</span></a>* <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-copy" title="tool_file_format_copy ()">tool_file_format_copy</a> (<em class="parameter"><code>const <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *from</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-getName" title="tool_file_format_getName ()">tool_file_format_getName</a> (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-getLabel" title="tool_file_format_getLabel ()">tool_file_format_getLabel</a> (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a>* <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-getFilePatterns" title="tool_file_format_getFilePatterns ()">tool_file_format_getFilePatterns</a> (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-canMatch" title="tool_file_format_canMatch ()">tool_file_format_canMatch</a> (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-match" title="tool_file_format_match ()">tool_file_format_match</a> (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);
<a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="returnvalue">ToolOption</span></a>* <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-addPropertyBoolean" title="tool_file_format_addPropertyBoolean ()">tool_file_format_addPropertyBoolean</a> (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> defaultVal</code></em>);
<a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="returnvalue">ToolOption</span></a>* <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-addPropertyInt" title="tool_file_format_addPropertyInt ()">tool_file_format_addPropertyInt</a> (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> defaultVal</code></em>);
<a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="returnvalue">ToolOption</span></a>* <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-getPropertyByName" title="tool_file_format_getPropertyByName ()">tool_file_format_getPropertyByName</a> (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a>* <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-getPropertyList" title="tool_file_format_getPropertyList ()">tool_file_format_getPropertyList</a> (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-iterNextProperty" title="tool_file_format_iterNextProperty ()">tool_file_format_iterNextProperty</a> (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormatIter" title="ToolFileFormatIter"><span class="type">ToolFileFormatIter</span></a> *iter</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-toolFileFormat.description"></a><h2>Description</h2>
<p>
</p>
<p>When dealing with files, it is convenient to class then by
formats, one format for JPEG files, one other for
postscript... Such file formats are characterized by their
description, explaining what they are, one or more name pattern
(e.g. "*.jpg") and some properties (e.g. compression level for JPEG
file).</p>
<p>
</p>
<p>This module describes objects that can store all these
informations and deals with them. To create a new file format, use
<a class="link" href="v-sim-toolFileFormat.html#tool-file-format-new" title="tool_file_format_new ()"><code class="function">tool_file_format_new()</code></a>. A <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> object can be used in a
GtkFileChooser object, using a GtkFileFilter. <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-getLabel" title="tool_file_format_getLabel ()"><code class="function">tool_file_format_getLabel()</code></a>
will return directly the label to give to the GtkFileFilter and the
name patterns can be passed to it also.</p>
<p>
</p>
<p>A file format property is a <a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> value. There are some
convenient routines to add common boolean or integer
properties. For instance, use <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-addPropertyBoolean" title="tool_file_format_addPropertyBoolean ()"><code class="function">tool_file_format_addPropertyBoolean()</code></a>
to add a boolean property to a given <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> object. Then the stored
properties can be iterated on using a <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormatIter" title="ToolFileFormatIter"><span class="type">ToolFileFormatIter</span></a> iterator.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-toolFileFormat.details"></a><h2>Details</h2>
<div class="refsect2" title="ToolFileFormat">
<a name="ToolFileFormat"></a><h3>ToolFileFormat</h3>
<pre class="programlisting">typedef struct _ToolFileFormat ToolFileFormat;</pre>
<p>
An opaque structure.
</p>
</div>
<hr>
<div class="refsect2" title="ToolFileFormatIter">
<a name="ToolFileFormatIter"></a><h3>ToolFileFormatIter</h3>
<pre class="programlisting">typedef struct {
GList *lst;
gchar *name;
gchar *label;
GValue *val;
} ToolFileFormatIter;
</pre>
<p>
Iterator on <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> object properties. See
<a class="link" href="v-sim-toolFileFormat.html#tool-file-format-iterNextProperty" title="tool_file_format_iterNextProperty ()"><code class="function">tool_file_format_iterNextProperty()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *<em class="structfield"><code><a name="ToolFileFormatIter.lst"></a>lst</code></em>;</span></p></td>
<td>internal pointer.
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="ToolFileFormatIter.name"></a>name</code></em>;</span></p></td>
<td>name of the current iterated property (read only).
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="ToolFileFormatIter.label"></a>label</code></em>;</span></p></td>
<td>label of the current iterated property (read only).
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *<em class="structfield"><code><a name="ToolFileFormatIter.val"></a>val</code></em>;</span></p></td>
<td>its value (read only).
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="TOOL_FILE_FORMAT_ERROR">
<a name="TOOL-FILE-FORMAT-ERROR:CAPS"></a><h3>TOOL_FILE_FORMAT_ERROR</h3>
<pre class="programlisting">#define TOOL_FILE_FORMAT_ERROR tool_file_format_getQuark()
</pre>
</div>
<hr>
<div class="refsect2" title="tool_file_format_getQuark ()">
<a name="tool-file-format-getQuark"></a><h3>tool_file_format_getQuark ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> tool_file_format_getQuark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2" title="enum ToolFileFormatErrorFlag">
<a name="ToolFileFormatErrorFlag"></a><h3>enum ToolFileFormatErrorFlag</h3>
<pre class="programlisting">typedef enum
{
TOOL_FILE_FORMAT_ERROR_METHOD, /* Error from the rendering method. */
TOOL_FILE_FORMAT_ERROR_FILE, /* Error when opening. */
TOOL_FILE_FORMAT_ERROR_FORMAT, /* Wrongness in format. */
TOOL_FILE_FORMAT_ERROR_UNKNOWN_FORMAT
} ToolFileFormatErrorFlag;
</pre>
<p>
These are flags used when reading a file with a loading method associated to a file format.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="TOOL-FILE-FORMAT-ERROR-METHOD:CAPS"></a><span class="term"><code class="literal">TOOL_FILE_FORMAT_ERROR_METHOD</code></span></p></td>
<td>Error from the loading method.
</td>
</tr>
<tr>
<td><p><a name="TOOL-FILE-FORMAT-ERROR-FILE:CAPS"></a><span class="term"><code class="literal">TOOL_FILE_FORMAT_ERROR_FILE</code></span></p></td>
<td>Error when opening.
</td>
</tr>
<tr>
<td><p><a name="TOOL-FILE-FORMAT-ERROR-FORMAT:CAPS"></a><span class="term"><code class="literal">TOOL_FILE_FORMAT_ERROR_FORMAT</code></span></p></td>
<td>Wrongness in format.
</td>
</tr>
<tr>
<td><p><a name="TOOL-FILE-FORMAT-ERROR-UNKNOWN-FORMAT:CAPS"></a><span class="term"><code class="literal">TOOL_FILE_FORMAT_ERROR_UNKNOWN_FORMAT</code></span></p></td>
<td>the file is not recognised.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_file_format_new ()">
<a name="tool-file-format-new"></a><h3>tool_file_format_new ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="returnvalue">ToolFileFormat</span></a>* tool_file_format_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *descr</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **patterns</code></em>);</pre>
<p>
Allocate a new <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a>. The <em class="parameter"><code>patterns</code></em> argument is copied in
the <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> object and can be freed safely after the call to this method.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>descr</code></em> :</span></p></td>
<td>a short string to label a new file format.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>patterns</code></em> :</span></p></td>
<td> a set of patterns to identify files of this format.. <acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1. <acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8. </td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly allocated ToolFileFormat,
or NULL if something goes wrong.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_file_format_newRestricted ()">
<a name="tool-file-format-newRestricted"></a><h3>tool_file_format_newRestricted ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="returnvalue">ToolFileFormat</span></a>* tool_file_format_newRestricted (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *descr</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **patterns</code></em>);</pre>
<p>
Allocate a new <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a>. The <em class="parameter"><code>patterns</code></em> argument is copied in
the <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> object and can be freed safely after the call to this method.
The <em class="parameter"><code>patterns</code></em> list is not all the patterns supported by the format.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>descr</code></em> :</span></p></td>
<td>a short string to label a new file format.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>patterns</code></em> :</span></p></td>
<td>a set of patterns to identify files of this format.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly allocated ToolFileFormat,
or NULL if something goes wrong.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_file_format_free ()">
<a name="tool-file-format-free"></a><h3>tool_file_format_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> tool_file_format_free (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>);</pre>
<p>
Free all the memory used by <em class="parameter"><code>format</code></em>. If <em class="parameter"><code>format</code></em> is NULL, the method
writes a warning on the eror output.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> to free.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_file_format_copy ()">
<a name="tool-file-format-copy"></a><h3>tool_file_format_copy ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="returnvalue">ToolFileFormat</span></a>* tool_file_format_copy (<em class="parameter"><code>const <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *from</code></em>);</pre>
<p>
Copy the given file format <em class="parameter"><code>from</code></em> a create a new one.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>from</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly created <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a>. Should
be freed with <a class="link" href="v-sim-toolFileFormat.html#tool-file-format-free" title="tool_file_format_free ()"><code class="function">tool_file_format_free()</code></a>.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="tool_file_format_getName ()">
<a name="tool-file-format-getName"></a><h3>tool_file_format_getName ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* tool_file_format_getName (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>);</pre>
<p>
This method gives the name describing the file format.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string with the name. This string
should not be freed.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_file_format_getLabel ()">
<a name="tool-file-format-getLabel"></a><h3>tool_file_format_getLabel ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* tool_file_format_getLabel (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>);</pre>
<p>
This method gives a label describing the file format.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string made by the name and all
the paterns of the given format, given in parentethis. This string
should not be freed.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_file_format_getFilePatterns ()">
<a name="tool-file-format-getFilePatterns"></a><h3>tool_file_format_getFilePatterns ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a>* tool_file_format_getFilePatterns (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>);</pre>
<p>
This method gives a list with the file patterns.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a list with the file
patterns. This list should not be freed.
. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. <acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8. </td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="tool_file_format_canMatch ()">
<a name="tool-file-format-canMatch"></a><h3>tool_file_format_canMatch ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> tool_file_format_canMatch (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>);</pre>
<p>
This method is used to know if the file pattern list can be used
to match a given filename with @<a class="link" href="v-sim-toolFileFormat.html#tool-file-format-match" title="tool_file_format_match ()"><code class="function">tool_file_format_match()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if a call to @<a class="link" href="v-sim-toolFileFormat.html#tool-file-format-match" title="tool_file_format_match ()"><code class="function">tool_file_format_match()</code></a> is safe.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="tool_file_format_match ()">
<a name="tool-file-format-match"></a><h3>tool_file_format_match ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* tool_file_format_match (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>
This method try to match the given string to one of the patterns of
the <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> <em class="parameter"><code>format</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>a string to match.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the matching pattern, if any.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_file_format_addPropertyBoolean ()">
<a name="tool-file-format-addPropertyBoolean"></a><h3>tool_file_format_addPropertyBoolean ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="returnvalue">ToolOption</span></a>* tool_file_format_addPropertyBoolean (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> defaultVal</code></em>);</pre>
<p>
Add a new boolean property to the file format <em class="parameter"><code>format</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>the <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>a name ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>a description ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>defaultVal</code></em> :</span></p></td>
<td>a default value.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly created <a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a>, free with <a class="link" href="v-sim-toolOptions.html#tool-option-free" title="tool_option_free ()"><code class="function">tool_option_free()</code></a>.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_file_format_addPropertyInt ()">
<a name="tool-file-format-addPropertyInt"></a><h3>tool_file_format_addPropertyInt ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="returnvalue">ToolOption</span></a>* tool_file_format_addPropertyInt (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> defaultVal</code></em>);</pre>
<p>
Add a new integer property to the file format <em class="parameter"><code>format</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>the <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>a name ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>a description ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>defaultVal</code></em> :</span></p></td>
<td>a default value.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly created <a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a>, free with <a class="link" href="v-sim-toolOptions.html#tool-option-free" title="tool_option_free ()"><code class="function">tool_option_free()</code></a>.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_file_format_getPropertyByName ()">
<a name="tool-file-format-getPropertyByName"></a><h3>tool_file_format_getPropertyByName ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="returnvalue">ToolOption</span></a>* tool_file_format_getPropertyByName (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Retrieve the corresponding property to <em class="parameter"><code>name</code></em> from the biven
<em class="parameter"><code>format</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name of a property.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the found <a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> or NULL.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="tool_file_format_getPropertyList ()">
<a name="tool-file-format-getPropertyList"></a><h3>tool_file_format_getPropertyList ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a>* tool_file_format_getPropertyList (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>);</pre>
<p>
Use this method to get a list of stored properties for the given <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a>.
The GList is composed of <a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> objects.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a
GList* that is read-only.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. <acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> ToolOption*. </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_file_format_iterNextProperty ()">
<a name="tool-file-format-iterNextProperty"></a><h3>tool_file_format_iterNextProperty ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> tool_file_format_iterNextProperty (<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormatIter" title="ToolFileFormatIter"><span class="type">ToolFileFormatIter</span></a> *iter</code></em>);</pre>
<p>
Run to the next property of the file format <em class="parameter"><code>format</code></em>. The iterator
attributes are updated so it's convenient to access the property
values and details, see <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormatIter" title="ToolFileFormatIter"><span class="type">ToolFileFormatIter</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>an iterator.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if any.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
