GI.Gtk.Objects.EventController

GtkEventController is the base class for event controllers.

These are ancillary objects associated to widgets, which react to GdkEvents, and possibly trigger actions as a consequence.

Event controllers are added to a widget with widgetAddController. It is rarely necessary to explicitly remove a controller with widgetRemoveController.

See the chapter on input handling for an overview of the basic concepts, such as the capture and bubble phases of event propagation.

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

GObject EventController

Defined in GI.Gtk.Objects.EventController

ManagedPtrNewtype EventController

Defined in GI.Gtk.Objects.EventController

Methods

toManagedPtr :: EventController -> ManagedPtr EventController

TypedObject EventController

Defined in GI.Gtk.Objects.EventController

Methods

glibType :: IO GType

HasParentTypes EventController

Defined in GI.Gtk.Objects.EventController

IsGValue (Maybe EventController)

Convert EventController to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.EventController

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe EventController -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe 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.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, reset, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getCurrentEvent, getCurrentEventDevice, getCurrentEventState, getCurrentEventTime, getData, getName, getPropagationLimit, getPropagationPhase, getProperty, getQdata, getWidget.

Setters

setData, setDataFull, setName, setPropagationLimit, setPropagationPhase, setProperty, setStaticName.

getCurrentEvent

eventControllerGetCurrentEvent

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> m (Maybe Event)

Returns: the event that is currently handled by controller

Returns the event that is currently being handled by the controller.

At other times, Nothing is returned.

getCurrentEventDevice

eventControllerGetCurrentEventDevice

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> m (Maybe Device)

Returns: device of the event is currently handled by controller

Returns the device of the event that is currently being handled by the controller.

At other times, Nothing is returned.

getCurrentEventState

eventControllerGetCurrentEventState

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> m [ModifierType]

Returns: modifier state of the event is currently handled by controller

Returns the modifier state of the event that is currently being handled by the controller.

At other times, 0 is returned.

getCurrentEventTime

eventControllerGetCurrentEventTime

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> m Word32

Returns: timestamp of the event is currently handled by controller

Returns the timestamp of the event that is currently being handled by the controller.

At other times, 0 is returned.

getName

eventControllerGetName

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> m (Maybe Text)

Returns: The controller name

Gets the name of controller.

getPropagationLimit

eventControllerGetPropagationLimit

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> m PropagationLimit

Returns: the propagation limit

Gets the propagation limit of the event controller.

getPropagationPhase

eventControllerGetPropagationPhase

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> m PropagationPhase

Returns: the propagation phase

Gets the propagation phase at which controller handles events.

getWidget

eventControllerGetWidget

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> m Widget

Returns: a GtkWidget

Returns the GtkWidget this controller relates to.

reset

eventControllerReset

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> m ()

Resets the controller to a clean state.

setName

eventControllerSetName

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> Maybe Text

name: a name for controller

-> m ()

Sets a name on the controller that can be used for debugging.

setPropagationLimit

eventControllerSetPropagationLimit

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> PropagationLimit

limit: the propagation limit

-> m ()

Sets the event propagation limit on the event controller.

If the limit is set to PropagationLimitSameNative, the controller won't handle events that are targeted at widgets on a different surface, such as popovers.

setPropagationPhase

eventControllerSetPropagationPhase

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> 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.

setStaticName

eventControllerSetStaticName

Arguments

:: (HasCallStack, MonadIO m, IsEventController a)

=> a

controller: a GtkEventController

-> Maybe Text

name: a name for controller, must be a static string

-> m ()

Sets a name on the controller that can be used for debugging.

Since: 4.8

Properties

name

The name for this controller, typically used for debugging purposes.

clearEventControllerName :: (MonadIO m, IsEventController o) => o -> m ()

Set the value of the “name” property to Nothing. When overloading is enabled, this is equivalent to

clear #name

constructEventControllerName :: (IsEventController o, MonadIO m) => Text -> m (GValueConstruct o)

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

getEventControllerName :: (MonadIO m, IsEventController o) => o -> m (Maybe Text)

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

get eventController #name

setEventControllerName :: (MonadIO m, IsEventController o) => o -> Text -> m ()

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

set eventController [ #name := value ]

propagationLimit

The limit for which events this controller will handle.

constructEventControllerPropagationLimit :: (IsEventController o, MonadIO m) => PropagationLimit -> m (GValueConstruct o)

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

getEventControllerPropagationLimit :: (MonadIO m, IsEventController o) => o -> m PropagationLimit

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

get eventController #propagationLimit

setEventControllerPropagationLimit :: (MonadIO m, IsEventController o) => o -> PropagationLimit -> m ()

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

set eventController [ #propagationLimit := value ]

propagationPhase

The propagation phase at which this controller will handle events.

constructEventControllerPropagationPhase :: (IsEventController o, MonadIO m) => PropagationPhase -> m (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.

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