RubyGems - gdk3 - Versions diffs - 1.2.0-x86-mingw32 - Mend

gdk3 1.2.0-x86-mingw32

Files changed (1337) hide show

data/vendor/local/share/gtk-doc/html/gtk3/GtkProgressBar.html ADDED Viewed

@@ -0,0 +1,668 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>GtkProgressBar</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.0">
+<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
+<link rel="up" href="DisplayWidgets.html" title="Display Widgets">
+<link rel="prev" href="GtkLabel.html" title="GtkLabel">
+<link rel="next" href="GtkStatusbar.html" title="GtkStatusbar">
+<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
+<tr valign="middle">
+<td><a accesskey="p" href="GtkLabel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="DisplayWidgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">GTK+ 3 Reference Manual</th>
+<td><a accesskey="n" href="GtkStatusbar.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#GtkProgressBar.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#GtkProgressBar.description" class="shortcut">Description</a>
+                   |
+                  <a href="#GtkProgressBar.object-hierarchy" class="shortcut">Object Hierarchy</a>
+                   |
+                  <a href="#GtkProgressBar.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
+                   |
+                  <a href="#GtkProgressBar.properties" class="shortcut">Properties</a>
+                   |
+                  <a href="#GtkProgressBar.style-properties" class="shortcut">Style Properties</a>
+</td></tr>
+</table>
+<div class="refentry">
+<a name="GtkProgressBar"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="GtkProgressBar.top_of_page"></a>GtkProgressBar</span></h2>
+<p>GtkProgressBar — A widget which indicates progress visually</p>
+</td>
+<td valign="top" align="right"><img src="progressbar.png"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="GtkProgressBar.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">
+#include &lt;gtk/gtk.h&gt;
+struct              <a class="link" href="GtkProgressBar.html#GtkProgressBar-struct" title="struct GtkProgressBar">GtkProgressBar</a>;
+<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>);
+<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>);
+<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>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> fraction</code></em>);
+<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>);
+<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-inverted" title="gtk_progress_bar_set_inverted ()">gtk_progress_bar_set_inverted</a>       (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
+                                                         <em class="parameter"><code><span class="type">gboolean</span> inverted</code></em>);
+<span class="returnvalue">gboolean</span>            <a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-inverted" title="gtk_progress_bar_get_inverted ()">gtk_progress_bar_get_inverted</a>       (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-show-text" title="gtk_progress_bar_set_show_text ()">gtk_progress_bar_set_show_text</a>      (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
+                                                         <em class="parameter"><code><span class="type">gboolean</span> show_text</code></em>);
+<span class="returnvalue">gboolean</span>            <a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-show-text" title="gtk_progress_bar_get_show_text ()">gtk_progress_bar_get_show_text</a>      (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);
+<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>,
+                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
+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>);
+<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>,
+                                                         <em class="parameter"><code><span class="type">PangoEllipsizeMode</span> mode</code></em>);
+<span class="returnvalue">PangoEllipsizeMode</span>  <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>);
+<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>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> fraction</code></em>);
+<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>);
+</pre>
+</div>
+<div class="refsect1">
+<a name="GtkProgressBar.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="synopsis">
+  GObject
+   +----GInitiallyUnowned
+         +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+               +----GtkProgressBar
+</pre>
+</div>
+<div class="refsect1">
+<a name="GtkProgressBar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
+<p>
+GtkProgressBar implements
+ AtkImplementorIface,  <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a> and  <a class="link" href="gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
+</div>
+<div class="refsect1">
+<a name="GtkProgressBar.properties"></a><h2>Properties</h2>
+<pre class="synopsis">
+  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--ellipsize" title='The "ellipsize" property'>ellipsize</a>"                <span class="type">PangoEllipsizeMode</span>    : Read / Write
+  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--fraction" title='The "fraction" property'>fraction</a>"                 <span class="type">gdouble</span>               : Read / Write
+  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--inverted" title='The "inverted" property'>inverted</a>"                 <span class="type">gboolean</span>              : Read / Write
+  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--pulse-step" title='The "pulse-step" property'>pulse-step</a>"               <span class="type">gdouble</span>               : Read / Write
+  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title='The "show-text" property'>show-text</a>"                <span class="type">gboolean</span>              : Read / Write
+  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--text" title='The "text" property'>text</a>"                     <span class="type">gchar</span>*                : Read / Write
+</pre>
+</div>
+<div class="refsect1">
+<a name="GtkProgressBar.style-properties"></a><h2>Style Properties</h2>
+<pre class="synopsis">
+  "<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
+  "<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
+  "<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
+  "<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
+  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-xspacing" title='The "xspacing" style property'>xspacing</a>"                 <span class="type">gint</span>                  : Read / Write
+  "<a class="link" href="GtkProgressBar.html#GtkProgressBar--s-yspacing" title='The "yspacing" style property'>yspacing</a>"                 <span class="type">gint</span>                  : Read / Write
+</pre>
+</div>
+<div class="refsect1">
+<a name="GtkProgressBar.description"></a><h2>Description</h2>
+<p>
+The <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> is typically used to display the progress of a long
+running operation.  It provides a visual clue that processing
+is underway.  The <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> can be used in two different
+modes: percentage mode and activity mode.
+</p>
+<p>
+When an application can determine how much work needs to take place
+(e.g. read a fixed number of bytes from a file) and can monitor its
+progress, it can use the <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> in percentage mode and the user
+sees a growing bar indicating the percentage of the work that has
+been completed.  In this mode, the application is required to call
+<a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-fraction" title="gtk_progress_bar_set_fraction ()"><code class="function">gtk_progress_bar_set_fraction()</code></a> periodically to update the progress bar.
+</p>
+<p>
+When an application has no accurate way of knowing the amount of work
+to do, it can use the <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> in activity mode, which shows
+activity by a block moving back and forth within the progress area. In
+this mode, the application is required to call <a class="link" href="GtkProgressBar.html#gtk-progress-bar-pulse" title="gtk_progress_bar_pulse ()"><code class="function">gtk_progress_bar_pulse()</code></a>
+periodically to update the progress bar.
+</p>
+<p>
+There is quite a bit of flexibility provided to control the appearance
+of the <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>.  Functions are provided to control the
+orientation of the bar, optional text can be displayed along with
+the bar, and the step size used in activity mode can be set.
+</p>
+</div>
+<div class="refsect1">
+<a name="GtkProgressBar.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="GtkProgressBar-struct"></a><h3>struct GtkProgressBar</h3>
+<pre class="programlisting">struct GtkProgressBar;</pre>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-new"></a><h3>gtk_progress_bar_new ()</h3>
+<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_progress_bar_new                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>
+Creates a new <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody><tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>.</td>
+</tr></tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-pulse"></a><h3>gtk_progress_bar_pulse ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_pulse              (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
+<p>
+Indicates that some progress has been made, but you don't know how much.
+Causes the progress bar to enter "activity mode," where a block
+bounces back and forth. 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>
+causes the block to move by a little bit (the amount of movement
+per pulse is determined by <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>).
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody><tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr></tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-set-fraction"></a><h3>gtk_progress_bar_set_fraction ()</h3>
+<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>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> fraction</code></em>);</pre>
+<p>
+Causes the progress bar to "fill in" the given fraction
+of the bar. The fraction should be between 0.0 and 1.0,
+inclusive.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>fraction</code></em> :</span></p></td>
+<td>fraction of the task that's been completed</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-get-fraction"></a><h3>gtk_progress_bar_get_fraction ()</h3>
+<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>
+<p>
+Returns the current fraction of the task that's been completed.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>a fraction from 0.0 to 1.0</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-set-inverted"></a><h3>gtk_progress_bar_set_inverted ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_set_inverted       (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
+                                                         <em class="parameter"><code><span class="type">gboolean</span> inverted</code></em>);</pre>
+<p>
+Progress bars normally grow from top to bottom or left to right.
+Inverted progress bars grow in the opposite direction.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>inverted</code></em> :</span></p></td>
+<td>
+<code class="literal">TRUE</code> to invert the progress bar</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-get-inverted"></a><h3>gtk_progress_bar_get_inverted ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_progress_bar_get_inverted       (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
+<p>
+Gets the value set by <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-inverted" title="gtk_progress_bar_set_inverted ()"><code class="function">gtk_progress_bar_set_inverted()</code></a>.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>
+<code class="literal">TRUE</code> if the progress bar is inverted</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-set-show-text"></a><h3>gtk_progress_bar_set_show_text ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                gtk_progress_bar_set_show_text      (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
+                                                         <em class="parameter"><code><span class="type">gboolean</span> show_text</code></em>);</pre>
+<p>
+Sets whether the progress bar will show text superimposed
+over the bar. The shown text is either the value of
+the <a class="link" href="GtkProgressBar.html#GtkProgressBar--text" title='The "text" property'><span class="type">"text"</span></a> property or, if that is <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>,
+the <a class="link" href="GtkProgressBar.html#GtkProgressBar--fraction" title='The "fraction" property'><span class="type">"fraction"</span></a> value, as a percentage.
+</p>
+<p>
+To make a progress bar that is styled and sized suitably for containing
+text (even if the actual text is blank), set <a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title='The "show-text" property'><span class="type">"show-text"</span></a> to
+<code class="literal">TRUE</code> and <a class="link" href="GtkProgressBar.html#GtkProgressBar--text" title='The "text" property'><span class="type">"text"</span></a> to the empty string (not <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>).
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>show_text</code></em> :</span></p></td>
+<td>whether to show superimposed text</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 3.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-get-show-text"></a><h3>gtk_progress_bar_get_show_text ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_progress_bar_get_show_text      (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
+<p>
+Gets the value of the <a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title='The "show-text" property'><span class="type">"show-text"</span></a> property.
+See <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-show-text" title="gtk_progress_bar_set_show_text ()"><code class="function">gtk_progress_bar_set_show_text()</code></a>.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>
+<code class="literal">TRUE</code> if text is shown in the progress bar</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 3.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-set-text"></a><h3>gtk_progress_bar_set_text ()</h3>
+<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>,
+                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
+<p>
+Causes the given <em class="parameter"><code>text</code></em> to appear superimposed on the progress bar.
+</p>
+<p>
+If <em class="parameter"><code>text</code></em> is <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> and <a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title='The "show-text" property'><span class="type">"show-text"</span></a> is <code class="literal">TRUE</code>, the current
+value of <a class="link" href="GtkProgressBar.html#GtkProgressBar--fraction" title='The "fraction" property'><span class="type">"fraction"</span></a> will be displayed as a percentage.
+</p>
+<p>
+If <em class="parameter"><code>text</code></em> is non-<a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> and <a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title='The "show-text" property'><span class="type">"show-text"</span></a> is <code class="literal">TRUE</code>, the text will
+be displayed. In this case, it will not display the progress percentage.
+If <em class="parameter"><code>text</code></em> is the empty string, the progress bar will still be styled and sized
+suitably for containing text, as long as <a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title='The "show-text" property'><span class="type">"show-text"</span></a> is <code class="literal">TRUE</code>.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
+<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>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-get-text"></a><h3>gtk_progress_bar_get_text ()</h3>
+<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>
+<p>
+Retrieves the text displayed superimposed on the progress bar,
+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
+to the text, not a copy of it, so will become invalid
+if you change the text in the progress bar.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<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
+and should not be modified or freed.</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-set-ellipsize"></a><h3>gtk_progress_bar_set_ellipsize ()</h3>
+<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>,
+                                                         <em class="parameter"><code><span class="type">PangoEllipsizeMode</span> mode</code></em>);</pre>
+<p>
+Sets the mode used to ellipsize (add an ellipsis: "...") the text
+if there is not enough space to render the entire string.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
+<td>a <span class="type">PangoEllipsizeMode</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-get-ellipsize"></a><h3>gtk_progress_bar_get_ellipsize ()</h3>
+<pre class="programlisting"><span class="returnvalue">PangoEllipsizeMode</span>  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>
+<p>
+Returns the ellipsizing position of the progress bar.
+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>.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td><span class="type">PangoEllipsizeMode</span></td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-set-pulse-step"></a><h3>gtk_progress_bar_set_pulse_step ()</h3>
+<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>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> fraction</code></em>);</pre>
+<p>
+Sets the fraction of total progress bar length to move the
+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>.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>fraction</code></em> :</span></p></td>
+<td>fraction between 0.0 and 1.0</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-progress-bar-get-pulse-step"></a><h3>gtk_progress_bar_get_pulse_step ()</h3>
+<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>
+<p>
+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>.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>pbar</code></em> :</span></p></td>
+<td>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>a fraction from 0.0 to 1.0</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+<div class="refsect1">
+<a name="GtkProgressBar.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="GtkProgressBar--ellipsize"></a><h3>The <code class="literal">"ellipsize"</code> property</h3>
+<pre class="programlisting">  "ellipsize"                <span class="type">PangoEllipsizeMode</span>    : Read / Write</pre>
+<p>
+The preferred place to ellipsize the string, if the progress bar does
+not have enough room to display the entire string, specified as a
+<span class="type">PangoEllipsizeMode</span>.
+</p>
+<p>
+Note that setting this property to a value other than
+<code class="literal">PANGO_ELLIPSIZE_NONE</code> has the side-effect that the progress bar requests
+only enough space to display the ellipsis ("..."). Another means to set a
+progress bar'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>.
+</p>
+<p>Default value: PANGO_ELLIPSIZE_NONE</p>
+<p class="since">Since 2.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkProgressBar--fraction"></a><h3>The <code class="literal">"fraction"</code> property</h3>
+<pre class="programlisting">  "fraction"                 <span class="type">gdouble</span>               : Read / Write</pre>
+<p>The fraction of total work that has been completed.</p>
+<p>Allowed values: [0,1]</p>
+<p>Default value: 0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkProgressBar--inverted"></a><h3>The <code class="literal">"inverted"</code> property</h3>
+<pre class="programlisting">  "inverted"                 <span class="type">gboolean</span>              : Read / Write</pre>
+<p>Invert the direction in which the progress bar grows.</p>
+<p>Default value: FALSE</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkProgressBar--pulse-step"></a><h3>The <code class="literal">"pulse-step"</code> property</h3>
+<pre class="programlisting">  "pulse-step"               <span class="type">gdouble</span>               : Read / Write</pre>
+<p>The fraction of total progress to move the bouncing block when pulsed.</p>
+<p>Allowed values: [0,1]</p>
+<p>Default value: 0.1</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkProgressBar--show-text"></a><h3>The <code class="literal">"show-text"</code> property</h3>
+<pre class="programlisting">  "show-text"                <span class="type">gboolean</span>              : Read / Write</pre>
+<p>
+Sets whether the progress bar will show text superimposed
+over the bar. The shown text is either the value of
+the <a class="link" href="GtkProgressBar.html#GtkProgressBar--text" title='The "text" property'><span class="type">"text"</span></a> property or, if that is <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>,
+the <a class="link" href="GtkProgressBar.html#GtkProgressBar--fraction" title='The "fraction" property'><span class="type">"fraction"</span></a> value, as a percentage.
+</p>
+<p>
+To make a progress bar that is styled and sized suitably for containing
+text (even if the actual text is blank), set <a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title='The "show-text" property'><span class="type">"show-text"</span></a> to
+<code class="literal">TRUE</code> and <a class="link" href="GtkProgressBar.html#GtkProgressBar--text" title='The "text" property'><span class="type">"text"</span></a> to the empty string (not <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>).
+</p>
+<p>Default value: FALSE</p>
+<p class="since">Since 3.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkProgressBar--text"></a><h3>The <code class="literal">"text"</code> property</h3>
+<pre class="programlisting">  "text"                     <span class="type">gchar</span>*                : Read / Write</pre>
+<p>Text to be displayed in the progress bar.</p>
+<p>Default value: NULL</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="GtkProgressBar.style-property-details"></a><h2>Style Property Details</h2>
+<div class="refsect2">
+<a name="GtkProgressBar--s-min-horizontal-bar-height"></a><h3>The <code class="literal">"min-horizontal-bar-height"</code> style property</h3>
+<pre class="programlisting">  "min-horizontal-bar-height" <span class="type">gint</span>                  : Read / Write</pre>
+<p>
+Minimum horizontal height of the progress bar.
+</p>
+<p>Allowed values: &gt;= 1</p>
+<p>Default value: 20</p>
+<p class="since">Since 2.14</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkProgressBar--s-min-horizontal-bar-width"></a><h3>The <code class="literal">"min-horizontal-bar-width"</code> style property</h3>
+<pre class="programlisting">  "min-horizontal-bar-width" <span class="type">gint</span>                  : Read / Write</pre>
+<p>
+The minimum horizontal width of the progress bar.
+</p>
+<p>Allowed values: &gt;= 1</p>
+<p>Default value: 150</p>
+<p class="since">Since 2.14</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkProgressBar--s-min-vertical-bar-height"></a><h3>The <code class="literal">"min-vertical-bar-height"</code> style property</h3>
+<pre class="programlisting">  "min-vertical-bar-height"  <span class="type">gint</span>                  : Read / Write</pre>
+<p>
+The minimum vertical height of the progress bar.
+</p>
+<p>Allowed values: &gt;= 1</p>
+<p>Default value: 80</p>
+<p class="since">Since 2.14</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkProgressBar--s-min-vertical-bar-width"></a><h3>The <code class="literal">"min-vertical-bar-width"</code> style property</h3>
+<pre class="programlisting">  "min-vertical-bar-width"   <span class="type">gint</span>                  : Read / Write</pre>
+<p>
+The minimum vertical width of the progress bar.
+</p>
+<p>Allowed values: &gt;= 1</p>
+<p>Default value: 22</p>
+<p class="since">Since 2.14</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkProgressBar--s-xspacing"></a><h3>The <code class="literal">"xspacing"</code> style property</h3>
+<pre class="programlisting">  "xspacing"                 <span class="type">gint</span>                  : Read / Write</pre>
+<p>Extra spacing applied to the width of a progress bar.</p>
+<p>Allowed values: &gt;= 0</p>
+<p>Default value: 7</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkProgressBar--s-yspacing"></a><h3>The <code class="literal">"yspacing"</code> style property</h3>
+<pre class="programlisting">  "yspacing"                 <span class="type">gint</span>                  : Read / Write</pre>
+<p>Extra spacing applied to the height of a progress bar.</p>
+<p>Allowed values: &gt;= 0</p>
+<p>Default value: 7</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.18.1</div>
+</body>
+</html>