GI.Gtk.Objects.GestureDrag

GestureDrag is a Gesture implementation that recognizes drag operations. The drag operation itself can be tracked throught the GestureDrag::drag-begin, GestureDrag::drag-update and GestureDrag::drag-end signals, or the relevant coordinates be extracted through gestureDragGetOffset and gestureDragGetStartPoint.

Exported types

newtype GestureDrag

Memory-managed wrapper type.

Constructors

GestureDrag (ManagedPtr GestureDrag)

Instances

GObject GestureDrag

Defined in GI.Gtk.Objects.GestureDrag

Methods

gobjectType :: IO GType

HasParentTypes GestureDrag

Defined in GI.Gtk.Objects.GestureDrag

type ParentTypes GestureDrag

Defined in GI.Gtk.Objects.GestureDrag

type ParentTypes GestureDrag = GestureSingle ': (Gesture ': (EventController ': (Object ': ([] :: [Type]))))

class (GObject o, IsDescendantOf GestureDrag o) => IsGestureDrag o

Type class for types which can be safely cast to GestureDrag, for instance with toGestureDrag.

Instances

(GObject o, IsDescendantOf GestureDrag o) => IsGestureDrag o

Defined in GI.Gtk.Objects.GestureDrag

toGestureDrag :: (MonadIO m, IsGestureDrag o) => o -> m GestureDrag

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

noGestureDrag :: Maybe GestureDrag

A convenience alias for Nothing :: Maybe GestureDrag.

Methods

getOffset

gestureDragGetOffset

Arguments

:: (HasCallStack, MonadIO m, IsGestureDrag a)

=> a

gesture: a Gesture

-> m (Bool, Double, Double)

Returns: True if the gesture is active

If the gesture is active, this function returns True and fills in x and y with the coordinates of the current point, as an offset to the starting drag point.

Since: 3.14

getStartPoint

gestureDragGetStartPoint

Arguments

:: (HasCallStack, MonadIO m, IsGestureDrag a)

=> a

gesture: a Gesture

-> m (Bool, Double, Double)

Returns: True if the gesture is active

If the gesture is active, this function returns True and fills in x and y with the drag start coordinates, in window-relative coordinates.

Since: 3.14

new

gestureDragNew

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a Widget

-> m GestureDrag

Returns: a newly created GestureDrag

Returns a newly created Gesture that recognizes drags.

Since: 3.14

Signals

dragBegin

type C_GestureDragDragBeginCallback = Ptr () -> CDouble -> CDouble -> Ptr () -> IO ()

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

type GestureDragDragBeginCallback

Arguments

 = Double

startX: X coordinate, relative to the widget allocation

-> Double

startY: Y coordinate, relative to the widget allocation

-> IO ()

This signal is emitted whenever dragging starts.

Since: 3.14

afterGestureDragDragBegin :: (IsGestureDrag a, MonadIO m) => a -> GestureDragDragBeginCallback -> m SignalHandlerId

Connect a signal handler for the “drag-begin” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after gestureDrag #dragBegin callback

genClosure_GestureDragDragBegin :: MonadIO m => GestureDragDragBeginCallback -> m (GClosure C_GestureDragDragBeginCallback)

Wrap the callback into a GClosure.

mk_GestureDragDragBeginCallback :: C_GestureDragDragBeginCallback -> IO (FunPtr C_GestureDragDragBeginCallback)

Generate a function pointer callable from C code, from a C_GestureDragDragBeginCallback.

noGestureDragDragBeginCallback :: Maybe GestureDragDragBeginCallback

A convenience synonym for Nothing :: Maybe GestureDragDragBeginCallback.

onGestureDragDragBegin :: (IsGestureDrag a, MonadIO m) => a -> GestureDragDragBeginCallback -> m SignalHandlerId

Connect a signal handler for the “drag-begin” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on gestureDrag #dragBegin callback

wrap_GestureDragDragBeginCallback :: GestureDragDragBeginCallback -> C_GestureDragDragBeginCallback

Wrap a GestureDragDragBeginCallback into a C_GestureDragDragBeginCallback.

dragEnd

type C_GestureDragDragEndCallback = Ptr () -> CDouble -> CDouble -> Ptr () -> IO ()

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

type GestureDragDragEndCallback

Arguments

 = Double

offsetX: X offset, relative to the start point

-> Double

offsetY: Y offset, relative to the start point

-> IO ()

This signal is emitted whenever the dragging is finished.

Since: 3.14

afterGestureDragDragEnd :: (IsGestureDrag a, MonadIO m) => a -> GestureDragDragEndCallback -> m SignalHandlerId

Connect a signal handler for the “drag-end” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after gestureDrag #dragEnd callback

genClosure_GestureDragDragEnd :: MonadIO m => GestureDragDragEndCallback -> m (GClosure C_GestureDragDragEndCallback)

Wrap the callback into a GClosure.

mk_GestureDragDragEndCallback :: C_GestureDragDragEndCallback -> IO (FunPtr C_GestureDragDragEndCallback)

Generate a function pointer callable from C code, from a C_GestureDragDragEndCallback.

noGestureDragDragEndCallback :: Maybe GestureDragDragEndCallback

A convenience synonym for Nothing :: Maybe GestureDragDragEndCallback.

onGestureDragDragEnd :: (IsGestureDrag a, MonadIO m) => a -> GestureDragDragEndCallback -> m SignalHandlerId

Connect a signal handler for the “drag-end” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on gestureDrag #dragEnd callback

wrap_GestureDragDragEndCallback :: GestureDragDragEndCallback -> C_GestureDragDragEndCallback

Wrap a GestureDragDragEndCallback into a C_GestureDragDragEndCallback.

dragUpdate

type C_GestureDragDragUpdateCallback = Ptr () -> CDouble -> CDouble -> Ptr () -> IO ()

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

type GestureDragDragUpdateCallback

Arguments

 = Double

offsetX: X offset, relative to the start point

-> Double

offsetY: Y offset, relative to the start point

-> IO ()

This signal is emitted whenever the dragging point moves.

Since: 3.14

afterGestureDragDragUpdate :: (IsGestureDrag a, MonadIO m) => a -> GestureDragDragUpdateCallback -> m SignalHandlerId

Connect a signal handler for the “drag-update” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after gestureDrag #dragUpdate callback

genClosure_GestureDragDragUpdate :: MonadIO m => GestureDragDragUpdateCallback -> m (GClosure C_GestureDragDragUpdateCallback)

Wrap the callback into a GClosure.

mk_GestureDragDragUpdateCallback :: C_GestureDragDragUpdateCallback -> IO (FunPtr C_GestureDragDragUpdateCallback)

Generate a function pointer callable from C code, from a C_GestureDragDragUpdateCallback.

noGestureDragDragUpdateCallback :: Maybe GestureDragDragUpdateCallback

A convenience synonym for Nothing :: Maybe GestureDragDragUpdateCallback.

onGestureDragDragUpdate :: (IsGestureDrag a, MonadIO m) => a -> GestureDragDragUpdateCallback -> m SignalHandlerId

Connect a signal handler for the “drag-update” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on gestureDrag #dragUpdate callback

wrap_GestureDragDragUpdateCallback :: GestureDragDragUpdateCallback -> C_GestureDragDragUpdateCallback

Wrap a GestureDragDragUpdateCallback into a C_GestureDragDragUpdateCallback.