GI.Gtk.Objects.DropControllerMotion

GtkDropControllerMotion is an event controller tracking the pointer during Drag-and-Drop operations.

It is modeled after EventControllerMotion so if you have used that, this should feel really familiar.

This controller is not able to accept drops, use DropTarget for that purpose.

Exported types

newtype DropControllerMotion

Memory-managed wrapper type.

Constructors

DropControllerMotion (ManagedPtr DropControllerMotion)

Instances

Eq DropControllerMotion

Defined in GI.Gtk.Objects.DropControllerMotion

Methods

(==) :: DropControllerMotion -> DropControllerMotion -> Bool

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

GObject DropControllerMotion

Defined in GI.Gtk.Objects.DropControllerMotion

ManagedPtrNewtype DropControllerMotion

Defined in GI.Gtk.Objects.DropControllerMotion

Methods

toManagedPtr :: DropControllerMotion -> ManagedPtr DropControllerMotion

TypedObject DropControllerMotion

Defined in GI.Gtk.Objects.DropControllerMotion

Methods

glibType :: IO GType

HasParentTypes DropControllerMotion

Defined in GI.Gtk.Objects.DropControllerMotion

IsGValue (Maybe DropControllerMotion)

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

Defined in GI.Gtk.Objects.DropControllerMotion

Methods

gvalueGType_ :: IO GType

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

gvalueGet_ :: Ptr GValue -> IO (Maybe DropControllerMotion)

type ParentTypes DropControllerMotion

Defined in GI.Gtk.Objects.DropControllerMotion

type ParentTypes DropControllerMotion = '[EventController, Object]

class (GObject o, IsDescendantOf DropControllerMotion o) => IsDropControllerMotion o

Type class for types which can be safely cast to DropControllerMotion, for instance with toDropControllerMotion.

Instances

(GObject o, IsDescendantOf DropControllerMotion o) => IsDropControllerMotion o

Defined in GI.Gtk.Objects.DropControllerMotion

toDropControllerMotion :: (MonadIO m, IsDropControllerMotion o) => o -> m DropControllerMotion

Cast to DropControllerMotion, 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, containsPointer, forceFloating, freezeNotify, getv, isFloating, isPointer, notify, notifyByPspec, ref, refSink, reset, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

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

Setters

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

containsPointer

dropControllerMotionContainsPointer

Arguments

:: (HasCallStack, MonadIO m, IsDropControllerMotion a)

=> a

self: a GtkDropControllerMotion

-> m Bool

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

Returns if a Drag-and-Drop operation is within the widget self or one of its children.

getDrop

dropControllerMotionGetDrop

Arguments

:: (HasCallStack, MonadIO m, IsDropControllerMotion a)

=> a

self: a GtkDropControllerMotion

-> m (Maybe Drop)

Returns: The GdkDrop currently happening within self

Returns the GdkDrop of a current Drag-and-Drop operation over the widget of self.

isPointer

dropControllerMotionIsPointer

Arguments

:: (HasCallStack, MonadIO m, IsDropControllerMotion a)

=> a

self: a GtkDropControllerMotion

-> m Bool

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

Returns if a Drag-and-Drop operation is within the widget self, not one of its children.

new

dropControllerMotionNew

Arguments

:: (HasCallStack, MonadIO m)

=> m DropControllerMotion

Returns: a new GtkDropControllerMotion

Creates a new event controller that will handle pointer motion events during drag and drop.

Properties

containsPointer

Whether the pointer of a Drag-and-Drop operation is in the controller's widget or a descendant.

See also DropControllerMotion:isPointer.

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

getDropControllerMotionContainsPointer :: (MonadIO m, IsDropControllerMotion o) => o -> m Bool

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

get dropControllerMotion #containsPointer

drop

The ongoing drop operation over the controller's widget or its descendant.

If no drop operation is going on, this property returns Nothing.

The event controller should not modify the drop, but it might want to query its properties.

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

getDropControllerMotionDrop :: (MonadIO m, IsDropControllerMotion o) => o -> m (Maybe Drop)

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

get dropControllerMotion #drop

isPointer

Whether the pointer is in the controllers widget itself, as opposed to in a descendent widget.

See also DropControllerMotion:containsPointer.

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

getDropControllerMotionIsPointer :: (MonadIO m, IsDropControllerMotion o) => o -> m Bool

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

get dropControllerMotion #isPointer

Signals

enter

type DropControllerMotionEnterCallback

Arguments

 = Double

x: coordinates of pointer location

-> Double

y: coordinates of pointer location

-> IO ()

Signals that the pointer has entered the widget.

afterDropControllerMotionEnter :: (IsDropControllerMotion a, MonadIO m) => a -> ((?self :: a) => DropControllerMotionEnterCallback) -> m SignalHandlerId

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

after dropControllerMotion #enter callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onDropControllerMotionEnter :: (IsDropControllerMotion a, MonadIO m) => a -> ((?self :: a) => DropControllerMotionEnterCallback) -> m SignalHandlerId

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

on dropControllerMotion #enter callback

leave

type DropControllerMotionLeaveCallback = IO ()

Signals that the pointer has left the widget.

afterDropControllerMotionLeave :: (IsDropControllerMotion a, MonadIO m) => a -> ((?self :: a) => DropControllerMotionLeaveCallback) -> m SignalHandlerId

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

after dropControllerMotion #leave callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onDropControllerMotionLeave :: (IsDropControllerMotion a, MonadIO m) => a -> ((?self :: a) => DropControllerMotionLeaveCallback) -> m SignalHandlerId

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

on dropControllerMotion #leave callback

motion

type DropControllerMotionMotionCallback

Arguments

 = Double

x: the x coordinate

-> Double

y: the y coordinate

-> IO ()

Emitted when the pointer moves inside the widget.

afterDropControllerMotionMotion :: (IsDropControllerMotion a, MonadIO m) => a -> ((?self :: a) => DropControllerMotionMotionCallback) -> m SignalHandlerId

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

after dropControllerMotion #motion callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onDropControllerMotionMotion :: (IsDropControllerMotion a, MonadIO m) => a -> ((?self :: a) => DropControllerMotionMotionCallback) -> m SignalHandlerId

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

on dropControllerMotion #motion callback