gi-gtk-3.0.31: Gtk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.EventController

Contents

Description

EventController is a base, low-level implementation for event controllers. Those react to a series of GdkEvents, and possibly trigger actions as a consequence of those.

Synopsis

Exported types

newtype EventController Source #

Memory-managed wrapper type.

class (GObject o, IsDescendantOf EventController o) => IsEventController o Source #

Type class for types which can be safely cast to EventController, for instance with toEventController.

toEventController :: (MonadIO m, IsEventController o) => o -> m EventController Source #

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

Methods

getPropagationPhase

eventControllerGetPropagationPhase Source #

Arguments

:: (HasCallStack, MonadIO m, IsEventController a) 
=> a

controller: a EventController

-> m PropagationPhase

Returns: the propagation phase

Gets the propagation phase at which controller handles events.

Since: 3.14

getWidget

eventControllerGetWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsEventController a) 
=> a

controller: a EventController

-> m Widget

Returns: a Widget

Returns the Widget this controller relates to.

Since: 3.14

handleEvent

eventControllerHandleEvent Source #

Arguments

:: (HasCallStack, MonadIO m, IsEventController a) 
=> a

controller: a EventController

-> Event

event: a Event

-> m Bool

Returns: True if the event was potentially useful to trigger the controller action

Feeds an events into controller, so it can be interpreted and the controller actions triggered.

Since: 3.14

reset

eventControllerReset Source #

Arguments

:: (HasCallStack, MonadIO m, IsEventController a) 
=> a

controller: a EventController

-> m () 

Resets the controller to a clean state. Every interaction the controller did through EventController::handle-event will be dropped at this point.

Since: 3.14

setPropagationPhase

eventControllerSetPropagationPhase Source #

Arguments

:: (HasCallStack, MonadIO m, IsEventController a) 
=> a

controller: a EventController

-> PropagationPhase

phase: a propagation phase

-> m () 

Sets the propagation phase at which a controller handles events.

If phase is PropagationPhaseNone, no automatic event handling will be performed, but other additional gesture maintenance will. In that phase, the events can be managed by calling eventControllerHandleEvent.

Since: 3.14

Properties

propagationPhase

The propagation phase at which this controller will handle events.

Since: 3.14

constructEventControllerPropagationPhase :: IsEventController o => PropagationPhase -> IO (GValueConstruct o) Source #

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

getEventControllerPropagationPhase :: (MonadIO m, IsEventController o) => o -> m PropagationPhase Source #

Get the value of the “propagation-phase” property. When overloading is enabled, this is equivalent to

get eventController #propagationPhase

setEventControllerPropagationPhase :: (MonadIO m, IsEventController o) => o -> PropagationPhase -> m () Source #

Set the value of the “propagation-phase” property. When overloading is enabled, this is equivalent to

set eventController [ #propagationPhase := value ]

widget

The widget receiving the GdkEvents that the controller will handle.

Since: 3.14

constructEventControllerWidget :: (IsEventController o, IsWidget a) => a -> IO (GValueConstruct o) Source #

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

getEventControllerWidget :: (MonadIO m, IsEventController o) => o -> m Widget Source #

Get the value of the “widget” property. When overloading is enabled, this is equivalent to

get eventController #widget