128 lines
5.4 KiB
HTML
128 lines
5.4 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>gimphelp</title>
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
|
|
<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.9 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="libgimp.html" title="Part I. 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 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 II. GIMP User Interface Library">
|
|
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
|
|
<link rel="index" href="libgimp-index.html" title="Index">
|
|
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
|
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
|
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table class="navigation" id="top" 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>
|
|
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2592030" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2574304" class="shortcut">Description</a></nobr></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>
|
|
<a name="id2592030"></a><span class="refentrytitle">gimphelp</span>
|
|
</h2>
|
|
<p>gimphelp — 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 class="link" 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="id2574304"></a><h2>Description</h2>
|
|
<p>
|
|
Loading help pages using gimp_help.
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2587190"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2613997"></a><h3>
|
|
<a name="gimp-help"></a>gimp_help ()</h3>
|
|
<a class="indexterm" name="id2617040"></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 <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-help-register"><code class="function">gimp_plugin_help_register()</code></a>
|
|
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><p><span class="term"><em class="parameter"><code>help_domain</code></em> :</span></p></td>
|
|
<td> The help domain in which help_id is registered.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
|
|
<td> The help page's ID.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td> TRUE on success.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2580866"></a><div class="refsect2" lang="en"><a name="id2580867"></a></div>
|
|
<hr>
|
|
<div class="refsect2" lang="en"><a name="id2580868"></a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|