← Back to branch summary

~ubuntu-branches/ubuntu/hoary/gimp/hoary

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2005-04-04 14:51:23 UTC
  • Revision ID: james.westby@ubuntu.com-20050404145123-9py049eeelfymur8
Tags: upstream-2.2.2
Import upstream version 2.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimpplugin.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-gimpplugin">
 
6
<refmeta>
 
7
<refentrytitle>gimpplugin</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMP Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>gimpplugin</refname><refpurpose>Functions useful for plugins, e.g. registration and progress indicators.</refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv><title>Synopsis</title>
 
17
 
 
18
<synopsis>
 
19
 
 
20
 
 
21
 
 
22
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-plugin-domain-register">gimp_plugin_domain_register</link>     (const <link linkend="gchar">gchar</link> *domain_name,
 
23
                                             const <link linkend="gchar">gchar</link> *domain_path);
 
24
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-plugin-help-register">gimp_plugin_help_register</link>       (const <link linkend="gchar">gchar</link> *domain_name,
 
25
                                             const <link linkend="gchar">gchar</link> *domain_uri);
 
26
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-plugin-icon-register">gimp_plugin_icon_register</link>       (const <link linkend="gchar">gchar</link> *procedure_name,
 
27
                                             <link linkend="GimpIconType">GimpIconType</link> icon_type,
 
28
                                             const <link linkend="guint8">guint8</link> *icon_data);
 
29
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-plugin-menu-register">gimp_plugin_menu_register</link>       (const <link linkend="gchar">gchar</link> *procedure_name,
 
30
                                             const <link linkend="gchar">gchar</link> *menu_path);
 
31
</synopsis>
 
32
</refsynopsisdiv>
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
<refsect1>
 
43
<title>Description</title>
 
44
<para>
 
45
Functions useful for plugins, e.g. registration and progress indicators.
 
46
 
 
47
</para>
 
48
</refsect1>
 
49
 
 
50
<refsect1>
 
51
<title>Details</title>
 
52
<refsect2>
 
53
<title><anchor id="gimp-plugin-domain-register"/>gimp_plugin_domain_register ()</title>
 
54
<indexterm><primary>gimp_plugin_domain_register</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_plugin_domain_register     (const <link linkend="gchar">gchar</link> *domain_name,
 
55
                                             const <link linkend="gchar">gchar</link> *domain_path);</programlisting>
 
56
<para>
 
57
Registers a textdomain for localisation.
 
58
</para>
 
59
<para>
 
60
This procedure adds a textdomain to the list of domains Gimp
 
61
searches for strings when translating its menu entries. There is no
 
62
need to call this function for plug-ins that have their strings
 
63
included in the gimp-std-plugins domain as that is used by default.
 
64
If the compiled message catalog is not in the standard location, you
 
65
may specify an absolute path to another location. This procedure can
 
66
only be called in the query function of a plug-in and it has to be
 
67
called before any procedure is installed.</para>
 
68
<para>
 
69
 
 
70
</para><variablelist role="params">
 
71
<varlistentry><term><parameter>domain_name</parameter>&nbsp;:</term>
 
72
<listitem><simpara> The name of the textdomain (must be unique).
 
73
</simpara></listitem></varlistentry>
 
74
<varlistentry><term><parameter>domain_path</parameter>&nbsp;:</term>
 
75
<listitem><simpara> The absolute path to the compiled message catalog (may be NULL).
 
76
</simpara></listitem></varlistentry>
 
77
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
 
78
</simpara></listitem></varlistentry>
 
79
</variablelist></refsect2>
 
80
<refsect2>
 
81
<title><anchor id="gimp-plugin-help-register"/>gimp_plugin_help_register ()</title>
 
82
<indexterm><primary>gimp_plugin_help_register</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_plugin_help_register       (const <link linkend="gchar">gchar</link> *domain_name,
 
83
                                             const <link linkend="gchar">gchar</link> *domain_uri);</programlisting>
 
84
<para>
 
85
Register a help path for a plug-in.
 
86
</para>
 
87
<para>
 
88
This procedure changes the help rootdir for the plug-in which calls
 
89
it. All subsequent calls of gimp_help from this plug-in will be
 
90
interpreted relative to this rootdir.</para>
 
91
<para>
 
92
 
 
93
</para><variablelist role="params">
 
94
<varlistentry><term><parameter>domain_name</parameter>&nbsp;:</term>
 
95
<listitem><simpara> The XML namespace of the plug-in's help pages.
 
96
</simpara></listitem></varlistentry>
 
97
<varlistentry><term><parameter>domain_uri</parameter>&nbsp;:</term>
 
98
<listitem><simpara> The root URI of the plug-in's help pages.
 
99
</simpara></listitem></varlistentry>
 
100
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
 
101
</simpara></listitem></varlistentry>
 
102
</variablelist></refsect2>
 
103
<refsect2>
 
104
<title><anchor id="gimp-plugin-icon-register"/>gimp_plugin_icon_register ()</title>
 
105
<indexterm><primary>gimp_plugin_icon_register</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_plugin_icon_register       (const <link linkend="gchar">gchar</link> *procedure_name,
 
106
                                             <link linkend="GimpIconType">GimpIconType</link> icon_type,
 
107
                                             const <link linkend="guint8">guint8</link> *icon_data);</programlisting>
 
108
<para>
 
109
 
 
110
</para><variablelist role="params">
 
111
<varlistentry><term><parameter>procedure_name</parameter>&nbsp;:</term>
 
112
<listitem><simpara>
 
113
</simpara></listitem></varlistentry>
 
114
<varlistentry><term><parameter>icon_type</parameter>&nbsp;:</term>
 
115
<listitem><simpara>
 
116
</simpara></listitem></varlistentry>
 
117
<varlistentry><term><parameter>icon_data</parameter>&nbsp;:</term>
 
118
<listitem><simpara>
 
119
</simpara></listitem></varlistentry>
 
120
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 
121
 
 
122
 
 
123
</simpara></listitem></varlistentry>
 
124
</variablelist></refsect2>
 
125
<refsect2>
 
126
<title><anchor id="gimp-plugin-menu-register"/>gimp_plugin_menu_register ()</title>
 
127
<indexterm><primary>gimp_plugin_menu_register</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_plugin_menu_register       (const <link linkend="gchar">gchar</link> *procedure_name,
 
128
                                             const <link linkend="gchar">gchar</link> *menu_path);</programlisting>
 
129
<para>
 
130
Register an additional menu path for a plug-in procedure.
 
131
</para>
 
132
<para>
 
133
This procedure installs an additional menu entry for the given
 
134
procedure.</para>
 
135
<para>
 
136
 
 
137
</para><variablelist role="params">
 
138
<varlistentry><term><parameter>procedure_name</parameter>&nbsp;:</term>
 
139
<listitem><simpara> The procedure for which to install the menu path.
 
140
</simpara></listitem></varlistentry>
 
141
<varlistentry><term><parameter>menu_path</parameter>&nbsp;:</term>
 
142
<listitem><simpara> The procedure's additional menu path.
 
143
</simpara></listitem></varlistentry>
 
144
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
 
145
 
 
146
</simpara></listitem></varlistentry>
 
147
</variablelist><para>Since  GIMP 2.2
 
148
</para></refsect2>
 
149
 
 
150
</refsect1>
 
151
 
 
152
 
 
153
 
 
154
 
 
155
</refentry>