callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.8.16

Browse Source
This commit is contained in:
Ari Pollak
2015-11-24 14:17:30 -05:00
parent bf2f572083
commit 66d1b776a9
842 changed files with 251623 additions and 240362 deletions
Download Patch File Download Diff File Expand all files Collapse all files

186
devel-docs/libgimp/html/libgimp-gimpgimprc.html
View File

@ -2,13 +2,13 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GIMP Library Reference Manual: gimpgimprc</title>
<title>gimpgimprc: GIMP Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="prev" href="libgimp-gimpcontext.html" title="gimpcontext">
<link rel="next" href="libgimp-gimphelp.html" title="gimphelp">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -27,7 +27,7 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimpgimprc.top_of_page"></a>gimpgimprc</span></h2>
<p>gimpgimprc — Interactions with settings from gimprc.</p>
<p>gimpgimprc</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
@ -41,7 +41,7 @@
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpgimprc.html#gimp-gimprc-query" title="gimp_gimprc_query ()">gimp_gimprc_query</a> <span class="c_punctuation">()</span>
@ -49,7 +49,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpgimprc.html#gimp-gimprc-set" title="gimp_gimprc_set ()">gimp_gimprc_set</a> <span class="c_punctuation">()</span>
@ -57,7 +57,7 @@
</tr>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/libgimpconfig/GimpColorConfig.html"><span class="returnvalue">GimpColorConfig</span></a> *
<a href="../libgimpconfig/GimpColorConfig.html"><span class="returnvalue">GimpColorConfig</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpgimprc.html#gimp-get-color-configuration" title="gimp_get_color_configuration ()">gimp_get_color_configuration</a> <span class="c_punctuation">()</span>
@ -65,7 +65,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpgimprc.html#gimp-get-default-comment" title="gimp_get_default_comment ()">gimp_get_default_comment</a> <span class="c_punctuation">()</span>
@ -73,7 +73,7 @@
</tr>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpunit.html#GimpUnit"><span class="returnvalue">GimpUnit</span></a>
<a href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"><span class="returnvalue">GimpUnit</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpgimprc.html#gimp-get-default-unit" title="gimp_get_default_unit ()">gimp_get_default_unit</a> <span class="c_punctuation">()</span>
@ -81,7 +81,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpgimprc.html#gimp-get-module-load-inhibit" title="gimp_get_module_load_inhibit ()">gimp_get_module_load_inhibit</a> <span class="c_punctuation">()</span>
@ -89,7 +89,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpgimprc.html#gimp-get-monitor-resolution" title="gimp_get_monitor_resolution ()">gimp_get_monitor_resolution</a> <span class="c_punctuation">()</span>
@ -97,7 +97,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpgimprc.html#gimp-get-theme-dir" title="gimp_get_theme_dir ()">gimp_get_theme_dir</a> <span class="c_punctuation">()</span>
@ -108,190 +108,59 @@
</div>
<div class="refsect1">
<a name="libgimp-gimpgimprc.description"></a><h2>Description</h2>
<p>Interactions with settings from gimprc.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimpgimprc.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-gimprc-query"></a><h3>gimp_gimprc_query ()</h3>
<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>
<p>Queries the gimprc file parser for information on a specified token.</p>
<p>This procedure is used to locate additional information contained in
the gimprc file considered extraneous to the operation of 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: (&lt;token&gt; &lt;value&gt;). 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.</p>
<div class="refsect3">
<a name="id-1.2.3.6.5.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>token</p></td>
<td class="parameter_description"><p>The token to query for.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.6.5.2.7"></a><h4>Returns</h4>
<p> The value associated with the queried token.</p>
<p></p>
</div>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_gimprc_query (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *token</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gimprc-set"></a><h3>gimp_gimprc_set ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gimprc_set (<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
<p>Sets a gimprc token to a value and saves it in the gimprc.</p>
<p>This procedure is used to add or change additional information in
the gimprc file that is considered extraneous to the operation of
GIMP. Plug-ins that need configuration information can use this
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
will accept _only_ string values in UTF-8 encoding.</p>
<div class="refsect3">
<a name="id-1.2.3.6.5.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>token</p></td>
<td class="parameter_description"><p>The token to add or modify.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>The value to set the token to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.6.5.3.7"></a><h4>Returns</h4>
<p> TRUE on success.</p>
<p></p>
</div>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_gimprc_set (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *token</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-color-configuration"></a><h3>gimp_get_color_configuration ()</h3>
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpconfig/GimpColorConfig.html"><span class="returnvalue">GimpColorConfig</span></a> *
<pre class="programlisting"><a href="../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>
<p>Retrieve a copy of the current color management configuration.</p>
<div class="refsect3">
<a name="id-1.2.3.6.5.4.5"></a><h4>Returns</h4>
<p> 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
this copy if you don't need it any longer.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-default-comment"></a><h3>gimp_get_default_comment ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_get_default_comment (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Get the default image comment as specified in the Preferences.</p>
<p>Returns a copy of the default image comment.</p>
<div class="refsect3">
<a name="id-1.2.3.6.5.5.6"></a><h4>Returns</h4>
<p> Default image comment.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-default-unit"></a><h3>gimp_get_default_unit ()</h3>
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpunit.html#GimpUnit"><span class="returnvalue">GimpUnit</span></a>
<pre class="programlisting"><a href="../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>
<p>Get the default unit (taken from the user's locale).</p>
<p>Returns the default unit's integer ID.</p>
<div class="refsect3">
<a name="id-1.2.3.6.5.6.6"></a><h4>Returns</h4>
<p> Default unit.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-module-load-inhibit"></a><h3>gimp_get_module_load_inhibit ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_get_module_load_inhibit (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Get the list of modules which should not be loaded.</p>
<p>Returns a copy of the list of modules which should not be loaded.</p>
<div class="refsect3">
<a name="id-1.2.3.6.5.7.6"></a><h4>Returns</h4>
<p> The list of modules.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-monitor-resolution"></a><h3>gimp_get_monitor_resolution ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_get_monitor_resolution (<em class="parameter"><code><span class="type">gdouble</span> *xres</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> *yres</code></em>);</pre>
<p>Get the monitor resolution as specified in the Preferences.</p>
<p>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.</p>
<div class="refsect3">
<a name="id-1.2.3.6.5.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>xres</p></td>
<td class="parameter_description"><p>X resolution.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>yres</p></td>
<td class="parameter_description"><p>Y resolution.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.6.5.8.7"></a><h4>Returns</h4>
<p> TRUE on success.</p>
<p></p>
</div>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_get_monitor_resolution (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *xres</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *yres</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-theme-dir"></a><h3>gimp_get_theme_dir ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_get_theme_dir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Get the directory of the current GUI theme.</p>
<p>Returns a copy of the current GUI theme dir.</p>
<div class="refsect3">
<a name="id-1.2.3.6.5.9.6"></a><h4>Returns</h4>
<p> The GUI theme dir.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
@ -299,7 +168,6 @@ gimp_get_theme_dir (<em class="parameter"><code><span class="type">void</span></
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>