diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 03:13:10 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 03:13:10 +0000 |
| commit | 3c57dd931145d43f2b0aef96c4d178135956bf91 (patch) | |
| tree | 3de698981e9f0cc2c4f9569b19a5f3595e741f6b /devel-docs/libgimp/html/libgimp-gimphelp.html | |
| parent | Initial commit. (diff) | |
| download | gimp-3c57dd931145d43f2b0aef96c4d178135956bf91.tar.xz gimp-3c57dd931145d43f2b0aef96c4d178135956bf91.zip | |
Adding upstream version 2.10.36.upstream/2.10.36
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'devel-docs/libgimp/html/libgimp-gimphelp.html')
| -rw-r--r-- | devel-docs/libgimp/html/libgimp-gimphelp.html | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/devel-docs/libgimp/html/libgimp-gimphelp.html b/devel-docs/libgimp/html/libgimp-gimphelp.html new file mode 100644 index 0000000..e4194c6 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimphelp.html @@ -0,0 +1,101 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gimphelp: GIMP Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<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-gimpgimprc.html" title="gimpgimprc"> +<link rel="next" href="libgimp-gimpmessage.html" title="gimpmessage"> +<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</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="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#libgimp-gimphelp.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libgimp-gimpgimprc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimp-gimpmessage.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimp-gimphelp"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libgimp-gimphelp.top_of_page"></a>gimphelp</span></h2> +<p>gimphelp — Loading help pages using gimp_help.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimp-gimphelp.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody><tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimphelp.html#gimp-help" title="gimp_help ()">gimp_help</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimp-gimphelp.description"></a><h2>Description</h2> +<p>Loading help pages using gimp_help.</p> +</div> +<div class="refsect1"> +<a name="libgimp-gimphelp.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-help"></a><h3>gimp_help ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_help (<em class="parameter"><code>const <span class="type">gchar</span> *help_domain</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>);</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" title="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> +<div class="refsect3"> +<a name="gimp-help.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>help_domain</p></td> +<td class="parameter_description"><p>The help domain in which help_id is registered.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help_id</p></td> +<td class="parameter_description"><p>The help page's ID.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-help.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.33.1</div> +</body> +</html>
\ No newline at end of file |