1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.EventBox</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-gtkentrycompletion.html" title="gtk.EntryCompletion"><link rel="next" href="class-gtkexpander.html" title="gtk.Expander"></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.EventBox</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkentrycompletion.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkexpander.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkeventbox"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.EventBox</h2><p>gtk.EventBox — a widget used to catch events for widgets which do not have
2
their own window.</p></div><div class="refsect1" lang="en"><a name="id3489262"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.EventBox</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a></span></span>):
3
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkeventbox.html#constructor-gtkeventbox" title="Constructor">gtk.EventBox</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkeventbox.html#method-gtkeventbox--get-visible-window" title="gtk.EventBox.get_visible_window">get_visible_window</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkeventbox.html#method-gtkeventbox--set-visible-window" title="gtk.EventBox.set_visible_window">set_visible_window</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>visible_window</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkeventbox.html#method-gtkeventbox--get-above-child" title="gtk.EventBox.get_above_child">get_above_child</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkeventbox.html#method-gtkeventbox--set-above-child" title="gtk.EventBox.set_above_child">set_above_child</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>above_child</code></em></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3489403"></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.EventBox</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-gtkentrycompletion.html" title="gtk.EntryCompletion"><link rel="next" href="class-gtkexpander.html" title="gtk.Expander"></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.EventBox</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkentrycompletion.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkexpander.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.EventBox"><a name="class-gtkeventbox"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.EventBox</h2><p>gtk.EventBox — a widget used to catch events for widgets which do not have
2
their own window.</p></div><div class="refsect1" title="Synopsis"><a name="id3799032"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.EventBox</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a></span></span>):
3
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkeventbox.html#constructor-gtkeventbox" title="Constructor">gtk.EventBox</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkeventbox.html#method-gtkeventbox--get-visible-window" title="gtk.EventBox.get_visible_window">get_visible_window</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkeventbox.html#method-gtkeventbox--set-visible-window" title="gtk.EventBox.set_visible_window">set_visible_window</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>visible_window</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkeventbox.html#method-gtkeventbox--get-above-child" title="gtk.EventBox.get_above_child">get_above_child</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkeventbox.html#method-gtkeventbox--set-above-child" title="gtk.EventBox.set_above_child">set_above_child</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>above_child</code></em></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3799173"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
4
4
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
5
5
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
6
6
+-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
7
7
+-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
8
8
+-- <a class="link" href="class-gtkeventbox.html" title="gtk.EventBox">gtk.EventBox</a>
9
</pre></div><div class="refsect1" lang="en"><a name="id3489454"></a><h2>Implemented Interfaces</h2><p>
9
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3799224"></a><h2>Implemented Interfaces</h2><p>
10
10
<a class="link" href="class-gtkeventbox.html" title="gtk.EventBox"><code class="classname">gtk.EventBox</code></a>
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-gtkeventbox"></a><h2>gtk.EventBox 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><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">"above-child"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, the event-trapping window
13
</p></div><div class="refsect1" title="gtk.EventBox Properties"><a name="properties-gtkeventbox"></a><h2>gtk.EventBox 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><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">"above-child"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, the event-trapping window
14
14
of the eventbox is above the window of the child widget as
15
15
opposed to below it. Available in GTK+ 2.4 and above.</td></tr><tr valign="top"><td valign="top">"visible-window"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, the event box is visible,
16
16
as opposed to invisible and only used to trap
17
events. Available in GTK+ 2.4 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="style-properties-gtkeventbox"></a><h2>gtk.EventBox 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><div class="refsect1" lang="en"><a name="signal-prototypes-gtkeventbox"></a><h2>gtk.EventBox 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></div><div class="refsect1" lang="en"><a name="id3489674"></a><h2>Description</h2><p>The <a class="link" href="class-gtkeventbox.html" title="gtk.EventBox"><code class="classname">gtk.EventBox</code></a>
17
events. Available in GTK+ 2.4 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.EventBox Style Properties"><a name="style-properties-gtkeventbox"></a><h2>gtk.EventBox 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><div class="refsect1" title="gtk.EventBox Signal Prototypes"><a name="signal-prototypes-gtkeventbox"></a><h2>gtk.EventBox 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></div><div class="refsect1" title="Description"><a name="id3799444"></a><h2>Description</h2><p>The <a class="link" href="class-gtkeventbox.html" title="gtk.EventBox"><code class="classname">gtk.EventBox</code></a>
18
18
widget is an invisible container widget that provides a window for widgets
19
19
that do not have their own window. In GTK, widgets must have a window to be
20
20
able to receive event signals. Those widgets that are "windowless" can use a
21
21
<a class="link" href="class-gtkeventbox.html" title="gtk.EventBox"><code class="classname">gtk.EventBox</code></a>
22
to receive event signals.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkeventbox"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.EventBox</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>an eventbox widget</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkeventbox.html" title="gtk.EventBox"><code class="classname">gtk.EventBox</code></a>
23
widget.</p></div><div class="refsect1" lang="en"><a name="id3489766"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkeventbox--get-visible-window"></a><h3>gtk.EventBox.get_visible_window</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_visible_window</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 the event box window is
24
visible.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">gtk_visible_window</code>() method returns
22
to receive event signals.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkeventbox"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.EventBox</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>an eventbox widget</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkeventbox.html" title="gtk.EventBox"><code class="classname">gtk.EventBox</code></a>
23
widget.</p></div><div class="refsect1" title="Methods"><a name="id3799536"></a><h2>Methods</h2><div class="refsect2" title="gtk.EventBox.get_visible_window"><a name="method-gtkeventbox--get-visible-window"></a><h3>gtk.EventBox.get_visible_window</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_visible_window</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 the event box window is
24
visible.</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.4 and above.</p></div><p>The <code class="methodname">gtk_visible_window</code>() method returns
25
25
<code class="literal">True</code> if the event box has a visible window. See the <a class="link" href="class-gtkeventbox.html#method-gtkeventbox--set-visible-window" title="gtk.EventBox.set_visible_window"><code class="methodname">set_visible_window()</code></a> method
26
for details.</p></div><div class="refsect2" lang="en"><a name="method-gtkeventbox--set-visible-window"></a><h3>gtk.EventBox.set_visible_window</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_visible_window</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>visible_window</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>visible_window</code></em> :</span></p></td><td>if <code class="literal">True</code> the event box window is
27
visible.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_visible_window</code>() method sets
26
for details.</p></div><div class="refsect2" title="gtk.EventBox.set_visible_window"><a name="method-gtkeventbox--set-visible-window"></a><h3>gtk.EventBox.set_visible_window</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_visible_window</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>visible_window</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>visible_window</code></em> :</span></p></td><td>if <code class="literal">True</code> the event box window is
27
visible.</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.4 and above.</p></div><p>The <code class="methodname">set_visible_window</code>() method sets
28
28
whether the event box uses a visible or invisible child window according to
29
29
the value specified by <em class="parameter"><code>visible_window</code></em>. If
30
30
<em class="parameter"><code>visible_window</code></em> is <code class="literal">True</code> the event
37
37
want to trap events. Creating a visible window may cause artifacts that are
38
38
visible to the user, especially if the user is using a theme with gradients
39
39
or pixmaps. The main reason to create a non input-only event box is if you
40
want to set the background to a different color or draw on it.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>There is one unexpected issue for an invisible event box that
40
want to set the background to a different color or draw on it.</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>There is one unexpected issue for an invisible event box that
41
41
has its window below the child. (See the <a class="link" href="class-gtkeventbox.html#method-gtkeventbox--set-above-child" title="gtk.EventBox.set_above_child"><code class="methodname">set_above_child()</code></a>
42
42
method.) Since the input-only window is not an ancestor window of any
43
43
windows that descendant widgets of the event box create, events on these
46
46
descendant window (see the <a class="link" href="class-gtkwidget.html#method-gtkwidget--add-events" title="gtk.Widget.add_events"><code class="methodname">gtk.Widget.add_events()</code></a>
47
47
method), it won't be received by the event box.</p><p> This problem doesn't occur for visible event boxes, because
48
48
the event box window is actually the ancestor of the descendant windows, not
49
just at the same place on the screen.</p></div></div><div class="refsect2" lang="en"><a name="method-gtkeventbox--get-above-child"></a><h3>gtk.EventBox.get_above_child</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_above_child</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 the event box window is
50
above the window of its child.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_above_child</code>() method returns
49
just at the same place on the screen.</p></div></div><div class="refsect2" title="gtk.EventBox.get_above_child"><a name="method-gtkeventbox--get-above-child"></a><h3>gtk.EventBox.get_above_child</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_above_child</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 the event box window is
50
above the window of its child.</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.4 and above.</p></div><p>The <code class="methodname">get_above_child</code>() method returns
51
51
the value of the "above-child" property that indicates whether the event box
52
52
window is above or below the windows of its child. See the <a class="link" href="class-gtkeventbox.html#method-gtkeventbox--set-above-child" title="gtk.EventBox.set_above_child"><code class="methodname">set_above_child()</code></a>
53
method for details.</p></div><div class="refsect2" lang="en"><a name="method-gtkeventbox--set-above-child"></a><h3>gtk.EventBox.set_above_child</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_above_child</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>above_child</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>above_child</code></em> :</span></p></td><td>if <code class="literal">True</code> the event box window is
54
above the windows of its child</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_above_child</code>() method sets the
53
method for details.</p></div><div class="refsect2" title="gtk.EventBox.set_above_child"><a name="method-gtkeventbox--set-above-child"></a><h3>gtk.EventBox.set_above_child</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_above_child</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>above_child</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>above_child</code></em> :</span></p></td><td>if <code class="literal">True</code> the event box window is
54
above the windows of its child</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.4 and above.</p></div><p>The <code class="methodname">set_above_child</code>() method sets the
55
55
"above-child" property to the value of
56
56
<em class="parameter"><code>above_child</code></em>. If <em class="parameter"><code>above_child</code></em> is
57
57
<code class="literal">True</code>, the event box window is positioned above the
added
removed
docs/html/class-gtkeventbox.html
