1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimpgimprc">
<refmeta>
<refentrytitle role="top_of_page">gimpgimprc</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpgimprc</refname>
<refpurpose>Interactions with settings from .gimprc.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gchar">gchar</link>* <link linkend="gimp-gimprc-query">gimp_gimprc_query</link> (const <link linkend="gchar">gchar</link> *token);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gimprc-set">gimp_gimprc_set</link> (const <link linkend="gchar">gchar</link> *token,
const <link linkend="gchar">gchar</link> *value);
<link linkend="gchar">gchar</link>* <link linkend="gimp-get-default-comment">gimp_get_default_comment</link> (void);
<link linkend="gchar">gchar</link>* <link linkend="gimp-get-module-load-inhibit">gimp_get_module_load_inhibit</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-get-monitor-resolution">gimp_get_monitor_resolution</link> (<link linkend="gdouble">gdouble</link> *xres,
<link linkend="gdouble">gdouble</link> *yres);
<link linkend="gchar">gchar</link>* <link linkend="gimp-get-theme-dir">gimp_get_theme_dir</link> (void);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Interactions with settings from .gimprc.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-gimprc-query" role="function"/>gimp_gimprc_query ()</title>
<indexterm><primary>gimp_gimprc_query</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_gimprc_query (const <link linkend="gchar">gchar</link> *token);</programlisting>
<para>
Queries the gimprc file parser for information on a specified token.
</para>
<para>
This procedure is used to locate additional information contained in
the gimprc file considered extraneous to the operation of the GIMP.
Plug-ins that need configuration information can expect it will be
stored in the user gimprc file and can use this procedure to
retrieve it. This query procedure will return the value associated
with the specified token. This corresponds _only_ to entries with
the format: (<token> <value>). The value must be a
string. Entries not corresponding to this format will cause warnings
to be issued on gimprc parsing and will not be queryable.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>token</parameter> :</term>
<listitem><simpara> The token to query for.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value associated with the queried token.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gimprc-set" role="function"/>gimp_gimprc_set ()</title>
<indexterm><primary>gimp_gimprc_set</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gimprc_set (const <link linkend="gchar">gchar</link> *token,
const <link linkend="gchar">gchar</link> *value);</programlisting>
<para>
Sets a gimprc token to a value and saves it in the gimprc.
</para>
<para>
This procedure is used to add or change additional information in
the gimprc file that is considered extraneous to the operation of
the GIMP. Plug-ins that need configuration information can use this
function to store it, and gimp_gimprc_query to retrieve it. This
will accept _only_ string values in UTF-8 encoding.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>token</parameter> :</term>
<listitem><simpara> The token to add or modify.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> The value to set the token to.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-get-default-comment" role="function"/>gimp_get_default_comment ()</title>
<indexterm><primary>gimp_get_default_comment</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_get_default_comment (void);</programlisting>
<para>
Get the default image comment as specified in the Preferences.
</para>
<para>
Returns a copy of the default image comment.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Default Image Comment.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-get-module-load-inhibit" role="function"/>gimp_get_module_load_inhibit ()</title>
<indexterm><primary>gimp_get_module_load_inhibit</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_get_module_load_inhibit (void);</programlisting>
<para>
Get the list of modules which should not be loaded.
</para>
<para>
Returns a copy of the list of modules which should not be loaded.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The list of modules.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-get-monitor-resolution" role="function"/>gimp_get_monitor_resolution ()</title>
<indexterm><primary>gimp_get_monitor_resolution</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_get_monitor_resolution (<link linkend="gdouble">gdouble</link> *xres,
<link linkend="gdouble">gdouble</link> *yres);</programlisting>
<para>
Get the monitor resolution as specified in the Preferences.
</para>
<para>
Returns the resolution of the monitor in pixels/inch. This value is
taken from the Preferences (or the windowing system if this is set
in the Preferences) and there's no guarantee for the value to be
reasonable.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xres</parameter> :</term>
<listitem><simpara> X resolution.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>yres</parameter> :</term>
<listitem><simpara> Y resolution.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-get-theme-dir" role="function"/>gimp_get_theme_dir ()</title>
<indexterm><primary>gimp_get_theme_dir</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_get_theme_dir (void);</programlisting>
<para>
Get the directory of the current GUI theme.
</para>
<para>
Returns a copy of the current GUI theme dir.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The GUI theme dir.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
