← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimpplugin.xml
22
22
 
23
23
 
24
24
 
25
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-plugin-domain-register">gimp_plugin_domain_register</link>     (const <link linkend="gchar">gchar</link> *domain_name,
26
 
                                             const <link linkend="gchar">gchar</link> *domain_path);
27
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-plugin-help-register">gimp_plugin_help_register</link>       (const <link linkend="gchar">gchar</link> *domain_name,
28
 
                                             const <link linkend="gchar">gchar</link> *domain_uri);
29
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-plugin-icon-register">gimp_plugin_icon_register</link>       (const <link linkend="gchar">gchar</link> *procedure_name,
30
 
                                             <link linkend="GimpIconType">GimpIconType</link> icon_type,
31
 
                                             const <link linkend="guint8">guint8</link> *icon_data);
32
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-plugin-menu-register">gimp_plugin_menu_register</link>       (const <link linkend="gchar">gchar</link> *procedure_name,
33
 
                                             const <link linkend="gchar">gchar</link> *menu_path);
 
25
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-plugin-domain-register">gimp_plugin_domain_register</link>         (const <link linkend="gchar">gchar</link> *domain_name,
 
26
                                                         const <link linkend="gchar">gchar</link> *domain_path);
 
27
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-plugin-help-register">gimp_plugin_help_register</link>           (const <link linkend="gchar">gchar</link> *domain_name,
 
28
                                                         const <link linkend="gchar">gchar</link> *domain_uri);
 
29
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-plugin-icon-register">gimp_plugin_icon_register</link>           (const <link linkend="gchar">gchar</link> *procedure_name,
 
30
                                                         <link linkend="GimpIconType">GimpIconType</link> icon_type,
 
31
                                                         const <link linkend="guint8">guint8</link> *icon_data);
 
32
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-plugin-menu-register">gimp_plugin_menu_register</link>           (const <link linkend="gchar">gchar</link> *procedure_name,
 
33
                                                         const <link linkend="gchar">gchar</link> *menu_path);
 
34
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-plugin-menu-branch-register">gimp_plugin_menu_branch_register</link>    (const <link linkend="gchar">gchar</link> *menu_path,
 
35
                                                         const <link linkend="gchar">gchar</link> *menu_name);
34
36
</synopsis>
35
37
</refsynopsisdiv>
36
38
 
54
56
<title role="details.title">Details</title>
55
57
<refsect2>
56
58
<title><anchor id="gimp-plugin-domain-register" role="function"/>gimp_plugin_domain_register ()</title>
57
 
<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,
58
 
                                             const <link linkend="gchar">gchar</link> *domain_path);</programlisting>
 
59
<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,
 
60
                                                         const <link linkend="gchar">gchar</link> *domain_path);</programlisting>
59
61
<para>
60
62
Registers a textdomain for localisation.
61
63
</para>
82
84
</variablelist></refsect2>
83
85
<refsect2>
84
86
<title><anchor id="gimp-plugin-help-register" role="function"/>gimp_plugin_help_register ()</title>
85
 
<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,
86
 
                                             const <link linkend="gchar">gchar</link> *domain_uri);</programlisting>
 
87
<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,
 
88
                                                         const <link linkend="gchar">gchar</link> *domain_uri);</programlisting>
87
89
<para>
88
90
Register a help path for a plug-in.
89
91
</para>
90
92
<para>
91
93
This procedure changes the help rootdir for the plug-in which calls
92
 
it. All subsequent calls of gimp_help from this plug-in will be
 
94
it. All subsequent calls of <link linkend="gimp-help"><function>gimp_help()</function></link> from this plug-in will be
93
95
interpreted relative to this rootdir.</para>
94
96
<para>
95
97
 
105
107
</variablelist></refsect2>
106
108
<refsect2>
107
109
<title><anchor id="gimp-plugin-icon-register" role="function"/>gimp_plugin_icon_register ()</title>
108
 
<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,
109
 
                                             <link linkend="GimpIconType">GimpIconType</link> icon_type,
110
 
                                             const <link linkend="guint8">guint8</link> *icon_data);</programlisting>
 
110
<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,
 
111
                                                         <link linkend="GimpIconType">GimpIconType</link> icon_type,
 
112
                                                         const <link linkend="guint8">guint8</link> *icon_data);</programlisting>
111
113
<para>
112
114
 
113
115
</para><variablelist role="params">
127
129
</variablelist></refsect2>
128
130
<refsect2>
129
131
<title><anchor id="gimp-plugin-menu-register" role="function" condition="since:GIMP 2.2"/>gimp_plugin_menu_register ()</title>
130
 
<indexterm role="GIMP 2.2"><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,
131
 
                                             const <link linkend="gchar">gchar</link> *menu_path);</programlisting>
 
132
<indexterm role="GIMP 2.2"><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,
 
133
                                                         const <link linkend="gchar">gchar</link> *menu_path);</programlisting>
132
134
<para>
133
135
Register an additional menu path for a plug-in procedure.
134
136
</para>
147
149
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
148
150
 
149
151
</simpara></listitem></varlistentry>
150
 
</variablelist><para>Since  GIMP 2.2
 
152
</variablelist><para role="since">Since  GIMP 2.2
 
153
</para></refsect2>
 
154
<refsect2>
 
155
<title><anchor id="gimp-plugin-menu-branch-register" role="function" condition="since:GIMP 2.4"/>gimp_plugin_menu_branch_register ()</title>
 
156
<indexterm role="GIMP 2.4"><primary>gimp_plugin_menu_branch_register</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_plugin_menu_branch_register    (const <link linkend="gchar">gchar</link> *menu_path,
 
157
                                                         const <link linkend="gchar">gchar</link> *menu_name);</programlisting>
 
158
<para>
 
159
Register a sub-menu.
 
160
</para>
 
161
<para>
 
162
This procedure installs an sub-menu which does not belong to any
 
163
procedure.</para>
 
164
<para>
 
165
 
 
166
</para><variablelist role="params">
 
167
<varlistentry><term><parameter>menu_path</parameter>&nbsp;:</term>
 
168
<listitem><simpara> The sub-menu's menu path.
 
169
</simpara></listitem></varlistentry>
 
170
<varlistentry><term><parameter>menu_name</parameter>&nbsp;:</term>
 
171
<listitem><simpara> The name of the sub-menu.
 
172
</simpara></listitem></varlistentry>
 
173
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
174
 
 
175
</simpara></listitem></varlistentry>
 
176
</variablelist><para role="since">Since  GIMP 2.4
151
177
</para></refsect2>
152
178
 
153
179
</refsect1>