← Back to branch summary

~ubuntu-branches/ubuntu/breezy/gimp/breezy

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2005-10-04 19:04:46 UTC
  • Revision ID: james.westby@ubuntu.com-20051004190446-ukh32kwk56s4sjhu
Tags: upstream-2.2.8
Import upstream version 2.2.8

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimpprogress.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-gimpprogress">
 
6
<refmeta>
 
7
<refentrytitle>gimpprogress</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMP Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>gimpprogress</refname><refpurpose>Functions for embedding the progress bar into a plug-in's GUI.</refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv><title>Synopsis</title>
 
17
 
 
18
<synopsis>
 
19
 
 
20
 
 
21
 
 
22
<link linkend="void">void</link>        (<link linkend="GimpProgressStartCallback">*GimpProgressStartCallback</link>)    (const <link linkend="gchar">gchar</link> *message,
 
23
                                             <link linkend="gboolean">gboolean</link> cancelable,
 
24
                                             <link linkend="gpointer">gpointer</link> user_data);
 
25
<link linkend="void">void</link>        (<link linkend="GimpProgressEndCallback">*GimpProgressEndCallback</link>)      (<link linkend="gpointer">gpointer</link> user_data);
 
26
<link linkend="void">void</link>        (<link linkend="GimpProgressTextCallback">*GimpProgressTextCallback</link>)     (const <link linkend="gchar">gchar</link> *message,
 
27
                                             <link linkend="gpointer">gpointer</link> user_data);
 
28
<link linkend="void">void</link>        (<link linkend="GimpProgressValueCallback">*GimpProgressValueCallback</link>)    (<link linkend="gdouble">gdouble</link> percentage,
 
29
                                             <link linkend="gpointer">gpointer</link> user_data);
 
30
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-progress-init">gimp_progress_init</link>              (const <link linkend="gchar">gchar</link> *message);
 
31
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-progress-update">gimp_progress_update</link>            (<link linkend="gdouble">gdouble</link> percentage);
 
32
const <link linkend="gchar">gchar</link>* <link linkend="gimp-progress-install">gimp_progress_install</link>          (<link linkend="GimpProgressStartCallback">GimpProgressStartCallback</link> start_callback,
 
33
                                             <link linkend="GimpProgressEndCallback">GimpProgressEndCallback</link> end_callback,
 
34
                                             <link linkend="GimpProgressTextCallback">GimpProgressTextCallback</link> text_callback,
 
35
                                             <link linkend="GimpProgressValueCallback">GimpProgressValueCallback</link> value_callback,
 
36
                                             <link linkend="gpointer">gpointer</link> user_data);
 
37
<link linkend="gpointer">gpointer</link>    <link linkend="gimp-progress-uninstall">gimp_progress_uninstall</link>         (const <link linkend="gchar">gchar</link> *progress_callback);
 
38
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-progress-cancel">gimp_progress_cancel</link>            (const <link linkend="gchar">gchar</link> *progress_callback);
 
39
</synopsis>
 
40
</refsynopsisdiv>
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
 
 
49
 
 
50
<refsect1>
 
51
<title>Description</title>
 
52
<para>
 
53
Functions for embedding the progress bar into a plug-in's GUI.
 
54
</para>
 
55
</refsect1>
 
56
 
 
57
<refsect1>
 
58
<title>Details</title>
 
59
<refsect2>
 
60
<title><anchor id="GimpProgressStartCallback"/>GimpProgressStartCallback ()</title>
 
61
<indexterm><primary>GimpProgressStartCallback</primary></indexterm><programlisting><link linkend="void">void</link>        (*GimpProgressStartCallback)    (const <link linkend="gchar">gchar</link> *message,
 
62
                                             <link linkend="gboolean">gboolean</link> cancelable,
 
63
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
64
<para>
 
65
 
 
66
</para><variablelist role="params">
 
67
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
68
<listitem><simpara>
 
69
</simpara></listitem></varlistentry>
 
70
<varlistentry><term><parameter>cancelable</parameter>&nbsp;:</term>
 
71
<listitem><simpara>
 
72
</simpara></listitem></varlistentry>
 
73
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
74
<listitem><simpara>
 
75
 
 
76
 
 
77
</simpara></listitem></varlistentry>
 
78
</variablelist></refsect2>
 
79
<refsect2>
 
80
<title><anchor id="GimpProgressEndCallback"/>GimpProgressEndCallback ()</title>
 
81
<indexterm><primary>GimpProgressEndCallback</primary></indexterm><programlisting><link linkend="void">void</link>        (*GimpProgressEndCallback)      (<link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
82
<para>
 
83
 
 
84
</para><variablelist role="params">
 
85
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
86
<listitem><simpara>
 
87
 
 
88
 
 
89
</simpara></listitem></varlistentry>
 
90
</variablelist></refsect2>
 
91
<refsect2>
 
92
<title><anchor id="GimpProgressTextCallback"/>GimpProgressTextCallback ()</title>
 
93
<indexterm><primary>GimpProgressTextCallback</primary></indexterm><programlisting><link linkend="void">void</link>        (*GimpProgressTextCallback)     (const <link linkend="gchar">gchar</link> *message,
 
94
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
95
<para>
 
96
 
 
97
</para><variablelist role="params">
 
98
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
99
<listitem><simpara>
 
100
</simpara></listitem></varlistentry>
 
101
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
102
<listitem><simpara>
 
103
 
 
104
 
 
105
</simpara></listitem></varlistentry>
 
106
</variablelist></refsect2>
 
107
<refsect2>
 
108
<title><anchor id="GimpProgressValueCallback"/>GimpProgressValueCallback ()</title>
 
109
<indexterm><primary>GimpProgressValueCallback</primary></indexterm><programlisting><link linkend="void">void</link>        (*GimpProgressValueCallback)    (<link linkend="gdouble">gdouble</link> percentage,
 
110
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
111
<para>
 
112
 
 
113
</para><variablelist role="params">
 
114
<varlistentry><term><parameter>percentage</parameter>&nbsp;:</term>
 
115
<listitem><simpara>
 
116
</simpara></listitem></varlistentry>
 
117
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
118
<listitem><simpara>
 
119
 
 
120
 
 
121
</simpara></listitem></varlistentry>
 
122
</variablelist></refsect2>
 
123
<refsect2>
 
124
<title><anchor id="gimp-progress-init"/>gimp_progress_init ()</title>
 
125
<indexterm><primary>gimp_progress_init</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_progress_init              (const <link linkend="gchar">gchar</link> *message);</programlisting>
 
126
<para>
 
127
Initializes the progress bar for the current plug-in.
 
128
</para>
 
129
<para>
 
130
Initializes the progress bar for the current plug-in. It is only
 
131
valid to call this procedure from a plug-in.</para>
 
132
<para>
 
133
 
 
134
</para><variablelist role="params">
 
135
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
136
<listitem><simpara> Message to use in the progress dialog.
 
137
</simpara></listitem></varlistentry>
 
138
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
139
</simpara></listitem></varlistentry>
 
140
</variablelist></refsect2>
 
141
<refsect2>
 
142
<title><anchor id="gimp-progress-update"/>gimp_progress_update ()</title>
 
143
<indexterm><primary>gimp_progress_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_progress_update            (<link linkend="gdouble">gdouble</link> percentage);</programlisting>
 
144
<para>
 
145
Updates the progress bar for the current plug-in.
 
146
</para>
 
147
<para>
 
148
Updates the progress bar for the current plug-in. It is only valid
 
149
to call this procedure from a plug-in.</para>
 
150
<para>
 
151
 
 
152
</para><variablelist role="params">
 
153
<varlistentry><term><parameter>percentage</parameter>&nbsp;:</term>
 
154
<listitem><simpara> Percentage of progress completed which must be between 0.0 and 1.0.
 
155
</simpara></listitem></varlistentry>
 
156
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
157
</simpara></listitem></varlistentry>
 
158
</variablelist></refsect2>
 
159
<refsect2>
 
160
<title><anchor id="gimp-progress-install"/>gimp_progress_install ()</title>
 
161
<indexterm role="GIMP"><primary>gimp_progress_install</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_progress_install          (<link linkend="GimpProgressStartCallback">GimpProgressStartCallback</link> start_callback,
 
162
                                             <link linkend="GimpProgressEndCallback">GimpProgressEndCallback</link> end_callback,
 
163
                                             <link linkend="GimpProgressTextCallback">GimpProgressTextCallback</link> text_callback,
 
164
                                             <link linkend="GimpProgressValueCallback">GimpProgressValueCallback</link> value_callback,
 
165
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
166
<para>
 
167
</para>
 
168
<para>
 
169
 
 
170
</para><variablelist role="params">
 
171
<varlistentry><term><parameter>start_callback</parameter>&nbsp;:</term>
 
172
<listitem><simpara> the function to call when progress starts
 
173
</simpara></listitem></varlistentry>
 
174
<varlistentry><term><parameter>end_callback</parameter>&nbsp;:</term>
 
175
<listitem><simpara>   the function to call when progress finishes
 
176
</simpara></listitem></varlistentry>
 
177
<varlistentry><term><parameter>text_callback</parameter>&nbsp;:</term>
 
178
<listitem><simpara>  the function to call to change the text
 
179
</simpara></listitem></varlistentry>
 
180
<varlistentry><term><parameter>value_callback</parameter>&nbsp;:</term>
 
181
<listitem><simpara> the function to call to change the value
 
182
</simpara></listitem></varlistentry>
 
183
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
184
<listitem><simpara>      a pointer that is returned when uninstalling the progress
 
185
</simpara></listitem></varlistentry>
 
186
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the name of the temporary procedure that's been installed
 
187
 
 
188
</simpara></listitem></varlistentry>
 
189
</variablelist><para>Since  GIMP 2.2
 
190
</para></refsect2>
 
191
<refsect2>
 
192
<title><anchor id="gimp-progress-uninstall"/>gimp_progress_uninstall ()</title>
 
193
<indexterm role="GIMP"><primary>gimp_progress_uninstall</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>    gimp_progress_uninstall         (const <link linkend="gchar">gchar</link> *progress_callback);</programlisting>
 
194
<para>
 
195
Uninstalls a temporary progress procedure that was installed using
 
196
<link linkend="gimp-progress-install"><function>gimp_progress_install()</function></link>.</para>
 
197
<para>
 
198
 
 
199
</para><variablelist role="params">
 
200
<varlistentry><term><parameter>progress_callback</parameter>&nbsp;:</term>
 
201
<listitem><simpara> the name of the temporary procedure to uninstall
 
202
</simpara></listitem></varlistentry>
 
203
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <parameter>user_data</parameter> that was passed to <link linkend="gimp-progress-install"><function>gimp_progress_install()</function></link>.
 
204
 
 
205
</simpara></listitem></varlistentry>
 
206
</variablelist><para>Since  GIMP 2.2
 
207
</para></refsect2>
 
208
<refsect2>
 
209
<title><anchor id="gimp-progress-cancel"/>gimp_progress_cancel ()</title>
 
210
<indexterm role="GIMP"><primary>gimp_progress_cancel</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_progress_cancel            (const <link linkend="gchar">gchar</link> *progress_callback);</programlisting>
 
211
<para>
 
212
Cancels a running progress.
 
213
</para>
 
214
<para>
 
215
This function cancels the currently running progress.</para>
 
216
<para>
 
217
 
 
218
</para><variablelist role="params">
 
219
<varlistentry><term><parameter>progress_callback</parameter>&nbsp;:</term>
 
220
<listitem><simpara> The name of the callback registered for this progress.
 
221
</simpara></listitem></varlistentry>
 
222
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
223
 
 
224
</simpara></listitem></varlistentry>
 
225
</variablelist><para>Since  GIMP 2.2
 
226
</para></refsect2>
 
227
 
 
228
</refsect1>
 
229
 
 
230
 
 
231
 
 
232
 
 
233
</refentry>