← Back to branch summary

~ubuntu-branches/ubuntu/quantal/gimp/quantal-updates

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Micah Gersten
  • Date: 2012-05-20 19:21:01 UTC
  • mfrom: (1.1.26) (0.4.16 sid)
  • Revision ID: package-import@ubuntu.com-20120520192101-bs7zetx8ffoq2nfv
Tags: 2.8.0-2ubuntu1
https://launchpad.net/bugs/908472
* Merge from Debian unstable (LP: #908472). Remaining Changes:
  - debian/patches/02_help-message.patch,
    debian/patches/03_gimp.desktop.in.in.patch:
    + Update some strings for Ubuntu
  - debian/control:
    + Update description
  - debian/rules:
    + Set gettext domain and update translation templates
* Drop the following patches that were applied upstream:
  - debian/patches/ghost-cursor.patch: fix Wacom tablet cursor events
  - debian/patches/embed-page-setup-dialog.patch

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/html/libgimp-gimpplugin.html
37
37
</tr></table></div>
38
38
<div class="refsynopsisdiv">
39
39
<a name="libgimp-gimpplugin.synopsis"></a><h2>Synopsis</h2>
40
 
<pre class="synopsis"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-domain-register" title="gimp_plugin_domain_register ()">gimp_plugin_domain_register</a>         (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain_name</code></em>,
41
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain_path</code></em>);
42
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-help-register" title="gimp_plugin_help_register ()">gimp_plugin_help_register</a>           (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain_name</code></em>,
43
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain_uri</code></em>);
44
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-icon-register" title="gimp_plugin_icon_register ()">gimp_plugin_icon_register</a>           (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *procedure_name</code></em>,
45
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpIconType"><span class="type">GimpIconType</span></a> icon_type</code></em>,
46
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *icon_data</code></em>);
47
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-menu-register" title="gimp_plugin_menu_register ()">gimp_plugin_menu_register</a>           (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *procedure_name</code></em>,
48
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *menu_path</code></em>);
49
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-menu-branch-register" title="gimp_plugin_menu_branch_register ()">gimp_plugin_menu_branch_register</a>    (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *menu_path</code></em>,
50
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *menu_name</code></em>);
51
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-set-pdb-error-handler" title="gimp_plugin_set_pdb_error_handler ()">gimp_plugin_set_pdb_error_handler</a>   (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBErrorHandler"><span class="type">GimpPDBErrorHandler</span></a> handler</code></em>);
52
 
<a href="/usr/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBErrorHandler"><span class="returnvalue">GimpPDBErrorHandler</span></a> <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-get-pdb-error-handler" title="gimp_plugin_get_pdb_error_handler ()">gimp_plugin_get_pdb_error_handler</a>   (<em class="parameter"><code><span class="type">void</span></code></em>);
 
40
<pre class="synopsis"><span class="returnvalue">gboolean</span>            <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-domain-register" title="gimp_plugin_domain_register ()">gimp_plugin_domain_register</a>         (<em class="parameter"><code>const <span class="type">gchar</span> *domain_name</code></em>,
 
41
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *domain_path</code></em>);
 
42
<span class="returnvalue">gboolean</span>            <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-help-register" title="gimp_plugin_help_register ()">gimp_plugin_help_register</a>           (<em class="parameter"><code>const <span class="type">gchar</span> *domain_name</code></em>,
 
43
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *domain_uri</code></em>);
 
44
<span class="returnvalue">gboolean</span>            <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-icon-register" title="gimp_plugin_icon_register ()">gimp_plugin_icon_register</a>           (<em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>,
 
45
                                                         <em class="parameter"><code><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpIconType"><span class="type">GimpIconType</span></a> icon_type</code></em>,
 
46
                                                         <em class="parameter"><code>const <span class="type">guint8</span> *icon_data</code></em>);
 
47
<span class="returnvalue">gboolean</span>            <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-menu-register" title="gimp_plugin_menu_register ()">gimp_plugin_menu_register</a>           (<em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>,
 
48
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *menu_path</code></em>);
 
49
<span class="returnvalue">gboolean</span>            <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-menu-branch-register" title="gimp_plugin_menu_branch_register ()">gimp_plugin_menu_branch_register</a>    (<em class="parameter"><code>const <span class="type">gchar</span> *menu_path</code></em>,
 
50
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *menu_name</code></em>);
 
51
<span class="returnvalue">gboolean</span>            <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-set-pdb-error-handler" title="gimp_plugin_set_pdb_error_handler ()">gimp_plugin_set_pdb_error_handler</a>   (<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBErrorHandler"><span class="type">GimpPDBErrorHandler</span></a> handler</code></em>);
 
52
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBErrorHandler"><span class="returnvalue">GimpPDBErrorHandler</span></a> <a class="link" href="libgimp-gimpplugin.html#gimp-plugin-get-pdb-error-handler" title="gimp_plugin_get_pdb_error_handler ()">gimp_plugin_get_pdb_error_handler</a>   (<em class="parameter"><code><span class="type">void</span></code></em>);
53
53
</pre>
54
54
</div>
55
55
<div class="refsect1">
56
56
<a name="libgimp-gimpplugin.description"></a><h2>Description</h2>
57
57
<p>
58
 
Functions useful for plugins, e.g. registration and progress indicators.
 
58
Functions useful for plugins, e.g. registration and progress
 
59
indicators.
59
60
</p>
60
61
</div>
61
62
<div class="refsect1">
62
63
<a name="libgimp-gimpplugin.details"></a><h2>Details</h2>
63
64
<div class="refsect2">
64
65
<a name="gimp-plugin-domain-register"></a><h3>gimp_plugin_domain_register ()</h3>
65
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gimp_plugin_domain_register         (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain_name</code></em>,
66
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain_path</code></em>);</pre>
 
66
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gimp_plugin_domain_register         (<em class="parameter"><code>const <span class="type">gchar</span> *domain_name</code></em>,
 
67
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *domain_path</code></em>);</pre>
67
68
<p>
68
69
Registers a textdomain for localisation.
69
70
</p>
71
72
This procedure adds a textdomain to the list of domains Gimp
72
73
searches for strings when translating its menu entries. There is no
73
74
need to call this function for plug-ins that have their strings
74
 
included in the gimp-std-plugins domain as that is used by default.
75
 
If the compiled message catalog is not in the standard location, you
76
 
may specify an absolute path to another location. This procedure can
77
 
only be called in the query function of a plug-in and it has to be
78
 
called before any procedure is installed.
 
75
included in the 'gimp-std-plugins' domain as that is used by
 
76
default. If the compiled message catalog is not in the standard
 
77
location, you may specify an absolute path to another location. This
 
78
procedure can only be called in the query function of a plug-in and
 
79
it has to be called before any procedure is installed.
79
80
</p>
80
81
<div class="variablelist"><table border="0">
81
82
<col align="left" valign="top">
98
99
<hr>
99
100
<div class="refsect2">
100
101
<a name="gimp-plugin-help-register"></a><h3>gimp_plugin_help_register ()</h3>
101
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gimp_plugin_help_register           (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain_name</code></em>,
102
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain_uri</code></em>);</pre>
 
102
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gimp_plugin_help_register           (<em class="parameter"><code>const <span class="type">gchar</span> *domain_name</code></em>,
 
103
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *domain_uri</code></em>);</pre>
103
104
<p>
104
105
Register a help path for a plug-in.
105
106
</p>
106
107
<p>
107
 
This procedure changes the help rootdir for the plug-in which calls
108
 
it. All subsequent calls of <a class="link" href="libgimp-gimphelp.html#gimp-help" title="gimp_help ()"><code class="function">gimp_help()</code></a> from this plug-in will be
109
 
interpreted relative to this rootdir.
 
108
This procedure registers user documentation for the calling plug-in
 
109
with the GIMP help system. The domain_uri parameter points to the
 
110
root directory where the plug-in help is installed. For each
 
111
supported language there should be a file called 'gimp-help.xml'
 
112
that maps the help IDs to the actual help files.
110
113
</p>
111
114
<div class="variablelist"><table border="0">
112
115
<col align="left" valign="top">
129
132
<hr>
130
133
<div class="refsect2">
131
134
<a name="gimp-plugin-icon-register"></a><h3>gimp_plugin_icon_register ()</h3>
132
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gimp_plugin_icon_register           (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *procedure_name</code></em>,
133
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpIconType"><span class="type">GimpIconType</span></a> icon_type</code></em>,
134
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *icon_data</code></em>);</pre>
 
135
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gimp_plugin_icon_register           (<em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>,
 
136
                                                         <em class="parameter"><code><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpIconType"><span class="type">GimpIconType</span></a> icon_type</code></em>,
 
137
                                                         <em class="parameter"><code>const <span class="type">guint8</span> *icon_data</code></em>);</pre>
135
138
<p>
136
139
</p>
137
140
</div>
138
141
<hr>
139
142
<div class="refsect2">
140
143
<a name="gimp-plugin-menu-register"></a><h3>gimp_plugin_menu_register ()</h3>
141
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gimp_plugin_menu_register           (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *procedure_name</code></em>,
142
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *menu_path</code></em>);</pre>
 
144
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gimp_plugin_menu_register           (<em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>,
 
145
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *menu_path</code></em>);</pre>
143
146
<p>
144
147
Register an additional menu path for a plug-in procedure.
145
148
</p>
169
172
<hr>
170
173
<div class="refsect2">
171
174
<a name="gimp-plugin-menu-branch-register"></a><h3>gimp_plugin_menu_branch_register ()</h3>
172
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gimp_plugin_menu_branch_register    (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *menu_path</code></em>,
173
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *menu_name</code></em>);</pre>
 
175
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gimp_plugin_menu_branch_register    (<em class="parameter"><code>const <span class="type">gchar</span> *menu_path</code></em>,
 
176
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *menu_name</code></em>);</pre>
174
177
<p>
175
178
Register a sub-menu.
176
179
</p>
202
205
<hr>
203
206
<div class="refsect2">
204
207
<a name="gimp-plugin-set-pdb-error-handler"></a><h3>gimp_plugin_set_pdb_error_handler ()</h3>
205
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gimp_plugin_set_pdb_error_handler   (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBErrorHandler"><span class="type">GimpPDBErrorHandler</span></a> handler</code></em>);</pre>
 
208
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gimp_plugin_set_pdb_error_handler   (<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBErrorHandler"><span class="type">GimpPDBErrorHandler</span></a> handler</code></em>);</pre>
206
209
<p>
207
210
Sets an error handler for procedure calls.
208
211
</p>
212
215
call made by a plug-in fails. Using this procedure the plug-in can
213
216
change this behavior. If the error handler is set to
214
217
<code class="literal">GIMP_PDB_ERROR_HANDLER_PLUGIN</code>, then the plug-in is responsible for
215
 
calling <a class="link" href="libgimp-gimp.html#gimp-get-pdb-error" title="gimp_get_pdb_error ()"><code class="function">gimp_get_pdb_error()</code></a> and handling the error whenever one if
 
218
calling <a class="link" href="libgimp-Gimp.html#gimp-get-pdb-error" title="gimp_get_pdb_error ()"><code class="function">gimp_get_pdb_error()</code></a> and handling the error whenever one if
216
219
its procedure calls fails. It can do this by displaying the error
217
220
message or by forwarding it in its own return values.
218
221
</p>
234
237
<hr>
235
238
<div class="refsect2">
236
239
<a name="gimp-plugin-get-pdb-error-handler"></a><h3>gimp_plugin_get_pdb_error_handler ()</h3>
237
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBErrorHandler"><span class="returnvalue">GimpPDBErrorHandler</span></a> gimp_plugin_get_pdb_error_handler   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
240
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBErrorHandler"><span class="returnvalue">GimpPDBErrorHandler</span></a> gimp_plugin_get_pdb_error_handler   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
238
241
<p>
239
242
Retrieves the active error handler for procedure calls.
240
243
</p>