← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimphelp.xml

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimphelp.xml
1
 
<?xml version="1.0" encoding="UTF-8" ?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
 
5
 
<refentry id="libgimp-gimphelp">
6
 
<refmeta>
7
 
<refentrytitle role="top_of_page" id="libgimp-gimphelp.top_of_page">gimphelp</refentrytitle>
8
 
<manvolnum>3</manvolnum>
9
 
<refmiscinfo>LIBGIMP Library</refmiscinfo>
10
 
</refmeta>
11
 
 
12
 
<refnamediv>
13
 
<refname>gimphelp</refname>
14
 
<refpurpose>Loading help pages using gimp_help.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libgimp-gimphelp.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>
21
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-help">gimp_help</link>                           (const <link linkend="gchar">gchar</link> *help_domain,
22
 
                                                         const <link linkend="gchar">gchar</link> *help_id);
23
 
</synopsis>
24
 
</refsynopsisdiv>
25
 
 
26
 
 
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
<refsect1 id="libgimp-gimphelp.description" role="desc">
35
 
<title role="desc.title">Description</title>
36
 
<para>
37
 
Loading help pages using gimp_help.
38
 
</para>
39
 
</refsect1>
40
 
 
41
 
<refsect1 id="libgimp-gimphelp.details" role="details">
42
 
<title role="details.title">Details</title>
43
 
<refsect2 id="gimp-help" role="function">
44
 
<title>gimp_help ()</title>
45
 
<indexterm zone="gimp-help"><primary sortas="gimp_help">gimp_help</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_help                           (const <link linkend="gchar">gchar</link> *help_domain,
46
 
                                                         const <link linkend="gchar">gchar</link> *help_id);</programlisting>
47
 
<para>
48
 
Load a help page.
49
 
</para>
50
 
<para>
51
 
This procedure loads the specified help page into the helpbrowser or
52
 
what ever is configured as help viewer. The help page is identified
53
 
by its domain and ID: if help_domain is NULL, we use the help_domain
54
 
which was registered using the <link linkend="gimp-plugin-help-register"><function>gimp_plugin_help_register()</function></link>
55
 
procedure. If help_domain is NULL and no help domain was registered,
56
 
the help domain of the main GIMP installation is used.</para>
57
 
<para>
58
 
</para><variablelist role="params">
59
 
<varlistentry><term><parameter>help_domain</parameter>&#160;:</term>
60
 
<listitem><simpara> The help domain in which help_id is registered.
61
 
</simpara></listitem></varlistentry>
62
 
<varlistentry><term><parameter>help_id</parameter>&#160;:</term>
63
 
<listitem><simpara> The help page's ID.
64
 
</simpara></listitem></varlistentry>
65
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
66
 
</simpara></listitem></varlistentry>
67
 
</variablelist></refsect2>
68
 
 
69
 
</refsect1>
70
 
 
71
 
 
72
 
 
73
 
 
74
 
</refentry>