← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/html/libgimp-gimpgimprc.html

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/html/libgimp-gimpgimprc.html
8
8
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
9
9
<link rel="prev" href="libgimp-gimpcontext.html" title="gimpcontext">
10
10
<link rel="next" href="libgimp-gimphelp.html" title="gimphelp">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
14
 
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
15
 
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
16
 
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
17
 
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
18
 
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
19
 
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
20
 
<link rel="index" href="libgimp-index.html" title="Index">
21
 
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
22
 
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
23
 
<link rel="index" href="libgimp-index-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
24
 
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
25
13
</head>
26
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
27
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
34
22
</tr>
35
23
<tr><td colspan="5" class="shortcuts">
36
24
<a href="#libgimp-gimpgimprc.synopsis" class="shortcut">Top</a>
37
 
                 | 
38
 
                <a href="#libgimp-gimpgimprc.description" class="shortcut">Description</a>
 
25
                   | 
 
26
                  <a href="#libgimp-gimpgimprc.description" class="shortcut">Description</a>
39
27
</td></tr>
40
28
</table>
41
29
<div class="refentry" title="gimpgimprc">
49
37
</tr></table></div>
50
38
<div class="refsynopsisdiv" title="Synopsis">
51
39
<a name="libgimp-gimpgimprc.synopsis"></a><h2>Synopsis</h2>
52
 
<pre class="synopsis">
53
 
<a
54
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
55
 
>gchar</a>*              <a class="link" href="libgimp-gimpgimprc.html#gimp-gimprc-query" title="gimp_gimprc_query ()">gimp_gimprc_query</a>                   (const <a
56
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
57
 
>gchar</a> *token);
58
 
<a
59
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
60
 
>gboolean</a>            <a class="link" href="libgimp-gimpgimprc.html#gimp-gimprc-set" title="gimp_gimprc_set ()">gimp_gimprc_set</a>                     (const <a
61
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
62
 
>gchar</a> *token,
63
 
                                                         const <a
64
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
65
 
>gchar</a> *value);
66
 
<a
67
 
href="../libgimpconfig/GimpColorConfig.html"
68
 
>GimpColorConfig</a> *   <a class="link" href="libgimp-gimpgimprc.html#gimp-get-color-configuration" title="gimp_get_color_configuration ()">gimp_get_color_configuration</a>        (void);
69
 
<a
70
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
71
 
>gchar</a>*              <a class="link" href="libgimp-gimpgimprc.html#gimp-get-default-comment" title="gimp_get_default_comment ()">gimp_get_default_comment</a>            (void);
72
 
<a
73
 
href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"
74
 
>GimpUnit</a>            <a class="link" href="libgimp-gimpgimprc.html#gimp-get-default-unit" title="gimp_get_default_unit ()">gimp_get_default_unit</a>               (void);
75
 
<a
76
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
77
 
>gchar</a>*              <a class="link" href="libgimp-gimpgimprc.html#gimp-get-module-load-inhibit" title="gimp_get_module_load_inhibit ()">gimp_get_module_load_inhibit</a>        (void);
78
 
<a
79
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
80
 
>gboolean</a>            <a class="link" href="libgimp-gimpgimprc.html#gimp-get-monitor-resolution" title="gimp_get_monitor_resolution ()">gimp_get_monitor_resolution</a>         (<a
81
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
82
 
>gdouble</a> *xres,
83
 
                                                         <a
84
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
85
 
>gdouble</a> *yres);
86
 
<a
87
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
88
 
>gchar</a>*              <a class="link" href="libgimp-gimpgimprc.html#gimp-get-theme-dir" title="gimp_get_theme_dir ()">gimp_get_theme_dir</a>                  (void);
 
40
<pre class="synopsis"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*              <a class="link" href="libgimp-gimpgimprc.html#gimp-gimprc-query" title="gimp_gimprc_query ()">gimp_gimprc_query</a>                   (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *token</code></em>);
 
41
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgimp-gimpgimprc.html#gimp-gimprc-set" title="gimp_gimprc_set ()">gimp_gimprc_set</a>                     (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *token</code></em>,
 
42
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);
 
43
<a href="../libgimpconfig/GimpColorConfig.html"><span class="returnvalue">GimpColorConfig</span></a> *   <a class="link" href="libgimp-gimpgimprc.html#gimp-get-color-configuration" title="gimp_get_color_configuration ()">gimp_get_color_configuration</a>        (<em class="parameter"><code><span class="type">void</span></code></em>);
 
44
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*              <a class="link" href="libgimp-gimpgimprc.html#gimp-get-default-comment" title="gimp_get_default_comment ()">gimp_get_default_comment</a>            (<em class="parameter"><code><span class="type">void</span></code></em>);
 
45
<a href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"><span class="returnvalue">GimpUnit</span></a>            <a class="link" href="libgimp-gimpgimprc.html#gimp-get-default-unit" title="gimp_get_default_unit ()">gimp_get_default_unit</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
 
46
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*              <a class="link" href="libgimp-gimpgimprc.html#gimp-get-module-load-inhibit" title="gimp_get_module_load_inhibit ()">gimp_get_module_load_inhibit</a>        (<em class="parameter"><code><span class="type">void</span></code></em>);
 
47
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgimp-gimpgimprc.html#gimp-get-monitor-resolution" title="gimp_get_monitor_resolution ()">gimp_get_monitor_resolution</a>         (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *xres</code></em>,
 
48
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *yres</code></em>);
 
49
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*              <a class="link" href="libgimp-gimpgimprc.html#gimp-get-theme-dir" title="gimp_get_theme_dir ()">gimp_get_theme_dir</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
89
50
</pre>
90
51
</div>
91
52
<div class="refsect1" title="Description">
98
59
<a name="libgimp-gimpgimprc.details"></a><h2>Details</h2>
99
60
<div class="refsect2" title="gimp_gimprc_query ()">
100
61
<a name="gimp-gimprc-query"></a><h3>gimp_gimprc_query ()</h3>
101
 
<pre class="programlisting"><a
102
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
103
 
>gchar</a>*              gimp_gimprc_query                   (const <a
104
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
105
 
>gchar</a> *token);</pre>
 
62
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*              gimp_gimprc_query                   (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *token</code></em>);</pre>
106
63
<p>
107
64
Queries the gimprc file parser for information on a specified token.
108
65
</p>
115
72
with the specified token. This corresponds _only_ to entries with
116
73
the format: (&lt;token&gt; &lt;value&gt;). The value must be a
117
74
string. Entries not corresponding to this format will cause warnings
118
 
to be issued on gimprc parsing and will not be queryable.</p>
119
 
<p>
 
75
to be issued on gimprc parsing and will not be queryable.
120
76
</p>
121
77
<div class="variablelist"><table border="0">
122
78
<col align="left" valign="top">
123
79
<tbody>
124
80
<tr>
125
81
<td><p><span class="term"><em class="parameter"><code>token</code></em> :</span></p></td>
126
 
<td> The token to query for.
 
82
<td>The token to query for.
127
83
</td>
128
84
</tr>
129
85
<tr>
137
93
<hr>
138
94
<div class="refsect2" title="gimp_gimprc_set ()">
139
95
<a name="gimp-gimprc-set"></a><h3>gimp_gimprc_set ()</h3>
140
 
<pre class="programlisting"><a
141
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
142
 
>gboolean</a>            gimp_gimprc_set                     (const <a
143
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
144
 
>gchar</a> *token,
145
 
                                                         const <a
146
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
147
 
>gchar</a> *value);</pre>
 
96
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gimp_gimprc_set                     (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *token</code></em>,
 
97
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
148
98
<p>
149
99
Sets a gimprc token to a value and saves it in the gimprc.
150
100
</p>
153
103
the gimprc file that is considered extraneous to the operation of
154
104
GIMP. Plug-ins that need configuration information can use this
155
105
function to store it, and <a class="link" href="libgimp-gimpgimprc.html#gimp-gimprc-query" title="gimp_gimprc_query ()"><code class="function">gimp_gimprc_query()</code></a> to retrieve it. This
156
 
will accept _only_ string values in UTF-8 encoding.</p>
157
 
<p>
 
106
will accept _only_ string values in UTF-8 encoding.
158
107
</p>
159
108
<div class="variablelist"><table border="0">
160
109
<col align="left" valign="top">
161
110
<tbody>
162
111
<tr>
163
112
<td><p><span class="term"><em class="parameter"><code>token</code></em> :</span></p></td>
164
 
<td> The token to add or modify.
 
113
<td>The token to add or modify.
165
114
</td>
166
115
</tr>
167
116
<tr>
168
117
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
169
 
<td> The value to set the token to.
 
118
<td>The value to set the token to.
170
119
</td>
171
120
</tr>
172
121
<tr>
180
129
<hr>
181
130
<div class="refsect2" title="gimp_get_color_configuration ()">
182
131
<a name="gimp-get-color-configuration"></a><h3>gimp_get_color_configuration ()</h3>
183
 
<pre class="programlisting"><a
184
 
href="../libgimpconfig/GimpColorConfig.html"
185
 
>GimpColorConfig</a> *   gimp_get_color_configuration        (void);</pre>
186
 
<p>
187
 
Retrieve a copy of the current color management configuration.</p>
188
 
<p>
 
132
<pre class="programlisting"><a href="../libgimpconfig/GimpColorConfig.html"><span class="returnvalue">GimpColorConfig</span></a> *   gimp_get_color_configuration        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
133
<p>
 
134
Retrieve a copy of the current color management configuration.
189
135
</p>
190
136
<div class="variablelist"><table border="0">
191
137
<col align="left" valign="top">
192
138
<tbody><tr>
193
139
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
194
 
<td> A copy of the core's <a
195
 
href="../libgimpconfig/GimpColorConfig.html"
196
 
><span class="type">GimpColorConfig</span></a>. You should unref
 
140
<td> A copy of the core's <a href="../libgimpconfig/GimpColorConfig.html"><span class="type">GimpColorConfig</span></a>. You should unref
197
141
         this copy if you don't need it any longer.
198
142
 
199
143
</td>
204
148
<hr>
205
149
<div class="refsect2" title="gimp_get_default_comment ()">
206
150
<a name="gimp-get-default-comment"></a><h3>gimp_get_default_comment ()</h3>
207
 
<pre class="programlisting"><a
208
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
209
 
>gchar</a>*              gimp_get_default_comment            (void);</pre>
 
151
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*              gimp_get_default_comment            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
210
152
<p>
211
153
Get the default image comment as specified in the Preferences.
212
154
</p>
213
155
<p>
214
 
Returns a copy of the default image comment.</p>
215
 
<p>
 
156
Returns a copy of the default image comment.
216
157
</p>
217
158
<div class="variablelist"><table border="0">
218
159
<col align="left" valign="top">
226
167
<hr>
227
168
<div class="refsect2" title="gimp_get_default_unit ()">
228
169
<a name="gimp-get-default-unit"></a><h3>gimp_get_default_unit ()</h3>
229
 
<pre class="programlisting"><a
230
 
href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"
231
 
>GimpUnit</a>            gimp_get_default_unit               (void);</pre>
 
170
<pre class="programlisting"><a href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"><span class="returnvalue">GimpUnit</span></a>            gimp_get_default_unit               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
232
171
<p>
233
172
Get the default unit (taken from the user's locale).
234
173
</p>
235
174
<p>
236
 
Returns the default unit's integer ID.</p>
237
 
<p>
 
175
Returns the default unit's integer ID.
238
176
</p>
239
177
<div class="variablelist"><table border="0">
240
178
<col align="left" valign="top">
250
188
<hr>
251
189
<div class="refsect2" title="gimp_get_module_load_inhibit ()">
252
190
<a name="gimp-get-module-load-inhibit"></a><h3>gimp_get_module_load_inhibit ()</h3>
253
 
<pre class="programlisting"><a
254
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
255
 
>gchar</a>*              gimp_get_module_load_inhibit        (void);</pre>
 
191
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*              gimp_get_module_load_inhibit        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
256
192
<p>
257
193
Get the list of modules which should not be loaded.
258
194
</p>
259
195
<p>
260
 
Returns a copy of the list of modules which should not be loaded.</p>
261
 
<p>
 
196
Returns a copy of the list of modules which should not be loaded.
262
197
</p>
263
198
<div class="variablelist"><table border="0">
264
199
<col align="left" valign="top">
272
207
<hr>
273
208
<div class="refsect2" title="gimp_get_monitor_resolution ()">
274
209
<a name="gimp-get-monitor-resolution"></a><h3>gimp_get_monitor_resolution ()</h3>
275
 
<pre class="programlisting"><a
276
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
277
 
>gboolean</a>            gimp_get_monitor_resolution         (<a
278
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
279
 
>gdouble</a> *xres,
280
 
                                                         <a
281
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
282
 
>gdouble</a> *yres);</pre>
 
210
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gimp_get_monitor_resolution         (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *xres</code></em>,
 
211
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *yres</code></em>);</pre>
283
212
<p>
284
213
Get the monitor resolution as specified in the Preferences.
285
214
</p>
287
216
Returns the resolution of the monitor in pixels/inch. This value is
288
217
taken from the Preferences (or the windowing system if this is set
289
218
in the Preferences) and there's no guarantee for the value to be
290
 
reasonable.</p>
291
 
<p>
 
219
reasonable.
292
220
</p>
293
221
<div class="variablelist"><table border="0">
294
222
<col align="left" valign="top">
295
223
<tbody>
296
224
<tr>
297
225
<td><p><span class="term"><em class="parameter"><code>xres</code></em> :</span></p></td>
298
 
<td> X resolution.
 
226
<td>X resolution.
299
227
</td>
300
228
</tr>
301
229
<tr>
302
230
<td><p><span class="term"><em class="parameter"><code>yres</code></em> :</span></p></td>
303
 
<td> Y resolution.
 
231
<td>Y resolution.
304
232
</td>
305
233
</tr>
306
234
<tr>
314
242
<hr>
315
243
<div class="refsect2" title="gimp_get_theme_dir ()">
316
244
<a name="gimp-get-theme-dir"></a><h3>gimp_get_theme_dir ()</h3>
317
 
<pre class="programlisting"><a
318
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
319
 
>gchar</a>*              gimp_get_theme_dir                  (void);</pre>
 
245
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*              gimp_get_theme_dir                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
320
246
<p>
321
247
Get the directory of the current GUI theme.
322
248
</p>
323
249
<p>
324
 
Returns a copy of the current GUI theme dir.</p>
325
 
<p>
 
250
Returns a copy of the current GUI theme dir.
326
251
</p>
327
252
<div class="variablelist"><table border="0">
328
253
<col align="left" valign="top">
337
262
</div>
338
263
<div class="footer">
339
264
<hr>
340
 
          Generated by GTK-Doc V1.11</div>
 
265
          Generated by GTK-Doc V1.15</div>
341
266
</body>
342
 
</html>
 
267
</html>
 
 
b'\\ No newline at end of file'