/usr/share/gtk-doc/html/pygtk/class-gtkprogressbar.html is in python-gtk2-doc 2.24.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.ProgressBar</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkprintsettings.html" title="gtk.PrintSettings"><link rel="next" href="class-gtkradioaction.html" title="gtk.RadioAction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.ProgressBar</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkprintsettings.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkradioaction.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.ProgressBar"><a name="class-gtkprogressbar"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.ProgressBar</h2><p>gtk.ProgressBar — a widget which indicates progress visually.</p></div><div class="refsect1" title="Synopsis"><a name="id3849293"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.ProgressBar</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gtkprogress">gtk.Progress</PYGTKDOCLINK></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkprogressbar.html#constructor-gtkprogressbar" title="Constructor">gtk.ProgressBar</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--pulse" title="gtk.ProgressBar.pulse">pulse</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--set-text" title="gtk.ProgressBar.set_text">set_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--set-fraction" title="gtk.ProgressBar.set_fraction">set_fraction</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>fraction</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--set-pulse-step" title="gtk.ProgressBar.set_pulse_step">set_pulse_step</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>fraction</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--set-orientation" title="gtk.ProgressBar.set_orientation">set_orientation</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>orientation</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--get-text" title="gtk.ProgressBar.get_text">get_text</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--get-fraction" title="gtk.ProgressBar.get_fraction">get_fraction</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--get-pulse-step" title="gtk.ProgressBar.get_pulse_step">get_pulse_step</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--get-orientation" title="gtk.ProgressBar.get_orientation">get_orientation</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--set-ellipsize" title="gtk.ProgressBar.set_ellipsize">set_ellipsize</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>mode</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--get-ellipsize" title="gtk.ProgressBar.get_ellipsize">get_ellipsize</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3849602"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <PYGTKDOCLINK HREF="class-gtkprogress">gtk.Progress</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkprogressbar.html" title="gtk.ProgressBar">gtk.ProgressBar</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3849647"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkprogressbar.html" title="gtk.ProgressBar"><code class="classname">gtk.ProgressBar</code></a>
implements
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
</p></div><div class="refsect1" title="gtk.ProgressBar Properties"><a name="properties-gtkprogressbar"></a><h2>gtk.ProgressBar Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a class="link" href="class-gtkwidget.html#properties-gtkwidget" title="gtk.Widget Properties">gtk.Widget Properties</a></p><p><PYGTKDOCLINK HREF="properties-gtkprogress">gtk.Progress Properties</PYGTKDOCLINK></p><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"discrete-blocks"</td><td valign="top">Read-Write</td><td valign="top">The number of discrete blocks in a progress bar (when shown
in the discrete style)</td></tr><tr valign="top"><td valign="top">"ellipsize"</td><td valign="top">Read-Write</td><td valign="top">The preferred place to ellipsize the string, if the
progressbar does not have enough room to display the entire
string, specified as one of the <a class="xref" href="pango-constants.html#pango-ellipsize-mode-constants" title="Pango Ellipsize Mode Constants">Pango Ellipsize Mode Constants</a>. Note that
setting this property to a value other than
<code class="literal">pango.ELLIPSIZE_NONE</code> has the side-effect that
the progressbar requests only enough space to display the ellipsis
"...". Another means to set a progressbar's width is the <a class="link" href="class-gtkwidget.html#method-gtkwidget--set-size-request" title="gtk.Widget.set_size_request"><code class="methodname">gtk.Widget.set_size_request()</code></a>.
This property is available in GTK+ 2.6 and above.</td></tr><tr valign="top"><td valign="top">"fraction"</td><td valign="top">Read-Write</td><td valign="top">The fraction of total work that has been completed</td></tr><tr valign="top"><td valign="top">"orientation"</td><td valign="top">Read-Write</td><td valign="top">The orientation and growth direction of the progress
bar - one of the <a class="xref" href="gtk-constants.html#gtk-progressbar-orientation-constants" title="GTK ProgressBar Orientation Constants">GTK ProgressBar Orientation Constants</a>:
<code class="literal">gtk.PROGRESS_LEFT_TO_RIGHT</code>,
<code class="literal">gtk.PROGRESS_RIGHT_TO_LEFT</code>,
<code class="literal">gtk.PROGRESS_BOTTOM_TO_TOP</code>,
<code class="literal">gtk.PROGRESS_TOP_TO_BOTTOM</code></td></tr><tr valign="top"><td valign="top">"pulse-step"</td><td valign="top">Read-Write</td><td valign="top">The fraction of total progress to move the bouncing
block when pulsed</td></tr><tr valign="top"><td valign="top">"text"</td><td valign="top">Read-Write</td><td valign="top">The text to be displayed in the progress bar</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.ProgressBar Style Properties"><a name="style-properties-gtkprogressbar"></a><h2>gtk.ProgressBar Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"min-horizontal-bar-height"</td><td valign="top">Read</td><td valign="top">
Minimum horizontal height of the progress bar.
Allowed values: >= 1. Default value: 20.
Available in GTK+ 2.14 and above.
</td></tr><tr valign="top"><td valign="top">"min-horizontal-bar-width"</td><td valign="top">Read</td><td valign="top">
The minimum horizontal width of the progress bar.
Allowed values: >= 1. Default value: 150.
Available in GTK+ 2.14 and above.
</td></tr><tr valign="top"><td valign="top">"min-vertical-bar-height"</td><td valign="top">Read</td><td valign="top">
The minimum vertical height of the progress bar.
Allowed values: >= 1. Default value: 80.
Available in GTK+ 2.14 and above.
</td></tr><tr valign="top"><td valign="top">"min-vertical-bar-width"</td><td valign="top">Read</td><td valign="top">
The minimum vertical width of the progress bar.
Allowed values: >= 1. Default value: 22.
Available in GTK+ 2.14 and above.
</td></tr><tr valign="top"><td valign="top">"xspacing"</td><td valign="top">Read</td><td valign="top">
Extra spacing applied to the width of a progress bar.
Allowed values: >= 0. Default value: 7.
</td></tr><tr valign="top"><td valign="top">"yspacing"</td><td valign="top">Read</td><td valign="top">
Extra spacing applied to the width of a progress bar.
Allowed values: >= 0. Default value: 7.
</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.ProgressBar Signal Prototypes"><a name="signal-prototypes-gtkprogressbar"></a><h2>gtk.ProgressBar Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p></div><div class="refsect1" title="Description"><a name="id3850139"></a><h2>Description</h2><p>The <a class="link" href="class-gtkprogressbar.html" title="gtk.ProgressBar"><code class="classname">gtk.ProgressBar</code></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="class-gtkprogressbar.html" title="gtk.ProgressBar"><code class="classname">gtk.ProgressBar</code></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="class-gtkprogressbar.html" title="gtk.ProgressBar"><code class="classname">gtk.ProgressBar</code></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 the <a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--set-fraction" title="gtk.ProgressBar.set_fraction"><code class="methodname">set_fraction</code>()</a>
method 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="class-gtkprogressbar.html" title="gtk.ProgressBar"><code class="classname">gtk.ProgressBar</code></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
the <a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--pulse" title="gtk.ProgressBar.pulse"><code class="methodname">pulse</code>()</a>
method 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="class-gtkprogressbar.html" title="gtk.ProgressBar"><code class="classname">gtk.ProgressBar</code></a>.
Methods 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" title="Constructor"><a name="constructor-gtkprogressbar"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.ProgressBar</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtkprogressbar.html" title="gtk.ProgressBar"><code class="classname">gtk.ProgressBar</code></a>
widget</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkprogressbar.html" title="gtk.ProgressBar"><code class="classname">gtk.Progressbar</code></a>
widget.</p></div><div class="refsect1" title="Methods"><a name="id3850303"></a><h2>Methods</h2><div class="refsect2" title="gtk.ProgressBar.pulse"><a name="method-gtkprogressbar--pulse"></a><h3>gtk.ProgressBar.pulse</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">pulse</span>(<span class="methodparam"></span>)</code></pre><p>The <code class="methodname">pulse</code>() method nudges the
progressbar to indicate that some progress has been made, but you don't know
how much. This method also changes progress bar mode to "activity mode,"
where a block bounces back and forth. Each call to the <a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--pulse" title="gtk.ProgressBar.pulse"><code class="methodname">pulse</code>()</a>
method causes the block to move by a little bit (the amount of movement per
pulse is determined by the <a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--set-pulse-step" title="gtk.ProgressBar.set_pulse_step"><code class="methodname">set_pulse_step</code>()</a>
method).</p></div><div class="refsect2" title="gtk.ProgressBar.set_text"><a name="method-gtkprogressbar--set-text"></a><h3>gtk.ProgressBar.set_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>text</code></strong> :</span></p></td><td>a UTF-8 string</td></tr></tbody></table><p>The <code class="methodname">set_text</code>() method superimposes the
text specified by <em class="parameter"><code>text</code></em> on the progress bar.</p></div><div class="refsect2" title="gtk.ProgressBar.set_fraction"><a name="method-gtkprogressbar--set-fraction"></a><h3>gtk.ProgressBar.set_fraction</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_fraction</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>fraction</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>fraction</code></strong> :</span></p></td><td>the fraction of the task that's been
completed</td></tr></tbody></table><p>The <code class="methodname">set_fraction</code>() method causes the
progress bar to "fill in" the portion of the bar specified by
<em class="parameter"><code>fraction</code></em>. The value of
<em class="parameter"><code>fraction</code></em> should be between 0.0 and 1.0.</p></div><div class="refsect2" title="gtk.ProgressBar.set_pulse_step"><a name="method-gtkprogressbar--set-pulse-step"></a><h3>gtk.ProgressBar.set_pulse_step</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_pulse_step</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>fraction</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>fraction</code></strong> :</span></p></td><td>a value between 0.0 and
1.0</td></tr></tbody></table><p>The <code class="methodname">set_pulse_step</code>() method sets the
portion (specified by <em class="parameter"><code>fraction</code></em>) of the total progress
bar length to move the bouncing block for each call to the <a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--pulse" title="gtk.ProgressBar.pulse"><code class="methodname">pulse</code>()</a>
method.</p></div><div class="refsect2" title="gtk.ProgressBar.set_orientation"><a name="method-gtkprogressbar--set-orientation"></a><h3>gtk.ProgressBar.set_orientation</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_orientation</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>orientation</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>orientation</code></strong> :</span></p></td><td>the orientation of the progress
bar</td></tr></tbody></table><p>The <code class="methodname">set_orientation</code>() method switches
the progress bar to a different orientation as specified by the value of
<em class="parameter"><code>orientation</code></em>. The value of
<em class="parameter"><code>orientation</code></em> must be one of the <a class="xref" href="gtk-constants.html#gtk-progressbar-orientation-constants" title="GTK ProgressBar Orientation Constants">GTK ProgressBar Orientation Constants</a>.</p></div><div class="refsect2" title="gtk.ProgressBar.get_text"><a name="method-gtkprogressbar--get-text"></a><h3>gtk.ProgressBar.get_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_text</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the text, or
<code class="literal">None</code></td></tr></tbody></table><p>The <code class="methodname">get_text</code>() method returns the text
superimposed on the progress bar. If there is no superimposed text this
method returns <code class="literal">None</code>.</p></div><div class="refsect2" title="gtk.ProgressBar.get_fraction"><a name="method-gtkprogressbar--get-fraction"></a><h3>gtk.ProgressBar.get_fraction</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_fraction</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><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><p>The <code class="methodname">get_fraction</code>() method returns the
current fraction of the task that's been set by the <a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--set-fraction" title="gtk.ProgressBar.set_fraction"><code class="methodname">set_fraction</code>()</a>
method .</p></div><div class="refsect2" title="gtk.ProgressBar.get_pulse_step"><a name="method-gtkprogressbar--get-pulse-step"></a><h3>gtk.ProgressBar.get_pulse_step</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_pulse_step</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><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><p>The <code class="methodname">get_pulse_step</code>() method returns the
pulse step set with the <a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--set-pulse-step" title="gtk.ProgressBar.set_pulse_step"><code class="methodname">set_pulse_step</code>()</a>.</p></div><div class="refsect2" title="gtk.ProgressBar.get_orientation"><a name="method-gtkprogressbar--get-orientation"></a><h3>gtk.ProgressBar.get_orientation</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_orientation</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the orientation of the progress
bar</td></tr></tbody></table><p>The <code class="methodname">get_orientation</code>() method returns
the current progress bar orientation. See the <a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--set-orientation" title="gtk.ProgressBar.set_orientation"><code class="methodname">set_orientation</code>()</a>
method for information about the orientation values.</p></div><div class="refsect2" title="gtk.ProgressBar.set_ellipsize"><a name="method-gtkprogressbar--set-ellipsize"></a><h3>gtk.ProgressBar.set_ellipsize</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_ellipsize</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>mode</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>mode</code></strong> :</span></p></td><td>one of the <a class="xref" href="pango-constants.html#pango-ellipsize-mode-constants" title="Pango Ellipsize Mode Constants">Pango Ellipsize Mode Constants</a></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">set_ellipsize</code>() method sets the
mode used to ellipsize (add an ellipsis "...") the text if there is not
enough space to render the entire string to the value specified by
<em class="parameter"><code>mode</code></em>. <em class="parameter"><code>mode</code></em> must be one of the
<a class="xref" href="pango-constants.html#pango-ellipsize-mode-constants" title="Pango Ellipsize Mode Constants">Pango Ellipsize Mode Constants</a></p></div><div class="refsect2" title="gtk.ProgressBar.get_ellipsize"><a name="method-gtkprogressbar--get-ellipsize"></a><h3>gtk.ProgressBar.get_ellipsize</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_ellipsize</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the mode used to ellipsize
text</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">get_ellipsize</code>() method returns the
mode used to ellipsize text when there is not enough space. See the <a class="link" href="class-gtkprogressbar.html#method-gtkprogressbar--set-ellipsize" title="gtk.ProgressBar.set_ellipsize"><code class="methodname">set_ellipsize</code>()</a>
method for information.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkprintsettings.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkradioaction.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.PrintSettings </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.RadioAction</td></tr></table></div></body></html>
|