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
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimpconfig-GimpConfig">
<refmeta>
<refentrytitle role="top_of_page" id="libgimpconfig-GimpConfig.top_of_page">gimpconfig-iface</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPCONFIG Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpconfig-iface</refname>
<refpurpose>High-level API for libgimpconfig.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libgimpconfig-GimpConfig.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="GimpConfigInterface"/>
<synopsis>
<link linkend="GimpConfig">GimpConfig</link>;
<link linkend="GimpConfigInterface-struct">GimpConfigInterface</link>;
<link linkend="gboolean">gboolean</link> <link linkend="gimp-config-serialize-to-file">gimp_config_serialize_to_file</link> (<link linkend="GimpConfig">GimpConfig</link> *config,
const <link linkend="gchar">gchar</link> *filename,
const <link linkend="gchar">gchar</link> *header,
const <link linkend="gchar">gchar</link> *footer,
<link linkend="gpointer">gpointer</link> data,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-config-serialize-to-fd">gimp_config_serialize_to_fd</link> (<link linkend="GimpConfig">GimpConfig</link> *config,
<link linkend="gint">gint</link> fd,
<link linkend="gpointer">gpointer</link> data);
<link linkend="gchar">gchar</link>* <link linkend="gimp-config-serialize-to-string">gimp_config_serialize_to_string</link> (<link linkend="GimpConfig">GimpConfig</link> *config,
<link linkend="gpointer">gpointer</link> data);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-config-deserialize-file">gimp_config_deserialize_file</link> (<link linkend="GimpConfig">GimpConfig</link> *config,
const <link linkend="gchar">gchar</link> *filename,
<link linkend="gpointer">gpointer</link> data,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-config-deserialize-string">gimp_config_deserialize_string</link> (<link linkend="GimpConfig">GimpConfig</link> *config,
const <link linkend="gchar">gchar</link> *text,
<link linkend="gint">gint</link> text_len,
<link linkend="gpointer">gpointer</link> data,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-config-deserialize-return">gimp_config_deserialize_return</link> (<link linkend="GScanner">GScanner</link> *scanner,
<link linkend="GTokenType">GTokenType</link> expected_token,
<link linkend="gint">gint</link> nest_level);
<link linkend="gpointer">gpointer</link> <link linkend="gimp-config-duplicate">gimp_config_duplicate</link> (<link linkend="GimpConfig">GimpConfig</link> *config);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-config-is-equal-to">gimp_config_is_equal_to</link> (<link linkend="GimpConfig">GimpConfig</link> *a,
<link linkend="GimpConfig">GimpConfig</link> *b);
<link linkend="void">void</link> <link linkend="gimp-config-reset">gimp_config_reset</link> (<link linkend="GimpConfig">GimpConfig</link> *config);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libgimpconfig-GimpConfig.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GInterface">GInterface</link>
+----GimpConfigInterface
</synopsis>
</refsect1>
<refsect1 id="libgimpconfig-GimpConfig.prerequisites" role="prerequisites">
<title role="prerequisites.title">Prerequisites</title>
<para>
GimpConfigInterface requires
<link linkend="GObject">GObject</link>.</para>
</refsect1>
<refsect1 id="libgimpconfig-GimpConfig.implementations" role="implementations">
<title role="implementations.title">Known Implementations</title>
<para>
GimpConfigInterface is implemented by
<link linkend="GimpColorConfig">GimpColorConfig</link>.</para>
</refsect1>
<refsect1 id="libgimpconfig-GimpConfig.description" role="desc">
<title role="desc.title">Description</title>
<para>
High-level API functions for libgimpconfig.
</para>
</refsect1>
<refsect1 id="libgimpconfig-GimpConfig.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GimpConfig" role="struct">
<title>GimpConfig</title>
<indexterm zone="GimpConfig"><primary>GimpConfig</primary></indexterm><programlisting>typedef struct _GimpConfig GimpConfig;</programlisting>
<para>
</para></refsect2>
<refsect2 id="GimpConfigInterface-struct" role="struct">
<title>GimpConfigInterface</title>
<indexterm zone="GimpConfigInterface-struct"><primary>GimpConfigInterface</primary></indexterm><programlisting>typedef struct _GimpConfigInterface GimpConfigInterface;</programlisting>
<para>
</para></refsect2>
<refsect2 id="gimp-config-serialize-to-file" role="function" condition="since:GIMP 2.4">
<title>gimp_config_serialize_to_file ()</title>
<indexterm zone="gimp-config-serialize-to-file" role="GIMP 2.4"><primary>gimp_config_serialize_to_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_config_serialize_to_file (<link linkend="GimpConfig">GimpConfig</link> *config,
const <link linkend="gchar">gchar</link> *filename,
const <link linkend="gchar">gchar</link> *header,
const <link linkend="gchar">gchar</link> *footer,
<link linkend="gpointer">gpointer</link> data,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Serializes the object properties of <parameter>config</parameter> to the file specified
by <parameter>filename</parameter>. If a file with that name already exists, it is
overwritten. Basically this function opens <parameter>filename</parameter> for you and
calls the serialize function of the <parameter>config</parameter>'s <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> the name of the file to write the configuration to.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>header</parameter> :</term>
<listitem><simpara> optional file header (must be ASCII only)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>footer</parameter> :</term>
<listitem><simpara> optional file footer (must be ASCII only)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> user data passed to the serialize implementation.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if serialization succeeded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-serialize-to-fd" role="function" condition="since:GIMP 2.4">
<title>gimp_config_serialize_to_fd ()</title>
<indexterm zone="gimp-config-serialize-to-fd" role="GIMP 2.4"><primary>gimp_config_serialize_to_fd</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_config_serialize_to_fd (<link linkend="GimpConfig">GimpConfig</link> *config,
<link linkend="gint">gint</link> fd,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Serializes the object properties of <parameter>config</parameter> to the given file
descriptor.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fd</parameter> :</term>
<listitem><simpara> a file descriptor, opened for writing
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> user data passed to the serialize implementation.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if serialization succeeded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-serialize-to-string" role="function" condition="since:GIMP 2.4">
<title>gimp_config_serialize_to_string ()</title>
<indexterm zone="gimp-config-serialize-to-string" role="GIMP 2.4"><primary>gimp_config_serialize_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_config_serialize_to_string (<link linkend="GimpConfig">GimpConfig</link> *config,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Serializes the object properties of <parameter>config</parameter> to a string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> user data passed to the serialize implementation.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated <link linkend="NUL:CAPS"><literal>NUL</literal></link>-terminated string.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-deserialize-file" role="function">
<title>gimp_config_deserialize_file ()</title>
<indexterm zone="gimp-config-deserialize-file"><primary>gimp_config_deserialize_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_config_deserialize_file (<link linkend="GimpConfig">GimpConfig</link> *config,
const <link linkend="gchar">gchar</link> *filename,
<link linkend="gpointer">gpointer</link> data,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-config-deserialize-string" role="function" condition="since:GIMP 2.4">
<title>gimp_config_deserialize_string ()</title>
<indexterm zone="gimp-config-deserialize-string" role="GIMP 2.4"><primary>gimp_config_deserialize_string</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_config_deserialize_string (<link linkend="GimpConfig">GimpConfig</link> *config,
const <link linkend="gchar">gchar</link> *text,
<link linkend="gint">gint</link> text_len,
<link linkend="gpointer">gpointer</link> data,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Configures <parameter>config</parameter> from <parameter>text</parameter>. Basically this function creates a
properly configured <link linkend="GScanner"><type>GScanner</type></link> for you and calls the deserialize
function of the <parameter>config</parameter>'s <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> string to deserialize (in UTF-8 encoding)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text_len</parameter> :</term>
<listitem><simpara> length of <parameter>text</parameter> in bytes or -1
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if deserialization succeeded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-deserialize-return" role="function" condition="since:GIMP 2.4">
<title>gimp_config_deserialize_return ()</title>
<indexterm zone="gimp-config-deserialize-return" role="GIMP 2.4"><primary>gimp_config_deserialize_return</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_config_deserialize_return (<link linkend="GScanner">GScanner</link> *scanner,
<link linkend="GTokenType">GTokenType</link> expected_token,
<link linkend="gint">gint</link> nest_level);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>scanner</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>expected_token</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>nest_level</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-duplicate" role="function" condition="since:GIMP 2.4">
<title>gimp_config_duplicate ()</title>
<indexterm zone="gimp-config-duplicate" role="GIMP 2.4"><primary>gimp_config_duplicate</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> gimp_config_duplicate (<link linkend="GimpConfig">GimpConfig</link> *config);</programlisting>
<para>
Creates a copy of the passed object by copying all object
properties. The default implementation of the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>
only works for objects that are completely defined by their
properties.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the duplicated <link linkend="GimpConfig"><type>GimpConfig</type></link> object
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-is-equal-to" role="function" condition="since:GIMP 2.4">
<title>gimp_config_is_equal_to ()</title>
<indexterm zone="gimp-config-is-equal-to" role="GIMP 2.4"><primary>gimp_config_is_equal_to</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_config_is_equal_to (<link linkend="GimpConfig">GimpConfig</link> *a,
<link linkend="GimpConfig">GimpConfig</link> *b);</programlisting>
<para>
Compares the two objects. The default implementation of the
<link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link> compares the object properties and thus only
works for objects that are completely defined by their
properties.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>a</parameter> :</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>b</parameter> :</term>
<listitem><simpara> another <link linkend="GObject"><type>GObject</type></link> of the same type as <parameter>a</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the two objects are equal.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-reset" role="function" condition="since:GIMP 2.4">
<title>gimp_config_reset ()</title>
<indexterm zone="gimp-config-reset" role="GIMP 2.4"><primary>gimp_config_reset</primary></indexterm><programlisting><link linkend="void">void</link> gimp_config_reset (<link linkend="GimpConfig">GimpConfig</link> *config);</programlisting>
<para>
Resets the object to its default state. The default implementation of the
<link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link> only works for objects that are completely defined by
their properties.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
</refsect1>
</refentry>
|
