Imported Upstream version 2.2.4

This commit is contained in:
Ari Pollak
2010-08-11 01:13:56 -04:00
parent 3154facabf
commit c5acc8ae10
5446 changed files with 2386086 additions and 390981 deletions

View File

@ -0,0 +1,66 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpplugin</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.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-gimpmessage.html" title="gimpmessage"><link rel="next" href="libgimp-gimpproceduraldb.html" title="gimpproceduraldb"><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<72>I.<2E>GIMP Constants"><link rel="part" href="libgimp.html" title="Part<72>II.<2E>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<72>III.<2E>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-gimpmessage.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-gimpproceduraldb.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-gimpplugin"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">gimpplugin</span></h2><p>gimpplugin &#8212; Functions useful for plugins, e.g. registration and progress indicators.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
gboolean <a href="libgimp-gimpplugin.html#gimp-plugin-domain-register">gimp_plugin_domain_register</a> (const gchar *domain_name,
const gchar *domain_path);
gboolean <a href="libgimp-gimpplugin.html#gimp-plugin-help-register">gimp_plugin_help_register</a> (const gchar *domain_name,
const gchar *domain_uri);
gboolean <a href="libgimp-gimpplugin.html#gimp-plugin-icon-register">gimp_plugin_icon_register</a> (const gchar *procedure_name,
<a href="libgimp-gimpenums.html#GimpIconType">GimpIconType</a> icon_type,
const guint8 *icon_data);
gboolean <a href="libgimp-gimpplugin.html#gimp-plugin-menu-register">gimp_plugin_menu_register</a> (const gchar *procedure_name,
const gchar *menu_path);
</pre></div><div class="refsect1" lang="en"><a name="id2577270"></a><h2>Description</h2><p>
Functions useful for plugins, e.g. registration and progress indicators.
</p></div><div class="refsect1" lang="en"><a name="id2577280"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2577286"></a><h3><a name="gimp-plugin-domain-register"></a>gimp_plugin_domain_register ()</h3><a class="indexterm" name="id2577294"></a><pre class="programlisting">gboolean gimp_plugin_domain_register (const gchar *domain_name,
const gchar *domain_path);</pre><p>
Registers a textdomain for localisation.
</p><p>
This procedure adds a textdomain to the list of domains Gimp
searches for strings when translating its menu entries. There is no
need to call this function for plug-ins that have their strings
included in the gimp-std-plugins domain as that is used by default.
If the compiled message catalog is not in the standard location, you
may specify an absolute path to another location. This procedure can
only be called in the query function of a plug-in and it has to be
called before any procedure is installed.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>domain_name</tt></i><EFBFBD>:</span></td><td> The name of the textdomain (must be unique).
</td></tr><tr><td><span class="term"><i class="parameter"><tt>domain_path</tt></i><EFBFBD>:</span></td><td> The absolute path to the compiled message catalog (may be NULL).
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2571725"></a><h3><a name="gimp-plugin-help-register"></a>gimp_plugin_help_register ()</h3><a class="indexterm" name="id2538565"></a><pre class="programlisting">gboolean gimp_plugin_help_register (const gchar *domain_name,
const gchar *domain_uri);</pre><p>
Register a help path for a plug-in.
</p><p>
This procedure changes the help rootdir for the plug-in which calls
it. All subsequent calls of gimp_help from this plug-in will be
interpreted relative to this rootdir.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>domain_name</tt></i><EFBFBD>:</span></td><td> The XML namespace of the plug-in's help pages.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>domain_uri</tt></i><EFBFBD>:</span></td><td> The root URI of the plug-in's help pages.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2530927"></a><h3><a name="gimp-plugin-icon-register"></a>gimp_plugin_icon_register ()</h3><a class="indexterm" name="id2530935"></a><pre class="programlisting">gboolean gimp_plugin_icon_register (const gchar *procedure_name,
<a href="libgimp-gimpenums.html#GimpIconType">GimpIconType</a> icon_type,
const guint8 *icon_data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>procedure_name</tt></i><EFBFBD>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>icon_type</tt></i><EFBFBD>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>icon_data</tt></i><EFBFBD>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2531008"></a><h3><a name="gimp-plugin-menu-register"></a>gimp_plugin_menu_register ()</h3><a class="indexterm" name="id2589620"></a><pre class="programlisting">gboolean gimp_plugin_menu_register (const gchar *procedure_name,
const gchar *menu_path);</pre><p>
Register an additional menu path for a plug-in procedure.
</p><p>
This procedure installs an additional menu entry for the given
procedure.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>procedure_name</tt></i><EFBFBD>:</span></td><td> The procedure for which to install the menu path.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>menu_path</tt></i><EFBFBD>:</span></td><td> The procedure's additional menu path.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div><p>Since GIMP 2.2
</p></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-gimpmessage.html"><b>&lt;&lt;<EFBFBD>gimpmessage</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimpproceduraldb.html"><b>gimpproceduraldb<EFBFBD>&gt;&gt;</b></a></td></tr></table></body></html>