~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimpgimprc</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
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.7 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
14
 
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
 
13
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
15
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
16
 
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
17
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
18
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
19
 
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
 
18
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
20
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-deprecated.html" title="Index of deprecated symbols">
21
24
</head>
22
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
29
32
<td><a accesskey="n" href="libgimp-gimphelp.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
33
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2538960" class="shortcut">Top</a>
 
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2587905" class="shortcut">Top</a>
32
35
                  &#160;|&#160;
33
 
                  <a href="#id2541521" class="shortcut">Description</a></nobr></td></tr>
 
36
                  <a href="#id2600226" class="shortcut">Description</a></nobr></td></tr>
34
37
</table>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimpgimprc"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
38
41
<td valign="top">
39
42
<h2>
40
 
<a name="id2538960"></a><span class="refentrytitle">gimpgimprc</span>
 
43
<a name="id2587905"></a><span class="refentrytitle">gimpgimprc</span>
41
44
</h2>
42
45
<p>gimpgimprc &#8212; Interactions with settings from .gimprc.</p>
43
46
</td>
49
52
 
50
53
 
51
54
 
52
 
gchar*      <a href="libgimp-gimpgimprc.html#gimp-gimprc-query">gimp_gimprc_query</a>               (const gchar *token);
53
 
gboolean    <a href="libgimp-gimpgimprc.html#gimp-gimprc-set">gimp_gimprc_set</a>                 (const gchar *token,
54
 
                                             const gchar *value);
55
 
gchar*      <a href="libgimp-gimpgimprc.html#gimp-get-default-comment">gimp_get_default_comment</a>        (void);
56
 
gchar*      <a href="libgimp-gimpgimprc.html#gimp-get-module-load-inhibit">gimp_get_module_load_inhibit</a>    (void);
57
 
gboolean    <a href="libgimp-gimpgimprc.html#gimp-get-monitor-resolution">gimp_get_monitor_resolution</a>     (gdouble *xres,
58
 
                                             gdouble *yres);
59
 
gchar*      <a href="libgimp-gimpgimprc.html#gimp-get-theme-dir">gimp_get_theme_dir</a>              (void);
 
55
gchar*              <a href="libgimp-gimpgimprc.html#gimp-gimprc-query">gimp_gimprc_query</a>                   (const gchar *token);
 
56
gboolean            <a href="libgimp-gimpgimprc.html#gimp-gimprc-set">gimp_gimprc_set</a>                     (const gchar *token,
 
57
                                                         const gchar *value);
 
58
<a
 
59
href="../libgimpconfig/GimpColorConfig.html"
 
60
>GimpColorConfig</a>*    <a href="libgimp-gimpgimprc.html#gimp-get-color-configuration">gimp_get_color_configuration</a>        (void);
 
61
gchar*              <a href="libgimp-gimpgimprc.html#gimp-get-default-comment">gimp_get_default_comment</a>            (void);
 
62
<a
 
63
href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"
 
64
>GimpUnit</a>            <a href="libgimp-gimpgimprc.html#gimp-get-default-unit">gimp_get_default_unit</a>               (void);
 
65
gchar*              <a href="libgimp-gimpgimprc.html#gimp-get-module-load-inhibit">gimp_get_module_load_inhibit</a>        (void);
 
66
gboolean            <a href="libgimp-gimpgimprc.html#gimp-get-monitor-resolution">gimp_get_monitor_resolution</a>         (gdouble *xres,
 
67
                                                         gdouble *yres);
 
68
gchar*              <a href="libgimp-gimpgimprc.html#gimp-get-theme-dir">gimp_get_theme_dir</a>                  (void);
60
69
</pre>
61
70
</div>
62
71
<div class="refsect1" lang="en">
63
 
<a name="id2541521"></a><h2>Description</h2>
 
72
<a name="id2600226"></a><h2>Description</h2>
64
73
<p>
65
74
Interactions with settings from .gimprc.
66
75
 
67
76
</p>
68
77
</div>
69
78
<div class="refsect1" lang="en">
70
 
<a name="id2541536"></a><h2>Details</h2>
 
79
<a name="id2600242"></a><h2>Details</h2>
71
80
<div class="refsect2" lang="en">
72
 
<a name="id2541547"></a><h3>
 
81
<a name="id2600252"></a><h3>
73
82
<a name="gimp-gimprc-query"></a>gimp_gimprc_query ()</h3>
74
 
<a class="indexterm" name="id2541559"></a><pre class="programlisting">gchar*      gimp_gimprc_query               (const gchar *token);</pre>
 
83
<a class="indexterm" name="id2600265"></a><pre class="programlisting">gchar*              gimp_gimprc_query                   (const gchar *token);</pre>
75
84
<p>
76
85
Queries the gimprc file parser for information on a specified token.
77
86
</p>
92
101
<col align="left" valign="top">
93
102
<tbody>
94
103
<tr>
95
 
<td>
96
 
<span class="term"><em class="parameter"><code>token</code></em>&#160;:</span></td>
 
104
<td><span class="term"><em class="parameter"><code>token</code></em>&#160;:</span></td>
97
105
<td> The token to query for.
98
106
</td>
99
107
</tr>
100
108
<tr>
101
 
<td>
102
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
109
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
103
110
<td> The value associated with the queried token.
104
111
</td>
105
112
</tr>
108
115
</div>
109
116
<hr>
110
117
<div class="refsect2" lang="en">
111
 
<a name="id2554933"></a><h3>
 
118
<a name="id2574878"></a><h3>
112
119
<a name="gimp-gimprc-set"></a>gimp_gimprc_set ()</h3>
113
 
<a class="indexterm" name="id2541608"></a><pre class="programlisting">gboolean    gimp_gimprc_set                 (const gchar *token,
114
 
                                             const gchar *value);</pre>
 
120
<a class="indexterm" name="id2574890"></a><pre class="programlisting">gboolean            gimp_gimprc_set                     (const gchar *token,
 
121
                                                         const gchar *value);</pre>
115
122
<p>
116
123
Sets a gimprc token to a value and saves it in the gimprc.
117
124
</p>
119
126
This procedure is used to add or change additional information in
120
127
the gimprc file that is considered extraneous to the operation of
121
128
the GIMP. Plug-ins that need configuration information can use this
122
 
function to store it, and gimp_gimprc_query to retrieve it. This
 
129
function to store it, and <a href="libgimp-gimpgimprc.html#gimp-gimprc-query"><code class="function">gimp_gimprc_query()</code></a> to retrieve it. This
123
130
will accept _only_ string values in UTF-8 encoding.</p>
124
131
<p>
125
132
 
128
135
<col align="left" valign="top">
129
136
<tbody>
130
137
<tr>
131
 
<td>
132
 
<span class="term"><em class="parameter"><code>token</code></em>&#160;:</span></td>
 
138
<td><span class="term"><em class="parameter"><code>token</code></em>&#160;:</span></td>
133
139
<td> The token to add or modify.
134
140
</td>
135
141
</tr>
136
142
<tr>
137
 
<td>
138
 
<span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
 
143
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
139
144
<td> The value to set the token to.
140
145
</td>
141
146
</tr>
142
147
<tr>
143
 
<td>
144
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
148
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
145
149
<td> TRUE on success.
146
150
</td>
147
151
</tr>
150
154
</div>
151
155
<hr>
152
156
<div class="refsect2" lang="en">
153
 
<a name="id2538710"></a><h3>
 
157
<a name="id2574991"></a><h3>
 
158
<a name="gimp-get-color-configuration"></a>gimp_get_color_configuration ()</h3>
 
159
<a class="indexterm" name="id2563209"></a><pre class="programlisting"><a
 
160
href="../libgimpconfig/GimpColorConfig.html"
 
161
>GimpColorConfig</a>*    gimp_get_color_configuration        (void);</pre>
 
162
<p>
 
163
Retrieve a copy of the current color management configuration.</p>
 
164
<p>
 
165
 
 
166
</p>
 
167
<div class="variablelist"><table border="0">
 
168
<col align="left" valign="top">
 
169
<tbody><tr>
 
170
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
171
<td> A copy of the core's <a
 
172
href="../libgimpconfig/GimpColorConfig.html"
 
173
><span class="type">GimpColorConfig</span></a>. You should unref
 
174
         this copy if you don't need it any longer.
 
175
 
 
176
</td>
 
177
</tr></tbody>
 
178
</table></div>
 
179
<p class="since">Since  GIMP 2.4
 
180
</p>
 
181
</div>
 
182
<hr>
 
183
<div class="refsect2" lang="en">
 
184
<a name="id2563265"></a><h3>
154
185
<a name="gimp-get-default-comment"></a>gimp_get_default_comment ()</h3>
155
 
<a class="indexterm" name="id2538721"></a><pre class="programlisting">gchar*      gimp_get_default_comment        (void);</pre>
 
186
<a class="indexterm" name="id2563276"></a><pre class="programlisting">gchar*              gimp_get_default_comment            (void);</pre>
156
187
<p>
157
188
Get the default image comment as specified in the Preferences.
158
189
</p>
164
195
<div class="variablelist"><table border="0">
165
196
<col align="left" valign="top">
166
197
<tbody><tr>
167
 
<td>
168
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
169
 
<td> Default Image Comment.
170
 
</td>
171
 
</tr></tbody>
172
 
</table></div>
173
 
</div>
174
 
<hr>
175
 
<div class="refsect2" lang="en">
176
 
<a name="id2538766"></a><h3>
 
198
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
199
<td> Default image comment.
 
200
</td>
 
201
</tr></tbody>
 
202
</table></div>
 
203
</div>
 
204
<hr>
 
205
<div class="refsect2" lang="en">
 
206
<a name="id2563321"></a><h3>
 
207
<a name="gimp-get-default-unit"></a>gimp_get_default_unit ()</h3>
 
208
<a class="indexterm" name="id2563335"></a><pre class="programlisting"><a
 
209
href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"
 
210
>GimpUnit</a>            gimp_get_default_unit               (void);</pre>
 
211
<p>
 
212
Get the default unit (taken from the user's locale).
 
213
</p>
 
214
<p>
 
215
Returns the default unit's integer ID.</p>
 
216
<p>
 
217
 
 
218
</p>
 
219
<div class="variablelist"><table border="0">
 
220
<col align="left" valign="top">
 
221
<tbody><tr>
 
222
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
223
<td> Default unit.
 
224
 
 
225
</td>
 
226
</tr></tbody>
 
227
</table></div>
 
228
<p class="since">Since  GIMP 2.4
 
229
</p>
 
230
</div>
 
231
<hr>
 
232
<div class="refsect2" lang="en">
 
233
<a name="id2563386"></a><h3>
177
234
<a name="gimp-get-module-load-inhibit"></a>gimp_get_module_load_inhibit ()</h3>
178
 
<a class="indexterm" name="id2538777"></a><pre class="programlisting">gchar*      gimp_get_module_load_inhibit    (void);</pre>
 
235
<a class="indexterm" name="id2563399"></a><pre class="programlisting">gchar*              gimp_get_module_load_inhibit        (void);</pre>
179
236
<p>
180
237
Get the list of modules which should not be loaded.
181
238
</p>
187
244
<div class="variablelist"><table border="0">
188
245
<col align="left" valign="top">
189
246
<tbody><tr>
190
 
<td>
191
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
247
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
192
248
<td> The list of modules.
193
249
</td>
194
250
</tr></tbody>
196
252
</div>
197
253
<hr>
198
254
<div class="refsect2" lang="en">
199
 
<a name="id2570158"></a><h3>
 
255
<a name="id2563444"></a><h3>
200
256
<a name="gimp-get-monitor-resolution"></a>gimp_get_monitor_resolution ()</h3>
201
 
<a class="indexterm" name="id2570169"></a><pre class="programlisting">gboolean    gimp_get_monitor_resolution     (gdouble *xres,
202
 
                                             gdouble *yres);</pre>
 
257
<a class="indexterm" name="id2560040"></a><pre class="programlisting">gboolean            gimp_get_monitor_resolution         (gdouble *xres,
 
258
                                                         gdouble *yres);</pre>
203
259
<p>
204
260
Get the monitor resolution as specified in the Preferences.
205
261
</p>
215
271
<col align="left" valign="top">
216
272
<tbody>
217
273
<tr>
218
 
<td>
219
 
<span class="term"><em class="parameter"><code>xres</code></em>&#160;:</span></td>
 
274
<td><span class="term"><em class="parameter"><code>xres</code></em>&#160;:</span></td>
220
275
<td> X resolution.
221
276
</td>
222
277
</tr>
223
278
<tr>
224
 
<td>
225
 
<span class="term"><em class="parameter"><code>yres</code></em>&#160;:</span></td>
 
279
<td><span class="term"><em class="parameter"><code>yres</code></em>&#160;:</span></td>
226
280
<td> Y resolution.
227
281
</td>
228
282
</tr>
229
283
<tr>
230
 
<td>
231
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
284
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
232
285
<td> TRUE on success.
233
286
</td>
234
287
</tr>
237
290
</div>
238
291
<hr>
239
292
<div class="refsect2" lang="en">
240
 
<a name="id2570258"></a><h3>
 
293
<a name="id2560130"></a><h3>
241
294
<a name="gimp-get-theme-dir"></a>gimp_get_theme_dir ()</h3>
242
 
<a class="indexterm" name="id2570270"></a><pre class="programlisting">gchar*      gimp_get_theme_dir              (void);</pre>
 
295
<a class="indexterm" name="id2560142"></a><pre class="programlisting">gchar*              gimp_get_theme_dir                  (void);</pre>
243
296
<p>
244
297
Get the directory of the current GUI theme.
245
298
</p>
251
304
<div class="variablelist"><table border="0">
252
305
<col align="left" valign="top">
253
306
<tbody><tr>
254
 
<td>
255
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
307
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
256
308
<td> The GUI theme dir.
257
309
</td>
258
310
</tr></tbody>