GI.Gtk.Objects.GestureStylus

GtkGestureStylus is a GtkGesture specific to stylus input.

The provided signals just relay the basic information of the stylus events.

Exported types

newtype GestureStylus

Memory-managed wrapper type.

Constructors

GestureStylus (ManagedPtr GestureStylus)

Instances

Eq GestureStylus

Defined in GI.Gtk.Objects.GestureStylus

Methods

(==) :: GestureStylus -> GestureStylus -> Bool

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

GObject GestureStylus

Defined in GI.Gtk.Objects.GestureStylus

ManagedPtrNewtype GestureStylus

Defined in GI.Gtk.Objects.GestureStylus

Methods

toManagedPtr :: GestureStylus -> ManagedPtr GestureStylus

TypedObject GestureStylus

Defined in GI.Gtk.Objects.GestureStylus

Methods

glibType :: IO GType

HasParentTypes GestureStylus

Defined in GI.Gtk.Objects.GestureStylus

IsGValue (Maybe GestureStylus)

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

Defined in GI.Gtk.Objects.GestureStylus

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes GestureStylus

Defined in GI.Gtk.Objects.GestureStylus

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

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

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

Instances

(GObject o, IsDescendantOf GestureStylus o) => IsGestureStylus o

Defined in GI.Gtk.Objects.GestureStylus

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

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

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

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

Setters

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

getAxis

gestureStylusGetAxis

Arguments

:: (HasCallStack, MonadIO m, IsGestureStylus a)

=> a

gesture: a GtkGestureStylus

-> 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 the handler of one of the GestureStylus::down, GestureStylus::motion, GestureStylus::up or GestureStylus::proximity signals.

getBacklog

gestureStylusGetBacklog

Arguments

:: (HasCallStack, MonadIO m, IsGestureStylus a)

=> a

gesture: a GtkGestureStylus

-> m (Bool, [TimeCoord])

Returns: True if there is a backlog to unfold in the current state.

Returns the accumulated backlog of tracking information.

By default, GTK will limit rate of input events. On stylus input where accuracy of strokes is paramount, this function returns the accumulated coordinate/timing state before the emission of the current Gtk.GestureStylus[motion] signal.

This function may only be called within a GestureStylus::motion signal handler, the state given in this signal and obtainable through gestureStylusGetAxis express the latest (most up-to-date) state in motion history.

The backlog is provided in chronological order.

getDeviceTool

gestureStylusGetDeviceTool

Arguments

:: (HasCallStack, MonadIO m, IsGestureStylus a)

=> a

gesture: a GtkGestureStylus

-> m (Maybe DeviceTool)

Returns: The current stylus tool

Returns the GdkDeviceTool currently driving input through this gesture.

This function must be called from the handler of one of the GestureStylus::down, GestureStylus::motion, GestureStylus::up or GestureStylus::proximity signals.

getStylusOnly

gestureStylusGetStylusOnly

Arguments

:: (HasCallStack, MonadIO m, IsGestureStylus a)

=> a

gesture: the gesture

-> m Bool

Returns: True if the gesture is only for stylus events

Checks whether the gesture is for styluses only.

Stylus-only gestures will signal events exclusively from stylus input devices.

Since: 4.10

new

gestureStylusNew

Arguments

:: (HasCallStack, MonadIO m)

=> m GestureStylus

Returns: a newly created stylus gesture

Creates a new GtkGestureStylus.

setStylusOnly

gestureStylusSetStylusOnly

Arguments

:: (HasCallStack, MonadIO m, IsGestureStylus a)

=> a

gesture: the gesture

-> Bool

stylusOnly: whether the gesture is used exclusively for stylus events

-> m ()

Sets the state of stylus-only

If true, the gesture will exclusively handle events from stylus input devices, otherwise it'll handle events from any pointing device.

Since: 4.10

Properties

stylusOnly

If this gesture should exclusively react to stylus input devices.

Since: 4.10

constructGestureStylusStylusOnly :: (IsGestureStylus o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getGestureStylusStylusOnly :: (MonadIO m, IsGestureStylus o) => o -> m Bool

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

get gestureStylus #stylusOnly

setGestureStylusStylusOnly :: (MonadIO m, IsGestureStylus o) => o -> Bool -> m ()

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

set gestureStylus [ #stylusOnly := value ]

Signals

down

type GestureStylusDownCallback

Arguments

 = Double

x: the X coordinate of the stylus event

-> Double

y: the Y coordinate of the stylus event

-> IO ()

Emitted when the stylus touches the device.

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

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

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

Arguments

 = Double

x: the X coordinate of the stylus event

-> Double

y: the Y coordinate of the stylus event

-> IO ()

Emitted when the stylus moves while touching the device.

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

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

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

Arguments

 = Double

x: the X coordinate of the stylus event

-> Double

y: the Y coordinate of the stylus event

-> IO ()

Emitted when the stylus is in proximity of the device.

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

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

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

Arguments

 = Double

x: the X coordinate of the stylus event

-> Double

y: the Y coordinate of the stylus event

-> IO ()

Emitted when the stylus no longer touches the device.

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

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

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