1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>gtkmm: Gtk::ProgressBar Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.3 -->
13
<table cellspacing="0" cellpadding="0">
15
<tr style="height: 56px;">
16
<td style="padding-left: 0.5em;">
17
<div id="projectname">gtkmm <span id="projectnumber">3.0.1</span></div>
23
<div id="navrow1" class="tabs">
25
<li><a href="index.html"><span>Main Page</span></a></li>
26
<li><a href="pages.html"><span>Related Pages</span></a></li>
27
<li><a href="modules.html"><span>Modules</span></a></li>
28
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
29
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
32
<div id="navrow2" class="tabs2">
34
<li><a href="annotated.html"><span>Class List</span></a></li>
35
<li><a href="classes.html"><span>Class Index</span></a></li>
36
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
37
<li><a href="functions.html"><span>Class Members</span></a></li>
40
<div id="nav-path" class="navpath">
42
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
43
<li class="navelem"><a class="el" href="classGtk_1_1ProgressBar.html">ProgressBar</a> </li>
49
<a href="#pub-methods">Public Member Functions</a> |
50
<a href="#related">Related Functions</a> </div>
51
<div class="headertitle">
52
<h1>Gtk::ProgressBar Class Reference<div class="ingroups"><a class="el" href="group__Widgets.html">Widgets</a></div></h1> </div>
54
<div class="contents">
55
<!-- doxytag: class="Gtk::ProgressBar" --><!-- doxytag: inherits="Gtk::Widget,Gtk::Orientable" -->
56
<p>A widget which indicates progress visually. <a href="#_details">More...</a></p>
57
<div class="dynheader">
58
Inheritance diagram for Gtk::ProgressBar:</div>
59
<div class="dyncontent">
60
<div class="center"><img src="classGtk_1_1ProgressBar__inherit__graph.png" border="0" usemap="#Gtk_1_1ProgressBar_inherit__map" alt="Inheritance graph"/></div>
61
<map name="Gtk_1_1ProgressBar_inherit__map" id="Gtk_1_1ProgressBar_inherit__map">
62
<area shape="rect" id="node2" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)" alt="" coords="153,326,244,357"/><area shape="rect" id="node4" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such as Gtk::Adjustme..." alt="" coords="7,246,95,277"/><area shape="rect" id="node6" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="5,166,96,197"/><area shape="rect" id="node8" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="51,86,171,117"/><area shape="rect" id="node14" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="120,166,224,197"/><area shape="rect" id="node10" doxygen="libsigc++-2.0.tag:http://library.gnome.org/devel/libsigc++/unstable/" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="57,6,164,37"/><area shape="rect" id="node12" href="classGtk_1_1Buildable.html" title="A base class for objects that can be built by Gtk::Builder." alt="" coords="119,246,223,277"/><area shape="rect" id="node19" href="classGtk_1_1Orientable.html" title="This interface is implemented by all widgets that can be oriented horizontally or vertically..." alt="" coords="324,326,433,357"/><area shape="rect" id="node17" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="247,246,369,277"/></map>
63
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
64
<div class="dynheader">
65
Collaboration diagram for Gtk::ProgressBar:</div>
66
<div class="dyncontent">
67
<div class="center"><img src="classGtk_1_1ProgressBar__coll__graph.png" border="0" usemap="#Gtk_1_1ProgressBar_coll__map" alt="Collaboration graph"/></div>
68
<map name="Gtk_1_1ProgressBar_coll__map" id="Gtk_1_1ProgressBar_coll__map">
69
<area shape="rect" id="node2" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)" alt="" coords="153,326,244,357"/><area shape="rect" id="node4" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such as Gtk::Adjustme..." alt="" coords="7,246,95,277"/><area shape="rect" id="node6" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="5,166,96,197"/><area shape="rect" id="node8" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="51,86,171,117"/><area shape="rect" id="node14" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="120,166,224,197"/><area shape="rect" id="node10" doxygen="libsigc++-2.0.tag:http://library.gnome.org/devel/libsigc++/unstable/" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="57,6,164,37"/><area shape="rect" id="node12" href="classGtk_1_1Buildable.html" title="A base class for objects that can be built by Gtk::Builder." alt="" coords="119,246,223,277"/><area shape="rect" id="node19" href="classGtk_1_1Orientable.html" title="This interface is implemented by all widgets that can be oriented horizontally or vertically..." alt="" coords="324,326,433,357"/><area shape="rect" id="node17" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="247,246,369,277"/></map>
70
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
72
<p><a href="classGtk_1_1ProgressBar-members.html">List of all members.</a></p>
73
<table class="memberdecls">
74
<tr><td colspan="2"><h2><a name="pub-methods"></a>
75
Public Member Functions</h2></td></tr>
76
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#acae7969db7608963603956601a412617">~ProgressBar</a> ()</td></tr>
77
<tr><td class="memItemLeft" align="right" valign="top">GtkProgressBar* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a07f879d345611f7dd0066ceecb8ecf95">gobj</a> ()</td></tr>
78
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a07f879d345611f7dd0066ceecb8ecf95"></a><br/></td></tr>
79
<tr><td class="memItemLeft" align="right" valign="top">const GtkProgressBar* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a436514b2bbc7e65c6bb3acc8567a0962">gobj</a> () const </td></tr>
80
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a436514b2bbc7e65c6bb3acc8567a0962"></a><br/></td></tr>
81
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a858446fa519774ff54caed7bb87be5f1">ProgressBar</a> ()</td></tr>
82
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a540b11622168ecb6da6ec77a918287f1">pulse</a> ()</td></tr>
83
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates that some progress is made, but you don't know how much. <a href="#a540b11622168ecb6da6ec77a918287f1"></a><br/></td></tr>
84
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#ad253279dc9fa248082d21c8fb4ded6d9">get_text</a> () const </td></tr>
85
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the text displayed superimposed on the progress bar, if any. <a href="#ad253279dc9fa248082d21c8fb4ded6d9"></a><br/></td></tr>
86
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a8944b906ff4ecdfc284c12fbc3103dce">set_text</a> (const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>& text)</td></tr>
87
<tr><td class="mdescLeft"> </td><td class="mdescRight">Causes the given <em>text</em> to appear superimposed on the progress bar. <a href="#a8944b906ff4ecdfc284c12fbc3103dce"></a><br/></td></tr>
88
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a2a0c02bc2def272773dcf7e5c23a0470">get_fraction</a> () const </td></tr>
89
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current fraction of the task that's been completed. <a href="#a2a0c02bc2def272773dcf7e5c23a0470"></a><br/></td></tr>
90
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a2b0f1e2619bb296d0290cba2ce3de1b3">set_fraction</a> (double fraction)</td></tr>
91
<tr><td class="mdescLeft"> </td><td class="mdescRight">Causes the progress bar to "fill in" the given fraction of the bar. <a href="#a2b0f1e2619bb296d0290cba2ce3de1b3"></a><br/></td></tr>
92
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a454ad874e4579cab01da0eec12b41dd9">get_pulse_step</a> () const </td></tr>
93
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the pulse step set with <a class="el" href="classGtk_1_1ProgressBar.html#a44e339d07c2bbfdbc1d8722dd7ca265c" title="Sets the fraction of total progress bar length to move the bouncing block for each call to pulse()...">set_pulse_step()</a> <a href="#a454ad874e4579cab01da0eec12b41dd9"></a><br/></td></tr>
94
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a44e339d07c2bbfdbc1d8722dd7ca265c">set_pulse_step</a> (double fraction)</td></tr>
95
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the fraction of total progress bar length to move the bouncing block for each call to <a class="el" href="classGtk_1_1ProgressBar.html#a540b11622168ecb6da6ec77a918287f1" title="Indicates that some progress is made, but you don't know how much.">pulse()</a>. <a href="#a44e339d07c2bbfdbc1d8722dd7ca265c"></a><br/></td></tr>
96
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a4735a220f8bde7b5e55a6a5b6c76a78f">set_inverted</a> (bool inverted=true)</td></tr>
97
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a474cd2f54b5979fea318c10c5a005459">get_inverted</a> () const </td></tr>
98
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a757a76b3e5850a27e3a072d55657279b">set_ellipsize</a> (<a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/group__pangommEnums.html#ga982cbecf0c4ee56766aab816a7f5ed0b">Pango::EllipsizeMode</a> mode)</td></tr>
99
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string. <a href="#a757a76b3e5850a27e3a072d55657279b"></a><br/></td></tr>
100
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/group__pangommEnums.html#ga982cbecf0c4ee56766aab816a7f5ed0b">Pango::EllipsizeMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#aa0282e0b3feacc66a4c758804eef33aa">get_ellipsize</a> () const </td></tr>
101
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the ellipsizing position of the progressbar. <a href="#aa0282e0b3feacc66a4c758804eef33aa"></a><br/></td></tr>
102
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a0bfa6042f5d4b3509967abc2d8af57fe">set_show_text</a> (bool show_text=true)</td></tr>
103
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the progressbar will show text superimposed over the bar. <a href="#a0bfa6042f5d4b3509967abc2d8af57fe"></a><br/></td></tr>
104
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a9ce61984ce442ec7a963f109a6083d7e">get_show_text</a> () const </td></tr>
105
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the value of the <a class="el" href="classGtk_1_1Widget.html#aa791d86a0bb3658e378e81d731dd0121" title="Flags a widget to be displayed.">Gtk::ProgressBar::show</a>-text property. <a href="#a9ce61984ce442ec7a963f109a6083d7e"></a><br/></td></tr>
106
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a82255016ad2a5fe4b394cb75f20a4180">property_fraction</a> ()</td></tr>
107
<tr><td class="mdescLeft"> </td><td class="mdescRight">The fraction of total work that has been completed. <a href="#a82255016ad2a5fe4b394cb75f20a4180"></a><br/></td></tr>
108
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
109
< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#af0d365e99e6d6da56f85a1c825b8521d">property_fraction</a> () const </td></tr>
110
<tr><td class="mdescLeft"> </td><td class="mdescRight">The fraction of total work that has been completed. <a href="#af0d365e99e6d6da56f85a1c825b8521d"></a><br/></td></tr>
111
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a3e6659f61a67ad6b7efe1202212cca18">property_pulse_step</a> ()</td></tr>
112
<tr><td class="mdescLeft"> </td><td class="mdescRight">The fraction of total progress to move the bouncing block when pulsed. <a href="#a3e6659f61a67ad6b7efe1202212cca18"></a><br/></td></tr>
113
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
114
< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#ad2147232471a77efbfb42ac4e4cfa15c">property_pulse_step</a> () const </td></tr>
115
<tr><td class="mdescLeft"> </td><td class="mdescRight">The fraction of total progress to move the bouncing block when pulsed. <a href="#ad2147232471a77efbfb42ac4e4cfa15c"></a><br/></td></tr>
116
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><br class="typebreak"/>
117
< <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a7beea96cbdf484f1662e4288781d05b3">property_text</a> ()</td></tr>
118
<tr><td class="mdescLeft"> </td><td class="mdescRight">Text to be displayed in the progress bar. <a href="#a7beea96cbdf484f1662e4288781d05b3"></a><br/></td></tr>
119
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
120
< <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#aae7c52de547fc84ec1bb9d7d558c5c0f">property_text</a> () const </td></tr>
121
<tr><td class="mdescLeft"> </td><td class="mdescRight">Text to be displayed in the progress bar. <a href="#aae7c52de547fc84ec1bb9d7d558c5c0f"></a><br/></td></tr>
122
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#aea3cb0e5e1fe1f1d63f5c732a99d9714">property_ellipsize</a> ()</td></tr>
123
<tr><td class="mdescLeft"> </td><td class="mdescRight">The preferred place to ellipsize the string, if the progress bar does not have enough room to display the entire string, if at all. <a href="#aea3cb0e5e1fe1f1d63f5c732a99d9714"></a><br/></td></tr>
124
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
125
< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#ad5f112713f68657d2a9ec4fc69358c09">property_ellipsize</a> () const </td></tr>
126
<tr><td class="mdescLeft"> </td><td class="mdescRight">The preferred place to ellipsize the string, if the progress bar does not have enough room to display the entire string, if at all. <a href="#ad5f112713f68657d2a9ec4fc69358c09"></a><br/></td></tr>
127
<tr><td colspan="2"><h2><a name="related"></a>
128
Related Functions</h2></td></tr>
129
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
130
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1ProgressBar.html">Gtk::ProgressBar</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ProgressBar.html#a4cfc731f614759c2cb4097396601a3a1">wrap</a> (GtkProgressBar* object, bool take_copy=false)</td></tr>
131
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a4cfc731f614759c2cb4097396601a3a1"></a><br/></td></tr>
133
<hr/><a name="_details"></a><h2>Detailed Description</h2>
134
<div class="textblock"><p>A widget which indicates progress visually. </p>
135
<p>The <a class="el" href="classGtk_1_1ProgressBar.html" title="A widget which indicates progress visually.">Gtk::ProgressBar</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="el" href="classGtk_1_1ProgressBar.html" title="A widget which indicates progress visually.">Gtk::ProgressBar</a> can be used in two different modes: percentage mode and activity mode.</p>
136
<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="el" href="classGtk_1_1ProgressBar.html" title="A widget which indicates progress visually.">Gtk::ProgressBar</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="el" href="classGtk_1_1ProgressBar.html#a2b0f1e2619bb296d0290cba2ce3de1b3" title="Causes the progress bar to "fill in" the given fraction of the bar.">set_fraction()</a> periodically to update the progress bar.</p>
137
<p>When an application has no accurate way of knowing the amount of work to do, it can use the <a class="el" href="classGtk_1_1ProgressBar.html" title="A widget which indicates progress visually.">Gtk::ProgressBar</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="el" href="classGtk_1_1ProgressBar.html#a540b11622168ecb6da6ec77a918287f1" title="Indicates that some progress is made, but you don't know how much.">pulse()</a> perodically to update the progress bar.</p>
138
<p>There is quite a bit of flexibility provided to control the appearance of the <a class="el" href="classGtk_1_1ProgressBar.html" title="A widget which indicates progress visually.">Gtk::ProgressBar</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>
139
<p>The <a class="el" href="classGtk_1_1ProgressBar.html" title="A widget which indicates progress visually.">ProgressBar</a> widget looks like this: </p>
141
<img src="progressbar1.png" alt="progressbar1.png"/>
143
</div><hr/><h2>Constructor & Destructor Documentation</h2>
144
<a class="anchor" id="acae7969db7608963603956601a412617"></a><!-- doxytag: member="Gtk::ProgressBar::~ProgressBar" ref="acae7969db7608963603956601a412617" args="()" -->
145
<div class="memitem">
146
<div class="memproto">
147
<table class="memname">
149
<td class="memname">virtual Gtk::ProgressBar::~ProgressBar </td>
151
<td class="paramname"></td><td>)</td>
152
<td><code> [virtual]</code></td>
160
<a class="anchor" id="a858446fa519774ff54caed7bb87be5f1"></a><!-- doxytag: member="Gtk::ProgressBar::ProgressBar" ref="a858446fa519774ff54caed7bb87be5f1" args="()" -->
161
<div class="memitem">
162
<div class="memproto">
163
<table class="memname">
165
<td class="memname">Gtk::ProgressBar::ProgressBar </td>
167
<td class="paramname"></td><td>)</td>
176
<hr/><h2>Member Function Documentation</h2>
177
<a class="anchor" id="aa0282e0b3feacc66a4c758804eef33aa"></a><!-- doxytag: member="Gtk::ProgressBar::get_ellipsize" ref="aa0282e0b3feacc66a4c758804eef33aa" args="() const " -->
178
<div class="memitem">
179
<div class="memproto">
180
<table class="memname">
182
<td class="memname"><a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/group__pangommEnums.html#ga982cbecf0c4ee56766aab816a7f5ed0b">Pango::EllipsizeMode</a> Gtk::ProgressBar::get_ellipsize </td>
184
<td class="paramname"></td><td>)</td>
191
<p>Returns the ellipsizing position of the progressbar. </p>
192
<p>See <a class="el" href="classGtk_1_1ProgressBar.html#a757a76b3e5850a27e3a072d55657279b" title="Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough sp...">set_ellipsize()</a>.</p>
193
<dl class="since_2_6"><dt><b><a class="el" href="since_2_6.html#_since_2_6000131">Since gtkmm 2.6:</a></b></dt><dd></dd></dl>
194
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/group__pangommEnums.html#ga982cbecf0c4ee56766aab816a7f5ed0b">Pango::EllipsizeMode</a>. </dd></dl>
198
<a class="anchor" id="a2a0c02bc2def272773dcf7e5c23a0470"></a><!-- doxytag: member="Gtk::ProgressBar::get_fraction" ref="a2a0c02bc2def272773dcf7e5c23a0470" args="() const " -->
199
<div class="memitem">
200
<div class="memproto">
201
<table class="memname">
203
<td class="memname">double Gtk::ProgressBar::get_fraction </td>
205
<td class="paramname"></td><td>)</td>
212
<p>Returns the current fraction of the task that's been completed. </p>
213
<dl class="return"><dt><b>Returns:</b></dt><dd>A fraction from 0.0 to 1.0. </dd></dl>
217
<a class="anchor" id="a474cd2f54b5979fea318c10c5a005459"></a><!-- doxytag: member="Gtk::ProgressBar::get_inverted" ref="a474cd2f54b5979fea318c10c5a005459" args="() const " -->
218
<div class="memitem">
219
<div class="memproto">
220
<table class="memname">
222
<td class="memname">bool Gtk::ProgressBar::get_inverted </td>
224
<td class="paramname"></td><td>)</td>
233
<a class="anchor" id="a454ad874e4579cab01da0eec12b41dd9"></a><!-- doxytag: member="Gtk::ProgressBar::get_pulse_step" ref="a454ad874e4579cab01da0eec12b41dd9" args="() const " -->
234
<div class="memitem">
235
<div class="memproto">
236
<table class="memname">
238
<td class="memname">double Gtk::ProgressBar::get_pulse_step </td>
240
<td class="paramname"></td><td>)</td>
247
<p>Retrieves the pulse step set with <a class="el" href="classGtk_1_1ProgressBar.html#a44e339d07c2bbfdbc1d8722dd7ca265c" title="Sets the fraction of total progress bar length to move the bouncing block for each call to pulse()...">set_pulse_step()</a> </p>
248
<dl class="return"><dt><b>Returns:</b></dt><dd>A fraction from 0.0 to 1.0. </dd></dl>
252
<a class="anchor" id="a9ce61984ce442ec7a963f109a6083d7e"></a><!-- doxytag: member="Gtk::ProgressBar::get_show_text" ref="a9ce61984ce442ec7a963f109a6083d7e" args="() const " -->
253
<div class="memitem">
254
<div class="memproto">
255
<table class="memname">
257
<td class="memname">bool Gtk::ProgressBar::get_show_text </td>
259
<td class="paramname"></td><td>)</td>
266
<p>Gets the value of the <a class="el" href="classGtk_1_1Widget.html#aa791d86a0bb3658e378e81d731dd0121" title="Flags a widget to be displayed.">Gtk::ProgressBar::show</a>-text property. </p>
267
<p>See <a class="el" href="classGtk_1_1ProgressBar.html#a0bfa6042f5d4b3509967abc2d8af57fe" title="Sets whether the progressbar will show text superimposed over the bar.">set_show_text()</a>.</p>
268
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000024">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
269
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if text is shown in the progress bar. </dd></dl>
273
<a class="anchor" id="ad253279dc9fa248082d21c8fb4ded6d9"></a><!-- doxytag: member="Gtk::ProgressBar::get_text" ref="ad253279dc9fa248082d21c8fb4ded6d9" args="() const " -->
274
<div class="memitem">
275
<div class="memproto">
276
<table class="memname">
278
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::ProgressBar::get_text </td>
280
<td class="paramname"></td><td>)</td>
287
<p>Retrieves the text displayed superimposed on the progress bar, if any. </p>
288
<dl class="return"><dt><b>Returns:</b></dt><dd>Text. </dd></dl>
292
<a class="anchor" id="a07f879d345611f7dd0066ceecb8ecf95"></a><!-- doxytag: member="Gtk::ProgressBar::gobj" ref="a07f879d345611f7dd0066ceecb8ecf95" args="()" -->
293
<div class="memitem">
294
<div class="memproto">
295
<table class="memname">
297
<td class="memname">GtkProgressBar* Gtk::ProgressBar::gobj </td>
299
<td class="paramname"></td><td>)</td>
300
<td><code> [inline]</code></td>
306
<p>Provides access to the underlying C GtkObject. </p>
308
<p>Reimplemented from <a class="el" href="classGtk_1_1Orientable.html#aff3a192c3b691efa1f4227b8e161843d">Gtk::Orientable</a>.</p>
312
<a class="anchor" id="a436514b2bbc7e65c6bb3acc8567a0962"></a><!-- doxytag: member="Gtk::ProgressBar::gobj" ref="a436514b2bbc7e65c6bb3acc8567a0962" args="() const " -->
313
<div class="memitem">
314
<div class="memproto">
315
<table class="memname">
317
<td class="memname">const GtkProgressBar* Gtk::ProgressBar::gobj </td>
319
<td class="paramname"></td><td>)</td>
320
<td> const<code> [inline]</code></td>
326
<p>Provides access to the underlying C GtkObject. </p>
328
<p>Reimplemented from <a class="el" href="classGtk_1_1Orientable.html#affca54ff29e09edd51a6ce57dd93a9df">Gtk::Orientable</a>.</p>
332
<a class="anchor" id="aea3cb0e5e1fe1f1d63f5c732a99d9714"></a><!-- doxytag: member="Gtk::ProgressBar::property_ellipsize" ref="aea3cb0e5e1fe1f1d63f5c732a99d9714" args="()" -->
333
<div class="memitem">
334
<div class="memproto">
335
<table class="memname">
337
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> Gtk::ProgressBar::property_ellipsize </td>
339
<td class="paramname"></td><td>)</td>
346
<p>The preferred place to ellipsize the string, if the progress bar does not have enough room to display the entire string, if at all. </p>
347
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
348
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
352
<a class="anchor" id="ad5f112713f68657d2a9ec4fc69358c09"></a><!-- doxytag: member="Gtk::ProgressBar::property_ellipsize" ref="ad5f112713f68657d2a9ec4fc69358c09" args="() const " -->
353
<div class="memitem">
354
<div class="memproto">
355
<table class="memname">
357
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gtk::ProgressBar::property_ellipsize </td>
359
<td class="paramname"></td><td>)</td>
366
<p>The preferred place to ellipsize the string, if the progress bar does not have enough room to display the entire string, if at all. </p>
367
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
368
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
372
<a class="anchor" id="a82255016ad2a5fe4b394cb75f20a4180"></a><!-- doxytag: member="Gtk::ProgressBar::property_fraction" ref="a82255016ad2a5fe4b394cb75f20a4180" args="()" -->
373
<div class="memitem">
374
<div class="memproto">
375
<table class="memname">
377
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><double> Gtk::ProgressBar::property_fraction </td>
379
<td class="paramname"></td><td>)</td>
386
<p>The fraction of total work that has been completed. </p>
387
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
388
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
392
<a class="anchor" id="af0d365e99e6d6da56f85a1c825b8521d"></a><!-- doxytag: member="Gtk::ProgressBar::property_fraction" ref="af0d365e99e6d6da56f85a1c825b8521d" args="() const " -->
393
<div class="memitem">
394
<div class="memproto">
395
<table class="memname">
397
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><double> Gtk::ProgressBar::property_fraction </td>
399
<td class="paramname"></td><td>)</td>
406
<p>The fraction of total work that has been completed. </p>
407
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
408
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
412
<a class="anchor" id="a3e6659f61a67ad6b7efe1202212cca18"></a><!-- doxytag: member="Gtk::ProgressBar::property_pulse_step" ref="a3e6659f61a67ad6b7efe1202212cca18" args="()" -->
413
<div class="memitem">
414
<div class="memproto">
415
<table class="memname">
417
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><double> Gtk::ProgressBar::property_pulse_step </td>
419
<td class="paramname"></td><td>)</td>
426
<p>The fraction of total progress to move the bouncing block when pulsed. </p>
427
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
428
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
432
<a class="anchor" id="ad2147232471a77efbfb42ac4e4cfa15c"></a><!-- doxytag: member="Gtk::ProgressBar::property_pulse_step" ref="ad2147232471a77efbfb42ac4e4cfa15c" args="() const " -->
433
<div class="memitem">
434
<div class="memproto">
435
<table class="memname">
437
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><double> Gtk::ProgressBar::property_pulse_step </td>
439
<td class="paramname"></td><td>)</td>
446
<p>The fraction of total progress to move the bouncing block when pulsed. </p>
447
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
448
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
452
<a class="anchor" id="aae7c52de547fc84ec1bb9d7d558c5c0f"></a><!-- doxytag: member="Gtk::ProgressBar::property_text" ref="aae7c52de547fc84ec1bb9d7d558c5c0f" args="() const " -->
453
<div class="memitem">
454
<div class="memproto">
455
<table class="memname">
457
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><<a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>> Gtk::ProgressBar::property_text </td>
459
<td class="paramname"></td><td>)</td>
466
<p>Text to be displayed in the progress bar. </p>
467
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
468
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
472
<a class="anchor" id="a7beea96cbdf484f1662e4288781d05b3"></a><!-- doxytag: member="Gtk::ProgressBar::property_text" ref="a7beea96cbdf484f1662e4288781d05b3" args="()" -->
473
<div class="memitem">
474
<div class="memproto">
475
<table class="memname">
477
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><<a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>> Gtk::ProgressBar::property_text </td>
479
<td class="paramname"></td><td>)</td>
486
<p>Text to be displayed in the progress bar. </p>
487
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
488
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
492
<a class="anchor" id="a540b11622168ecb6da6ec77a918287f1"></a><!-- doxytag: member="Gtk::ProgressBar::pulse" ref="a540b11622168ecb6da6ec77a918287f1" args="()" -->
493
<div class="memitem">
494
<div class="memproto">
495
<table class="memname">
497
<td class="memname">void Gtk::ProgressBar::pulse </td>
499
<td class="paramname"></td><td>)</td>
506
<p>Indicates that some progress is made, but you don't know how much. </p>
507
<p>Causes the progress bar to enter "activity mode," where a block bounces back and forth. Each call to <a class="el" href="classGtk_1_1ProgressBar.html#a540b11622168ecb6da6ec77a918287f1" title="Indicates that some progress is made, but you don't know how much.">pulse()</a> causes the block to move by a little bit (the amount of movement per pulse is determined by <a class="el" href="classGtk_1_1ProgressBar.html#a44e339d07c2bbfdbc1d8722dd7ca265c" title="Sets the fraction of total progress bar length to move the bouncing block for each call to pulse()...">set_pulse_step()</a>). </p>
511
<a class="anchor" id="a757a76b3e5850a27e3a072d55657279b"></a><!-- doxytag: member="Gtk::ProgressBar::set_ellipsize" ref="a757a76b3e5850a27e3a072d55657279b" args="(Pango::EllipsizeMode mode)" -->
512
<div class="memitem">
513
<div class="memproto">
514
<table class="memname">
516
<td class="memname">void Gtk::ProgressBar::set_ellipsize </td>
518
<td class="paramtype"><a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/group__pangommEnums.html#ga982cbecf0c4ee56766aab816a7f5ed0b">Pango::EllipsizeMode</a> </td>
519
<td class="paramname"><em>mode</em></td><td>)</td>
526
<p>Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string. </p>
527
<dl class="since_2_6"><dt><b><a class="el" href="since_2_6.html#_since_2_6000130">Since gtkmm 2.6:</a></b></dt><dd></dd></dl>
528
<dl><dt><b>Parameters:</b></dt><dd>
529
<table class="params">
530
<tr><td class="paramname">mode</td><td>A <a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/group__pangommEnums.html#ga982cbecf0c4ee56766aab816a7f5ed0b">Pango::EllipsizeMode</a>. </td></tr>
537
<a class="anchor" id="a2b0f1e2619bb296d0290cba2ce3de1b3"></a><!-- doxytag: member="Gtk::ProgressBar::set_fraction" ref="a2b0f1e2619bb296d0290cba2ce3de1b3" args="(double fraction)" -->
538
<div class="memitem">
539
<div class="memproto">
540
<table class="memname">
542
<td class="memname">void Gtk::ProgressBar::set_fraction </td>
544
<td class="paramtype">double </td>
545
<td class="paramname"><em>fraction</em></td><td>)</td>
552
<p>Causes the progress bar to "fill in" the given fraction of the bar. </p>
553
<p>The fraction should be between 0.0 and 1.0, inclusive. </p>
554
<dl><dt><b>Parameters:</b></dt><dd>
555
<table class="params">
556
<tr><td class="paramname">fraction</td><td>Fraction of the task that's been completed. </td></tr>
563
<a class="anchor" id="a4735a220f8bde7b5e55a6a5b6c76a78f"></a><!-- doxytag: member="Gtk::ProgressBar::set_inverted" ref="a4735a220f8bde7b5e55a6a5b6c76a78f" args="(bool inverted=true)" -->
564
<div class="memitem">
565
<div class="memproto">
566
<table class="memname">
568
<td class="memname">void Gtk::ProgressBar::set_inverted </td>
570
<td class="paramtype">bool </td>
571
<td class="paramname"><em>inverted</em> = <code>true</code></td><td>)</td>
580
<a class="anchor" id="a44e339d07c2bbfdbc1d8722dd7ca265c"></a><!-- doxytag: member="Gtk::ProgressBar::set_pulse_step" ref="a44e339d07c2bbfdbc1d8722dd7ca265c" args="(double fraction)" -->
581
<div class="memitem">
582
<div class="memproto">
583
<table class="memname">
585
<td class="memname">void Gtk::ProgressBar::set_pulse_step </td>
587
<td class="paramtype">double </td>
588
<td class="paramname"><em>fraction</em></td><td>)</td>
595
<p>Sets the fraction of total progress bar length to move the bouncing block for each call to <a class="el" href="classGtk_1_1ProgressBar.html#a540b11622168ecb6da6ec77a918287f1" title="Indicates that some progress is made, but you don't know how much.">pulse()</a>. </p>
596
<dl><dt><b>Parameters:</b></dt><dd>
597
<table class="params">
598
<tr><td class="paramname">fraction</td><td>Fraction between 0.0 and 1.0. </td></tr>
605
<a class="anchor" id="a0bfa6042f5d4b3509967abc2d8af57fe"></a><!-- doxytag: member="Gtk::ProgressBar::set_show_text" ref="a0bfa6042f5d4b3509967abc2d8af57fe" args="(bool show_text=true)" -->
606
<div class="memitem">
607
<div class="memproto">
608
<table class="memname">
610
<td class="memname">void Gtk::ProgressBar::set_show_text </td>
612
<td class="paramtype">bool </td>
613
<td class="paramname"><em>show_text</em> = <code>true</code></td><td>)</td>
620
<p>Sets whether the progressbar will show text superimposed over the bar. </p>
621
<p>The shown text is either the value of the Gtk::ProgressBar::text property or, if that is <code>0</code>, the Gtk::ProgressBar::fraction value, as a percentage.</p>
622
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000023">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
623
<dl><dt><b>Parameters:</b></dt><dd>
624
<table class="params">
625
<tr><td class="paramname">show_text</td><td>Whether to show superimposed text. </td></tr>
632
<a class="anchor" id="a8944b906ff4ecdfc284c12fbc3103dce"></a><!-- doxytag: member="Gtk::ProgressBar::set_text" ref="a8944b906ff4ecdfc284c12fbc3103dce" args="(const Glib::ustring &text)" -->
633
<div class="memitem">
634
<div class="memproto">
635
<table class="memname">
637
<td class="memname">void Gtk::ProgressBar::set_text </td>
639
<td class="paramtype">const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
640
<td class="paramname"><em>text</em></td><td>)</td>
647
<p>Causes the given <em>text</em> to appear superimposed on the progress bar. </p>
648
<dl><dt><b>Parameters:</b></dt><dd>
649
<table class="params">
650
<tr><td class="paramname">text</td><td>A UTF-8 string, or <code>0</code>. </td></tr>
657
<hr/><h2>Friends And Related Function Documentation</h2>
658
<a class="anchor" id="a4cfc731f614759c2cb4097396601a3a1"></a><!-- doxytag: member="Gtk::ProgressBar::wrap" ref="a4cfc731f614759c2cb4097396601a3a1" args="(GtkProgressBar *object, bool take_copy=false)" -->
659
<div class="memitem">
660
<div class="memproto">
661
<table class="memname">
663
<td class="memname"><a class="el" href="classGtk_1_1ProgressBar.html">Gtk::ProgressBar</a>* wrap </td>
665
<td class="paramtype">GtkProgressBar * </td>
666
<td class="paramname"><em>object</em>, </td>
669
<td class="paramkey"></td>
671
<td class="paramtype">bool </td>
672
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
677
<td></td><td><code> [related]</code></td>
683
<p>A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
684
<dl><dt><b>Parameters:</b></dt><dd>
685
<table class="params">
686
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
687
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
691
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
695
<hr/>The documentation for this class was generated from the following file:<ul>
696
<li>gtkmm/progressbar.h</li>
699
<hr class="footer"/><address class="footer"><small>Generated on Mon May 9 2011 10:20:09 for gtkmm by 
700
<a href="http://www.doxygen.org/index.html">
701
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
added
removed
docs/reference/html/classGtk_1_1ProgressBar.html
