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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
<?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-gimpplugin">
<refmeta>
<refentrytitle role="top_of_page">gimpplugin</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpplugin</refname>
<refpurpose>Functions useful for plugins, e.g. registration and progress indicators.</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-plugin-domain-register">gimp_plugin_domain_register</link> (const <link linkend="gchar">gchar</link> *domain_name,
const <link linkend="gchar">gchar</link> *domain_path);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-plugin-help-register">gimp_plugin_help_register</link> (const <link linkend="gchar">gchar</link> *domain_name,
const <link linkend="gchar">gchar</link> *domain_uri);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-plugin-icon-register">gimp_plugin_icon_register</link> (const <link linkend="gchar">gchar</link> *procedure_name,
<link linkend="GimpIconType">GimpIconType</link> icon_type,
const <link linkend="guint8">guint8</link> *icon_data);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-plugin-menu-register">gimp_plugin_menu_register</link> (const <link linkend="gchar">gchar</link> *procedure_name,
const <link linkend="gchar">gchar</link> *menu_path);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions useful for plugins, e.g. registration and progress indicators.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-plugin-domain-register" role="function"/>gimp_plugin_domain_register ()</title>
<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,
const <link linkend="gchar">gchar</link> *domain_path);</programlisting>
<para>
Registers a textdomain for localisation.
</para>
<para>
This procedure adds a textdomain to the list of domains Gimp
searches for strings when translating its menu entries. There is no
need to call this function for plug-ins that have their strings
included in the gimp-std-plugins domain as that is used by default.
If the compiled message catalog is not in the standard location, you
may specify an absolute path to another location. This procedure can
only be called in the query function of a plug-in and it has to be
called before any procedure is installed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>domain_name</parameter> :</term>
<listitem><simpara> The name of the textdomain (must be unique).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>domain_path</parameter> :</term>
<listitem><simpara> The absolute path to the compiled message catalog (may be NULL).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-plugin-help-register" role="function"/>gimp_plugin_help_register ()</title>
<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,
const <link linkend="gchar">gchar</link> *domain_uri);</programlisting>
<para>
Register a help path for a plug-in.
</para>
<para>
This procedure changes the help rootdir for the plug-in which calls
it. All subsequent calls of gimp_help from this plug-in will be
interpreted relative to this rootdir.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>domain_name</parameter> :</term>
<listitem><simpara> The XML namespace of the plug-in's help pages.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>domain_uri</parameter> :</term>
<listitem><simpara> The root URI of the plug-in's help pages.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-plugin-icon-register" role="function"/>gimp_plugin_icon_register ()</title>
<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,
<link linkend="GimpIconType">GimpIconType</link> icon_type,
const <link linkend="guint8">guint8</link> *icon_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>procedure_name</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_type</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-plugin-menu-register" role="function" condition="since:GIMP 2.2"/>gimp_plugin_menu_register ()</title>
<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,
const <link linkend="gchar">gchar</link> *menu_path);</programlisting>
<para>
Register an additional menu path for a plug-in procedure.
</para>
<para>
This procedure installs an additional menu entry for the given
procedure.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>procedure_name</parameter> :</term>
<listitem><simpara> The procedure for which to install the menu path.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>menu_path</parameter> :</term>
<listitem><simpara> The procedure's additional menu path.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>
</refentry>
|
