gi-gtk3-3.0.44: Gtk 3.x bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.GestureStylus

Contents

- Exported types
- Methods
  - getAxis
  - getDeviceTool
  - new
- Signals
  - down
  - motion
  - proximity
  - up

Description

`GestureStylus` is a `Gesture` implementation specific to stylus input. The provided signals just provide the basic information

Synopsis

- newtype GestureStylus = GestureStylus (ManagedPtr GestureStylus)
- class (GObject o, IsDescendantOf GestureStylus o) => IsGestureStylus o
- toGestureStylus :: (MonadIO m, IsGestureStylus o) => o -> m GestureStylus
- gestureStylusGetAxis :: (HasCallStack, MonadIO m, IsGestureStylus a) => a -> AxisUse -> m (Bool, Double)
- gestureStylusGetDeviceTool :: (HasCallStack, MonadIO m, IsGestureStylus a) => a -> m (Maybe DeviceTool)
- gestureStylusNew :: (HasCallStack, MonadIO m, IsWidget a) => a -> m GestureStylus
- type GestureStylusDownCallback = Double -> Double -> IO ()
- afterGestureStylusDown :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusDownCallback) -> m SignalHandlerId
- onGestureStylusDown :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusDownCallback) -> m SignalHandlerId
- type GestureStylusMotionCallback = Double -> Double -> IO ()
- afterGestureStylusMotion :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusMotionCallback) -> m SignalHandlerId
- onGestureStylusMotion :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusMotionCallback) -> m SignalHandlerId
- type GestureStylusProximityCallback = Double -> Double -> IO ()
- afterGestureStylusProximity :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusProximityCallback) -> m SignalHandlerId
- onGestureStylusProximity :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusProximityCallback) -> m SignalHandlerId
- type GestureStylusUpCallback = Double -> Double -> IO ()
- afterGestureStylusUp :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusUpCallback) -> m SignalHandlerId
- onGestureStylusUp :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusUpCallback) -> m SignalHandlerId

# Exported types

newtype GestureStylus Source #

Memory-managed wrapper type.

Constructors

GestureStylus (ManagedPtr GestureStylus) |

#### Instances

Instances details

Eq GestureStylus Source # |
Instance details Defined in GI.Gtk.Objects.GestureStylus Methods (==) :: GestureStylus -> GestureStylus -> Bool Source # (/=) :: GestureStylus -> GestureStylus -> Bool Source #
GObject GestureStylus Source # |
Instance details Defined in GI.Gtk.Objects.GestureStylus
ManagedPtrNewtype GestureStylus Source # |
Instance details Defined in GI.Gtk.Objects.GestureStylus Methods toManagedPtr :: GestureStylus -> ManagedPtr GestureStylus Source #
TypedObject GestureStylus Source # |
Instance details Defined in GI.Gtk.Objects.GestureStylus Methods glibType :: IO GType Source #
HasParentTypes GestureStylus Source # |
Instance details Defined in GI.Gtk.Objects.GestureStylus
IsGValue (Maybe GestureStylus) Source # | Convert `GestureStylus` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.GestureStylus Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe GestureStylus -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe GestureStylus) Source #
type ParentTypes GestureStylus Source # |
Instance details Defined in GI.Gtk.Objects.GestureStylus type ParentTypes GestureStylus = '[GestureSingle, Gesture, EventController, Object]

class (GObject o, IsDescendantOf GestureStylus o) => IsGestureStylus o Source #

Type class for types which can be safely cast to `GestureStylus`, for instance with `toGestureStylus`.

#### Instances

Instances details

(GObject o, IsDescendantOf GestureStylus o) => IsGestureStylus o Source # |
Instance details Defined in GI.Gtk.Objects.GestureStylus

toGestureStylus :: (MonadIO m, IsGestureStylus o) => o -> m GestureStylus Source #

Cast to `GestureStylus`, 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

Expand

#### 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

getAxes, getAxis, getBoundingBox, getBoundingBoxCenter, getButton, getCurrentButton, getCurrentSequence, getData, getDevice, getDeviceTool, getExclusive, getGroup, getLastEvent, getLastUpdatedSequence, getPoint, getPropagationPhase, getProperty, getQdata, getSequenceState, getSequences, getTouchOnly, getWidget, getWindow.

#### Setters

setButton, setData, setDataFull, setExclusive, setPropagationPhase, setProperty, setSequenceState, setState, setTouchOnly, setWindow.

## getAxis

gestureStylusGetAxis Source #

Arguments

:: (HasCallStack, MonadIO m, IsGestureStylus a) |
=> a | `gesture`: a `GestureStylus`
-> AxisUse | `axis`: requested device axis
-> m (Bool, Double) | Returns: `TRUE` if there is a current value for the axis

Returns the current value for the requested `axis`. This function must be called from either the `GestureStylus`:`down`, `GestureStylus`:`motion`, `GestureStylus`:`up` or `GestureStylus`:`proximity` signals.

Since: 3.24

## getDeviceTool

gestureStylusGetDeviceTool Source #

Arguments

:: (HasCallStack, MonadIO m, IsGestureStylus a) |
=> a | `gesture`: a `GestureStylus`
-> m (Maybe DeviceTool) | Returns: The current stylus tool

Returns the `DeviceTool` currently driving input through this gesture. This function must be called from either the GestureStylus::down, GestureStylus::motion, GestureStylus::up or GestureStylus::proximity signal handlers.

Since: 3.24

## new

gestureStylusNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsWidget a) |
=> a | `widget`: a `Widget`
-> m GestureStylus | Returns: a newly created stylus gesture

Creates a new `GestureStylus`.

Since: 3.24

# Signals

## down

type GestureStylusDownCallback = Double -> Double -> IO () Source #

No description available in the introspection data.

afterGestureStylusDown :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusDownCallback) -> m SignalHandlerId Source #

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

    after gestureStylus #down 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.

onGestureStylusDown :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusDownCallback) -> m SignalHandlerId Source #

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

    on gestureStylus #down callback

## motion

type GestureStylusMotionCallback = Double -> Double -> IO () Source #

No description available in the introspection data.

afterGestureStylusMotion :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusMotionCallback) -> m SignalHandlerId Source #

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

    after gestureStylus #motion 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.

onGestureStylusMotion :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusMotionCallback) -> m SignalHandlerId Source #

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

    on gestureStylus #motion callback

## proximity

type GestureStylusProximityCallback = Double -> Double -> IO () Source #

No description available in the introspection data.

afterGestureStylusProximity :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusProximityCallback) -> m SignalHandlerId Source #

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

    after gestureStylus #proximity 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.

onGestureStylusProximity :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusProximityCallback) -> m SignalHandlerId Source #

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

    on gestureStylus #proximity callback

## up

type GestureStylusUpCallback = Double -> Double -> IO () Source #

No description available in the introspection data.

afterGestureStylusUp :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusUpCallback) -> m SignalHandlerId Source #

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

    after gestureStylus #up 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.

onGestureStylusUp :: (IsGestureStylus a, MonadIO m) => a -> ((?self :: a) => GestureStylusUpCallback) -> m SignalHandlerId Source #

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

    on gestureStylus #up callback