GI.Gtk.Objects.GestureSwipe

GestureSwipe is a Gesture implementation able to recognize swipes, after a press/move/.../move/release sequence happens, the GestureSwipe::swipe signal will be emitted, providing the velocity and directionality of the sequence at the time it was lifted.

If the velocity is desired in intermediate points, gestureSwipeGetVelocity can be called on eg. a Gesture::update handler.

All velocities are reported in pixels/sec units.

Exported types

newtype GestureSwipe

Memory-managed wrapper type.

Constructors

GestureSwipe (ManagedPtr GestureSwipe)

Instances

GObject GestureSwipe

Defined in GI.Gtk.Objects.GestureSwipe

Methods

gobjectType :: GestureSwipe -> IO GType

IsObject GestureSwipe

Defined in GI.Gtk.Objects.GestureSwipe

IsEventController GestureSwipe

Defined in GI.Gtk.Objects.GestureSwipe

IsGesture GestureSwipe

Defined in GI.Gtk.Objects.GestureSwipe

IsGestureSingle GestureSwipe

Defined in GI.Gtk.Objects.GestureSwipe

IsGestureSwipe GestureSwipe

Defined in GI.Gtk.Objects.GestureSwipe

class GObject o => IsGestureSwipe o

Type class for types which can be safely cast to GestureSwipe, for instance with toGestureSwipe.

Instances

(GObject a, (UnknownAncestorError GestureSwipe a :: Constraint)) => IsGestureSwipe a

Defined in GI.Gtk.Objects.GestureSwipe

IsGestureSwipe GestureSwipe

Defined in GI.Gtk.Objects.GestureSwipe

toGestureSwipe :: (MonadIO m, IsGestureSwipe o) => o -> m GestureSwipe

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

noGestureSwipe :: Maybe GestureSwipe

A convenience alias for Nothing :: Maybe GestureSwipe.

Methods

getVelocity

gestureSwipeGetVelocity

Arguments

:: (HasCallStack, MonadIO m, IsGestureSwipe a)

=> a

gesture: a GestureSwipe

-> m (Bool, Double, Double)

Returns: whether velocity could be calculated

If the gesture is recognized, this function returns True and fill in velocityX and velocityY with the recorded velocity, as per the last event(s) processed.

Since: 3.14

new

gestureSwipeNew

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a Widget

-> m GestureSwipe

Returns: a newly created GestureSwipe

Returns a newly created Gesture that recognizes swipes.

Since: 3.14

Signals

swipe

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

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

type GestureSwipeSwipeCallback

Arguments

 = Double

velocityX: velocity in the X axis, in pixels/sec

-> Double

velocityY: velocity in the Y axis, in pixels/sec

-> IO ()

This signal is emitted when the recognized gesture is finished, velocity and direction are a product of previously recorded events.

Since: 3.14

afterGestureSwipeSwipe :: (IsGestureSwipe a, MonadIO m) => a -> GestureSwipeSwipeCallback -> m SignalHandlerId

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

after gestureSwipe #swipe callback

genClosure_GestureSwipeSwipe :: GestureSwipeSwipeCallback -> IO Closure

Wrap the callback into a Closure.

mk_GestureSwipeSwipeCallback :: C_GestureSwipeSwipeCallback -> IO (FunPtr C_GestureSwipeSwipeCallback)

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

noGestureSwipeSwipeCallback :: Maybe GestureSwipeSwipeCallback

A convenience synonym for Nothing :: Maybe GestureSwipeSwipeCallback.

onGestureSwipeSwipe :: (IsGestureSwipe a, MonadIO m) => a -> GestureSwipeSwipeCallback -> m SignalHandlerId

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

on gestureSwipe #swipe callback

wrap_GestureSwipeSwipeCallback :: GestureSwipeSwipeCallback -> C_GestureSwipeSwipeCallback

Wrap a GestureSwipeSwipeCallback into a C_GestureSwipeSwipeCallback.