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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
<?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-gimpprogress">
<refmeta>
<refentrytitle role="top_of_page">gimpprogress</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpprogress</refname>
<refpurpose>Functions for embedding the progress bar into a plug-in's GUI.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="void">void</link> (<link linkend="GimpProgressStartCallback">*GimpProgressStartCallback</link>) (const <link linkend="gchar">gchar</link> *message,
<link linkend="gboolean">gboolean</link> cancelable,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> (<link linkend="GimpProgressEndCallback">*GimpProgressEndCallback</link>) (<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> (<link linkend="GimpProgressTextCallback">*GimpProgressTextCallback</link>) (const <link linkend="gchar">gchar</link> *message,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> (<link linkend="GimpProgressValueCallback">*GimpProgressValueCallback</link>) (<link linkend="gdouble">gdouble</link> percentage,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-progress-init">gimp_progress_init</link> (const <link linkend="gchar">gchar</link> *message);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-progress-update">gimp_progress_update</link> (<link linkend="gdouble">gdouble</link> percentage);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-progress-install">gimp_progress_install</link> (<link linkend="GimpProgressStartCallback">GimpProgressStartCallback</link> start_callback,
<link linkend="GimpProgressEndCallback">GimpProgressEndCallback</link> end_callback,
<link linkend="GimpProgressTextCallback">GimpProgressTextCallback</link> text_callback,
<link linkend="GimpProgressValueCallback">GimpProgressValueCallback</link> value_callback,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gpointer">gpointer</link> <link linkend="gimp-progress-uninstall">gimp_progress_uninstall</link> (const <link linkend="gchar">gchar</link> *progress_callback);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-progress-cancel">gimp_progress_cancel</link> (const <link linkend="gchar">gchar</link> *progress_callback);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions for embedding the progress bar into a plug-in's GUI.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GimpProgressStartCallback" role="function"/>GimpProgressStartCallback ()</title>
<indexterm><primary>GimpProgressStartCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpProgressStartCallback) (const <link linkend="gchar">gchar</link> *message,
<link linkend="gboolean">gboolean</link> cancelable,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>message</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cancelable</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GimpProgressEndCallback" role="function"/>GimpProgressEndCallback ()</title>
<indexterm><primary>GimpProgressEndCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpProgressEndCallback) (<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GimpProgressTextCallback" role="function"/>GimpProgressTextCallback ()</title>
<indexterm><primary>GimpProgressTextCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpProgressTextCallback) (const <link linkend="gchar">gchar</link> *message,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>message</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GimpProgressValueCallback" role="function"/>GimpProgressValueCallback ()</title>
<indexterm><primary>GimpProgressValueCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpProgressValueCallback) (<link linkend="gdouble">gdouble</link> percentage,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>percentage</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-progress-init" role="function"/>gimp_progress_init ()</title>
<indexterm><primary>gimp_progress_init</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_progress_init (const <link linkend="gchar">gchar</link> *message);</programlisting>
<para>
Initializes the progress bar for the current plug-in.
</para>
<para>
Initializes the progress bar for the current plug-in. It is only
valid to call this procedure from a plug-in.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>message</parameter> :</term>
<listitem><simpara> Message to use in the progress dialog.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-progress-update" role="function"/>gimp_progress_update ()</title>
<indexterm><primary>gimp_progress_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_progress_update (<link linkend="gdouble">gdouble</link> percentage);</programlisting>
<para>
Updates the progress bar for the current plug-in.
</para>
<para>
Updates the progress bar for the current plug-in. It is only valid
to call this procedure from a plug-in.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>percentage</parameter> :</term>
<listitem><simpara> Percentage of progress completed which must be between 0.0 and 1.0.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-progress-install" role="function" condition="since:GIMP 2.2"/>gimp_progress_install ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_progress_install</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_progress_install (<link linkend="GimpProgressStartCallback">GimpProgressStartCallback</link> start_callback,
<link linkend="GimpProgressEndCallback">GimpProgressEndCallback</link> end_callback,
<link linkend="GimpProgressTextCallback">GimpProgressTextCallback</link> text_callback,
<link linkend="GimpProgressValueCallback">GimpProgressValueCallback</link> value_callback,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>start_callback</parameter> :</term>
<listitem><simpara> the function to call when progress starts
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end_callback</parameter> :</term>
<listitem><simpara> the function to call when progress finishes
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text_callback</parameter> :</term>
<listitem><simpara> the function to call to change the text
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_callback</parameter> :</term>
<listitem><simpara> the function to call to change the value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> a pointer that is returned when uninstalling the progress
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the name of the temporary procedure that's been installed
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-progress-uninstall" role="function" condition="since:GIMP 2.2"/>gimp_progress_uninstall ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_progress_uninstall</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> gimp_progress_uninstall (const <link linkend="gchar">gchar</link> *progress_callback);</programlisting>
<para>
Uninstalls a temporary progress procedure that was installed using
<link linkend="gimp-progress-install"><function>gimp_progress_install()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>progress_callback</parameter> :</term>
<listitem><simpara> the name of the temporary procedure to uninstall
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <parameter>user_data</parameter> that was passed to <link linkend="gimp-progress-install"><function>gimp_progress_install()</function></link>.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-progress-cancel" role="function" condition="since:GIMP 2.2"/>gimp_progress_cancel ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_progress_cancel</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_progress_cancel (const <link linkend="gchar">gchar</link> *progress_callback);</programlisting>
<para>
Cancels a running progress.
</para>
<para>
This function cancels the currently running progress.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>progress_callback</parameter> :</term>
<listitem><simpara> The name of the callback registered for this progress.
</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>
|
