1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimphelp">
<refmeta>
<refentrytitle role="top_of_page">gimphelp</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimphelp</refname>
<refpurpose>Loading help pages using gimp_help.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gboolean">gboolean</link> <link linkend="gimp-help">gimp_help</link> (const <link linkend="gchar">gchar</link> *help_domain,
const <link linkend="gchar">gchar</link> *help_id);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Loading help pages using gimp_help.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-help" role="function"/>gimp_help ()</title>
<indexterm><primary>gimp_help</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_help (const <link linkend="gchar">gchar</link> *help_domain,
const <link linkend="gchar">gchar</link> *help_id);</programlisting>
<para>
Load a help page.
</para>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>help_domain</parameter> :</term>
<listitem><simpara> The help domain in which help_id is registered.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>help_id</parameter> :</term>
<listitem><simpara> The help page's ID.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
