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

37 lines
4.6 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>gimphelp</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-gimpgimprc.html" title="gimpgimprc"><link rel="next" href="libgimp-gimpmessage.html" title="gimpmessage"><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-gimpgimprc.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-gimpmessage.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-gimphelp"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">gimphelp</span></h2><p>gimphelp &#8212; Loading help pages using gimp_help.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimphelp.html#gimp-help">gimp_help</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_domain,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id);
</pre></div><div class="refsect1" lang="en"><a name="id2578356"></a><h2>Description</h2><p>
Loading help pages using gimp_help.
</p></div><div class="refsect1" lang="en"><a name="id2562132"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2466549"></a><h3><a name="gimp-help"></a>gimp_help ()</h3><a class="indexterm" name="id2575215"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_help (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_domain,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id);</pre><p>
Load a help page.
</p><p>
This procedure loads the specified help page into the helpbrowser or
what ever is configured as help viewer. The help page is identified
by its domain and ID: if help_domain is NULL, we use the help_domain
which was registered using the gimp-plugin-help-register procedure.
If help_domain is NULL and no help domain was registered, the help
domain of the main GIMP installation is used.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>help_domain</tt></i> :</span></td><td> The help domain in which help_id is registered.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>help_id</tt></i> :</span></td><td> The help page's ID.
</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></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-gimpgimprc.html"><b>&lt;&lt; gimpgimprc</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimpmessage.html"><b>gimpmessage &gt;&gt;</b></a></td></tr></table></body></html>