| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Objects.GestureMultiPress
Description
GestureMultiPress is a Gesture implementation able to recognize
multiple clicks on a nearby zone, which can be listened for through the
pressed signal. Whenever time or distance between
clicks exceed the GTK+ defaults, 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.
Synopsis
- newtype GestureMultiPress = GestureMultiPress (ManagedPtr GestureMultiPress)
- class (GObject o, IsDescendantOf GestureMultiPress o) => IsGestureMultiPress o
- toGestureMultiPress :: (MonadIO m, IsGestureMultiPress o) => o -> m GestureMultiPress
- gestureMultiPressGetArea :: (HasCallStack, MonadIO m, IsGestureMultiPress a) => a -> m (Bool, Rectangle)
- gestureMultiPressNew :: (HasCallStack, MonadIO m, IsWidget a) => a -> m GestureMultiPress
- gestureMultiPressSetArea :: (HasCallStack, MonadIO m, IsGestureMultiPress a) => a -> Maybe Rectangle -> m ()
- type C_GestureMultiPressPressedCallback = Ptr () -> Int32 -> CDouble -> CDouble -> Ptr () -> IO ()
- type GestureMultiPressPressedCallback = Int32 -> Double -> Double -> IO ()
- afterGestureMultiPressPressed :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressPressedCallback -> m SignalHandlerId
- genClosure_GestureMultiPressPressed :: MonadIO m => GestureMultiPressPressedCallback -> m (GClosure C_GestureMultiPressPressedCallback)
- mk_GestureMultiPressPressedCallback :: C_GestureMultiPressPressedCallback -> IO (FunPtr C_GestureMultiPressPressedCallback)
- noGestureMultiPressPressedCallback :: Maybe GestureMultiPressPressedCallback
- onGestureMultiPressPressed :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressPressedCallback -> m SignalHandlerId
- wrap_GestureMultiPressPressedCallback :: GestureMultiPressPressedCallback -> C_GestureMultiPressPressedCallback
- type C_GestureMultiPressReleasedCallback = Ptr () -> Int32 -> CDouble -> CDouble -> Ptr () -> IO ()
- type GestureMultiPressReleasedCallback = Int32 -> Double -> Double -> IO ()
- afterGestureMultiPressReleased :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressReleasedCallback -> m SignalHandlerId
- genClosure_GestureMultiPressReleased :: MonadIO m => GestureMultiPressReleasedCallback -> m (GClosure C_GestureMultiPressReleasedCallback)
- mk_GestureMultiPressReleasedCallback :: C_GestureMultiPressReleasedCallback -> IO (FunPtr C_GestureMultiPressReleasedCallback)
- noGestureMultiPressReleasedCallback :: Maybe GestureMultiPressReleasedCallback
- onGestureMultiPressReleased :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressReleasedCallback -> m SignalHandlerId
- wrap_GestureMultiPressReleasedCallback :: GestureMultiPressReleasedCallback -> C_GestureMultiPressReleasedCallback
- type C_GestureMultiPressStoppedCallback = Ptr () -> Ptr () -> IO ()
- type GestureMultiPressStoppedCallback = IO ()
- afterGestureMultiPressStopped :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressStoppedCallback -> m SignalHandlerId
- genClosure_GestureMultiPressStopped :: MonadIO m => GestureMultiPressStoppedCallback -> m (GClosure C_GestureMultiPressStoppedCallback)
- mk_GestureMultiPressStoppedCallback :: C_GestureMultiPressStoppedCallback -> IO (FunPtr C_GestureMultiPressStoppedCallback)
- noGestureMultiPressStoppedCallback :: Maybe GestureMultiPressStoppedCallback
- onGestureMultiPressStopped :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressStoppedCallback -> m SignalHandlerId
- wrap_GestureMultiPressStoppedCallback :: GestureMultiPressStoppedCallback -> C_GestureMultiPressStoppedCallback
Exported types
newtype GestureMultiPress Source #
Memory-managed wrapper type.
Constructors
| GestureMultiPress (ManagedPtr GestureMultiPress) |
Instances
class (GObject o, IsDescendantOf GestureMultiPress o) => IsGestureMultiPress o Source #
Type class for types which can be safely cast to GestureMultiPress, for instance with toGestureMultiPress.
Instances
| (GObject o, IsDescendantOf GestureMultiPress o) => IsGestureMultiPress o Source # | |
Defined in GI.Gtk.Objects.GestureMultiPress | |
toGestureMultiPress :: (MonadIO m, IsGestureMultiPress o) => o -> m GestureMultiPress Source #
Cast to GestureMultiPress, 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
getArea, getBoundingBox, getBoundingBoxCenter, getButton, getCurrentButton, getCurrentSequence, getData, getDevice, getExclusive, getGroup, getLastEvent, getLastUpdatedSequence, getPoint, getPropagationPhase, getProperty, getQdata, getSequenceState, getSequences, getTouchOnly, getWidget, getWindow.
Setters
setArea, setButton, setData, setDataFull, setExclusive, setPropagationPhase, setProperty, setSequenceState, setState, setTouchOnly, setWindow.
getArea
gestureMultiPressGetArea Source #
Arguments
| :: (HasCallStack, MonadIO m, IsGestureMultiPress a) | |
| => a |
|
| -> m (Bool, Rectangle) | Returns: |
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
Arguments
| :: (HasCallStack, MonadIO m, IsWidget a) | |
| => a |
|
| -> m GestureMultiPress | Returns: a newly created |
Returns a newly created Gesture that recognizes single and multiple
presses.
Since: 3.14
setArea
gestureMultiPressSetArea Source #
Arguments
| :: (HasCallStack, MonadIO m, IsGestureMultiPress a) | |
| => a |
|
| -> Maybe Rectangle |
|
| -> 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 () Source #
Type for the callback on the (unwrapped) C side.
type GestureMultiPressPressedCallback Source #
Arguments
| = Int32 |
|
| -> Double |
|
| -> Double |
|
| -> IO () |
This signal is emitted whenever a button or touch press happens.
Since: 3.14
afterGestureMultiPressPressed :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressPressedCallback -> 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 gestureMultiPress #pressed callback
genClosure_GestureMultiPressPressed :: MonadIO m => GestureMultiPressPressedCallback -> m (GClosure C_GestureMultiPressPressedCallback) Source #
Wrap the callback into a GClosure.
mk_GestureMultiPressPressedCallback :: C_GestureMultiPressPressedCallback -> IO (FunPtr C_GestureMultiPressPressedCallback) Source #
Generate a function pointer callable from C code, from a C_GestureMultiPressPressedCallback.
noGestureMultiPressPressedCallback :: Maybe GestureMultiPressPressedCallback Source #
A convenience synonym for Nothing :: Maybe GestureMultiPressPressedCallback
onGestureMultiPressPressed :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressPressedCallback -> 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 gestureMultiPress #pressed callback
wrap_GestureMultiPressPressedCallback :: GestureMultiPressPressedCallback -> C_GestureMultiPressPressedCallback Source #
released
type C_GestureMultiPressReleasedCallback = Ptr () -> Int32 -> CDouble -> CDouble -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type GestureMultiPressReleasedCallback Source #
Arguments
| = Int32 |
|
| -> Double |
|
| -> Double |
|
| -> 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 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 Source #
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 :: MonadIO m => GestureMultiPressReleasedCallback -> m (GClosure C_GestureMultiPressReleasedCallback) Source #
Wrap the callback into a GClosure.
mk_GestureMultiPressReleasedCallback :: C_GestureMultiPressReleasedCallback -> IO (FunPtr C_GestureMultiPressReleasedCallback) Source #
Generate a function pointer callable from C code, from a C_GestureMultiPressReleasedCallback.
noGestureMultiPressReleasedCallback :: Maybe GestureMultiPressReleasedCallback Source #
A convenience synonym for Nothing :: Maybe GestureMultiPressReleasedCallback
onGestureMultiPressReleased :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressReleasedCallback -> m SignalHandlerId Source #
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 Source #
stopped
type C_GestureMultiPressStoppedCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type GestureMultiPressStoppedCallback = IO () Source #
This signal is emitted whenever any time/distance threshold has been exceeded.
Since: 3.14
afterGestureMultiPressStopped :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressStoppedCallback -> m SignalHandlerId Source #
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 :: MonadIO m => GestureMultiPressStoppedCallback -> m (GClosure C_GestureMultiPressStoppedCallback) Source #
Wrap the callback into a GClosure.
mk_GestureMultiPressStoppedCallback :: C_GestureMultiPressStoppedCallback -> IO (FunPtr C_GestureMultiPressStoppedCallback) Source #
Generate a function pointer callable from C code, from a C_GestureMultiPressStoppedCallback.
noGestureMultiPressStoppedCallback :: Maybe GestureMultiPressStoppedCallback Source #
A convenience synonym for Nothing :: Maybe GestureMultiPressStoppedCallback
onGestureMultiPressStopped :: (IsGestureMultiPress a, MonadIO m) => a -> GestureMultiPressStoppedCallback -> m SignalHandlerId Source #
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