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

Memory-managed wrapper type.

Constructors

EventController (ManagedPtr EventController)

Instances

Eq EventController

Defined in GI.Gtk.Objects.EventController

Methods

(==) :: EventController -> EventController -> Bool

(/=) :: EventController -> EventController -> Bool

IsGValue EventController

Convert EventController to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.EventController

Methods

toGValue :: EventController -> IO GValue

fromGValue :: GValue -> IO EventController

GObject EventController

Defined in GI.Gtk.Objects.EventController

Methods

gobjectType :: IO GType

HasParentTypes EventController

Defined in GI.Gtk.Objects.EventController

type ParentTypes EventController

Defined in GI.Gtk.Objects.EventController

type ParentTypes EventController = '[Object]

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

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

Instances

(GObject o, IsDescendantOf EventController o) => IsEventController o

Defined in GI.Gtk.Objects.EventController

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

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

noEventController :: Maybe EventController

A convenience alias for Nothing :: Maybe EventController.

Methods

Overloaded 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

The propagation phase at which this controller will handle events.

Since: 3.14

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

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

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 ()

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)

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

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

get eventController #widget