~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

« back to all changes in this revision

Viewing changes to docs/html/class-gtkstatusbar.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-01-07 11:08:47 UTC
  • mfrom: (1.2.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20100107110847-f5av7e1ttudh7ra6
Tags: 2.17.0-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Statusbar</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" 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-gtkspinbutton.html" title="gtk.SpinButton"><link rel="next" href="class-gtkstatusicon.html" title="gtk.StatusIcon"></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.Statusbar</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkspinbutton.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkstatusicon.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkstatusbar"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">gtk.Statusbar</span></h2><p>gtk.Statusbar — report messages of minor importance to the user.</p></div><div class="refsect1" lang="en"><a name="id3690273"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Statusbar</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkhbox.html" title="gtk.HBox">gtk.HBox</a></span></span>):
2
 
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gtkstatusbar.html#constructor-gtkstatusbar" title="Constructor">gtk.Statusbar</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--get-context-id" title="gtk.Statusbar.get_context_id">get_context_id</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_description</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--push" title="gtk.Statusbar.push">push</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</code></strong></span></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-gtkstatusbar.html#method-gtkstatusbar--pop" title="gtk.Statusbar.pop">pop</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--remove-message" title="gtk.Statusbar.remove_message">remove_message</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>message_id</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--remove" title="gtk.Statusbar.remove">remove</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>message_id</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--set-has-resize-grip" title="gtk.Statusbar.set_has_resize_grip">set_has_resize_grip</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--get-has-resize-grip" title="gtk.Statusbar.get_has_resize_grip">get_has_resize_grip</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3690549"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Statusbar</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><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-gtkspinbutton.html" title="gtk.SpinButton"><link rel="next" href="class-gtkstatusicon.html" title="gtk.StatusIcon"></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.Statusbar</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkspinbutton.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkstatusicon.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.Statusbar"><a name="class-gtkstatusbar"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">gtk.Statusbar</span></h2><p>gtk.Statusbar — report messages of minor importance to the user.</p></div><div class="refsect1" title="Synopsis"><a name="id4000273"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Statusbar</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkhbox.html" title="gtk.HBox">gtk.HBox</a></span></span>):
 
2
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gtkstatusbar.html#constructor-gtkstatusbar" title="Constructor">gtk.Statusbar</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--get-context-id" title="gtk.Statusbar.get_context_id">get_context_id</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_description</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--push" title="gtk.Statusbar.push">push</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</code></strong></span></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-gtkstatusbar.html#method-gtkstatusbar--pop" title="gtk.Statusbar.pop">pop</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--remove-message" title="gtk.Statusbar.remove_message">remove_message</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>message_id</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--remove" title="gtk.Statusbar.remove">remove</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>message_id</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--set-has-resize-grip" title="gtk.Statusbar.set_has_resize_grip">set_has_resize_grip</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--get-has-resize-grip" title="gtk.Statusbar.get_has_resize_grip">get_has_resize_grip</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id4000549"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
3
3
  +-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
4
4
    +-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
5
5
      +-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
6
6
        +-- <a class="link" href="class-gtkbox.html" title="gtk.Box">gtk.Box</a>
7
7
          +-- <a class="link" href="class-gtkhbox.html" title="gtk.HBox">gtk.HBox</a>
8
8
            +-- <a class="link" href="class-gtkstatusbar.html" title="gtk.Statusbar">gtk.Statusbar</a>
9
 
</pre></div><div class="refsect1" lang="en"><a name="id3690606"></a><h2>Implemented Interfaces</h2><p>
 
9
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id4000606"></a><h2>Implemented Interfaces</h2><p>
10
10
                        <a class="link" href="class-gtkstatusbar.html" title="gtk.Statusbar"><code class="classname">gtk.Statusbar</code></a>
11
11
                        implements 
12
12
                        <a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
13
 
                </p></div><div class="refsect1" lang="en"><a name="properties-gtkstatusbar"></a><h2>gtk.Statusbar 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><a class="link" href="class-gtkcontainer.html#properties-gtkcontainer" title="gtk.Container Properties">gtk.Container Properties</a></p><p><a class="link" href="class-gtkbox.html#properties-gtkbox" title="gtk.Box Properties">gtk.Box 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><col><col></colgroup><tbody><tr valign="top"><td valign="top">"has-resize-grip"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, the statusbar has a grip
 
13
                </p></div><div class="refsect1" title="gtk.Statusbar Properties"><a name="properties-gtkstatusbar"></a><h2>gtk.Statusbar 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><a class="link" href="class-gtkcontainer.html#properties-gtkcontainer" title="gtk.Container Properties">gtk.Container Properties</a></p><p><a class="link" href="class-gtkbox.html#properties-gtkbox" title="gtk.Box Properties">gtk.Box 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">"has-resize-grip"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, the statusbar has a grip
14
14
              for resizing the toplevel window. Available in GTK+ 2.4 and
15
 
              above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="style-properties-gtkstatusbar"></a><h2>gtk.Statusbar 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><col><col></colgroup><tbody><tr valign="top"><td valign="top">"shadow-type"</td><td valign="top">Read</td><td valign="top">The style of bevel around the statusbar text</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="child-properties-gtkstatusbar"></a><h2>gtk.Statusbar Child Properties</h2><p><a class="link" href="class-gtkbox.html#child-properties-gtkbox" title="gtk.Box Child Properties">gtk.Box Child Properties</a></p></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkstatusbar"></a><h2>gtk.Statusbar 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><p><a class="link" href="class-gtkcontainer.html#signal-prototypes-gtkcontainer" title="gtk.Container Signal Prototypes">gtk.Container Signal Prototypes</a></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkstatusbar.html#signal-gtkstatusbar--text-popped" title='The "text-popped" gtk.Statusbar Signal'>text-popped</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>statusbar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context_id</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>text</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkstatusbar.html#signal-gtkstatusbar--text-pushed" title='The "text-pushed" gtk.Statusbar Signal'>text-pushed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>statusbar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context_id</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>text</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3691063"></a><h2>Description</h2><p>A <a class="link" href="class-gtkstatusbar.html" title="gtk.Statusbar"><code class="classname">gtk.Statusbar</code></a> is
 
15
              above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.Statusbar Style Properties"><a name="style-properties-gtkstatusbar"></a><h2>gtk.Statusbar 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">"shadow-type"</td><td valign="top">Read</td><td valign="top">The style of bevel around the statusbar text</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.Statusbar Child Properties"><a name="child-properties-gtkstatusbar"></a><h2>gtk.Statusbar Child Properties</h2><p><a class="link" href="class-gtkbox.html#child-properties-gtkbox" title="gtk.Box Child Properties">gtk.Box Child Properties</a></p></div><div class="refsect1" title="gtk.Statusbar Signal Prototypes"><a name="signal-prototypes-gtkstatusbar"></a><h2>gtk.Statusbar 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><p><a class="link" href="class-gtkcontainer.html#signal-prototypes-gtkcontainer" title="gtk.Container Signal Prototypes">gtk.Container Signal Prototypes</a></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkstatusbar.html#signal-gtkstatusbar--text-popped" title='The "text-popped" gtk.Statusbar Signal'>text-popped</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>statusbar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context_id</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>text</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkstatusbar.html#signal-gtkstatusbar--text-pushed" title='The "text-pushed" gtk.Statusbar Signal'>text-pushed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>statusbar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context_id</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>text</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" title="Description"><a name="id4001063"></a><h2>Description</h2><p>A <a class="link" href="class-gtkstatusbar.html" title="gtk.Statusbar"><code class="classname">gtk.Statusbar</code></a> is
16
16
usually placed along the bottom of an application's main <a class="link" href="class-gtkwindow.html" title="gtk.Window"><code class="classname">gtk.Window</code></a>. It may
17
17
provide a regular commentary of the application's status (as is usually the
18
18
case in a web browser, for example), or may be used to simply output a
29
29
retrieved using the context message using the <a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--get-context-id" title="gtk.Statusbar.get_context_id"><code class="methodname">get_context_id</code>()</a> 
30
30
method. Note that messages are stored in a stack, and when choosing which
31
31
message to display, the stack structure is adhered to, regardless of the
32
 
context identifier of a message.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkstatusbar"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.Statusbar</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-gtkstatusbar.html" title="gtk.Statusbar"><code class="classname">gtk.Statusbar</code></a>
 
32
context identifier of a message.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkstatusbar"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.Statusbar</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-gtkstatusbar.html" title="gtk.Statusbar"><code class="classname">gtk.Statusbar</code></a>
33
33
widget</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkstatusbar.html" title="gtk.Statusbar"><code class="classname">gtk.Statusbar</code></a>
34
 
widget.</p></div><div class="refsect1" lang="en"><a name="id3691214"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkstatusbar--get-context-id"></a><h3>gtk.Statusbar.get_context_id</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_context_id</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_description</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>context_description</code></strong> :</span></p></td><td>a string identifying the context for the
 
34
widget.</p></div><div class="refsect1" title="Methods"><a name="id4001214"></a><h2>Methods</h2><div class="refsect2" title="gtk.Statusbar.get_context_id"><a name="method-gtkstatusbar--get-context-id"></a><h3>gtk.Statusbar.get_context_id</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_context_id</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_description</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>context_description</code></strong> :</span></p></td><td>a string identifying the context for the
35
35
message</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an integer context
36
36
identifier</td></tr></tbody></table><p>The <code class="methodname">get_context_id</code>() method returns a
37
37
new or existing context identifier, given a description of the actual
38
38
context specified by <em class="parameter"><code>context_description</code></em>. In effect,
39
39
<code class="methodname">get_context_id</code>() both registers and retrieves a
40
 
context identifier.</p></div><div class="refsect2" lang="en"><a name="method-gtkstatusbar--push"></a><h3>gtk.Statusbar.push</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">push</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</code></strong></span></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>context_id</code></strong> :</span></p></td><td>a context identifier</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>text</code></strong> :</span></p></td><td>the message text</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an integer message
 
40
context identifier.</p></div><div class="refsect2" title="gtk.Statusbar.push"><a name="method-gtkstatusbar--push"></a><h3>gtk.Statusbar.push</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">push</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</code></strong></span></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>context_id</code></strong> :</span></p></td><td>a context identifier</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>text</code></strong> :</span></p></td><td>the message text</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an integer message
41
41
identifier</td></tr></tbody></table><p>The <code class="methodname">push</code>() method pushes a new message
42
42
specified by <em class="parameter"><code>text</code></em> with the specified
43
43
<em class="parameter"><code>context_id</code></em> onto a statusbar's stack and returns a
44
44
message id that that can be used with the <a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--remove-message" title="gtk.Statusbar.remove_message"><code class="methodname">remove_message</code>()</a>
45
 
method.</p></div><div class="refsect2" lang="en"><a name="method-gtkstatusbar--pop"></a><h3>gtk.Statusbar.pop</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">pop</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</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>context_id</code></strong> :</span></p></td><td>a context identifier</td></tr></tbody></table><p>The <code class="methodname">pop</code>() method removes the top
 
45
method.</p></div><div class="refsect2" title="gtk.Statusbar.pop"><a name="method-gtkstatusbar--pop"></a><h3>gtk.Statusbar.pop</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">pop</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</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>context_id</code></strong> :</span></p></td><td>a context identifier</td></tr></tbody></table><p>The <code class="methodname">pop</code>() method removes the top
46
46
message with the specified <em class="parameter"><code>context_id</code></em> from the
47
 
statusbar's stack.</p></div><div class="refsect2" lang="en"><a name="method-gtkstatusbar--remove-message"></a><h3>gtk.Statusbar.remove_message</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">remove_message</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>message_id</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>context_id</code></strong> :</span></p></td><td>the context identifier</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>message_id</code></strong> :</span></p></td><td>the message identifier</td></tr></tbody></table><p>The <code class="methodname">remove_message</code>() method removes the message
 
47
statusbar's stack.</p></div><div class="refsect2" title="gtk.Statusbar.remove_message"><a name="method-gtkstatusbar--remove-message"></a><h3>gtk.Statusbar.remove_message</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">remove_message</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context_id</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>message_id</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>context_id</code></strong> :</span></p></td><td>the context identifier</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>message_id</code></strong> :</span></p></td><td>the message identifier</td></tr></tbody></table><p>The <code class="methodname">remove_message</code>() method removes the message
48
48
with the specified <em class="parameter"><code>message_id</code></em> and
49
 
<em class="parameter"><code>context_id</code></em> from the statusbar's message stack.</p></div><div class="refsect2" lang="en"><a name="method-gtkstatusbar--remove"></a><h3>gtk.Statusbar.remove</h3><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated in PyGTK 2.18 and above</p></div><p>This method calls either
 
49
<em class="parameter"><code>context_id</code></em> from the statusbar's message stack.</p></div><div class="refsect2" title="gtk.Statusbar.remove"><a name="method-gtkstatusbar--remove"></a><h3>gtk.Statusbar.remove</h3><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated in PyGTK 2.18 and above</p></div><p>This method calls either
50
50
        <a class="link" href="class-gtkcontainer.html#method-gtkcontainer--remove" title="gtk.Container.remove">gtk.Container.remove</a>
51
51
        or <a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--remove-message" title="gtk.Statusbar.remove_message">gtk.Statusbar.remove_message</a>
52
52
        depending on parameters.  The second option is for compatibility only and will be
53
53
        eventually removed.  New code should use <code class="literal">remove</code> only to remove
54
54
        widgets (as in <code class="literal">gtk.Container</code> method).  To remove messages, use
55
55
        <a class="link" href="class-gtkstatusbar.html#method-gtkstatusbar--remove-message" title="gtk.Statusbar.remove_message">gtk.Statusbar.remove_message</a>
56
 
        directly.</p></div><div class="refsect2" lang="en"><a name="method-gtkstatusbar--set-has-resize-grip"></a><h3>gtk.Statusbar.set_has_resize_grip</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_has_resize_grip</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</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>setting</code></strong> :</span></p></td><td>if <code class="literal">True</code> a resize grip is
 
56
        directly.</p></div><div class="refsect2" title="gtk.Statusbar.set_has_resize_grip"><a name="method-gtkstatusbar--set-has-resize-grip"></a><h3>gtk.Statusbar.set_has_resize_grip</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_has_resize_grip</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</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>setting</code></strong> :</span></p></td><td>if <code class="literal">True</code> a resize grip is
57
57
displayed</td></tr></tbody></table><p>The <code class="methodname">set_has_resize_grip</code>() method sets
58
58
the internal "has_resize_grip" property to the value specified by
59
59
<em class="parameter"><code>setting</code></em>. If <em class="parameter"><code>setting</code></em> is
60
 
<code class="literal">True</code> a resize grip is displayed on the statusbar</p></div><div class="refsect2" lang="en"><a name="method-gtkstatusbar--get-has-resize-grip"></a><h3>gtk.Statusbar.get_has_resize_grip</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_has_resize_grip</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><code class="literal">True</code> if a resize grip is
 
60
<code class="literal">True</code> a resize grip is displayed on the statusbar</p></div><div class="refsect2" title="gtk.Statusbar.get_has_resize_grip"><a name="method-gtkstatusbar--get-has-resize-grip"></a><h3>gtk.Statusbar.get_has_resize_grip</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_has_resize_grip</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><code class="literal">True</code> if a resize grip is
61
61
displayed</td></tr></tbody></table><p>The <code class="methodname">get_has_resize_grip</code>() method
62
62
returns the value of the internal "has_resize_grip" property that determines
63
 
if a resize grip is displayed on the statusbar.</p></div></div><div class="refsect1" lang="en"><a name="id3691876"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkstatusbar--text-popped"></a><h3>The "text-popped" gtk.Statusbar Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>statusbar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context_id</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>text</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>statusbar</code></em> :</span></p></td><td>the statusbar that received the
 
63
if a resize grip is displayed on the statusbar.</p></div></div><div class="refsect1" title="Signals"><a name="id4001876"></a><h2>Signals</h2><div class="refsect2" title='The "text-popped" gtk.Statusbar Signal'><a name="signal-gtkstatusbar--text-popped"></a><h3>The "text-popped" gtk.Statusbar Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>statusbar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context_id</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>text</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>statusbar</code></em> :</span></p></td><td>the statusbar that received the
64
64
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>context_id</code></em> :</span></p></td><td>the context identifier of the top
65
65
message</td></tr><tr><td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td><td>the string containing the top message
66
66
text</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
69
69
any)</td></tr></tbody></table><p>The "text-popped" signal is emitted when a message is removed
70
70
from the statusbar message stack. Note the text and context_id are for the
71
71
top message on the statusbar stack not the message that was actually
72
 
removed.</p></div><div class="refsect2" lang="en"><a name="signal-gtkstatusbar--text-pushed"></a><h3>The "text-pushed" gtk.Statusbar Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>statusbar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context_id</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>text</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>statusbar</code></em> :</span></p></td><td>the statusbar that received the
 
72
removed.</p></div><div class="refsect2" title='The "text-pushed" gtk.Statusbar Signal'><a name="signal-gtkstatusbar--text-pushed"></a><h3>The "text-pushed" gtk.Statusbar Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>statusbar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>context_id</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>text</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>statusbar</code></em> :</span></p></td><td>the statusbar that received the
73
73
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>context_id</code></em> :</span></p></td><td>the context identifier of the message
74
74
added</td></tr><tr><td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td><td>the string containing the message
75
75
text</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified