GI.Gtk.Objects.GestureDrag

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

Exported types

newtype GestureDrag

Memory-managed wrapper type.

Constructors

GestureDrag (ManagedPtr GestureDrag)

Instances

Eq GestureDrag

Defined in GI.Gtk.Objects.GestureDrag

Methods

(==) :: GestureDrag -> GestureDrag -> Bool

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

GObject GestureDrag

Defined in GI.Gtk.Objects.GestureDrag

ManagedPtrNewtype GestureDrag

Defined in GI.Gtk.Objects.GestureDrag

Methods

toManagedPtr :: GestureDrag -> ManagedPtr GestureDrag

TypedObject GestureDrag

Defined in GI.Gtk.Objects.GestureDrag

Methods

glibType :: IO GType

HasParentTypes GestureDrag

Defined in GI.Gtk.Objects.GestureDrag

IsGValue (Maybe GestureDrag)

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

Defined in GI.Gtk.Objects.GestureDrag

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes GestureDrag

Defined in GI.Gtk.Objects.GestureDrag

type ParentTypes GestureDrag = '[GestureSingle, Gesture, EventController, Object]

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.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, group, handleEvent, handlesSequence, isActive, isFloating, isGroupedWith, isRecognized, notify, notifyByPspec, ref, refSink, reset, runDispose, stealData, stealQdata, thawNotify, ungroup, unref, watchClosure.

Getters

getBoundingBox, getBoundingBoxCenter, getButton, getCurrentButton, getCurrentSequence, getData, getDevice, getExclusive, getGroup, getLastEvent, getLastUpdatedSequence, getOffset, getPoint, getPropagationPhase, getProperty, getQdata, getSequenceState, getSequences, getStartPoint, getTouchOnly, getWidget, getWindow.

Setters

setButton, setData, setDataFull, setExclusive, setPropagationPhase, setProperty, setSequenceState, setState, setTouchOnly, setWindow.

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 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 -> ((?self :: a) => GestureDragDragBeginCallback) -> m SignalHandlerId

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

after gestureDrag #dragBegin 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.

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

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

on gestureDrag #dragBegin callback

dragEnd

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 -> ((?self :: a) => GestureDragDragEndCallback) -> m SignalHandlerId

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

after gestureDrag #dragEnd 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.

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

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

on gestureDrag #dragEnd callback

dragUpdate

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 -> ((?self :: a) => GestureDragDragUpdateCallback) -> m SignalHandlerId

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

after gestureDrag #dragUpdate 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.

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

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

on gestureDrag #dragUpdate callback