1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>GtkProgress</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
7
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
8
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
9
<link rel="prev" href="GtkPreview.html" title="GtkPreview">
10
<link rel="next" href="GtkText.html" title="GtkText">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="GtkPreview.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="DeprecatedObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
21
<td><a accesskey="n" href="GtkText.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#GtkProgress.synopsis" class="shortcut">Top</a>
26
<a href="#GtkProgress.description" class="shortcut">Description</a>
28
<a href="#GtkProgress.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#GtkProgress.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32
<a href="#GtkProgress.properties" class="shortcut">Properties</a>
35
<div class="refentry">
36
<a name="GtkProgress"></a><div class="titlepage"></div>
37
<div class="refnamediv"><table width="100%"><tr>
39
<h2><span class="refentrytitle"><a name="GtkProgress.top_of_page"></a>GtkProgress</span></h2>
40
<p>GtkProgress — Base class for GtkProgressBar</p>
42
<td valign="top" align="right"></td>
44
<div class="refsynopsisdiv">
45
<a name="GtkProgress.synopsis"></a><h2>Synopsis</h2>
46
<pre class="synopsis">
47
#include <gtk/gtk.h>
49
struct <a class="link" href="GtkProgress.html#GtkProgress-struct" title="struct GtkProgress">GtkProgress</a>;
50
<span class="returnvalue">void</span> <a class="link" href="GtkProgress.html#gtk-progress-set-show-text" title="gtk_progress_set_show_text ()">gtk_progress_set_show_text</a> (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
51
<em class="parameter"><code><span class="type">gboolean</span> show_text</code></em>);
52
<span class="returnvalue">void</span> <a class="link" href="GtkProgress.html#gtk-progress-set-text-alignment" title="gtk_progress_set_text_alignment ()">gtk_progress_set_text_alignment</a> (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
53
<em class="parameter"><code><span class="type">gfloat</span> x_align</code></em>,
54
<em class="parameter"><code><span class="type">gfloat</span> y_align</code></em>);
55
<span class="returnvalue">void</span> <a class="link" href="GtkProgress.html#gtk-progress-set-format-string" title="gtk_progress_set_format_string ()">gtk_progress_set_format_string</a> (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
56
<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>);
57
<span class="returnvalue">void</span> <a class="link" href="GtkProgress.html#gtk-progress-set-adjustment" title="gtk_progress_set_adjustment ()">gtk_progress_set_adjustment</a> (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
58
<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *adjustment</code></em>);
59
<span class="returnvalue">void</span> <a class="link" href="GtkProgress.html#gtk-progress-set-percentage" title="gtk_progress_set_percentage ()">gtk_progress_set_percentage</a> (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
60
<em class="parameter"><code><span class="type">gdouble</span> percentage</code></em>);
61
<span class="returnvalue">void</span> <a class="link" href="GtkProgress.html#gtk-progress-set-value" title="gtk_progress_set_value ()">gtk_progress_set_value</a> (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
62
<em class="parameter"><code><span class="type">gdouble</span> value</code></em>);
63
<span class="returnvalue">gdouble</span> <a class="link" href="GtkProgress.html#gtk-progress-get-value" title="gtk_progress_get_value ()">gtk_progress_get_value</a> (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>);
64
<span class="returnvalue">void</span> <a class="link" href="GtkProgress.html#gtk-progress-set-activity-mode" title="gtk_progress_set_activity_mode ()">gtk_progress_set_activity_mode</a> (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
65
<em class="parameter"><code><span class="type">gboolean</span> activity_mode</code></em>);
66
<span class="returnvalue">gchar</span> * <a class="link" href="GtkProgress.html#gtk-progress-get-current-text" title="gtk_progress_get_current_text ()">gtk_progress_get_current_text</a> (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>);
67
<span class="returnvalue">gchar</span> * <a class="link" href="GtkProgress.html#gtk-progress-get-text-from-value" title="gtk_progress_get_text_from_value ()">gtk_progress_get_text_from_value</a> (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
68
<em class="parameter"><code><span class="type">gdouble</span> value</code></em>);
69
<span class="returnvalue">gdouble</span> <a class="link" href="GtkProgress.html#gtk-progress-get-current-percentage" title="gtk_progress_get_current_percentage ()">gtk_progress_get_current_percentage</a> (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>);
70
<span class="returnvalue">gdouble</span> <a class="link" href="GtkProgress.html#gtk-progress-get-percentage-from-value" title="gtk_progress_get_percentage_from_value ()">gtk_progress_get_percentage_from_value</a>
71
(<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
72
<em class="parameter"><code><span class="type">gdouble</span> value</code></em>);
73
<span class="returnvalue">void</span> <a class="link" href="GtkProgress.html#gtk-progress-configure" title="gtk_progress_configure ()">gtk_progress_configure</a> (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
74
<em class="parameter"><code><span class="type">gdouble</span> value</code></em>,
75
<em class="parameter"><code><span class="type">gdouble</span> min</code></em>,
76
<em class="parameter"><code><span class="type">gdouble</span> max</code></em>);
79
<div class="refsect1">
80
<a name="GtkProgress.object-hierarchy"></a><h2>Object Hierarchy</h2>
81
<pre class="synopsis">
83
+----GInitiallyUnowned
84
+----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
85
+----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
87
+----<a class="link" href="GtkProgressBar.html" title="GtkProgressBar">GtkProgressBar</a>
90
<div class="refsect1">
91
<a name="GtkProgress.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
93
GtkProgress implements
94
AtkImplementorIface and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
96
<div class="refsect1">
97
<a name="GtkProgress.properties"></a><h2>Properties</h2>
98
<pre class="synopsis">
99
"<a class="link" href="GtkProgress.html#GtkProgress--activity-mode" title='The "activity-mode" property'>activity-mode</a>" <span class="type">gboolean</span> : Read / Write
100
"<a class="link" href="GtkProgress.html#GtkProgress--show-text" title='The "show-text" property'>show-text</a>" <span class="type">gboolean</span> : Read / Write
101
"<a class="link" href="GtkProgress.html#GtkProgress--text-xalign" title='The "text-xalign" property'>text-xalign</a>" <span class="type">gfloat</span> : Read / Write
102
"<a class="link" href="GtkProgress.html#GtkProgress--text-yalign" title='The "text-yalign" property'>text-yalign</a>" <span class="type">gfloat</span> : Read / Write
105
<div class="refsect1">
106
<a name="GtkProgress.description"></a><h2>Description</h2>
108
A <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> is the abstract base class used to derive
109
a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> which provides a visual representation of
110
the progress of a long running operation.
113
<div class="refsect1">
114
<a name="GtkProgress.details"></a><h2>Details</h2>
115
<div class="refsect2">
116
<a name="GtkProgress-struct"></a><h3>struct GtkProgress</h3>
117
<pre class="programlisting">struct GtkProgress;</pre>
119
The <a class="link" href="GtkProgress.html#GtkProgress-struct" title="struct GtkProgress"><span class="type">GtkProgress</span></a> struct contains private data only.
120
and should be accessed using the functions below.
124
<div class="refsect2">
125
<a name="gtk-progress-set-show-text"></a><h3>gtk_progress_set_show_text ()</h3>
126
<pre class="programlisting"><span class="returnvalue">void</span> gtk_progress_set_show_text (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
127
<em class="parameter"><code><span class="type">gboolean</span> show_text</code></em>);</pre>
128
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
129
<h3 class="title">Warning</h3>
130
<p><code class="literal">gtk_progress_set_show_text</code> is deprecated and should not be used in newly-written code.</p>
133
Controls whether progress text is shown.
135
<div class="variablelist"><table border="0" class="variablelist">
137
<col align="left" valign="top">
142
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
143
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
146
<td><p><span class="term"><em class="parameter"><code>show_text</code></em> :</span></p></td>
147
<td>a boolean indicating whether the progress text
154
<div class="refsect2">
155
<a name="gtk-progress-set-text-alignment"></a><h3>gtk_progress_set_text_alignment ()</h3>
156
<pre class="programlisting"><span class="returnvalue">void</span> gtk_progress_set_text_alignment (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
157
<em class="parameter"><code><span class="type">gfloat</span> x_align</code></em>,
158
<em class="parameter"><code><span class="type">gfloat</span> y_align</code></em>);</pre>
159
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
160
<h3 class="title">Warning</h3>
161
<p><code class="literal">gtk_progress_set_text_alignment</code> is deprecated and should not be used in newly-written code.</p>
164
Controls the alignment of the text within the progress bar area.
166
<div class="variablelist"><table border="0" class="variablelist">
168
<col align="left" valign="top">
173
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
174
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
177
<td><p><span class="term"><em class="parameter"><code>x_align</code></em> :</span></p></td>
178
<td>a number between 0.0 and 1.0 indicating the horizontal
179
alignment of the progress text within the <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
182
<td><p><span class="term"><em class="parameter"><code>y_align</code></em> :</span></p></td>
183
<td>a number between 0.0 and 1.0 indicating the vertical
184
alignment of the progress text within the <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
190
<div class="refsect2">
191
<a name="gtk-progress-set-format-string"></a><h3>gtk_progress_set_format_string ()</h3>
192
<pre class="programlisting"><span class="returnvalue">void</span> gtk_progress_set_format_string (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
193
<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>);</pre>
194
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
195
<h3 class="title">Warning</h3>
196
<p><code class="literal">gtk_progress_set_format_string</code> is deprecated and should not be used in newly-written code.</p>
199
Sets a format string used to display text indicating the
200
current progress. The string can contain the following substitution characters:
202
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
203
<li class="listitem"><p>
204
%v - the current progress value.
206
<li class="listitem"><p>
207
%l - the lower bound for the progress value.
209
<li class="listitem"><p>
210
%u - the upper bound for the progress value.
212
<li class="listitem"><p>
213
%p - the current progress percentage.
218
<div class="variablelist"><table border="0" class="variablelist">
220
<col align="left" valign="top">
225
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
226
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
229
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
230
<td>a string used to display progress text, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
231
to restore to the default format.</td>
237
<div class="refsect2">
238
<a name="gtk-progress-set-adjustment"></a><h3>gtk_progress_set_adjustment ()</h3>
239
<pre class="programlisting"><span class="returnvalue">void</span> gtk_progress_set_adjustment (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
240
<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *adjustment</code></em>);</pre>
241
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
242
<h3 class="title">Warning</h3>
243
<p><code class="literal">gtk_progress_set_adjustment</code> is deprecated and should not be used in newly-written code.</p>
246
Associates a <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> with the <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>. A <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>
247
is used to represent the upper and lower bounds and the step interval
248
of the underlying value for which progress is shown.
250
<div class="variablelist"><table border="0" class="variablelist">
252
<col align="left" valign="top">
257
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
258
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
261
<td><p><span class="term"><em class="parameter"><code>adjustment</code></em> :</span></p></td>
262
<td>the <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> to be associated with the <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
268
<div class="refsect2">
269
<a name="gtk-progress-set-percentage"></a><h3>gtk_progress_set_percentage ()</h3>
270
<pre class="programlisting"><span class="returnvalue">void</span> gtk_progress_set_percentage (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
271
<em class="parameter"><code><span class="type">gdouble</span> percentage</code></em>);</pre>
272
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
273
<h3 class="title">Warning</h3>
274
<p><code class="literal">gtk_progress_set_percentage</code> is deprecated and should not be used in newly-written code.</p>
277
Sets the current percentage completion for the <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
279
<div class="variablelist"><table border="0" class="variablelist">
281
<col align="left" valign="top">
286
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
287
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
290
<td><p><span class="term"><em class="parameter"><code>percentage</code></em> :</span></p></td>
291
<td>the percentage complete which must be between 0.0
298
<div class="refsect2">
299
<a name="gtk-progress-set-value"></a><h3>gtk_progress_set_value ()</h3>
300
<pre class="programlisting"><span class="returnvalue">void</span> gtk_progress_set_value (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
301
<em class="parameter"><code><span class="type">gdouble</span> value</code></em>);</pre>
302
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
303
<h3 class="title">Warning</h3>
304
<p><code class="literal">gtk_progress_set_value</code> is deprecated and should not be used in newly-written code.</p>
307
Sets the value within the <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> to an absolute value.
308
The value must be within the valid range of values for the
309
underlying <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>.
311
<div class="variablelist"><table border="0" class="variablelist">
313
<col align="left" valign="top">
318
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
319
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
322
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
323
<td>the value indicating the current completed amount.</td>
329
<div class="refsect2">
330
<a name="gtk-progress-get-value"></a><h3>gtk_progress_get_value ()</h3>
331
<pre class="programlisting"><span class="returnvalue">gdouble</span> gtk_progress_get_value (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>);</pre>
332
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
333
<h3 class="title">Warning</h3>
334
<p><code class="literal">gtk_progress_get_value</code> is deprecated and should not be used in newly-written code.</p>
337
Returns the current progress complete value.
339
<div class="variablelist"><table border="0" class="variablelist">
341
<col align="left" valign="top">
346
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
347
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
350
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
351
<td>the current progress complete value.</td>
357
<div class="refsect2">
358
<a name="gtk-progress-set-activity-mode"></a><h3>gtk_progress_set_activity_mode ()</h3>
359
<pre class="programlisting"><span class="returnvalue">void</span> gtk_progress_set_activity_mode (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
360
<em class="parameter"><code><span class="type">gboolean</span> activity_mode</code></em>);</pre>
361
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
362
<h3 class="title">Warning</h3>
363
<p><code class="literal">gtk_progress_set_activity_mode</code> is deprecated and should not be used in newly-written code.</p>
366
A <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> can be in one of two different modes: percentage
367
mode (the default) and activity mode. In activity mode, the
368
progress is simply indicated as activity rather than as a percentage
371
<div class="variablelist"><table border="0" class="variablelist">
373
<col align="left" valign="top">
378
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
379
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
382
<td><p><span class="term"><em class="parameter"><code>activity_mode</code></em> :</span></p></td>
383
<td>a boolean, <code class="literal">TRUE</code> for activity mode.</td>
389
<div class="refsect2">
390
<a name="gtk-progress-get-current-text"></a><h3>gtk_progress_get_current_text ()</h3>
391
<pre class="programlisting"><span class="returnvalue">gchar</span> * gtk_progress_get_current_text (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>);</pre>
392
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
393
<h3 class="title">Warning</h3>
394
<p><code class="literal">gtk_progress_get_current_text</code> is deprecated and should not be used in newly-written code.</p>
397
Returns the current text associated with the <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>. This
398
text is the based on the underlying format string after any substitutions
401
<div class="variablelist"><table border="0" class="variablelist">
403
<col align="left" valign="top">
408
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
409
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
412
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
413
<td>the text indicating the current progress.</td>
419
<div class="refsect2">
420
<a name="gtk-progress-get-text-from-value"></a><h3>gtk_progress_get_text_from_value ()</h3>
421
<pre class="programlisting"><span class="returnvalue">gchar</span> * gtk_progress_get_text_from_value (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
422
<em class="parameter"><code><span class="type">gdouble</span> value</code></em>);</pre>
423
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
424
<h3 class="title">Warning</h3>
425
<p><code class="literal">gtk_progress_get_text_from_value</code> is deprecated and should not be used in newly-written code.</p>
428
Returns the text indicating the progress based on the supplied value.
429
The current value for the <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> remains unchanged.
431
<div class="variablelist"><table border="0" class="variablelist">
433
<col align="left" valign="top">
438
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
439
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
442
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
443
<td>an absolute progress value to use when formatting the progress text.</td>
446
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
447
<td>a string indicating the progress.</td>
453
<div class="refsect2">
454
<a name="gtk-progress-get-current-percentage"></a><h3>gtk_progress_get_current_percentage ()</h3>
455
<pre class="programlisting"><span class="returnvalue">gdouble</span> gtk_progress_get_current_percentage (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>);</pre>
456
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
457
<h3 class="title">Warning</h3>
458
<p><code class="literal">gtk_progress_get_current_percentage</code> is deprecated and should not be used in newly-written code.</p>
461
Returns the current progress as a percentage.
463
<div class="variablelist"><table border="0" class="variablelist">
465
<col align="left" valign="top">
470
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
471
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
474
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
475
<td>a number between 0.0 and 1.0 indicating the percentage complete.</td>
481
<div class="refsect2">
482
<a name="gtk-progress-get-percentage-from-value"></a><h3>gtk_progress_get_percentage_from_value ()</h3>
483
<pre class="programlisting"><span class="returnvalue">gdouble</span> gtk_progress_get_percentage_from_value
484
(<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
485
<em class="parameter"><code><span class="type">gdouble</span> value</code></em>);</pre>
486
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
487
<h3 class="title">Warning</h3>
488
<p><code class="literal">gtk_progress_get_percentage_from_value</code> is deprecated and should not be used in newly-written code.</p>
491
Returns the progress as a percentage calculated from the supplied
492
absolute progress value.
494
<div class="variablelist"><table border="0" class="variablelist">
496
<col align="left" valign="top">
501
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
502
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
505
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
506
<td>an absolute progress value.</td>
509
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
510
<td>a number between 0.0 and 1.0 indicating the percentage complete
511
represented by <em class="parameter"><code>value</code></em>.</td>
517
<div class="refsect2">
518
<a name="gtk-progress-configure"></a><h3>gtk_progress_configure ()</h3>
519
<pre class="programlisting"><span class="returnvalue">void</span> gtk_progress_configure (<em class="parameter"><code><a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> *progress</code></em>,
520
<em class="parameter"><code><span class="type">gdouble</span> value</code></em>,
521
<em class="parameter"><code><span class="type">gdouble</span> min</code></em>,
522
<em class="parameter"><code><span class="type">gdouble</span> max</code></em>);</pre>
523
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
524
<h3 class="title">Warning</h3>
525
<p><code class="literal">gtk_progress_configure</code> is deprecated and should not be used in newly-written code.</p>
528
Allows the configuration of the minimum, maximum, and current values for
529
the <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
531
<div class="variablelist"><table border="0" class="variablelist">
533
<col align="left" valign="top">
538
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
539
<td>a <a class="link" href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.</td>
542
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
543
<td>the current progress value.</td>
546
<td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
547
<td>the minimum progress value.</td>
550
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
551
<td>the maximum progress value.</td>
557
<div class="refsect1">
558
<a name="GtkProgress.property-details"></a><h2>Property Details</h2>
559
<div class="refsect2">
560
<a name="GtkProgress--activity-mode"></a><h3>The <code class="literal">"activity-mode"</code> property</h3>
561
<pre class="programlisting"> "activity-mode" <span class="type">gboolean</span> : Read / Write</pre>
562
<p>If TRUE, the GtkProgress is in activity mode, meaning that it signals something is happening, but not how much of the activity is finished. This is used when you're doing something but don't know how long it will take.</p>
563
<p>Default value: FALSE</p>
566
<div class="refsect2">
567
<a name="GtkProgress--show-text"></a><h3>The <code class="literal">"show-text"</code> property</h3>
568
<pre class="programlisting"> "show-text" <span class="type">gboolean</span> : Read / Write</pre>
569
<p>Whether the progress is shown as text.</p>
570
<p>Default value: FALSE</p>
573
<div class="refsect2">
574
<a name="GtkProgress--text-xalign"></a><h3>The <code class="literal">"text-xalign"</code> property</h3>
575
<pre class="programlisting"> "text-xalign" <span class="type">gfloat</span> : Read / Write</pre>
576
<p>The horizontal text alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.</p>
577
<p>Allowed values: [0,1]</p>
578
<p>Default value: 0.5</p>
581
<div class="refsect2">
582
<a name="GtkProgress--text-yalign"></a><h3>The <code class="literal">"text-yalign"</code> property</h3>
583
<pre class="programlisting"> "text-yalign" <span class="type">gfloat</span> : Read / Write</pre>
584
<p>The vertical text alignment, from 0 (top) to 1 (bottom).</p>
585
<p>Allowed values: [0,1]</p>
586
<p>Default value: 0.5</p>
592
Generated by GTK-Doc V1.18</div>
b'\\ No newline at end of file'
added
removed
share/gtk-doc/html/gtk2/GtkProgress.html
