/usr/share/gtk-doc/html/pygtk/class-gtkeventbox.html is in python-gtk2-doc 2.24.0-5.1ubuntu2.
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 | <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.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-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
their own window.</p></div><div class="refsect1" title="Synopsis"><a name="id3694621"></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>):
<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="id3694762"></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>
+-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
+-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
+-- <a class="link" href="class-gtkeventbox.html" title="gtk.EventBox">gtk.EventBox</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3694813"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkeventbox.html" title="gtk.EventBox"><code class="classname">gtk.EventBox</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.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
of the eventbox is above the window of the child widget as
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,
as opposed to invisible and only used to trap
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="id3695032"></a><h2>Description</h2><p>The <a class="link" href="class-gtkeventbox.html" title="gtk.EventBox"><code class="classname">gtk.EventBox</code></a>
widget is an invisible container widget that provides a window for widgets
that do not have their own window. In GTK, widgets must have a window to be
able to receive event signals. Those widgets that are "windowless" can use a
<a class="link" href="class-gtkeventbox.html" title="gtk.EventBox"><code class="classname">gtk.EventBox</code></a>
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>
widget.</p></div><div class="refsect1" title="Methods"><a name="id3695124"></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
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
<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
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
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
whether the event box uses a visible or invisible child window according to
the value specified by <em class="parameter"><code>visible_window</code></em>. If
<em class="parameter"><code>visible_window</code></em> is <code class="literal">True</code> the event
box uses a visible child window; otherwise, an invisible child window. The
default is to use visible windows.</p><p>In an invisible window event box, the window that that the event
box creates is a <code class="literal">gtk.gdk.INPUT_ONLY</code> window, that is
invisible and only serves to receive events. A visible window event box
creates a visible (<code class="literal">gtk.gdk.INPUT_OUTPUT</code>) window that acts
as the parent window for all the widgets contained in the event box.</p><p>You should generally make your event box invisible if you just
want to trap events. Creating a visible window may cause artifacts that are
visible to the user, especially if the user is using a theme with gradients
or pixmaps. The main reason to create a non input-only event box is if you
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
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>
method.) Since the input-only window is not an ancestor window of any
windows that descendant widgets of the event box create, events on these
windows aren't propagated up by the windowing system, but only by GTK+. The
practical effect of this is if an event isn't in the event mask for the
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>
method), it won't be received by the event box.</p><p> This problem doesn't occur for visible event boxes, because
the event box window is actually the ancestor of the descendant windows, not
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
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
the value of the "above-child" property that indicates whether the event box
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>
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
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
"above-child" property to the value of
<em class="parameter"><code>above_child</code></em>. If <em class="parameter"><code>above_child</code></em> is
<code class="literal">True</code>, the event box window is positioned above the
windows of its child; otherwise, below it. If the window is above, all
events inside the event box will go to the event box. If the window is
below, events in windows of child widgets will first got to that widget, and
then to its parents. The default is to keep the window below the child.</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-gtkentrycompletion.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-gtkexpander.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.EntryCompletion </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.Expander</td></tr></table></div></body></html>
|