← Back to branch summary

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

« back to all changes in this revision

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

  • 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:
devel-docs/libgimp/xml/gimpgimprc.xml
22
22
 
23
23
 
24
24
 
25
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-gimprc-query">gimp_gimprc_query</link>               (const <link linkend="gchar">gchar</link> *token);
26
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-gimprc-set">gimp_gimprc_set</link>                 (const <link linkend="gchar">gchar</link> *token,
27
 
                                             const <link linkend="gchar">gchar</link> *value);
28
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-get-default-comment">gimp_get_default_comment</link>        (void);
29
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-get-module-load-inhibit">gimp_get_module_load_inhibit</link>    (void);
30
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-get-monitor-resolution">gimp_get_monitor_resolution</link>     (<link linkend="gdouble">gdouble</link> *xres,
31
 
                                             <link linkend="gdouble">gdouble</link> *yres);
32
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-get-theme-dir">gimp_get_theme_dir</link>              (void);
 
25
<link linkend="gchar">gchar</link>*              <link linkend="gimp-gimprc-query">gimp_gimprc_query</link>                   (const <link linkend="gchar">gchar</link> *token);
 
26
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gimprc-set">gimp_gimprc_set</link>                     (const <link linkend="gchar">gchar</link> *token,
 
27
                                                         const <link linkend="gchar">gchar</link> *value);
 
28
<link linkend="GimpColorConfig">GimpColorConfig</link>*    <link linkend="gimp-get-color-configuration">gimp_get_color_configuration</link>        (void);
 
29
<link linkend="gchar">gchar</link>*              <link linkend="gimp-get-default-comment">gimp_get_default_comment</link>            (void);
 
30
<link linkend="GimpUnit">GimpUnit</link>            <link linkend="gimp-get-default-unit">gimp_get_default_unit</link>               (void);
 
31
<link linkend="gchar">gchar</link>*              <link linkend="gimp-get-module-load-inhibit">gimp_get_module_load_inhibit</link>        (void);
 
32
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-get-monitor-resolution">gimp_get_monitor_resolution</link>         (<link linkend="gdouble">gdouble</link> *xres,
 
33
                                                         <link linkend="gdouble">gdouble</link> *yres);
 
34
<link linkend="gchar">gchar</link>*              <link linkend="gimp-get-theme-dir">gimp_get_theme_dir</link>                  (void);
33
35
</synopsis>
34
36
</refsynopsisdiv>
35
37
 
53
55
<title role="details.title">Details</title>
54
56
<refsect2>
55
57
<title><anchor id="gimp-gimprc-query" role="function"/>gimp_gimprc_query ()</title>
56
 
<indexterm><primary>gimp_gimprc_query</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_gimprc_query               (const <link linkend="gchar">gchar</link> *token);</programlisting>
 
58
<indexterm><primary>gimp_gimprc_query</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_gimprc_query                   (const <link linkend="gchar">gchar</link> *token);</programlisting>
57
59
<para>
58
60
Queries the gimprc file parser for information on a specified token.
59
61
</para>
78
80
</variablelist></refsect2>
79
81
<refsect2>
80
82
<title><anchor id="gimp-gimprc-set" role="function"/>gimp_gimprc_set ()</title>
81
 
<indexterm><primary>gimp_gimprc_set</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_gimprc_set                 (const <link linkend="gchar">gchar</link> *token,
82
 
                                             const <link linkend="gchar">gchar</link> *value);</programlisting>
 
83
<indexterm><primary>gimp_gimprc_set</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gimprc_set                     (const <link linkend="gchar">gchar</link> *token,
 
84
                                                         const <link linkend="gchar">gchar</link> *value);</programlisting>
83
85
<para>
84
86
Sets a gimprc token to a value and saves it in the gimprc.
85
87
</para>
87
89
This procedure is used to add or change additional information in
88
90
the gimprc file that is considered extraneous to the operation of
89
91
the GIMP. Plug-ins that need configuration information can use this
90
 
function to store it, and gimp_gimprc_query to retrieve it. This
 
92
function to store it, and <link linkend="gimp-gimprc-query"><function>gimp_gimprc_query()</function></link> to retrieve it. This
91
93
will accept _only_ string values in UTF-8 encoding.</para>
92
94
<para>
93
95
 
102
104
</simpara></listitem></varlistentry>
103
105
</variablelist></refsect2>
104
106
<refsect2>
 
107
<title><anchor id="gimp-get-color-configuration" role="function" condition="since:GIMP 2.4"/>gimp_get_color_configuration ()</title>
 
108
<indexterm role="GIMP 2.4"><primary>gimp_get_color_configuration</primary></indexterm><programlisting><link linkend="GimpColorConfig">GimpColorConfig</link>*    gimp_get_color_configuration        (void);</programlisting>
 
109
<para>
 
110
Retrieve a copy of the current color management configuration.</para>
 
111
<para>
 
112
 
 
113
</para><variablelist role="params">
 
114
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A copy of the core's <link linkend="GimpColorConfig"><type>GimpColorConfig</type></link>. You should unref
 
115
         this copy if you don't need it any longer.
 
116
 
 
117
</simpara></listitem></varlistentry>
 
118
</variablelist><para role="since">Since  GIMP 2.4
 
119
</para></refsect2>
 
120
<refsect2>
105
121
<title><anchor id="gimp-get-default-comment" role="function"/>gimp_get_default_comment ()</title>
106
 
<indexterm><primary>gimp_get_default_comment</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_get_default_comment        (void);</programlisting>
 
122
<indexterm><primary>gimp_get_default_comment</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_get_default_comment            (void);</programlisting>
107
123
<para>
108
124
Get the default image comment as specified in the Preferences.
109
125
</para>
112
128
<para>
113
129
 
114
130
</para><variablelist role="params">
115
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Default Image Comment.
 
131
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Default image comment.
116
132
</simpara></listitem></varlistentry>
117
133
</variablelist></refsect2>
118
134
<refsect2>
 
135
<title><anchor id="gimp-get-default-unit" role="function" condition="since:GIMP 2.4"/>gimp_get_default_unit ()</title>
 
136
<indexterm role="GIMP 2.4"><primary>gimp_get_default_unit</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link>            gimp_get_default_unit               (void);</programlisting>
 
137
<para>
 
138
Get the default unit (taken from the user's locale).
 
139
</para>
 
140
<para>
 
141
Returns the default unit's integer ID.</para>
 
142
<para>
 
143
 
 
144
</para><variablelist role="params">
 
145
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Default unit.
 
146
 
 
147
</simpara></listitem></varlistentry>
 
148
</variablelist><para role="since">Since  GIMP 2.4
 
149
</para></refsect2>
 
150
<refsect2>
119
151
<title><anchor id="gimp-get-module-load-inhibit" role="function"/>gimp_get_module_load_inhibit ()</title>
120
 
<indexterm><primary>gimp_get_module_load_inhibit</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_get_module_load_inhibit    (void);</programlisting>
 
152
<indexterm><primary>gimp_get_module_load_inhibit</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_get_module_load_inhibit        (void);</programlisting>
121
153
<para>
122
154
Get the list of modules which should not be loaded.
123
155
</para>
131
163
</variablelist></refsect2>
132
164
<refsect2>
133
165
<title><anchor id="gimp-get-monitor-resolution" role="function"/>gimp_get_monitor_resolution ()</title>
134
 
<indexterm><primary>gimp_get_monitor_resolution</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_get_monitor_resolution     (<link linkend="gdouble">gdouble</link> *xres,
135
 
                                             <link linkend="gdouble">gdouble</link> *yres);</programlisting>
 
166
<indexterm><primary>gimp_get_monitor_resolution</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_get_monitor_resolution         (<link linkend="gdouble">gdouble</link> *xres,
 
167
                                                         <link linkend="gdouble">gdouble</link> *yres);</programlisting>
136
168
<para>
137
169
Get the monitor resolution as specified in the Preferences.
138
170
</para>
155
187
</variablelist></refsect2>
156
188
<refsect2>
157
189
<title><anchor id="gimp-get-theme-dir" role="function"/>gimp_get_theme_dir ()</title>
158
 
<indexterm><primary>gimp_get_theme_dir</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_get_theme_dir              (void);</programlisting>
 
190
<indexterm><primary>gimp_get_theme_dir</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_get_theme_dir                  (void);</programlisting>
159
191
<para>
160
192
Get the directory of the current GUI theme.
161
193
</para>