~ubuntu-branches/ubuntu/saucy/gimp/saucy-updates

1.1.3 by Sebastien Bacher
Import upstream version 2.2.13
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1 by Daniel Holbach
Import upstream version 2.2.9
2
<html>
3
<head>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
1 by Daniel Holbach
Import upstream version 2.2.9
5
<title>gimpgimprc</title>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
0.2.2 by Ari Pollak
Import upstream version 2.6.7
7
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
1 by Daniel Holbach
Import upstream version 2.2.9
8
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
9
<link rel="prev" href="libgimp-gimpcontext.html" title="gimpcontext">
10
<link rel="next" href="libgimp-gimphelp.html" title="gimphelp">
0.3.5 by Ari Pollak
Import upstream version 2.6.12
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
1 by Daniel Holbach
Import upstream version 2.2.9
12
<link rel="stylesheet" href="style.css" type="text/css">
13
</head>
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
1.1.3 by Sebastien Bacher
Import upstream version 2.2.13
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
<tr valign="middle">
1 by Daniel Holbach
Import upstream version 2.2.9
17
<td><a accesskey="p" href="libgimp-gimpcontext.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">GIMP Library Reference Manual</th>
21
<td><a accesskey="n" href="libgimp-gimphelp.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
1.1.3 by Sebastien Bacher
Import upstream version 2.2.13
22
</tr>
1.1.20 by Pedro Fragoso
Import upstream version 2.6.6
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#libgimp-gimpgimprc.synopsis" class="shortcut">Top</a>
0.3.3 by Ari Pollak
Import upstream version 2.6.10
25
                   | 
26
                  <a href="#libgimp-gimpgimprc.description" class="shortcut">Description</a>
1.1.20 by Pedro Fragoso
Import upstream version 2.6.6
27
</td></tr>
1.1.3 by Sebastien Bacher
Import upstream version 2.2.13
28
</table>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
29
<div class="refentry">
1 by Daniel Holbach
Import upstream version 2.2.9
30
<a name="libgimp-gimpgimprc"></a><div class="titlepage"></div>
31
<div class="refnamediv"><table width="100%"><tr>
32
<td valign="top">
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
33
<h2><span class="refentrytitle"><a name="libgimp-gimpgimprc.top_of_page"></a>gimpgimprc</span></h2>
0.3.6 by Jordi Mallach
Import upstream version 2.8.0
34
<p>gimpgimprc — Interactions with settings from gimprc.</p>
1 by Daniel Holbach
Import upstream version 2.2.9
35
</td>
36
<td valign="top" align="right"></td>
37
</tr></table></div>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
38
<div class="refsynopsisdiv">
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
39
<a name="libgimp-gimpgimprc.synopsis"></a><h2>Synopsis</h2>
0.3.6 by Jordi Mallach
Import upstream version 2.8.0
40
<pre class="synopsis"><span class="returnvalue">gchar</span> *             <a class="link" href="libgimp-gimpgimprc.html#gimp-gimprc-query" title="gimp_gimprc_query ()">gimp_gimprc_query</a>                   (<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>);
41
<span class="returnvalue">gboolean</span>            <a class="link" href="libgimp-gimpgimprc.html#gimp-gimprc-set" title="gimp_gimprc_set ()">gimp_gimprc_set</a>                     (<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>,
42
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);
0.3.8 by Ari Pollak
Import upstream version 2.8.4
43
<a href="/local/head/share/gtk-doc/html/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>);
0.3.6 by Jordi Mallach
Import upstream version 2.8.0
44
<span class="returnvalue">gchar</span> *             <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>);
0.3.8 by Ari Pollak
Import upstream version 2.8.4
45
<a href="/local/head/share/gtk-doc/html/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>);
0.3.6 by Jordi Mallach
Import upstream version 2.8.0
46
<span class="returnvalue">gchar</span> *             <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
<span class="returnvalue">gboolean</span>            <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><span class="type">gdouble</span> *xres</code></em>,
48
                                                         <em class="parameter"><code><span class="type">gdouble</span> *yres</code></em>);
49
<span class="returnvalue">gchar</span> *             <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>);
1 by Daniel Holbach
Import upstream version 2.2.9
50
</pre>
51
</div>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
52
<div class="refsect1">
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
53
<a name="libgimp-gimpgimprc.description"></a><h2>Description</h2>
1 by Daniel Holbach
Import upstream version 2.2.9
54
<p>
0.3.6 by Jordi Mallach
Import upstream version 2.8.0
55
Interactions with settings from gimprc.
1 by Daniel Holbach
Import upstream version 2.2.9
56
</p>
57
</div>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
58
<div class="refsect1">
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
59
<a name="libgimp-gimpgimprc.details"></a><h2>Details</h2>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
60
<div class="refsect2">
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
61
<a name="gimp-gimprc-query"></a><h3>gimp_gimprc_query ()</h3>
0.3.6 by Jordi Mallach
Import upstream version 2.8.0
62
<pre class="programlisting"><span class="returnvalue">gchar</span> *             gimp_gimprc_query                   (<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>);</pre>
1 by Daniel Holbach
Import upstream version 2.2.9
63
<p>
64
Queries the gimprc file parser for information on a specified token.
65
</p>
66
<p>
67
This procedure is used to locate additional information contained in
1.1.5 by Daniel Holbach
Import upstream version 2.3.18
68
the gimprc file considered extraneous to the operation of GIMP.
1 by Daniel Holbach
Import upstream version 2.2.9
69
Plug-ins that need configuration information can expect it will be
70
stored in the user gimprc file and can use this procedure to
71
retrieve it. This query procedure will return the value associated
72
with the specified token. This corresponds _only_ to entries with
73
the format: (&lt;token&gt; &lt;value&gt;). The value must be a
74
string. Entries not corresponding to this format will cause warnings
0.3.3 by Ari Pollak
Import upstream version 2.6.10
75
to be issued on gimprc parsing and will not be queryable.
1 by Daniel Holbach
Import upstream version 2.2.9
76
</p>
77
<div class="variablelist"><table border="0">
78
<col align="left" valign="top">
79
<tbody>
80
<tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
81
<td><p><span class="term"><em class="parameter"><code>token</code></em> :</span></p></td>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
82
<td>The token to query for.</td>
1 by Daniel Holbach
Import upstream version 2.2.9
83
</tr>
84
<tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
85
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
86
<td>The value associated with the queried token.</td>
1 by Daniel Holbach
Import upstream version 2.2.9
87
</tr>
88
</tbody>
89
</table></div>
90
</div>
91
<hr>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
92
<div class="refsect2">
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
93
<a name="gimp-gimprc-set"></a><h3>gimp_gimprc_set ()</h3>
0.3.6 by Jordi Mallach
Import upstream version 2.8.0
94
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gimp_gimprc_set                     (<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>,
95
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
1 by Daniel Holbach
Import upstream version 2.2.9
96
<p>
97
Sets a gimprc token to a value and saves it in the gimprc.
98
</p>
99
<p>
100
This procedure is used to add or change additional information in
101
the gimprc file that is considered extraneous to the operation of
1.1.5 by Daniel Holbach
Import upstream version 2.3.18
102
GIMP. Plug-ins that need configuration information can use this
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
103
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
0.3.3 by Ari Pollak
Import upstream version 2.6.10
104
will accept _only_ string values in UTF-8 encoding.
1 by Daniel Holbach
Import upstream version 2.2.9
105
</p>
106
<div class="variablelist"><table border="0">
107
<col align="left" valign="top">
108
<tbody>
109
<tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
110
<td><p><span class="term"><em class="parameter"><code>token</code></em> :</span></p></td>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
111
<td>The token to add or modify.</td>
1 by Daniel Holbach
Import upstream version 2.2.9
112
</tr>
113
<tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
114
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
115
<td>The value to set the token to.</td>
1 by Daniel Holbach
Import upstream version 2.2.9
116
</tr>
117
<tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
118
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
119
<td>TRUE on success.</td>
1 by Daniel Holbach
Import upstream version 2.2.9
120
</tr>
121
</tbody>
122
</table></div>
123
</div>
124
<hr>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
125
<div class="refsect2">
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
126
<a name="gimp-get-color-configuration"></a><h3>gimp_get_color_configuration ()</h3>
0.3.8 by Ari Pollak
Import upstream version 2.8.4
127
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/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>
0.3.3 by Ari Pollak
Import upstream version 2.6.10
128
<p>
129
Retrieve a copy of the current color management configuration.
1.1.4 by Daniel Holbach
Import upstream version 2.3.16
130
</p>
131
<div class="variablelist"><table border="0">
132
<col align="left" valign="top">
133
<tbody><tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
134
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
0.3.8 by Ari Pollak
Import upstream version 2.8.4
135
<td>A copy of the core's <a href="/local/head/share/gtk-doc/html/libgimpconfig/GimpColorConfig.html"><span class="type">GimpColorConfig</span></a>. You should unref
0.3.5 by Ari Pollak
Import upstream version 2.6.12
136
this copy if you don't need it any longer.</td>
1.1.4 by Daniel Holbach
Import upstream version 2.3.16
137
</tr></tbody>
138
</table></div>
1.1.20 by Pedro Fragoso
Import upstream version 2.6.6
139
<p class="since">Since GIMP 2.4</p>
1.1.4 by Daniel Holbach
Import upstream version 2.3.16
140
</div>
141
<hr>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
142
<div class="refsect2">
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
143
<a name="gimp-get-default-comment"></a><h3>gimp_get_default_comment ()</h3>
0.3.6 by Jordi Mallach
Import upstream version 2.8.0
144
<pre class="programlisting"><span class="returnvalue">gchar</span> *             gimp_get_default_comment            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1 by Daniel Holbach
Import upstream version 2.2.9
145
<p>
146
Get the default image comment as specified in the Preferences.
147
</p>
148
<p>
0.3.3 by Ari Pollak
Import upstream version 2.6.10
149
Returns a copy of the default image comment.
1 by Daniel Holbach
Import upstream version 2.2.9
150
</p>
151
<div class="variablelist"><table border="0">
152
<col align="left" valign="top">
153
<tbody><tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
154
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
155
<td>Default image comment.</td>
1.1.4 by Daniel Holbach
Import upstream version 2.3.16
156
</tr></tbody>
157
</table></div>
158
</div>
159
<hr>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
160
<div class="refsect2">
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
161
<a name="gimp-get-default-unit"></a><h3>gimp_get_default_unit ()</h3>
0.3.8 by Ari Pollak
Import upstream version 2.8.4
162
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/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>
1.1.4 by Daniel Holbach
Import upstream version 2.3.16
163
<p>
164
Get the default unit (taken from the user's locale).
165
</p>
166
<p>
0.3.3 by Ari Pollak
Import upstream version 2.6.10
167
Returns the default unit's integer ID.
1.1.4 by Daniel Holbach
Import upstream version 2.3.16
168
</p>
169
<div class="variablelist"><table border="0">
170
<col align="left" valign="top">
171
<tbody><tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
172
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
173
<td>Default unit.</td>
1.1.4 by Daniel Holbach
Import upstream version 2.3.16
174
</tr></tbody>
175
</table></div>
1.1.20 by Pedro Fragoso
Import upstream version 2.6.6
176
<p class="since">Since GIMP 2.4</p>
1.1.4 by Daniel Holbach
Import upstream version 2.3.16
177
</div>
178
<hr>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
179
<div class="refsect2">
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
180
<a name="gimp-get-module-load-inhibit"></a><h3>gimp_get_module_load_inhibit ()</h3>
0.3.6 by Jordi Mallach
Import upstream version 2.8.0
181
<pre class="programlisting"><span class="returnvalue">gchar</span> *             gimp_get_module_load_inhibit        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1 by Daniel Holbach
Import upstream version 2.2.9
182
<p>
183
Get the list of modules which should not be loaded.
184
</p>
185
<p>
0.3.3 by Ari Pollak
Import upstream version 2.6.10
186
Returns a copy of the list of modules which should not be loaded.
1 by Daniel Holbach
Import upstream version 2.2.9
187
</p>
188
<div class="variablelist"><table border="0">
189
<col align="left" valign="top">
190
<tbody><tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
191
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
192
<td>The list of modules.</td>
1 by Daniel Holbach
Import upstream version 2.2.9
193
</tr></tbody>
194
</table></div>
195
</div>
196
<hr>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
197
<div class="refsect2">
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
198
<a name="gimp-get-monitor-resolution"></a><h3>gimp_get_monitor_resolution ()</h3>
0.3.6 by Jordi Mallach
Import upstream version 2.8.0
199
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gimp_get_monitor_resolution         (<em class="parameter"><code><span class="type">gdouble</span> *xres</code></em>,
200
                                                         <em class="parameter"><code><span class="type">gdouble</span> *yres</code></em>);</pre>
1 by Daniel Holbach
Import upstream version 2.2.9
201
<p>
202
Get the monitor resolution as specified in the Preferences.
203
</p>
204
<p>
205
Returns the resolution of the monitor in pixels/inch. This value is
206
taken from the Preferences (or the windowing system if this is set
207
in the Preferences) and there's no guarantee for the value to be
0.3.3 by Ari Pollak
Import upstream version 2.6.10
208
reasonable.
1 by Daniel Holbach
Import upstream version 2.2.9
209
</p>
210
<div class="variablelist"><table border="0">
211
<col align="left" valign="top">
212
<tbody>
213
<tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
214
<td><p><span class="term"><em class="parameter"><code>xres</code></em> :</span></p></td>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
215
<td>X resolution.</td>
1 by Daniel Holbach
Import upstream version 2.2.9
216
</tr>
217
<tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
218
<td><p><span class="term"><em class="parameter"><code>yres</code></em> :</span></p></td>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
219
<td>Y resolution.</td>
1 by Daniel Holbach
Import upstream version 2.2.9
220
</tr>
221
<tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
222
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
223
<td>TRUE on success.</td>
1 by Daniel Holbach
Import upstream version 2.2.9
224
</tr>
225
</tbody>
226
</table></div>
227
</div>
228
<hr>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
229
<div class="refsect2">
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
230
<a name="gimp-get-theme-dir"></a><h3>gimp_get_theme_dir ()</h3>
0.3.6 by Jordi Mallach
Import upstream version 2.8.0
231
<pre class="programlisting"><span class="returnvalue">gchar</span> *             gimp_get_theme_dir                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1 by Daniel Holbach
Import upstream version 2.2.9
232
<p>
233
Get the directory of the current GUI theme.
234
</p>
235
<p>
0.3.3 by Ari Pollak
Import upstream version 2.6.10
236
Returns a copy of the current GUI theme dir.
1 by Daniel Holbach
Import upstream version 2.2.9
237
</p>
238
<div class="variablelist"><table border="0">
239
<col align="left" valign="top">
240
<tbody><tr>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
241
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
242
<td>The GUI theme dir.</td>
1 by Daniel Holbach
Import upstream version 2.2.9
243
</tr></tbody>
244
</table></div>
245
</div>
246
</div>
1.1.13 by Bryce Harrington
Import upstream version 2.4.6
247
</div>
248
<div class="footer">
1.1.8 by Steve Kowalik
Import upstream version 2.4.1
249
<hr>
0.3.5 by Ari Pollak
Import upstream version 2.6.12
250
          Generated by GTK-Doc V1.18</div>
1 by Daniel Holbach
Import upstream version 2.2.9
251
</body>
0.3.3 by Ari Pollak
Import upstream version 2.6.10
252
</html>