GI.Gtk.Objects.GestureMultiPress

GestureMultiPress is a Gesture implementation able to recognize multiple clicks on a nearby zone, which can be listened for through the GestureMultiPress::pressed signal. Whenever time or distance between clicks exceed the GTK+ defaults, GestureMultiPress::stopped is emitted, and the click counter is reset.

Callers may also restrict the area that is considered valid for a >1 touch/button press through gestureMultiPressSetArea, so any click happening outside that area is considered to be a first click of its own.

Exported types

newtype GestureMultiPress

Memory-managed wrapper type.

Constructors

GestureMultiPress (ManagedPtr GestureMultiPress)

Instances

GObject GestureMultiPress

Defined in GI.Gtk.Objects.GestureMultiPress

Methods

gobjectType :: GestureMultiPress -> IO GType

IsObject GestureMultiPress

Defined in GI.Gtk.Objects.GestureMultiPress

IsEventController GestureMultiPress

Defined in GI.Gtk.Objects.GestureMultiPress

IsGesture GestureMultiPress

Defined in GI.Gtk.Objects.GestureMultiPress

IsGestureSingle GestureMultiPress

Defined in GI.Gtk.Objects.GestureMultiPress

IsGestureMultiPress GestureMultiPress

Defined in GI.Gtk.Objects.GestureMultiPress

class GObject o => IsGestureMultiPress o

Type class for types which can be safely cast to GestureMultiPress, for instance with toGestureMultiPress.

Instances

(GObject a, (UnknownAncestorError GestureMultiPress a :: Constraint)) => IsGestureMultiPress a

Defined in GI.Gtk.Objects.GestureMultiPress

IsGestureMultiPress GestureMultiPress

Defined in GI.Gtk.Objects.GestureMultiPress

toGestureMultiPress :: (MonadIO m, IsGestureMultiPress o) => o -> m GestureMultiPress

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

noGestureMultiPress :: Maybe GestureMultiPress

A convenience alias for Nothing :: Maybe GestureMultiPress.

Methods

getArea

gestureMultiPressGetArea

Arguments

:: (HasCallStack, MonadIO m, IsGestureMultiPress a)

=> a

gesture: a GestureMultiPress

-> m (Bool, Rectangle)

Returns: True if rect was filled with the press area

If an area was set through gestureMultiPressSetArea, this function will return True and fill in rect with the press area. See gestureMultiPressSetArea for more details on what the press area represents.

Since: 3.14

new

gestureMultiPressNew

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a Widget

-> m GestureMultiPress

Returns: a newly created GestureMultiPress

Returns a newly created Gesture that recognizes single and multiple presses.

Since: 3.14

setArea

gestureMultiPressSetArea

Arguments

:: (HasCallStack, MonadIO m, IsGestureMultiPress a)

=> a

gesture: a GestureMultiPress

-> Maybe Rectangle

rect: rectangle to receive coordinates on

-> m ()

If rect is non-Nothing, the press area will be checked to be confined within the rectangle, otherwise the button count will be reset so the press is seen as being the first one. If rect is Nothing, the area will be reset to an unrestricted state.

Note: The rectangle is only used to determine whether any non-first click falls within the expected area. This is not akin to an input shape.

Since: 3.14

Signals

pressed

type C_GestureMultiPressPressedCallback = Ptr () -> Int32 -> CDouble -> CDouble -> Ptr () -> IO ()

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

type GestureMultiPressPressedCallback

Arguments

 = Int32

nPress: how many touch/button presses happened with this one

-> Double

x: The X coordinate, in widget allocation coordinates

-> Double

y: The Y coordinate, in widget allocation coordinates

-> IO ()

This signal is emitted whenever a button or touch press happens.

Since: 3.14

afterGestureMultiPressPressed :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressPressedCallback -> m SignalHandlerId

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

after gestureMultiPress #pressed callback

genClosure_GestureMultiPressPressed :: GestureMultiPressPressedCallback -> IO Closure

Wrap the callback into a Closure.

mk_GestureMultiPressPressedCallback :: C_GestureMultiPressPressedCallback -> IO (FunPtr C_GestureMultiPressPressedCallback)

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

noGestureMultiPressPressedCallback :: Maybe GestureMultiPressPressedCallback

A convenience synonym for Nothing :: Maybe GestureMultiPressPressedCallback.

onGestureMultiPressPressed :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressPressedCallback -> m SignalHandlerId

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

on gestureMultiPress #pressed callback

wrap_GestureMultiPressPressedCallback :: GestureMultiPressPressedCallback -> C_GestureMultiPressPressedCallback

Wrap a GestureMultiPressPressedCallback into a C_GestureMultiPressPressedCallback.

released

type C_GestureMultiPressReleasedCallback = Ptr () -> Int32 -> CDouble -> CDouble -> Ptr () -> IO ()

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

type GestureMultiPressReleasedCallback

Arguments

 = Int32

nPress: number of press that is paired with this release

-> Double

x: The X coordinate, in widget allocation coordinates

-> Double

y: The Y coordinate, in widget allocation coordinates

-> IO ()

This signal is emitted when a button or touch is released. nPress will report the number of press that is paired to this event, note that GestureMultiPress::stopped may have been emitted between the press and its release, nPress will only start over at the next press.

Since: 3.14

afterGestureMultiPressReleased :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressReleasedCallback -> m SignalHandlerId

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

after gestureMultiPress #released callback

genClosure_GestureMultiPressReleased :: GestureMultiPressReleasedCallback -> IO Closure

Wrap the callback into a Closure.

mk_GestureMultiPressReleasedCallback :: C_GestureMultiPressReleasedCallback -> IO (FunPtr C_GestureMultiPressReleasedCallback)

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

noGestureMultiPressReleasedCallback :: Maybe GestureMultiPressReleasedCallback

A convenience synonym for Nothing :: Maybe GestureMultiPressReleasedCallback.

onGestureMultiPressReleased :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressReleasedCallback -> m SignalHandlerId

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

on gestureMultiPress #released callback

wrap_GestureMultiPressReleasedCallback :: GestureMultiPressReleasedCallback -> C_GestureMultiPressReleasedCallback

Wrap a GestureMultiPressReleasedCallback into a C_GestureMultiPressReleasedCallback.

stopped

type C_GestureMultiPressStoppedCallback = Ptr () -> Ptr () -> IO ()

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

type GestureMultiPressStoppedCallback = IO ()

This signal is emitted whenever any time/distance threshold has been exceeded.

Since: 3.14

afterGestureMultiPressStopped :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressStoppedCallback -> m SignalHandlerId

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

after gestureMultiPress #stopped callback

genClosure_GestureMultiPressStopped :: GestureMultiPressStoppedCallback -> IO Closure

Wrap the callback into a Closure.

mk_GestureMultiPressStoppedCallback :: C_GestureMultiPressStoppedCallback -> IO (FunPtr C_GestureMultiPressStoppedCallback)

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

noGestureMultiPressStoppedCallback :: Maybe GestureMultiPressStoppedCallback

A convenience synonym for Nothing :: Maybe GestureMultiPressStoppedCallback.

onGestureMultiPressStopped :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressStoppedCallback -> m SignalHandlerId

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

on gestureMultiPress #stopped callback

wrap_GestureMultiPressStoppedCallback :: GestureMultiPressStoppedCallback -> C_GestureMultiPressStoppedCallback

Wrap a GestureMultiPressStoppedCallback into a C_GestureMultiPressStoppedCallback.