GI.Gtk.Objects.GestureLongPress

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.

Exported types

newtype GestureLongPress

Memory-managed wrapper type.

Constructors

GestureLongPress (ManagedPtr GestureLongPress)

Instances

Eq GestureLongPress

Defined in GI.Gtk.Objects.GestureLongPress

Methods

(==) :: GestureLongPress -> GestureLongPress -> Bool

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

GObject GestureLongPress

Defined in GI.Gtk.Objects.GestureLongPress

ManagedPtrNewtype GestureLongPress

Defined in GI.Gtk.Objects.GestureLongPress

Methods

toManagedPtr :: GestureLongPress -> ManagedPtr GestureLongPress

TypedObject GestureLongPress

Defined in GI.Gtk.Objects.GestureLongPress

Methods

glibType :: IO GType

HasParentTypes GestureLongPress

Defined in GI.Gtk.Objects.GestureLongPress

IsGValue (Maybe GestureLongPress)

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

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

Defined in GI.Gtk.Objects.GestureLongPress

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

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

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

Instances

(GObject o, IsDescendantOf GestureLongPress o) => IsGestureLongPress o

Defined in GI.Gtk.Objects.GestureLongPress

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

Cast to GestureLongPress, 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, handlesSequence, isActive, isFloating, isGroupedWith, isRecognized, notify, notifyByPspec, ref, refSink, reset, runDispose, stealData, stealQdata, thawNotify, ungroup, unref, watchClosure.

Getters

getBoundingBox, getBoundingBoxCenter, getButton, getCurrentButton, getCurrentEvent, getCurrentEventDevice, getCurrentEventState, getCurrentEventTime, getCurrentSequence, getData, getDelayFactor, getDevice, getExclusive, getGroup, getLastEvent, getLastUpdatedSequence, getName, getPoint, getPropagationLimit, getPropagationPhase, getProperty, getQdata, getSequenceState, getSequences, getTouchOnly, getWidget.

Setters

setButton, setData, setDataFull, setDelayFactor, setExclusive, setName, setPropagationLimit, setPropagationPhase, setProperty, setSequenceState, setState, setTouchOnly.

getDelayFactor

gestureLongPressGetDelayFactor

Arguments

:: (HasCallStack, MonadIO m, IsGestureLongPress a)

=> a

gesture: A GtkGestureLongPress

-> m Double

Returns: the delay factor

Returns the delay factor.

new

gestureLongPressNew

Arguments

:: (HasCallStack, MonadIO m)

=> m GestureLongPress

Returns: a newly created GtkGestureLongPress.

Returns a newly created GtkGesture that recognizes long presses.

setDelayFactor

gestureLongPressSetDelayFactor

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)

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

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 ()

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 ()

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

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

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

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

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

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