GestureStylusProtocol

public protocol GestureStylusProtocol : GestureSingleProtocol

GtkGestureStylus is a GtkGesture specific to stylus input.

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

The GestureStylusProtocol protocol exposes the methods and properties of an underlying GtkGestureStylus instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see GestureStylus. Alternatively, use GestureStylusRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkGestureStylus instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • gesture_stylus_ptr Default implementation

    Typed pointer to the underlying GtkGestureStylus instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkGestureStylus instance.

    Declaration

    Swift

    var gesture_stylus_ptr: UnsafeMutablePointer<GtkGestureStylus>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to GestureStylusProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

GestureStylus Class

  • Bind a GestureStylusPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: GestureStylusPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a GestureStylus property

    Declaration

    Swift

    @inlinable
func get(property: GestureStylusPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a GestureStylus property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: GestureStylusPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

GestureStylus signals

  • Connect a Swift signal handler to the given, typed GestureStylusSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: GestureStylusSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    handler

    The Swift signal handler (function or callback) to invoke on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Connect a C signal handler to the given, typed GestureStylusSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: GestureStylusSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub
  • onDown(flags:handler:) Extension method

    Emitted when the stylus touches the device.

    Note

    This represents the underlying down signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onDown(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GestureStylusRef, _ x: Double, _ y: Double) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    x

    the X coordinate of the stylus event
    y

    the Y coordinate of the stylus event
    handler

    The signal handler to call Run the given callback whenever the down signal is emitted
    Show on GitHub
  • downSignal Extension method

    Typed down signal for using the connect(signal:) methods

    Declaration

    Swift

    static var downSignal: GestureStylusSignalName { get }
    Show on GitHub
  • onMotion(flags:handler:) Extension method

    Emitted when the stylus moves while touching the device.

    Note

    This represents the underlying motion signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onMotion(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GestureStylusRef, _ x: Double, _ y: Double) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    x

    the X coordinate of the stylus event
    y

    the Y coordinate of the stylus event
    handler

    The signal handler to call Run the given callback whenever the motion signal is emitted
    Show on GitHub
  • motionSignal Extension method

    Typed motion signal for using the connect(signal:) methods

    Declaration

    Swift

    static var motionSignal: GestureStylusSignalName { get }
    Show on GitHub
  • onProximity(flags:handler:) Extension method

    Emitted when the stylus is in proximity of the device.

    Note

    This represents the underlying proximity signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onProximity(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GestureStylusRef, _ x: Double, _ y: Double) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    x

    the X coordinate of the stylus event
    y

    the Y coordinate of the stylus event
    handler

    The signal handler to call Run the given callback whenever the proximity signal is emitted
    Show on GitHub
  • proximitySignal Extension method

    Typed proximity signal for using the connect(signal:) methods

    Declaration

    Swift

    static var proximitySignal: GestureStylusSignalName { get }
    Show on GitHub
  • onUp(flags:handler:) Extension method

    Emitted when the stylus no longer touches the device.

    Note

    This represents the underlying up signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onUp(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GestureStylusRef, _ x: Double, _ y: Double) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    x

    the X coordinate of the stylus event
    y

    the Y coordinate of the stylus event
    handler

    The signal handler to call Run the given callback whenever the up signal is emitted
    Show on GitHub
  • upSignal Extension method

    Typed up signal for using the connect(signal:) methods

    Declaration

    Swift

    static var upSignal: GestureStylusSignalName { get }
    Show on GitHub

GestureStylus Class: GestureStylusProtocol extension (methods and fields)

  • get(axes:values:) Extension method

    Returns the current values for the requested axes.

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

    Declaration

    Swift

    @inlinable
func get(axes: UnsafeMutablePointer<GdkAxisUse>!, values: UnsafeMutablePointer<UnsafeMutablePointer<CDouble>?>!) -> Bool
    Show on GitHub
  • get(axis:value:) Extension method

    Returns the current value for the requested axis.

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

    Declaration

    Swift

    @inlinable
func get(axis: GdkAxisUse, value: UnsafeMutablePointer<CDouble>!) -> Bool
    Show on GitHub
  • get(backlog:nElems:) Extension method

    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.GestureStylusmotion] signal.

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

    The backlog is provided in chronological order.

    Declaration

    Swift

    @inlinable
func get(backlog: UnsafeMutablePointer<UnsafeMutablePointer<GdkTimeCoord>?>!, nElems: UnsafeMutablePointer<guint>!) -> Bool
    Show on GitHub
  • getDeviceTool() Extension method

    Returns the GdkDeviceTool currently driving input through this gesture.

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

    Declaration

    Swift

    @inlinable
func getDeviceTool() -> Gdk.DeviceToolRef!
    Show on GitHub
  • deviceTool Extension method

    Returns the GdkDeviceTool currently driving input through this gesture.

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

    Declaration

    Swift

    @inlinable
var deviceTool: Gdk.DeviceToolRef! { get }
    Show on GitHub