gi-gtk-4.0.4: Gtk bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gtk.Objects.EventControllerMotion

Description

EventControllerMotion is an event controller meant for situations where you need to track the position of the pointer.

Synopsis

Exported types

newtype EventControllerMotion Source #

Memory-managed wrapper type.

Constructors

EventControllerMotion (ManagedPtr EventControllerMotion) 

class (GObject o, IsDescendantOf EventControllerMotion o) => IsEventControllerMotion o Source #

Type class for types which can be safely cast to EventControllerMotion, for instance with toEventControllerMotion.

Instances

Instances details
(GObject o, IsDescendantOf EventControllerMotion o) => IsEventControllerMotion o Source # 
Instance details

Defined in GI.Gtk.Objects.EventControllerMotion

toEventControllerMotion :: (MonadIO m, IsEventControllerMotion o) => o -> m EventControllerMotion Source #

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

Methods

containsPointer

eventControllerMotionContainsPointer Source #

Arguments

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

self: a EventControllerMotion

-> m Bool

Returns: True if a pointer is within self or one of its children

Returns the value of the GtkEventControllerMotion:contains-pointer property.

isPointer

eventControllerMotionIsPointer Source #

Arguments

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

self: a EventControllerMotion

-> m Bool

Returns: True if a pointer is within self but not one of its children

Returns the value of the GtkEventControllerMotion:is-pointer property.

new

eventControllerMotionNew Source #

Creates a new event controller that will handle motion events.

Properties

containsPointer

Whether the pointer is in the controllers widget or a descendant. See also EventControllerMotion:is-pointer.

When handling crossing events, this property is updated before enter but after leave is emitted.

getEventControllerMotionContainsPointer :: (MonadIO m, IsEventControllerMotion o) => o -> m Bool Source #

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

get eventControllerMotion #containsPointer

isPointer

Whether the pointer is in the controllers widget itself, as opposed to in a descendent widget. See also EventControllerMotion:contains-pointer.

When handling crossing events, this property is updated before enter but after leave is emitted.

getEventControllerMotionIsPointer :: (MonadIO m, IsEventControllerMotion o) => o -> m Bool Source #

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

get eventControllerMotion #isPointer

Signals

enter

type C_EventControllerMotionEnterCallback = Ptr () -> CDouble -> CDouble -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type EventControllerMotionEnterCallback Source #

Arguments

 = Double

x: coordinates of pointer location

-> Double

y: coordinates of pointer location

-> IO () 

Signals that the pointer has entered the widget.

afterEventControllerMotionEnter :: (IsEventControllerMotion a, MonadIO m) => a -> EventControllerMotionEnterCallback -> m SignalHandlerId Source #

Connect a signal handler for the enter signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after eventControllerMotion #enter callback

onEventControllerMotionEnter :: (IsEventControllerMotion a, MonadIO m) => a -> EventControllerMotionEnterCallback -> m SignalHandlerId Source #

Connect a signal handler for the enter signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on eventControllerMotion #enter callback

leave

type C_EventControllerMotionLeaveCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type EventControllerMotionLeaveCallback = IO () Source #

Signals that the pointer has left the widget.

afterEventControllerMotionLeave :: (IsEventControllerMotion a, MonadIO m) => a -> EventControllerMotionLeaveCallback -> m SignalHandlerId Source #

Connect a signal handler for the leave signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after eventControllerMotion #leave callback

onEventControllerMotionLeave :: (IsEventControllerMotion a, MonadIO m) => a -> EventControllerMotionLeaveCallback -> m SignalHandlerId Source #

Connect a signal handler for the leave signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on eventControllerMotion #leave callback

motion

type C_EventControllerMotionMotionCallback = Ptr () -> CDouble -> CDouble -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type EventControllerMotionMotionCallback Source #

Arguments

 = Double

x: the x coordinate

-> Double

y: the y coordinate

-> IO () 

Emitted when the pointer moves inside the widget.

afterEventControllerMotionMotion :: (IsEventControllerMotion a, MonadIO m) => a -> EventControllerMotionMotionCallback -> m SignalHandlerId Source #

Connect a signal handler for the motion signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after eventControllerMotion #motion callback

onEventControllerMotionMotion :: (IsEventControllerMotion a, MonadIO m) => a -> EventControllerMotionMotionCallback -> m SignalHandlerId Source #

Connect a signal handler for the motion signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on eventControllerMotion #motion callback