~ubuntu-branches/ubuntu/raring/gtk+2.0/raring-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkProgressBar.html

  • Committer: Package Import Robot
  • Author(s): Robert Ancell
  • Date: 2012-09-05 17:27:55 UTC
  • mfrom: (1.14.14)
  • Revision ID: package-import@ubuntu.com-20120905172755-14uyfpowr7elvr7m
Tags: 2.24.12-0ubuntu1
* New upstream bugfix release
* debian/patches/091_bugzilla_tooltip_refresh.patch:
  - Applied upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="DisplayWidgets.html" title="Display Widgets">
9
9
<link rel="prev" href="GtkLabel.html" title="GtkLabel">
10
10
<link rel="next" href="GtkStatusbar.html" title="GtkStatusbar">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
52
52
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkProgressBar.html#gtk-progress-bar-new" title="gtk_progress_bar_new ()">gtk_progress_bar_new</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
53
53
<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-pulse" title="gtk_progress_bar_pulse ()">gtk_progress_bar_pulse</a>              (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);
54
54
<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-text" title="gtk_progress_bar_set_text ()">gtk_progress_bar_set_text</a>           (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
55
 
                                                         <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> *text</code></em>);
 
55
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
56
56
<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-fraction" title="gtk_progress_bar_set_fraction ()">gtk_progress_bar_set_fraction</a>       (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
57
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);
 
57
                                                         <em class="parameter"><code><span class="type">gdouble</span> fraction</code></em>);
58
58
<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-pulse-step" title="gtk_progress_bar_set_pulse_step ()">gtk_progress_bar_set_pulse_step</a>     (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
59
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);
 
59
                                                         <em class="parameter"><code><span class="type">gdouble</span> fraction</code></em>);
60
60
<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-orientation" title="gtk_progress_bar_set_orientation ()">gtk_progress_bar_set_orientation</a>    (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
61
61
                                                         <em class="parameter"><code><a class="link" href="GtkProgressBar.html#GtkProgressBarOrientation" title="enum GtkProgressBarOrientation"><span class="type">GtkProgressBarOrientation</span></a> orientation</code></em>);
62
62
<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-ellipsize" title="gtk_progress_bar_set_ellipsize ()">gtk_progress_bar_set_ellipsize</a>      (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
63
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a> mode</code></em>);
 
63
                                                         <em class="parameter"><code><a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a> mode</code></em>);
64
64
enum                <a class="link" href="GtkProgressBar.html#GtkProgressBarOrientation" title="enum GtkProgressBarOrientation">GtkProgressBarOrientation</a>;
65
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-text" title="gtk_progress_bar_get_text ()">gtk_progress_bar_get_text</a>           (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);
66
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-fraction" title="gtk_progress_bar_get_fraction ()">gtk_progress_bar_get_fraction</a>       (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);
67
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-pulse-step" title="gtk_progress_bar_get_pulse_step ()">gtk_progress_bar_get_pulse_step</a>     (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);
 
65
const <span class="returnvalue">gchar</span> *       <a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-text" title="gtk_progress_bar_get_text ()">gtk_progress_bar_get_text</a>           (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);
 
66
<span class="returnvalue">gdouble</span>             <a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-fraction" title="gtk_progress_bar_get_fraction ()">gtk_progress_bar_get_fraction</a>       (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);
 
67
<span class="returnvalue">gdouble</span>             <a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-pulse-step" title="gtk_progress_bar_get_pulse_step ()">gtk_progress_bar_get_pulse_step</a>     (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);
68
68
<a class="link" href="GtkProgressBar.html#GtkProgressBarOrientation" title="enum GtkProgressBarOrientation"><span class="returnvalue">GtkProgressBarOrientation</span></a> <a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-orientation" title="gtk_progress_bar_get_orientation ()">gtk_progress_bar_get_orientation</a>
69
69
                                                        (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);
70
 
<a href="/usr/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="returnvalue">PangoEllipsizeMode</span></a>  <a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-ellipsize" title="gtk_progress_bar_get_ellipsize ()">gtk_progress_bar_get_ellipsize</a>      (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);
 
70
<a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="returnvalue">PangoEllipsizeMode</span></a>  <a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-ellipsize" title="gtk_progress_bar_get_ellipsize ()">gtk_progress_bar_get_ellipsize</a>      (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);
71
71
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkProgressBar.html#gtk-progress-bar-new-with-adjustment" title="gtk_progress_bar_new_with_adjustment ()">gtk_progress_bar_new_with_adjustment</a>
72
72
                                                        (<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *adjustment</code></em>);
73
73
<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-bar-style" title="gtk_progress_bar_set_bar_style ()">gtk_progress_bar_set_bar_style</a>      (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
75
75
enum                <a class="link" href="GtkProgressBar.html#GtkProgressBarStyle" title="enum GtkProgressBarStyle">GtkProgressBarStyle</a>;
76
76
<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-discrete-blocks" title="gtk_progress_bar_set_discrete_blocks ()">gtk_progress_bar_set_discrete_blocks</a>
77
77
                                                        (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
78
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> blocks</code></em>);
 
78
                                                         <em class="parameter"><code><span class="type">guint</span> blocks</code></em>);
79
79
<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-activity-step" title="gtk_progress_bar_set_activity_step ()">gtk_progress_bar_set_activity_step</a>  (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
80
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> step</code></em>);
 
80
                                                         <em class="parameter"><code><span class="type">guint</span> step</code></em>);
81
81
<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-activity-blocks" title="gtk_progress_bar_set_activity_blocks ()">gtk_progress_bar_set_activity_blocks</a>
82
82
                                                        (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
83
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> blocks</code></em>);
 
83
                                                         <em class="parameter"><code><span class="type">guint</span> blocks</code></em>);
84
84
<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-update" title="gtk_progress_bar_update ()">gtk_progress_bar_update</a>             (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
85
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> percentage</code></em>);
 
85
                                                         <em class="parameter"><code><span class="type">gdouble</span> percentage</code></em>);
86
86
</pre>
87
87
</div>
88
88
<div class="refsect1">
105
105
<div class="refsect1">
106
106
<a name="GtkProgressBar.properties"></a><h2>Properties</h2>
107
107
<pre class="synopsis">
108
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--activity-blocks" title='The "activity-blocks" property'>activity-blocks</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
109
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--activity-step" title='The "activity-step" property'>activity-step</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
 
108
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--activity-blocks" title='The "activity-blocks" property'>activity-blocks</a>"          <span class="type">guint</span>                 : Read / Write
 
109
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--activity-step" title='The "activity-step" property'>activity-step</a>"            <span class="type">guint</span>                 : Read / Write
110
110
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--adjustment" title='The "adjustment" property'>adjustment</a>"               <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>*        : Read / Write
111
111
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--bar-style" title='The "bar-style" property'>bar-style</a>"                <a class="link" href="GtkProgressBar.html#GtkProgressBarStyle" title="enum GtkProgressBarStyle"><span class="type">GtkProgressBarStyle</span></a>   : Read / Write
112
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--discrete-blocks" title='The "discrete-blocks" property'>discrete-blocks</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
113
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--ellipsize" title='The "ellipsize" property'>ellipsize</a>"                <a href="/usr/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a>    : Read / Write
114
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--fraction" title='The "fraction" property'>fraction</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
 
112
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--discrete-blocks" title='The "discrete-blocks" property'>discrete-blocks</a>"          <span class="type">guint</span>                 : Read / Write
 
113
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--ellipsize" title='The "ellipsize" property'>ellipsize</a>"                <a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a>    : Read / Write
 
114
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--fraction" title='The "fraction" property'>fraction</a>"                 <span class="type">gdouble</span>               : Read / Write
115
115
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--orientation" title='The "orientation" property'>orientation</a>"              <a class="link" href="GtkProgressBar.html#GtkProgressBarOrientation" title="enum GtkProgressBarOrientation"><span class="type">GtkProgressBarOrientation</span></a>  : Read / Write
116
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--pulse-step" title='The "pulse-step" property'>pulse-step</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
117
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--text" title='The "text" property'>text</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
116
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--pulse-step" title='The "pulse-step" property'>pulse-step</a>"               <span class="type">gdouble</span>               : Read / Write
 
117
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--text" title='The "text" property'>text</a>"                     <span class="type">gchar</span>*                : Read / Write
118
118
</pre>
119
119
</div>
120
120
<div class="refsect1">
121
121
<a name="GtkProgressBar.style-properties"></a><h2>Style Properties</h2>
122
122
<pre class="synopsis">
123
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-min-horizontal-bar-height" title='The "min-horizontal-bar-height" style property'>min-horizontal-bar-height</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
124
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-min-horizontal-bar-width" title='The "min-horizontal-bar-width" style property'>min-horizontal-bar-width</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
125
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-min-vertical-bar-height" title='The "min-vertical-bar-height" style property'>min-vertical-bar-height</a>"  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
126
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-min-vertical-bar-width" title='The "min-vertical-bar-width" style property'>min-vertical-bar-width</a>"   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
127
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-xspacing" title='The "xspacing" style property'>xspacing</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
128
 
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-yspacing" title='The "yspacing" style property'>yspacing</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
 
123
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-min-horizontal-bar-height" title='The "min-horizontal-bar-height" style property'>min-horizontal-bar-height</a>" <span class="type">gint</span>                  : Read / Write
 
124
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-min-horizontal-bar-width" title='The "min-horizontal-bar-width" style property'>min-horizontal-bar-width</a>" <span class="type">gint</span>                  : Read / Write
 
125
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-min-vertical-bar-height" title='The "min-vertical-bar-height" style property'>min-vertical-bar-height</a>"  <span class="type">gint</span>                  : Read / Write
 
126
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-min-vertical-bar-width" title='The "min-vertical-bar-width" style property'>min-vertical-bar-width</a>"   <span class="type">gint</span>                  : Read / Write
 
127
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-xspacing" title='The "xspacing" style property'>xspacing</a>"                 <span class="type">gint</span>                  : Read / Write
 
128
  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-yspacing" title='The "yspacing" style property'>yspacing</a>"                 <span class="type">gint</span>                  : Read / Write
129
129
</pre>
130
130
</div>
131
131
<div class="refsect1">
231
231
<div class="refsect2">
232
232
<a name="gtk-progress-bar-set-text"></a><h3>gtk_progress_bar_set_text ()</h3>
233
233
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_set_text           (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
234
 
                                                         <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> *text</code></em>);</pre>
 
234
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
235
235
<p>
236
236
Causes the given <em class="parameter"><code>text</code></em> to appear superimposed on the progress bar.
237
237
</p>
248
248
</tr>
249
249
<tr>
250
250
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
251
 
<td>a UTF-8 string, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
251
<td>a UTF-8 string, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
252
252
</td>
253
253
</tr>
254
254
</tbody>
258
258
<div class="refsect2">
259
259
<a name="gtk-progress-bar-set-fraction"></a><h3>gtk_progress_bar_set_fraction ()</h3>
260
260
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_set_fraction       (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
261
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);</pre>
 
261
                                                         <em class="parameter"><code><span class="type">gdouble</span> fraction</code></em>);</pre>
262
262
<p>
263
263
Causes the progress bar to "fill in" the given fraction
264
264
of the bar. The fraction should be between 0.0 and 1.0,
286
286
<div class="refsect2">
287
287
<a name="gtk-progress-bar-set-pulse-step"></a><h3>gtk_progress_bar_set_pulse_step ()</h3>
288
288
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_set_pulse_step     (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
289
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);</pre>
 
289
                                                         <em class="parameter"><code><span class="type">gdouble</span> fraction</code></em>);</pre>
290
290
<p>
291
291
Sets the fraction of total progress bar length to move the
292
292
bouncing block for each call to <a class="link" href="GtkProgressBar.html#gtk-progress-bar-pulse" title="gtk_progress_bar_pulse ()"><code class="function">gtk_progress_bar_pulse()</code></a>.
340
340
<div class="refsect2">
341
341
<a name="gtk-progress-bar-set-ellipsize"></a><h3>gtk_progress_bar_set_ellipsize ()</h3>
342
342
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_set_ellipsize      (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
343
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a> mode</code></em>);</pre>
 
343
                                                         <em class="parameter"><code><a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a> mode</code></em>);</pre>
344
344
<p>
345
345
Sets the mode used to ellipsize (add an ellipsis: "...") the text 
346
346
if there is not enough space to render the entire string.
358
358
</tr>
359
359
<tr>
360
360
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
361
 
<td>a <a href="/usr/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a>
 
361
<td>a <a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a>
362
362
</td>
363
363
</tr>
364
364
</tbody>
411
411
<hr>
412
412
<div class="refsect2">
413
413
<a name="gtk-progress-bar-get-text"></a><h3>gtk_progress_bar_get_text ()</h3>
414
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gtk_progress_bar_get_text           (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
 
414
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       gtk_progress_bar_get_text           (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
415
415
<p>
416
416
Retrieves the text displayed superimposed on the progress bar,
417
 
if any, otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. The return value is a reference
 
417
if any, otherwise <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. The return value is a reference
418
418
to the text, not a copy of it, so will become invalid
419
419
if you change the text in the progress bar.
420
420
</p>
431
431
</tr>
432
432
<tr>
433
433
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
434
 
<td>text, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; this string is owned by the widget
 
434
<td>text, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>; this string is owned by the widget
435
435
and should not be modified or freed.</td>
436
436
</tr>
437
437
</tbody>
440
440
<hr>
441
441
<div class="refsect2">
442
442
<a name="gtk-progress-bar-get-fraction"></a><h3>gtk_progress_bar_get_fraction ()</h3>
443
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             gtk_progress_bar_get_fraction       (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
 
443
<pre class="programlisting"><span class="returnvalue">gdouble</span>             gtk_progress_bar_get_fraction       (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
444
444
<p>
445
445
Returns the current fraction of the task that's been completed.
446
446
</p>
465
465
<hr>
466
466
<div class="refsect2">
467
467
<a name="gtk-progress-bar-get-pulse-step"></a><h3>gtk_progress_bar_get_pulse_step ()</h3>
468
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             gtk_progress_bar_get_pulse_step     (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
 
468
<pre class="programlisting"><span class="returnvalue">gdouble</span>             gtk_progress_bar_get_pulse_step     (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
469
469
<p>
470
470
Retrieves the pulse step set with <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-pulse-step" title="gtk_progress_bar_set_pulse_step ()"><code class="function">gtk_progress_bar_set_pulse_step()</code></a>
471
471
</p>
516
516
<hr>
517
517
<div class="refsect2">
518
518
<a name="gtk-progress-bar-get-ellipsize"></a><h3>gtk_progress_bar_get_ellipsize ()</h3>
519
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="returnvalue">PangoEllipsizeMode</span></a>  gtk_progress_bar_get_ellipsize      (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
 
519
<pre class="programlisting"><a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="returnvalue">PangoEllipsizeMode</span></a>  gtk_progress_bar_get_ellipsize      (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
520
520
<p>
521
521
Returns the ellipsizing position of the progressbar. 
522
522
See <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-ellipsize" title="gtk_progress_bar_set_ellipsize ()"><code class="function">gtk_progress_bar_set_ellipsize()</code></a>.
534
534
</tr>
535
535
<tr>
536
536
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
537
 
<td><a href="/usr/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a></td>
 
537
<td><a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a></td>
538
538
</tr>
539
539
</tbody>
540
540
</table></div>
636
636
<a name="gtk-progress-bar-set-discrete-blocks"></a><h3>gtk_progress_bar_set_discrete_blocks ()</h3>
637
637
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_set_discrete_blocks
638
638
                                                        (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
639
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> blocks</code></em>);</pre>
 
639
                                                         <em class="parameter"><code><span class="type">guint</span> blocks</code></em>);</pre>
640
640
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
641
641
<h3 class="title">Warning</h3>
642
642
<p><code class="literal">gtk_progress_bar_set_discrete_blocks</code> is deprecated and should not be used in newly-written code.</p>
666
666
<div class="refsect2">
667
667
<a name="gtk-progress-bar-set-activity-step"></a><h3>gtk_progress_bar_set_activity_step ()</h3>
668
668
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_set_activity_step  (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
669
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> step</code></em>);</pre>
 
669
                                                         <em class="parameter"><code><span class="type">guint</span> step</code></em>);</pre>
670
670
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
671
671
<h3 class="title">Warning</h3>
672
672
<p><code class="literal">gtk_progress_bar_set_activity_step</code> is deprecated and should not be used in newly-written code.</p>
699
699
<a name="gtk-progress-bar-set-activity-blocks"></a><h3>gtk_progress_bar_set_activity_blocks ()</h3>
700
700
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_set_activity_blocks
701
701
                                                        (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
702
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> blocks</code></em>);</pre>
 
702
                                                         <em class="parameter"><code><span class="type">guint</span> blocks</code></em>);</pre>
703
703
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
704
704
<h3 class="title">Warning</h3>
705
705
<p><code class="literal">gtk_progress_bar_set_activity_blocks</code> is deprecated and should not be used in newly-written code.</p>
729
729
<div class="refsect2">
730
730
<a name="gtk-progress-bar-update"></a><h3>gtk_progress_bar_update ()</h3>
731
731
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_update             (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
732
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> percentage</code></em>);</pre>
 
732
                                                         <em class="parameter"><code><span class="type">gdouble</span> percentage</code></em>);</pre>
733
733
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
734
734
<h3 class="title">Warning</h3>
735
735
<p><code class="literal">gtk_progress_bar_update</code> is deprecated and should not be used in newly-written code.</p>
760
760
<a name="GtkProgressBar.property-details"></a><h2>Property Details</h2>
761
761
<div class="refsect2">
762
762
<a name="GtkProgressBar--activity-blocks"></a><h3>The <code class="literal">"activity-blocks"</code> property</h3>
763
 
<pre class="programlisting">  "activity-blocks"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 
763
<pre class="programlisting">  "activity-blocks"          <span class="type">guint</span>                 : Read / Write</pre>
764
764
<p>The number of blocks which can fit in the progress bar area in activity mode (Deprecated).</p>
765
765
<p>Allowed values: &gt;= 2</p>
766
766
<p>Default value: 5</p>
768
768
<hr>
769
769
<div class="refsect2">
770
770
<a name="GtkProgressBar--activity-step"></a><h3>The <code class="literal">"activity-step"</code> property</h3>
771
 
<pre class="programlisting">  "activity-step"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 
771
<pre class="programlisting">  "activity-step"            <span class="type">guint</span>                 : Read / Write</pre>
772
772
<p>The increment used for each iteration in activity mode (Deprecated).</p>
773
773
<p>Default value: 3</p>
774
774
</div>
788
788
<hr>
789
789
<div class="refsect2">
790
790
<a name="GtkProgressBar--discrete-blocks"></a><h3>The <code class="literal">"discrete-blocks"</code> property</h3>
791
 
<pre class="programlisting">  "discrete-blocks"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 
791
<pre class="programlisting">  "discrete-blocks"          <span class="type">guint</span>                 : Read / Write</pre>
792
792
<p>The number of discrete blocks in a progress bar (when shown in the discrete style).</p>
793
793
<p>Allowed values: &gt;= 2</p>
794
794
<p>Default value: 10</p>
796
796
<hr>
797
797
<div class="refsect2">
798
798
<a name="GtkProgressBar--ellipsize"></a><h3>The <code class="literal">"ellipsize"</code> property</h3>
799
 
<pre class="programlisting">  "ellipsize"                <a href="/usr/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a>    : Read / Write</pre>
 
799
<pre class="programlisting">  "ellipsize"                <a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a>    : Read / Write</pre>
800
800
<p>
801
801
The preferred place to ellipsize the string, if the progressbar does
802
802
not have enough room to display the entire string, specified as a 
804
804
</p>
805
805
<p>
806
806
Note that setting this property to a value other than 
807
 
<a href="/usr/share/gtk-doc/html/pango/pango-Layout-Objects.html#PANGO-ELLIPSIZE-NONE:CAPS"><code class="literal">PANGO_ELLIPSIZE_NONE</code></a> has the side-effect that the progressbar requests 
 
807
<a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PANGO-ELLIPSIZE-NONE:CAPS"><code class="literal">PANGO_ELLIPSIZE_NONE</code></a> has the side-effect that the progressbar requests 
808
808
only enough space to display the ellipsis "...". Another means to set a 
809
809
progressbar's width is <a class="link" href="GtkWidget.html#gtk-widget-set-size-request" title="gtk_widget_set_size_request ()"><code class="function">gtk_widget_set_size_request()</code></a>.
810
810
</p>
814
814
<hr>
815
815
<div class="refsect2">
816
816
<a name="GtkProgressBar--fraction"></a><h3>The <code class="literal">"fraction"</code> property</h3>
817
 
<pre class="programlisting">  "fraction"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 
817
<pre class="programlisting">  "fraction"                 <span class="type">gdouble</span>               : Read / Write</pre>
818
818
<p>The fraction of total work that has been completed.</p>
819
819
<p>Allowed values: [0,1]</p>
820
820
<p>Default value: 0</p>
829
829
<hr>
830
830
<div class="refsect2">
831
831
<a name="GtkProgressBar--pulse-step"></a><h3>The <code class="literal">"pulse-step"</code> property</h3>
832
 
<pre class="programlisting">  "pulse-step"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 
832
<pre class="programlisting">  "pulse-step"               <span class="type">gdouble</span>               : Read / Write</pre>
833
833
<p>The fraction of total progress to move the bouncing block when pulsed.</p>
834
834
<p>Allowed values: [0,1]</p>
835
835
<p>Default value: 0.1</p>
837
837
<hr>
838
838
<div class="refsect2">
839
839
<a name="GtkProgressBar--text"></a><h3>The <code class="literal">"text"</code> property</h3>
840
 
<pre class="programlisting">  "text"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
840
<pre class="programlisting">  "text"                     <span class="type">gchar</span>*                : Read / Write</pre>
841
841
<p>Text to be displayed in the progress bar.</p>
842
842
<p>Default value: NULL</p>
843
843
</div>
846
846
<a name="GtkProgressBar.style-property-details"></a><h2>Style Property Details</h2>
847
847
<div class="refsect2">
848
848
<a name="GtkProgressBar--s-min-horizontal-bar-height"></a><h3>The <code class="literal">"min-horizontal-bar-height"</code> style property</h3>
849
 
<pre class="programlisting">  "min-horizontal-bar-height" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
849
<pre class="programlisting">  "min-horizontal-bar-height" <span class="type">gint</span>                  : Read / Write</pre>
850
850
<p>
851
851
Minimum horizontal height of the progress bar.
852
852
</p>
857
857
<hr>
858
858
<div class="refsect2">
859
859
<a name="GtkProgressBar--s-min-horizontal-bar-width"></a><h3>The <code class="literal">"min-horizontal-bar-width"</code> style property</h3>
860
 
<pre class="programlisting">  "min-horizontal-bar-width" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
860
<pre class="programlisting">  "min-horizontal-bar-width" <span class="type">gint</span>                  : Read / Write</pre>
861
861
<p>
862
862
The minimum horizontal width of the progress bar.
863
863
</p>
868
868
<hr>
869
869
<div class="refsect2">
870
870
<a name="GtkProgressBar--s-min-vertical-bar-height"></a><h3>The <code class="literal">"min-vertical-bar-height"</code> style property</h3>
871
 
<pre class="programlisting">  "min-vertical-bar-height"  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
871
<pre class="programlisting">  "min-vertical-bar-height"  <span class="type">gint</span>                  : Read / Write</pre>
872
872
<p>
873
873
The minimum vertical height of the progress bar.
874
874
</p>
879
879
<hr>
880
880
<div class="refsect2">
881
881
<a name="GtkProgressBar--s-min-vertical-bar-width"></a><h3>The <code class="literal">"min-vertical-bar-width"</code> style property</h3>
882
 
<pre class="programlisting">  "min-vertical-bar-width"   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
882
<pre class="programlisting">  "min-vertical-bar-width"   <span class="type">gint</span>                  : Read / Write</pre>
883
883
<p>
884
884
The minimum vertical width of the progress bar.
885
885
</p>
890
890
<hr>
891
891
<div class="refsect2">
892
892
<a name="GtkProgressBar--s-xspacing"></a><h3>The <code class="literal">"xspacing"</code> style property</h3>
893
 
<pre class="programlisting">  "xspacing"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
893
<pre class="programlisting">  "xspacing"                 <span class="type">gint</span>                  : Read / Write</pre>
894
894
<p>Extra spacing applied to the width of a progress bar.</p>
895
895
<p>Allowed values: &gt;= 0</p>
896
896
<p>Default value: 7</p>
898
898
<hr>
899
899
<div class="refsect2">
900
900
<a name="GtkProgressBar--s-yspacing"></a><h3>The <code class="literal">"yspacing"</code> style property</h3>
901
 
<pre class="programlisting">  "yspacing"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
901
<pre class="programlisting">  "yspacing"                 <span class="type">gint</span>                  : Read / Write</pre>
902
902
<p>Extra spacing applied to the height of a progress bar.</p>
903
903
<p>Allowed values: &gt;= 0</p>
904
904
<p>Default value: 7</p>
907
907
</div>
908
908
<div class="footer">
909
909
<hr>
910
 
          Generated by GTK-Doc V1.18</div>
 
910
          Generated by GTK-Doc V1.18.1</div>
911
911
</body>
912
912
</html>
 
 
b'\\ No newline at end of file'