~canonical-dx-team/ubuntu/maverick/gtk+2.0/menuproxy

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2010-06-11 12:19:30 UTC
  • mfrom: (1.11.6 upstream)
  • mto: This revision was merged to the branch mainline in revision 175.
  • Revision ID: james.westby@ubuntu.com-20100611121930-n4pklvkoqdsg12vm
Tags: 2.21.2-1
* New upstream development release:
  + debian/rules,
    debian/libgtk2.0-0.symbols:
    - Update for new API symbols.
  + debian/patches/070_mandatory-relibtoolize.patch:
    - Regenerated for the new version.
  + debian/control.in:
    - Update GLib (build-) dependency to >= 2.25.8.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</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>);
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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</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>);
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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</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>);
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
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>);
64
64
enum                <a class="link" href="GtkProgressBar.html#GtkProgressBarOrientation" title="enum GtkProgressBarOrientation">GtkProgressBarOrientation</a>;
65
 
const <a href="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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 <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>);
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
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>);
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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> blocks</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>);
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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> step</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>);
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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> blocks</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>);
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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> percentage</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>);
86
86
</pre>
87
87
</div>
88
88
<div class="refsect1" title="Object Hierarchy">
89
89
<a name="GtkProgressBar.object-hierarchy"></a><h2>Object Hierarchy</h2>
90
90
<pre class="synopsis">
91
 
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
92
 
   +----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
91
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
92
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
93
93
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
94
94
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
95
95
                     +----<a class="link" href="GtkProgress.html" title="GtkProgress">GtkProgress</a>
105
105
<div class="refsect1" title="Properties">
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="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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>"          <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
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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</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
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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</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
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="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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>"               <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
118
118
</pre>
119
119
</div>
120
120
<div class="refsect1" title="Style Properties">
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="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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>" <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
129
129
</pre>
130
130
</div>
131
131
<div class="refsect1" title="Description">
223
223
<div class="refsect2" title="gtk_progress_bar_set_text ()">
224
224
<a name="gtk-progress-bar-set-text"></a><h3>gtk_progress_bar_set_text ()</h3>
225
225
<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>,
226
 
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
 
226
                                                         <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>
227
227
<p>
228
228
Causes the given <em class="parameter"><code>text</code></em> to appear superimposed on the progress bar.
229
229
</p>
237
237
</tr>
238
238
<tr>
239
239
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
240
 
<td> a UTF-8 string, or <a href="/usr/share/gtk-doc/html/glib/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>
 
240
<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>
241
241
</td>
242
242
</tr>
243
243
</tbody>
247
247
<div class="refsect2" title="gtk_progress_bar_set_fraction ()">
248
248
<a name="gtk-progress-bar-set-fraction"></a><h3>gtk_progress_bar_set_fraction ()</h3>
249
249
<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>,
250
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);</pre>
 
250
                                                         <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>
251
251
<p>
252
252
Causes the progress bar to "fill in" the given fraction
253
253
of the bar. The fraction should be between 0.0 and 1.0,
273
273
<div class="refsect2" title="gtk_progress_bar_set_pulse_step ()">
274
274
<a name="gtk-progress-bar-set-pulse-step"></a><h3>gtk_progress_bar_set_pulse_step ()</h3>
275
275
<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>,
276
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);</pre>
 
276
                                                         <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>
277
277
<p>
278
278
Sets the fraction of total progress bar length to move the
279
279
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>.
389
389
<hr>
390
390
<div class="refsect2" title="gtk_progress_bar_get_text ()">
391
391
<a name="gtk-progress-bar-get-text"></a><h3>gtk_progress_bar_get_text ()</h3>
392
 
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/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>
 
392
<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>
393
393
<p>
394
394
Retrieves the text displayed superimposed on the progress bar,
395
 
if any, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. The return value is a reference
 
395
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
396
396
to the text, not a copy of it, so will become invalid
397
397
if you change the text in the progress bar.
398
398
</p>
406
406
</tr>
407
407
<tr>
408
408
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
409
 
<td> text, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; this string is owned by the widget
 
409
<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
410
410
and should not be modified or freed.
411
411
</td>
412
412
</tr>
416
416
<hr>
417
417
<div class="refsect2" title="gtk_progress_bar_get_fraction ()">
418
418
<a name="gtk-progress-bar-get-fraction"></a><h3>gtk_progress_bar_get_fraction ()</h3>
419
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/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>
 
419
<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>
420
420
<p>
421
421
Returns the current fraction of the task that's been completed.
422
422
</p>
439
439
<hr>
440
440
<div class="refsect2" title="gtk_progress_bar_get_pulse_step ()">
441
441
<a name="gtk-progress-bar-get-pulse-step"></a><h3>gtk_progress_bar_get_pulse_step ()</h3>
442
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/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>
 
442
<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>
443
443
<p>
444
444
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>
445
445
</p>
599
599
<a name="gtk-progress-bar-set-discrete-blocks"></a><h3>gtk_progress_bar_set_discrete_blocks ()</h3>
600
600
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_set_discrete_blocks
601
601
                                                        (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
602
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> blocks</code></em>);</pre>
 
602
                                                         <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>
603
603
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
604
604
<h3 class="title">Warning</h3>
605
605
<p><code class="literal">gtk_progress_bar_set_discrete_blocks</code> is deprecated and should not be used in newly-written code.</p>
628
628
<div class="refsect2" title="gtk_progress_bar_set_activity_step ()">
629
629
<a name="gtk-progress-bar-set-activity-step"></a><h3>gtk_progress_bar_set_activity_step ()</h3>
630
630
<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>,
631
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> step</code></em>);</pre>
 
631
                                                         <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>
632
632
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
633
633
<h3 class="title">Warning</h3>
634
634
<p><code class="literal">gtk_progress_bar_set_activity_step</code> is deprecated and should not be used in newly-written code.</p>
660
660
<a name="gtk-progress-bar-set-activity-blocks"></a><h3>gtk_progress_bar_set_activity_blocks ()</h3>
661
661
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_set_activity_blocks
662
662
                                                        (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
663
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> blocks</code></em>);</pre>
 
663
                                                         <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>
664
664
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
665
665
<h3 class="title">Warning</h3>
666
666
<p><code class="literal">gtk_progress_bar_set_activity_blocks</code> is deprecated and should not be used in newly-written code.</p>
689
689
<div class="refsect2" title="gtk_progress_bar_update ()">
690
690
<a name="gtk-progress-bar-update"></a><h3>gtk_progress_bar_update ()</h3>
691
691
<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>,
692
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> percentage</code></em>);</pre>
 
692
                                                         <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>
693
693
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
694
694
<h3 class="title">Warning</h3>
695
695
<p><code class="literal">gtk_progress_bar_update</code> is deprecated and should not be used in newly-written code.</p>
719
719
<a name="GtkProgressBar.property-details"></a><h2>Property Details</h2>
720
720
<div class="refsect2" title='The "activity-blocks" property'>
721
721
<a name="GtkProgressBar--activity-blocks"></a><h3>The <code class="literal">"activity-blocks"</code> property</h3>
722
 
<pre class="programlisting">  "activity-blocks"          <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 
722
<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>
723
723
<p>The number of blocks which can fit in the progress bar area in activity mode (Deprecated).</p>
724
724
<p>Allowed values: &gt;= 2</p>
725
725
<p>Default value: 5</p>
727
727
<hr>
728
728
<div class="refsect2" title='The "activity-step" property'>
729
729
<a name="GtkProgressBar--activity-step"></a><h3>The <code class="literal">"activity-step"</code> property</h3>
730
 
<pre class="programlisting">  "activity-step"            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 
730
<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>
731
731
<p>The increment used for each iteration in activity mode (Deprecated).</p>
732
732
<p>Default value: 3</p>
733
733
</div>
747
747
<hr>
748
748
<div class="refsect2" title='The "discrete-blocks" property'>
749
749
<a name="GtkProgressBar--discrete-blocks"></a><h3>The <code class="literal">"discrete-blocks"</code> property</h3>
750
 
<pre class="programlisting">  "discrete-blocks"          <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 
750
<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>
751
751
<p>The number of discrete blocks in a progress bar (when shown in the discrete style).</p>
752
752
<p>Allowed values: &gt;= 2</p>
753
753
<p>Default value: 10</p>
773
773
<hr>
774
774
<div class="refsect2" title='The "fraction" property'>
775
775
<a name="GtkProgressBar--fraction"></a><h3>The <code class="literal">"fraction"</code> property</h3>
776
 
<pre class="programlisting">  "fraction"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 
776
<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>
777
777
<p>The fraction of total work that has been completed.</p>
778
778
<p>Allowed values: [0,1]</p>
779
779
<p>Default value: 0</p>
788
788
<hr>
789
789
<div class="refsect2" title='The "pulse-step" property'>
790
790
<a name="GtkProgressBar--pulse-step"></a><h3>The <code class="literal">"pulse-step"</code> property</h3>
791
 
<pre class="programlisting">  "pulse-step"               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 
791
<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>
792
792
<p>The fraction of total progress to move the bouncing block when pulsed.</p>
793
793
<p>Allowed values: [0,1]</p>
794
794
<p>Default value: 0.1</p>
796
796
<hr>
797
797
<div class="refsect2" title='The "text" property'>
798
798
<a name="GtkProgressBar--text"></a><h3>The <code class="literal">"text"</code> property</h3>
799
 
<pre class="programlisting">  "text"                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
799
<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>
800
800
<p>Text to be displayed in the progress bar.</p>
801
801
<p>Default value: NULL</p>
802
802
</div>
805
805
<a name="GtkProgressBar.style-property-details"></a><h2>Style Property Details</h2>
806
806
<div class="refsect2" title='The "min-horizontal-bar-height" style property'>
807
807
<a name="GtkProgressBar--s-min-horizontal-bar-height"></a><h3>The <code class="literal">"min-horizontal-bar-height"</code> style property</h3>
808
 
<pre class="programlisting">  "min-horizontal-bar-height" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
808
<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>
809
809
<p>
810
810
Minimum horizontal height of the progress bar.
811
811
</p>
816
816
<hr>
817
817
<div class="refsect2" title='The "min-horizontal-bar-width" style property'>
818
818
<a name="GtkProgressBar--s-min-horizontal-bar-width"></a><h3>The <code class="literal">"min-horizontal-bar-width"</code> style property</h3>
819
 
<pre class="programlisting">  "min-horizontal-bar-width" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
819
<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>
820
820
<p>
821
821
The minimum horizontal width of the progress bar.
822
822
</p>
827
827
<hr>
828
828
<div class="refsect2" title='The "min-vertical-bar-height" style property'>
829
829
<a name="GtkProgressBar--s-min-vertical-bar-height"></a><h3>The <code class="literal">"min-vertical-bar-height"</code> style property</h3>
830
 
<pre class="programlisting">  "min-vertical-bar-height"  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
830
<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>
831
831
<p>
832
832
The minimum vertical height of the progress bar.
833
833
</p>
838
838
<hr>
839
839
<div class="refsect2" title='The "min-vertical-bar-width" style property'>
840
840
<a name="GtkProgressBar--s-min-vertical-bar-width"></a><h3>The <code class="literal">"min-vertical-bar-width"</code> style property</h3>
841
 
<pre class="programlisting">  "min-vertical-bar-width"   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
841
<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>
842
842
<p>
843
843
The minimum vertical width of the progress bar.
844
844
</p>
849
849
<hr>
850
850
<div class="refsect2" title='The "xspacing" style property'>
851
851
<a name="GtkProgressBar--s-xspacing"></a><h3>The <code class="literal">"xspacing"</code> style property</h3>
852
 
<pre class="programlisting">  "xspacing"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
852
<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>
853
853
<p>Extra spacing applied to the width of a progress bar.</p>
854
854
<p>Allowed values: &gt;= 0</p>
855
855
<p>Default value: 7</p>
857
857
<hr>
858
858
<div class="refsect2" title='The "yspacing" style property'>
859
859
<a name="GtkProgressBar--s-yspacing"></a><h3>The <code class="literal">"yspacing"</code> style property</h3>
860
 
<pre class="programlisting">  "yspacing"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
860
<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>
861
861
<p>Extra spacing applied to the height of a progress bar.</p>
862
862
<p>Allowed values: &gt;= 0</p>
863
863
<p>Default value: 7</p>