25
const <link linkend="gchar">gchar</link>* <link linkend="gimp-directory">gimp_directory</link> (void);
26
<link linkend="gchar">gchar</link>* <link linkend="gimp-personal-rc-file">gimp_personal_rc_file</link> (const <link linkend="gchar">gchar</link> *basename);
27
const <link linkend="gchar">gchar</link>* <link linkend="gimp-data-directory">gimp_data_directory</link> (void);
28
const <link linkend="gchar">gchar</link>* <link linkend="gimp-locale-directory">gimp_locale_directory</link> (void);
29
const <link linkend="gchar">gchar</link>* <link linkend="gimp-plug-in-directory">gimp_plug_in_directory</link> (void);
30
const <link linkend="gchar">gchar</link>* <link linkend="gimp-sysconf-directory">gimp_sysconf_directory</link> (void);
31
const <link linkend="gchar">gchar</link>* <link linkend="gimp-gtkrc">gimp_gtkrc</link> (void);
32
<link linkend="GList">GList</link>* <link linkend="gimp-path-parse">gimp_path_parse</link> (const <link linkend="gchar">gchar</link> *path,
33
<link linkend="gint">gint</link> max_paths,
34
<link linkend="gboolean">gboolean</link> check,
35
<link linkend="GList">GList</link> **check_failed);
36
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-to-str">gimp_path_to_str</link> (<link linkend="GList">GList</link> *path);
37
<link linkend="void">void</link> <link linkend="gimp-path-free">gimp_path_free</link> (<link linkend="GList">GList</link> *path);
38
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-get-user-writable-dir">gimp_path_get_user_writable_dir</link> (<link linkend="GList">GList</link> *path);
25
<link linkend="void">void</link> <link linkend="gimp-env-init">gimp_env_init</link> (<link linkend="gboolean">gboolean</link> plug_in);
26
const <link linkend="gchar">gchar</link>* <link linkend="gimp-directory">gimp_directory</link> (void);
27
<link linkend="gchar">gchar</link>* <link linkend="gimp-personal-rc-file">gimp_personal_rc_file</link> (const <link linkend="gchar">gchar</link> *basename);
28
const <link linkend="gchar">gchar</link>* <link linkend="gimp-data-directory">gimp_data_directory</link> (void);
29
const <link linkend="gchar">gchar</link>* <link linkend="gimp-locale-directory">gimp_locale_directory</link> (void);
30
const <link linkend="gchar">gchar</link>* <link linkend="gimp-plug-in-directory">gimp_plug_in_directory</link> (void);
31
const <link linkend="gchar">gchar</link>* <link linkend="gimp-sysconf-directory">gimp_sysconf_directory</link> (void);
32
const <link linkend="gchar">gchar</link>* <link linkend="gimp-gtkrc">gimp_gtkrc</link> (void);
33
<link linkend="GList">GList</link>* <link linkend="gimp-path-parse">gimp_path_parse</link> (const <link linkend="gchar">gchar</link> *path,
34
<link linkend="gint">gint</link> max_paths,
35
<link linkend="gboolean">gboolean</link> check,
36
<link linkend="GList">GList</link> **check_failed);
37
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-to-str">gimp_path_to_str</link> (<link linkend="GList">GList</link> *path);
38
<link linkend="void">void</link> <link linkend="gimp-path-free">gimp_path_free</link> (<link linkend="GList">GList</link> *path);
39
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-get-user-writable-dir">gimp_path_get_user_writable_dir</link> (<link linkend="GList">GList</link> *path);
58
59
<refsect1 role="details">
59
60
<title role="details.title">Details</title>
62
<title><anchor id="gimp-env-init" role="function" condition="since:GIMP 2.4"/>gimp_env_init ()</title>
63
<indexterm role="GIMP 2.4"><primary>gimp_env_init</primary></indexterm><programlisting><link linkend="void">void</link> gimp_env_init (<link linkend="gboolean">gboolean</link> plug_in);</programlisting>
65
You don't need to care about this function. It is being called for
66
you automatically (by means of the <link linkend="MAIN:CAPS"><function>MAIN()</function></link> macro that every plug-in
67
runs). Calling it again will cause a fatal error.</para>
70
</para><variablelist role="params">
71
<varlistentry><term><parameter>plug_in</parameter> :</term>
72
<listitem><simpara> must be <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if this function is called from a plug-in
73
</simpara></listitem></varlistentry>
74
</variablelist><para role="since">Since GIMP 2.4
61
77
<title><anchor id="gimp-directory" role="function"/>gimp_directory ()</title>
62
<indexterm><primary>gimp_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_directory (void);</programlisting>
78
<indexterm><primary>gimp_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_directory (void);</programlisting>
64
80
Returns the user-specific GIMP settings directory. If the
65
81
environment variable GIMP2_DIRECTORY exists, it is used. If it is
80
The returned string is allocated just once, and should *NOT* be
81
freed with <link linkend="g-free"><function>g_free()</function></link>. The returned string is in the encoding used
82
for filenames by the system, which isn't necessarily UTF-8 (never
83
is on Windows).</para>
96
The returned string is owned by GIMP and must not be modified or
97
freed. The returned string is in the encoding used for filenames by
98
the system, which isn't necessarily UTF-8 (never is on Windows).</para>
86
101
</para><variablelist role="params">
89
104
</variablelist></refsect2>
91
106
<title><anchor id="gimp-personal-rc-file" role="function"/>gimp_personal_rc_file ()</title>
92
<indexterm><primary>gimp_personal_rc_file</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_personal_rc_file (const <link linkend="gchar">gchar</link> *basename);</programlisting>
107
<indexterm><primary>gimp_personal_rc_file</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_personal_rc_file (const <link linkend="gchar">gchar</link> *basename);</programlisting>
94
109
Returns the name of a file in the user-specific GIMP settings directory.
109
124
</variablelist></refsect2>
111
126
<title><anchor id="gimp-data-directory" role="function"/>gimp_data_directory ()</title>
112
<indexterm><primary>gimp_data_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_data_directory (void);</programlisting>
127
<indexterm><primary>gimp_data_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_data_directory (void);</programlisting>
114
129
Returns the top directory for GIMP data. If the environment
115
130
variable GIMP2_DATADIR exists, that is used. It should be an
118
133
from the executable's name is used.
121
The returned string is allocated just once, and should *NOT* be
122
freed with <link linkend="g-free"><function>g_free()</function></link>. The returned string is in the encoding used
123
for filenames by the system, which isn't necessarily UTF-8 (never
124
is on Windows).</para>
136
The returned string is owned by GIMP and must not be modified or
137
freed. The returned string is in the encoding used for filenames by
138
the system, which isn't necessarily UTF-8 (never is on Windows).</para>
127
141
</para><variablelist role="params">
130
144
</variablelist></refsect2>
132
146
<title><anchor id="gimp-locale-directory" role="function"/>gimp_locale_directory ()</title>
133
<indexterm><primary>gimp_locale_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_locale_directory (void);</programlisting>
147
<indexterm><primary>gimp_locale_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_locale_directory (void);</programlisting>
135
149
Returns the top directory for GIMP locale files. If the environment
136
150
variable GIMP2_LOCALEDIR exists, that is used. It should be an
139
153
from the executable's name is used.
142
The returned string is allocated just once, and should *NOT* be
143
freed with <link linkend="g-free"><function>g_free()</function></link>. The returned string is in the encoding used
144
for filenames by the system, which isn't necessarily UTF-8 (never
145
is on Windows).</para>
156
The returned string is owned by GIMP and must not be modified or
157
freed. The returned string is in the encoding used for filenames by
158
the system, which isn't necessarily UTF-8 (never is on Windows).</para>
148
161
</para><variablelist role="params">
151
164
</variablelist></refsect2>
153
166
<title><anchor id="gimp-plug-in-directory" role="function"/>gimp_plug_in_directory ()</title>
154
<indexterm><primary>gimp_plug_in_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_plug_in_directory (void);</programlisting>
167
<indexterm><primary>gimp_plug_in_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_plug_in_directory (void);</programlisting>
156
169
Returns the top directory for GIMP plug_ins and modules. If the
157
170
environment variable GIMP2_PLUGINDIR exists, that is used. It
160
173
deduced from the executable's name is used.
163
The returned string is allocated just once, and should *NOT* be
164
freed with <link linkend="g-free"><function>g_free()</function></link>. The returned string is in the encoding used
165
for filenames by the system, which isn't necessarily UTF-8 (never
166
is on Windows).</para>
176
The returned string is owned by GIMP and must not be modified or
177
freed. The returned string is in the encoding used for filenames by
178
the system, which isn't necessarily UTF-8 (never is on Windows).</para>
169
181
</para><variablelist role="params">
172
184
</variablelist></refsect2>
174
186
<title><anchor id="gimp-sysconf-directory" role="function"/>gimp_sysconf_directory ()</title>
175
<indexterm><primary>gimp_sysconf_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_sysconf_directory (void);</programlisting>
187
<indexterm><primary>gimp_sysconf_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_sysconf_directory (void);</programlisting>
177
189
Returns the top directory for GIMP config files. If the environment
178
190
variable GIMP2_SYSCONFDIR exists, that is used. It should be an
181
193
from the executable's name is used.
184
The returned string is allocated just once, and should *NOT* be
185
freed with <link linkend="g-free"><function>g_free()</function></link>. The returned string is in the encoding used
186
for filenames by the system, which isn't necessarily UTF-8 (never
187
is on Windows).</para>
196
The returned string is owned by GIMP and must not be modified or
197
freed. The returned string is in the encoding used for filenames by
198
the system, which isn't necessarily UTF-8 (never is on Windows).</para>
190
201
</para><variablelist role="params">
193
204
</variablelist></refsect2>
195
206
<title><anchor id="gimp-gtkrc" role="function"/>gimp_gtkrc ()</title>
196
<indexterm><primary>gimp_gtkrc</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_gtkrc (void);</programlisting>
207
<indexterm><primary>gimp_gtkrc</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_gtkrc (void);</programlisting>
198
209
Returns the name of the GIMP's application-specific gtkrc file.
201
The returned string is allocated just once, and should *NOT* be
202
freed with <link linkend="g-free"><function>g_free()</function></link>. The returned string is in the encoding used
203
for filenames by the system, which isn't necessarily UTF-8 (never
204
is on Windows).</para>
212
The returned string is owned by GIMP and must not be modified or
213
freed. The returned string is in the encoding used for filenames by
214
the system, which isn't necessarily UTF-8 (never is on Windows).</para>
207
217
</para><variablelist role="params">
210
220
</variablelist></refsect2>
212
222
<title><anchor id="gimp-path-parse" role="function"/>gimp_path_parse ()</title>
213
<indexterm><primary>gimp_path_parse</primary></indexterm><programlisting><link linkend="GList">GList</link>* gimp_path_parse (const <link linkend="gchar">gchar</link> *path,
214
<link linkend="gint">gint</link> max_paths,
215
<link linkend="gboolean">gboolean</link> check,
216
<link linkend="GList">GList</link> **check_failed);</programlisting>
223
<indexterm><primary>gimp_path_parse</primary></indexterm><programlisting><link linkend="GList">GList</link>* gimp_path_parse (const <link linkend="gchar">gchar</link> *path,
224
<link linkend="gint">gint</link> max_paths,
225
<link linkend="gboolean">gboolean</link> check,
226
<link linkend="GList">GList</link> **check_failed);</programlisting>
237
247
</variablelist></refsect2>
239
249
<title><anchor id="gimp-path-to-str" role="function"/>gimp_path_to_str ()</title>
240
<indexterm><primary>gimp_path_to_str</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_to_str (<link linkend="GList">GList</link> *path);</programlisting>
250
<indexterm><primary>gimp_path_to_str</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_to_str (<link linkend="GList">GList</link> *path);</programlisting>
251
261
</variablelist></refsect2>
253
263
<title><anchor id="gimp-path-free" role="function"/>gimp_path_free ()</title>
254
<indexterm><primary>gimp_path_free</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_free (<link linkend="GList">GList</link> *path);</programlisting>
264
<indexterm><primary>gimp_path_free</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_free (<link linkend="GList">GList</link> *path);</programlisting>
256
266
This function frees the memory allocated for the list and the strings
257
267
it contains.</para>
264
274
</variablelist></refsect2>
266
276
<title><anchor id="gimp-path-get-user-writable-dir" role="function"/>gimp_path_get_user_writable_dir ()</title>
267
<indexterm><primary>gimp_path_get_user_writable_dir</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_get_user_writable_dir (<link linkend="GList">GList</link> *path);</programlisting>
277
<indexterm><primary>gimp_path_get_user_writable_dir</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_get_user_writable_dir (<link linkend="GList">GList</link> *path);</programlisting>
269
279
Note that you have to <link linkend="g-free"><function>g_free()</function></link> the returned string.</para>
added
removed
devel-docs/libgimpbase/xml/gimpenv.xml
