Gtk.EventBox

g Atk.ImplementorIface Atk.ImplementorIface Gtk.Widget Gtk.Widget Atk.ImplementorIface->Gtk.Widget GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Gtk.Widget GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.Bin Gtk.Bin Gtk.EventBox Gtk.EventBox Gtk.Bin->Gtk.EventBox Gtk.Buildable->Gtk.Widget Gtk.Container Gtk.Container Gtk.Container->Gtk.Bin Gtk.Widget->Gtk.Container

Subclasses:None

Properties

Inherited:Gtk.Container (3), Gtk.Widget (39)
Name Type Flags Short Description
above-child bool r/w/en Whether the event-trapping window of the eventbox is above the window of the child widget as opposed to below it.
visible-window bool r/w/en Whether the event box is visible, as opposed to invisible and only used to trap events.

Style Properties

Inherited:Gtk.Widget (17)

Fields

Inherited:Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)
Name Type Access Description
bin Gtk.Bin r  

Class Details

class Gtk.EventBox(**kwargs)
Bases:Gtk.Bin
Abstract:No
Structure:Gtk.EventBoxClass

The Gtk.EventBox widget is a subclass of Gtk.Bin which also has its own window. It is useful since it allows you to catch events for widgets which do not have their own window.

classmethod new()[source]
Returns:a new Gtk.EventBox
Return type:Gtk.Widget

Creates a new Gtk.EventBox.

get_above_child()[source]
Returns:True if the event box window is above the window of its child
Return type:bool

Returns whether the event box window is above or below the windows of its child. See Gtk.EventBox.set_above_child() for details.

New in version 2.4.

get_visible_window()[source]
Returns:True if the event box window is visible
Return type:bool

Returns whether the event box has a visible window. See Gtk.EventBox.set_visible_window() for details.

New in version 2.4.

set_above_child(above_child)[source]
Parameters:above_child (bool) – True if the event box window is above its child

Set whether the event box window is positioned above the windows of its child, as opposed to 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.

New in version 2.4.

set_visible_window(visible_window)[source]
Parameters:visible_window (bool) – True to make the event box have a visible window

Set whether the event box uses a visible or invisible child window. The default is to use visible windows.

In an invisible window event box, the window that the event box creates is a Gdk.WindowWindowClass.INPUT_ONLY window, which means that it is invisible and only serves to receive events.

A visible window event box creates a visible (Gdk.WindowWindowClass.INPUT_OUTPUT) window that acts as the parent window for all the widgets contained in the event box.

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.

There is one unexpected issue for an invisible event box that has its window below the child. (See Gtk.EventBox.set_above_child().) Since the input-only window is not an ancestor window of any windows that descendent 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 Gtk.Widget.add_events()), it won’t be received by the event box.

This problem doesn’t occur for visible event boxes, because in that case, the event box window is actually the ancestor of the descendant windows, not just at the same place on the screen.

New in version 2.4.

Property Details

Gtk.EventBox.props.above_child
Name:above-child
Type:bool
Default Value:False
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the event-trapping window of the eventbox is above the window of the child widget as opposed to below it.

Gtk.EventBox.props.visible_window
Name:visible-window
Type:bool
Default Value:True
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the event box is visible, as opposed to invisible and only used to trap events.