gi-gtk-3.0.43: Gtk bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.EventBox

Contents

- Exported types
- Methods
  - getAboveChild
  - getVisibleWindow
  - new
  - setAboveChild
  - setVisibleWindow
- Properties
  - aboveChild
  - visibleWindow

Description

The `EventBox` widget is a subclass of `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.

Synopsis

- newtype EventBox = EventBox (ManagedPtr EventBox)
- class (GObject o, IsDescendantOf EventBox o) => IsEventBox o
- toEventBox :: (MonadIO m, IsEventBox o) => o -> m EventBox
- eventBoxGetAboveChild :: (HasCallStack, MonadIO m, IsEventBox a) => a -> m Bool
- eventBoxGetVisibleWindow :: (HasCallStack, MonadIO m, IsEventBox a) => a -> m Bool
- eventBoxNew :: (HasCallStack, MonadIO m) => m EventBox
- eventBoxSetAboveChild :: (HasCallStack, MonadIO m, IsEventBox a) => a -> Bool -> m ()
- eventBoxSetVisibleWindow :: (HasCallStack, MonadIO m, IsEventBox a) => a -> Bool -> m ()
- constructEventBoxAboveChild :: (IsEventBox o, MonadIO m) => Bool -> m (GValueConstruct o)
- getEventBoxAboveChild :: (MonadIO m, IsEventBox o) => o -> m Bool
- setEventBoxAboveChild :: (MonadIO m, IsEventBox o) => o -> Bool -> m ()
- constructEventBoxVisibleWindow :: (IsEventBox o, MonadIO m) => Bool -> m (GValueConstruct o)
- getEventBoxVisibleWindow :: (MonadIO m, IsEventBox o) => o -> m Bool
- setEventBoxVisibleWindow :: (MonadIO m, IsEventBox o) => o -> Bool -> m ()

# Exported types

newtype EventBox Source #

Memory-managed wrapper type.

Constructors

EventBox (ManagedPtr EventBox) |

#### Instances

Instances details

Eq EventBox Source # |
Instance details Defined in GI.Gtk.Objects.EventBox Methods (==) :: EventBox -> EventBox -> Bool Source # (/=) :: EventBox -> EventBox -> Bool Source #
GObject EventBox Source # |
Instance details Defined in GI.Gtk.Objects.EventBox
ManagedPtrNewtype EventBox Source # |
Instance details Defined in GI.Gtk.Objects.EventBox Methods toManagedPtr :: EventBox -> ManagedPtr EventBox Source #
TypedObject EventBox Source # |
Instance details Defined in GI.Gtk.Objects.EventBox Methods glibType :: IO GType Source #
HasParentTypes EventBox Source # |
Instance details Defined in GI.Gtk.Objects.EventBox
IsGValue (Maybe EventBox) Source # | Convert `EventBox` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.EventBox Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe EventBox -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe EventBox) Source #
type ParentTypes EventBox Source # |
Instance details Defined in GI.Gtk.Objects.EventBox type ParentTypes EventBox = '[Bin, Container, Widget, Object, ImplementorIface, Buildable]

class (GObject o, IsDescendantOf EventBox o) => IsEventBox o Source #

Type class for types which can be safely cast to `EventBox`, for instance with `toEventBox`.

#### Instances

Instances details

(GObject o, IsDescendantOf EventBox o) => IsEventBox o Source # |
Instance details Defined in GI.Gtk.Objects.EventBox

toEventBox :: (MonadIO m, IsEventBox o) => o -> m EventBox Source #

Cast to `EventBox`, for types for which this is known to be safe. For general casts, use `castTo`.

# Methods

### Click to display all available methods, including inherited ones

Expand

#### Methods

activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

#### Getters

getAboveChild, getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisibleWindow, getVisual, getWindow.

#### Setters

setAboveChild, setAccelPath, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisibleWindow, setVisual, setWindow.

## getAboveChild

eventBoxGetAboveChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsEventBox a) |
=> a | `eventBox`: a `EventBox`
-> m Bool | Returns: `True` if the event box window is above the window of its child

Returns whether the event box window is above or below the windows of its child. See `eventBoxSetAboveChild` for details.

Since: 2.4

## getVisibleWindow

eventBoxGetVisibleWindow Source #

Arguments

:: (HasCallStack, MonadIO m, IsEventBox a) |
=> a | `eventBox`: a `EventBox`
-> m Bool | Returns: `True` if the event box window is visible

Returns whether the event box has a visible window. See `eventBoxSetVisibleWindow` for details.

Since: 2.4

## new

eventBoxNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m EventBox | Returns: a new `EventBox`

Creates a new `EventBox`.

## setAboveChild

eventBoxSetAboveChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsEventBox a) |
=> a | `eventBox`: a `EventBox`
-> Bool | `aboveChild`: `True` if the event box window is above its child
-> m () |

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.

Since: 2.4

## setVisibleWindow

eventBoxSetVisibleWindow Source #

Arguments

:: (HasCallStack, MonadIO m, IsEventBox a) |
=> a | `eventBox`: a `EventBox`
-> Bool | `visibleWindow`: `True` to make the event box have a visible window
-> m () |

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 `WindowWindowClassInputOnly` window, which means that it is invisible and only serves to receive events.

A visible window event box creates a visible (`WindowWindowClassInputOutput`) 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 `eventBoxSetAboveChild`.) 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 `widgetAddEvents`), 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.

Since: 2.4

# Properties

## aboveChild

No description available in the introspection data.

constructEventBoxAboveChild :: (IsEventBox o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`above-child`” property. This is rarely needed directly, but it is used by `new`.

getEventBoxAboveChild :: (MonadIO m, IsEventBox o) => o -> m Bool Source #

Get the value of the “`above-child`” property. When overloading is enabled, this is equivalent to

    get eventBox #aboveChild

setEventBoxAboveChild :: (MonadIO m, IsEventBox o) => o -> Bool -> m () Source #

Set the value of the “`above-child`” property. When overloading is enabled, this is equivalent to

    set eventBox [ #aboveChild := value ]

## visibleWindow

No description available in the introspection data.

constructEventBoxVisibleWindow :: (IsEventBox o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`visible-window`” property. This is rarely needed directly, but it is used by `new`.

getEventBoxVisibleWindow :: (MonadIO m, IsEventBox o) => o -> m Bool Source #

Get the value of the “`visible-window`” property. When overloading is enabled, this is equivalent to

    get eventBox #visibleWindow

setEventBoxVisibleWindow :: (MonadIO m, IsEventBox o) => o -> Bool -> m () Source #

Set the value of the “`visible-window`” property. When overloading is enabled, this is equivalent to

    set eventBox [ #visibleWindow := value ]