GI.Gtk.Objects.EventController

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.

Exported types

newtype EventController

Constructors

EventController (ManagedPtr EventController)

Instances

GObject EventController

Methods

gobjectType :: EventController -> IO GType

IsObject EventController

IsEventController EventController

class GObject o => IsEventController o

Instances

(GObject a, UnknownAncestorError Constraint EventController a) => IsEventController a

IsEventController GestureSingle

IsEventController GestureDrag

IsEventController Gesture

IsEventController EventController

IsEventController GestureLongPress

IsEventController GestureMultiPress

IsEventController GestureRotate

IsEventController GestureSwipe

IsEventController GestureZoom

IsEventController GesturePan

IsEventController PadController

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

noEventController :: Maybe EventController

Methods

getPropagationPhase

eventControllerGetPropagationPhase

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

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

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

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

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

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

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

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

widget

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

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