Files
gimp/devel-docs/libgimp/html/libgimp-gimpgimprc.html
2010-08-11 01:14:57 -04:00

75 lines
9.1 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpgimprc</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" 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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants"><link rel="part" href="libgimp.html" title="Part II. GIMP Library"><link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images"><link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties"><link rel="chapter" href="libgimp-data.html" title="Data Objects"><link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs"><link rel="part" href="libgimpui.html" title="Part III. GIMP User Interface Library"><link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libgimp-gimpcontext.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GIMP Library Reference Manual</th><td><a accesskey="n" href="libgimp-gimphelp.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="libgimp-gimpgimprc"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">gimpgimprc</span></h2><p>gimpgimprc &#8212; Interactions with settings from .gimprc.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
gchar* <a href="libgimp-gimpgimprc.html#gimp-gimprc-query">gimp_gimprc_query</a> (const gchar *token);
gboolean <a href="libgimp-gimpgimprc.html#gimp-gimprc-set">gimp_gimprc_set</a> (const gchar *token,
const gchar *value);
gchar* <a href="libgimp-gimpgimprc.html#gimp-get-default-comment">gimp_get_default_comment</a> (void);
gchar* <a href="libgimp-gimpgimprc.html#gimp-get-module-load-inhibit">gimp_get_module_load_inhibit</a> (void);
gboolean <a href="libgimp-gimpgimprc.html#gimp-get-monitor-resolution">gimp_get_monitor_resolution</a> (gdouble *xres,
gdouble *yres);
gchar* <a href="libgimp-gimpgimprc.html#gimp-get-theme-dir">gimp_get_theme_dir</a> (void);
</pre></div><div class="refsect1" lang="en"><a name="id2583375"></a><h2>Description</h2><p>
Interactions with settings from .gimprc.
</p></div><div class="refsect1" lang="en"><a name="id2583384"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2583390"></a><h3><a name="gimp-gimprc-query"></a>gimp_gimprc_query ()</h3><a class="indexterm" name="id2583398"></a><pre class="programlisting">gchar* gimp_gimprc_query (const gchar *token);</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 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: (&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><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>token</code></em> :</span></td><td> The token to query for.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The value associated with the queried token.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2546558"></a><h3><a name="gimp-gimprc-set"></a>gimp_gimprc_set ()</h3><a class="indexterm" name="id2532752"></a><pre class="programlisting">gboolean gimp_gimprc_set (const gchar *token,
const gchar *value);</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
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.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>token</code></em> :</span></td><td> The token to add or modify.
</td></tr><tr><td><span class="term"><em class="parameter"><code>value</code></em> :</span></td><td> The value to set the token to.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2543729"></a><h3><a name="gimp-get-default-comment"></a>gimp_get_default_comment ()</h3><a class="indexterm" name="id2543736"></a><pre class="programlisting">gchar* gimp_get_default_comment (void);</pre><p>
Get the default image comment as specified in the Preferences.
</p><p>
Returns a copy of the default image comment.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> Default Image Comment.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2543769"></a><h3><a name="gimp-get-module-load-inhibit"></a>gimp_get_module_load_inhibit ()</h3><a class="indexterm" name="id2543777"></a><pre class="programlisting">gchar* gimp_get_module_load_inhibit (void);</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><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The list of modules.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2543811"></a><h3><a name="gimp-get-monitor-resolution"></a>gimp_get_monitor_resolution ()</h3><a class="indexterm" name="id2543818"></a><pre class="programlisting">gboolean gimp_get_monitor_resolution (gdouble *xres,
gdouble *yres);</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><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>xres</code></em> :</span></td><td> X resolution.
</td></tr><tr><td><span class="term"><em class="parameter"><code>yres</code></em> :</span></td><td> Y resolution.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2580360"></a><h3><a name="gimp-get-theme-dir"></a>gimp_get_theme_dir ()</h3><a class="indexterm" name="id2580367"></a><pre class="programlisting">gchar* gimp_get_theme_dir (void);</pre><p>
Get the directory of the current GUI theme.
</p><p>
Returns a copy of the current GUI theme dir.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The GUI theme dir.
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimp-gimpcontext.html"><b>&lt;&lt; gimpcontext</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimphelp.html"><b>gimphelp &gt;&gt;</b></a></td></tr></table></body></html>