← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpconfig/xml/gimpconfig-iface.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpconfig/xml/gimpconfig-iface.xml
12
12
<refnamediv>
13
13
<refname>gimpconfig-iface</refname>
14
14
<refpurpose>High-level API for libgimpconfig.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="libgimpconfig-GimpConfig.synopsis" role="synopsis">
30
29
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-config-serialize-to-fd">gimp_config_serialize_to_fd</link>         (<link linkend="GimpConfig">GimpConfig</link> *config,
31
30
                                                         <link linkend="gint">gint</link> fd,
32
31
                                                         <link linkend="gpointer">gpointer</link> data);
33
 
<link linkend="gchar">gchar</link>*              <link linkend="gimp-config-serialize-to-string">gimp_config_serialize_to_string</link>     (<link linkend="GimpConfig">GimpConfig</link> *config,
 
32
<link linkend="gchar">gchar</link> *             <link linkend="gimp-config-serialize-to-string">gimp_config_serialize_to_string</link>     (<link linkend="GimpConfig">GimpConfig</link> *config,
34
33
                                                         <link linkend="gpointer">gpointer</link> data);
35
34
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-config-deserialize-file">gimp_config_deserialize_file</link>        (<link linkend="GimpConfig">GimpConfig</link> *config,
36
35
                                                         const <link linkend="gchar">gchar</link> *filename,
60
59
  <link linkend="GInterface">GInterface</link>
61
60
   +----GimpConfigInterface
62
61
</synopsis>
63
 
 
64
62
</refsect1>
65
63
 
66
64
<refsect1 id="libgimpconfig-GimpConfig.prerequisites" role="prerequisites">
68
66
<para>
69
67
GimpConfigInterface requires
70
68
 <link linkend="GObject">GObject</link>.</para>
71
 
 
72
69
</refsect1>
73
70
 
74
71
 
78
75
<para>
79
76
GimpConfigInterface is implemented by
80
77
 <link linkend="GimpColorConfig">GimpColorConfig</link>.</para>
81
 
 
82
78
</refsect1>
83
79
 
84
80
 
88
84
<title role="desc.title">Description</title>
89
85
<para>
90
86
High-level API functions for libgimpconfig.
91
 
 
92
87
</para>
93
88
</refsect1>
94
89
 
96
91
<title role="details.title">Details</title>
97
92
<refsect2 id="GimpConfig" role="struct">
98
93
<title>GimpConfig</title>
99
 
<indexterm zone="GimpConfig"><primary>GimpConfig</primary></indexterm><programlisting>typedef struct _GimpConfig GimpConfig;</programlisting>
 
94
<indexterm zone="GimpConfig"><primary sortas="GimpConfig">GimpConfig</primary></indexterm><programlisting>typedef struct _GimpConfig GimpConfig;</programlisting>
100
95
<para>
101
 
 
102
96
</para></refsect2>
103
97
<refsect2 id="GimpConfigInterface-struct" role="struct">
104
98
<title>GimpConfigInterface</title>
105
 
<indexterm zone="GimpConfigInterface-struct"><primary>GimpConfigInterface</primary></indexterm><programlisting>typedef struct _GimpConfigInterface GimpConfigInterface;</programlisting>
 
99
<indexterm zone="GimpConfigInterface-struct"><primary sortas="GimpConfigInterface">GimpConfigInterface</primary></indexterm><programlisting>typedef struct _GimpConfigInterface GimpConfigInterface;</programlisting>
106
100
<para>
107
 
 
108
101
</para></refsect2>
109
102
<refsect2 id="gimp-config-serialize-to-file" role="function" condition="since:GIMP 2.4">
110
103
<title>gimp_config_serialize_to_file ()</title>
111
 
<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,
 
104
<indexterm zone="gimp-config-serialize-to-file" role="GIMP 2.4"><primary sortas="gimp_config_serialize_to_file">gimp_config_serialize_to_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_config_serialize_to_file       (<link linkend="GimpConfig">GimpConfig</link> *config,
112
105
                                                         const <link linkend="gchar">gchar</link> *filename,
113
106
                                                         const <link linkend="gchar">gchar</link> *header,
114
107
                                                         const <link linkend="gchar">gchar</link> *footer,
120
113
overwritten. Basically this function opens <parameter>filename</parameter> for you and
121
114
calls the serialize function of the <parameter>config</parameter>'s <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.</para>
122
115
<para>
123
 
 
124
116
</para><variablelist role="params">
125
 
<varlistentry><term><parameter>config</parameter>&nbsp;:</term>
 
117
<varlistentry><term><parameter>config</parameter>&#160;:</term>
126
118
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
127
119
</simpara></listitem></varlistentry>
128
 
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
 
120
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
129
121
<listitem><simpara> the name of the file to write the configuration to.
130
122
</simpara></listitem></varlistentry>
131
 
<varlistentry><term><parameter>header</parameter>&nbsp;:</term>
 
123
<varlistentry><term><parameter>header</parameter>&#160;:</term>
132
124
<listitem><simpara> optional file header (must be ASCII only)
133
125
</simpara></listitem></varlistentry>
134
 
<varlistentry><term><parameter>footer</parameter>&nbsp;:</term>
 
126
<varlistentry><term><parameter>footer</parameter>&#160;:</term>
135
127
<listitem><simpara> optional file footer (must be ASCII only)
136
128
</simpara></listitem></varlistentry>
137
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
129
<varlistentry><term><parameter>data</parameter>&#160;:</term>
138
130
<listitem><simpara> user data passed to the serialize implementation.
139
131
</simpara></listitem></varlistentry>
140
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
132
<varlistentry><term><parameter>error</parameter>&#160;:</term>
141
133
<listitem><simpara>
142
134
</simpara></listitem></varlistentry>
143
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if serialization succeeded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
 
135
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if serialization succeeded, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
144
136
 
145
137
</simpara></listitem></varlistentry>
146
 
</variablelist><para role="since">Since  GIMP 2.4
147
 
</para></refsect2>
 
138
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
148
139
<refsect2 id="gimp-config-serialize-to-fd" role="function" condition="since:GIMP 2.4">
149
140
<title>gimp_config_serialize_to_fd ()</title>
150
 
<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,
 
141
<indexterm zone="gimp-config-serialize-to-fd" role="GIMP 2.4"><primary sortas="gimp_config_serialize_to_fd">gimp_config_serialize_to_fd</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_config_serialize_to_fd         (<link linkend="GimpConfig">GimpConfig</link> *config,
151
142
                                                         <link linkend="gint">gint</link> fd,
152
143
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
153
144
<para>
154
145
Serializes the object properties of <parameter>config</parameter> to the given file
155
146
descriptor.</para>
156
147
<para>
157
 
 
158
148
</para><variablelist role="params">
159
 
<varlistentry><term><parameter>config</parameter>&nbsp;:</term>
 
149
<varlistentry><term><parameter>config</parameter>&#160;:</term>
160
150
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
161
151
</simpara></listitem></varlistentry>
162
 
<varlistentry><term><parameter>fd</parameter>&nbsp;:</term>
 
152
<varlistentry><term><parameter>fd</parameter>&#160;:</term>
163
153
<listitem><simpara> a file descriptor, opened for writing
164
154
</simpara></listitem></varlistentry>
165
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
155
<varlistentry><term><parameter>data</parameter>&#160;:</term>
166
156
<listitem><simpara> user data passed to the serialize implementation.
167
157
</simpara></listitem></varlistentry>
168
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if serialization succeeded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
 
158
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if serialization succeeded, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
169
159
 
170
160
</simpara></listitem></varlistentry>
171
 
</variablelist><para role="since">Since  GIMP 2.4
172
 
</para></refsect2>
 
161
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
173
162
<refsect2 id="gimp-config-serialize-to-string" role="function" condition="since:GIMP 2.4">
174
163
<title>gimp_config_serialize_to_string ()</title>
175
 
<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,
 
164
<indexterm zone="gimp-config-serialize-to-string" role="GIMP 2.4"><primary sortas="gimp_config_serialize_to_string">gimp_config_serialize_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             gimp_config_serialize_to_string     (<link linkend="GimpConfig">GimpConfig</link> *config,
176
165
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
177
166
<para>
178
167
Serializes the object properties of <parameter>config</parameter> to a string.</para>
179
168
<para>
180
 
 
181
169
</para><variablelist role="params">
182
 
<varlistentry><term><parameter>config</parameter>&nbsp;:</term>
 
170
<varlistentry><term><parameter>config</parameter>&#160;:</term>
183
171
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
184
172
</simpara></listitem></varlistentry>
185
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
173
<varlistentry><term><parameter>data</parameter>&#160;:</term>
186
174
<listitem><simpara> user data passed to the serialize implementation.
187
175
</simpara></listitem></varlistentry>
188
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated <link linkend="NUL:CAPS"><literal>NUL</literal></link>-terminated string.
 
176
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated <link linkend="NUL--CAPS"><literal>NUL</literal></link>-terminated string.
189
177
 
190
178
</simpara></listitem></varlistentry>
191
 
</variablelist><para role="since">Since  GIMP 2.4
192
 
</para></refsect2>
 
179
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
193
180
<refsect2 id="gimp-config-deserialize-file" role="function" condition="since:GIMP 2.4">
194
181
<title>gimp_config_deserialize_file ()</title>
195
 
<indexterm zone="gimp-config-deserialize-file" role="GIMP 2.4"><primary>gimp_config_deserialize_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_config_deserialize_file        (<link linkend="GimpConfig">GimpConfig</link> *config,
 
182
<indexterm zone="gimp-config-deserialize-file" role="GIMP 2.4"><primary sortas="gimp_config_deserialize_file">gimp_config_deserialize_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_config_deserialize_file        (<link linkend="GimpConfig">GimpConfig</link> *config,
196
183
                                                         const <link linkend="gchar">gchar</link> *filename,
197
184
                                                         <link linkend="gpointer">gpointer</link> data,
198
185
                                                         <link linkend="GError">GError</link> **error);</programlisting>
202
189
creates a properly configured <link linkend="GScanner"><type>GScanner</type></link> for you and calls the
203
190
deserialize function of the <parameter>config</parameter>'s <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.</para>
204
191
<para>
205
 
 
206
192
</para><variablelist role="params">
207
 
<varlistentry><term><parameter>config</parameter>&nbsp;:</term>
 
193
<varlistentry><term><parameter>config</parameter>&#160;:</term>
208
194
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
209
195
</simpara></listitem></varlistentry>
210
 
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
 
196
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
211
197
<listitem><simpara> the name of the file to read configuration from.
212
198
</simpara></listitem></varlistentry>
213
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
199
<varlistentry><term><parameter>data</parameter>&#160;:</term>
214
200
<listitem><simpara> user data passed to the deserialize implementation.
215
201
</simpara></listitem></varlistentry>
216
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
202
<varlistentry><term><parameter>error</parameter>&#160;:</term>
217
203
<listitem><simpara>
218
204
</simpara></listitem></varlistentry>
219
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if deserialization succeeded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
 
205
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if deserialization succeeded, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
220
206
 
221
207
</simpara></listitem></varlistentry>
222
 
</variablelist><para role="since">Since  GIMP 2.4
223
 
</para></refsect2>
 
208
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
224
209
<refsect2 id="gimp-config-deserialize-string" role="function" condition="since:GIMP 2.4">
225
210
<title>gimp_config_deserialize_string ()</title>
226
 
<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,
 
211
<indexterm zone="gimp-config-deserialize-string" role="GIMP 2.4"><primary sortas="gimp_config_deserialize_string">gimp_config_deserialize_string</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_config_deserialize_string      (<link linkend="GimpConfig">GimpConfig</link> *config,
227
212
                                                         const <link linkend="gchar">gchar</link> *text,
228
213
                                                         <link linkend="gint">gint</link> text_len,
229
214
                                                         <link linkend="gpointer">gpointer</link> data,
233
218
properly configured <link linkend="GScanner"><type>GScanner</type></link> for you and calls the deserialize
234
219
function of the <parameter>config</parameter>'s <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.</para>
235
220
<para>
236
 
 
237
221
</para><variablelist role="params">
238
 
<varlistentry><term><parameter>config</parameter>&nbsp;:</term>
 
222
<varlistentry><term><parameter>config</parameter>&#160;:</term>
239
223
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
240
224
</simpara></listitem></varlistentry>
241
 
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
 
225
<varlistentry><term><parameter>text</parameter>&#160;:</term>
242
226
<listitem><simpara> string to deserialize (in UTF-8 encoding)
243
227
</simpara></listitem></varlistentry>
244
 
<varlistentry><term><parameter>text_len</parameter>&nbsp;:</term>
 
228
<varlistentry><term><parameter>text_len</parameter>&#160;:</term>
245
229
<listitem><simpara> length of <parameter>text</parameter> in bytes or -1
246
230
</simpara></listitem></varlistentry>
247
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
248
 
<listitem><simpara>
249
 
</simpara></listitem></varlistentry>
250
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
251
 
<listitem><simpara>
252
 
</simpara></listitem></varlistentry>
253
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if deserialization succeeded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
 
231
<varlistentry><term><parameter>data</parameter>&#160;:</term>
 
232
<listitem><simpara>
 
233
</simpara></listitem></varlistentry>
 
234
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
235
<listitem><simpara>
 
236
</simpara></listitem></varlistentry>
 
237
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if deserialization succeeded, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
254
238
 
255
239
</simpara></listitem></varlistentry>
256
 
</variablelist><para role="since">Since  GIMP 2.4
257
 
</para></refsect2>
 
240
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
258
241
<refsect2 id="gimp-config-deserialize-return" role="function" condition="since:GIMP 2.4">
259
242
<title>gimp_config_deserialize_return ()</title>
260
 
<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,
 
243
<indexterm zone="gimp-config-deserialize-return" role="GIMP 2.4"><primary sortas="gimp_config_deserialize_return">gimp_config_deserialize_return</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_config_deserialize_return      (<link linkend="GScanner">GScanner</link> *scanner,
261
244
                                                         <link linkend="GTokenType">GTokenType</link> expected_token,
262
245
                                                         <link linkend="gint">gint</link> nest_level);</programlisting>
263
246
<para>
264
247
</para>
265
248
<para>
266
 
 
267
249
</para><variablelist role="params">
268
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
269
 
<listitem><simpara>
270
 
</simpara></listitem></varlistentry>
271
 
<varlistentry><term><parameter>expected_token</parameter>&nbsp;:</term>
272
 
<listitem><simpara>
273
 
</simpara></listitem></varlistentry>
274
 
<varlistentry><term><parameter>nest_level</parameter>&nbsp;:</term>
275
 
<listitem><simpara>
276
 
</simpara></listitem></varlistentry>
277
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
250
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
 
251
<listitem><simpara>
 
252
</simpara></listitem></varlistentry>
 
253
<varlistentry><term><parameter>expected_token</parameter>&#160;:</term>
 
254
<listitem><simpara>
 
255
</simpara></listitem></varlistentry>
 
256
<varlistentry><term><parameter>nest_level</parameter>&#160;:</term>
 
257
<listitem><simpara>
 
258
</simpara></listitem></varlistentry>
 
259
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
278
260
 
279
261
</simpara></listitem></varlistentry>
280
 
</variablelist><para role="since">Since  GIMP 2.4
281
 
</para></refsect2>
 
262
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
282
263
<refsect2 id="gimp-config-duplicate" role="function" condition="since:GIMP 2.4">
283
264
<title>gimp_config_duplicate ()</title>
284
 
<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>
 
265
<indexterm zone="gimp-config-duplicate" role="GIMP 2.4"><primary sortas="gimp_config_duplicate">gimp_config_duplicate</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            gimp_config_duplicate               (<link linkend="GimpConfig">GimpConfig</link> *config);</programlisting>
285
266
<para>
286
267
Creates a copy of the passed object by copying all object
287
268
properties. The default implementation of the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>
288
269
only works for objects that are completely defined by their
289
270
properties.</para>
290
271
<para>
291
 
 
292
272
</para><variablelist role="params">
293
 
<varlistentry><term><parameter>config</parameter>&nbsp;:</term>
 
273
<varlistentry><term><parameter>config</parameter>&#160;:</term>
294
274
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
295
275
</simpara></listitem></varlistentry>
296
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the duplicated <link linkend="GimpConfig"><type>GimpConfig</type></link> object
 
276
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the duplicated <link linkend="GimpConfig"><type>GimpConfig</type></link> object
297
277
 
298
278
</simpara></listitem></varlistentry>
299
 
</variablelist><para role="since">Since  GIMP 2.4
300
 
</para></refsect2>
 
279
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
301
280
<refsect2 id="gimp-config-is-equal-to" role="function" condition="since:GIMP 2.4">
302
281
<title>gimp_config_is_equal_to ()</title>
303
 
<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,
 
282
<indexterm zone="gimp-config-is-equal-to" role="GIMP 2.4"><primary sortas="gimp_config_is_equal_to">gimp_config_is_equal_to</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_config_is_equal_to             (<link linkend="GimpConfig">GimpConfig</link> *a,
304
283
                                                         <link linkend="GimpConfig">GimpConfig</link> *b);</programlisting>
305
284
<para>
306
285
Compares the two objects. The default implementation of the
308
287
works for objects that are completely defined by their
309
288
properties.</para>
310
289
<para>
311
 
 
312
290
</para><variablelist role="params">
313
 
<varlistentry><term><parameter>a</parameter>&nbsp;:</term>
 
291
<varlistentry><term><parameter>a</parameter>&#160;:</term>
314
292
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
315
293
</simpara></listitem></varlistentry>
316
 
<varlistentry><term><parameter>b</parameter>&nbsp;:</term>
 
294
<varlistentry><term><parameter>b</parameter>&#160;:</term>
317
295
<listitem><simpara> another <link linkend="GObject"><type>GObject</type></link> of the same type as <parameter>a</parameter>.
318
296
</simpara></listitem></varlistentry>
319
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the two objects are equal.
 
297
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the two objects are equal.
320
298
 
321
299
</simpara></listitem></varlistentry>
322
 
</variablelist><para role="since">Since  GIMP 2.4
323
 
</para></refsect2>
 
300
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
324
301
<refsect2 id="gimp-config-reset" role="function" condition="since:GIMP 2.4">
325
302
<title>gimp_config_reset ()</title>
326
 
<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>
 
303
<indexterm zone="gimp-config-reset" role="GIMP 2.4"><primary sortas="gimp_config_reset">gimp_config_reset</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_config_reset                   (<link linkend="GimpConfig">GimpConfig</link> *config);</programlisting>
327
304
<para>
328
305
Resets the object to its default state. The default implementation of the
329
306
<link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link> only works for objects that are completely defined by
330
307
their properties.</para>
331
308
<para>
332
 
 
333
309
</para><variablelist role="params">
334
 
<varlistentry><term><parameter>config</parameter>&nbsp;:</term>
 
310
<varlistentry><term><parameter>config</parameter>&#160;:</term>
335
311
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
336
312
</simpara></listitem></varlistentry>
337
 
</variablelist><para role="since">Since  GIMP 2.4
338
 
</para></refsect2>
 
313
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
339
314
<refsect2 id="gimp-config-copy" role="function" condition="since:GIMP 2.6">
340
315
<title>gimp_config_copy ()</title>
341
 
<indexterm zone="gimp-config-copy" role="GIMP 2.6"><primary>gimp_config_copy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_config_copy                    (<link linkend="GimpConfig">GimpConfig</link> *src,
 
316
<indexterm zone="gimp-config-copy" role="GIMP 2.6"><primary sortas="gimp_config_copy">gimp_config_copy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_config_copy                    (<link linkend="GimpConfig">GimpConfig</link> *src,
342
317
                                                         <link linkend="GimpConfig">GimpConfig</link> *dest,
343
318
                                                         <link linkend="GParamFlags">GParamFlags</link> flags);</programlisting>
344
319
<para>
349
324
<para>
350
325
Properties marked as "construct-only" are not touched.</para>
351
326
<para>
352
 
 
353
327
</para><variablelist role="params">
354
 
<varlistentry><term><parameter>src</parameter>&nbsp;:</term>
 
328
<varlistentry><term><parameter>src</parameter>&#160;:</term>
355
329
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> that implements the <link linkend="GimpConfigInterface"><type>GimpConfigInterface</type></link>.
356
330
</simpara></listitem></varlistentry>
357
 
<varlistentry><term><parameter>dest</parameter>&nbsp;:</term>
 
331
<varlistentry><term><parameter>dest</parameter>&#160;:</term>
358
332
<listitem><simpara> another <link linkend="GObject"><type>GObject</type></link> of the same type as <parameter>a</parameter>.
359
333
</simpara></listitem></varlistentry>
360
 
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
 
334
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
361
335
<listitem><simpara> a mask of GParamFlags
362
336
</simpara></listitem></varlistentry>
363
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>dest</parameter> was modified, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
 
337
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>dest</parameter> was modified, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
364
338
 
365
339
</simpara></listitem></varlistentry>
366
 
</variablelist><para role="since">Since  GIMP 2.6
367
 
</para></refsect2>
 
340
</variablelist><para role="since">Since GIMP 2.6</para></refsect2>
368
341
 
369
342
</refsect1>
370
343