gi-gtk-4.0.9: Gtk bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gtk.Objects.GestureLongPress

Description

GtkGestureLongPress is a GtkGesture for long presses.

This gesture is also known as “Press and Hold”.

When the timeout is exceeded, the gesture is triggering the GestureLongPress::pressed signal.

If the touchpoint is lifted before the timeout passes, or if it drifts too far of the initial press point, the GestureLongPress::cancelled signal will be emitted.

How long the timeout is before the pressed signal gets emitted is determined by the Settings:gtkLongPressTime setting. It can be modified by the GestureLongPress:delayFactor property.

Synopsis

Exported types

newtype GestureLongPress Source #

Memory-managed wrapper type.

Constructors

GestureLongPress (ManagedPtr GestureLongPress) 

Instances

Instances details
Eq GestureLongPress Source # 
Instance details

Defined in GI.Gtk.Objects.GestureLongPress

GObject GestureLongPress Source # 
Instance details

Defined in GI.Gtk.Objects.GestureLongPress

ManagedPtrNewtype GestureLongPress Source # 
Instance details

Defined in GI.Gtk.Objects.GestureLongPress

TypedObject GestureLongPress Source # 
Instance details

Defined in GI.Gtk.Objects.GestureLongPress

Methods

glibType :: IO GType

HasParentTypes GestureLongPress Source # 
Instance details

Defined in GI.Gtk.Objects.GestureLongPress

IsGValue (Maybe GestureLongPress) Source #

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

Instance details

Defined in GI.Gtk.Objects.GestureLongPress

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes GestureLongPress Source # 
Instance details

Defined in GI.Gtk.Objects.GestureLongPress

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

class (GObject o, IsDescendantOf GestureLongPress o) => IsGestureLongPress o Source #

Type class for types which can be safely cast to GestureLongPress, for instance with toGestureLongPress.

Instances

Instances details
(GObject o, IsDescendantOf GestureLongPress o) => IsGestureLongPress o Source # 
Instance details

Defined in GI.Gtk.Objects.GestureLongPress

toGestureLongPress :: (MonadIO m, IsGestureLongPress o) => o -> m GestureLongPress Source #

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

Methods

getDelayFactor

gestureLongPressGetDelayFactor Source #

Arguments

:: (HasCallStack, MonadIO m, IsGestureLongPress a) 
=> a

gesture: A GtkGestureLongPress

-> m Double

Returns: the delay factor

Returns the delay factor.

new

gestureLongPressNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m GestureLongPress

Returns: a newly created GtkGestureLongPress.

Returns a newly created GtkGesture that recognizes long presses.

setDelayFactor

gestureLongPressSetDelayFactor Source #

Arguments

:: (HasCallStack, MonadIO m, IsGestureLongPress a) 
=> a

gesture: A GtkGestureLongPress

-> Double

delayFactor: The delay factor to apply

-> m () 

Applies the given delay factor.

The default long press time will be multiplied by this value. Valid values are in the range [0.5..2.0].

Properties

delayFactor

Factor by which to modify the default timeout.

constructGestureLongPressDelayFactor :: (IsGestureLongPress o, MonadIO m) => Double -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “delay-factor” property. This is rarely needed directly, but it is used by new.

getGestureLongPressDelayFactor :: (MonadIO m, IsGestureLongPress o) => o -> m Double Source #

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

get gestureLongPress #delayFactor

setGestureLongPressDelayFactor :: (MonadIO m, IsGestureLongPress o) => o -> Double -> m () Source #

Set the value of the “delay-factor” property. When overloading is enabled, this is equivalent to

set gestureLongPress [ #delayFactor := value ]

Signals

cancelled

type GestureLongPressCancelledCallback = IO () Source #

Emitted whenever a press moved too far, or was released before GestureLongPress::pressed happened.

afterGestureLongPressCancelled :: (IsGestureLongPress a, MonadIO m) => a -> ((?self :: a) => GestureLongPressCancelledCallback) -> m SignalHandlerId Source #

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

after gestureLongPress #cancelled 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.

onGestureLongPressCancelled :: (IsGestureLongPress a, MonadIO m) => a -> ((?self :: a) => GestureLongPressCancelledCallback) -> m SignalHandlerId Source #

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

on gestureLongPress #cancelled callback

pressed

type GestureLongPressPressedCallback Source #

Arguments

 = Double

x: the X coordinate where the press happened, relative to the widget allocation

-> Double

y: the Y coordinate where the press happened, relative to the widget allocation

-> IO () 

Emitted whenever a press goes unmoved/unreleased longer than what the GTK defaults tell.

afterGestureLongPressPressed :: (IsGestureLongPress a, MonadIO m) => a -> ((?self :: a) => GestureLongPressPressedCallback) -> m SignalHandlerId Source #

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

after gestureLongPress #pressed 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.

onGestureLongPressPressed :: (IsGestureLongPress a, MonadIO m) => a -> ((?self :: a) => GestureLongPressPressedCallback) -> m SignalHandlerId Source #

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

on gestureLongPress #pressed callback