GestureSwipeProtocol

public protocol GestureSwipeProtocol : GestureSingleProtocol

GtkGestureSwipe is a GtkGesture for swipe gestures.

After a press/move/…/move/release sequence happens, the [signalGtk.GestureSwipe::swipe] signal will be emitted, providing the velocity and directionality of the sequence at the time it was lifted.

If the velocity is desired in intermediate points, [methodGtk.GestureSwipe.get_velocity] can be called in a [signalGtk.Gesture::update] handler.

All velocities are reported in pixels/sec units.

The GestureSwipeProtocol protocol exposes the methods and properties of an underlying GtkGestureSwipe 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 GestureSwipe. Alternatively, use GestureSwipeRef 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 GtkGestureSwipe instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkGestureSwipe instance.

    Default Implementation

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

    Declaration

    Swift

    var gesture_swipe_ptr: UnsafeMutablePointer<GtkGestureSwipe>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to GestureSwipeProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

GestureSwipe Class

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

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: GestureSwipePropertyName, 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 GestureSwipe property

    Declaration

    Swift

    @inlinable
func get(property: GestureSwipePropertyName) -> 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 GestureSwipe property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

GestureSwipe signals

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

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: GestureSwipeSignalName, 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 GestureSwipeSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: GestureSwipeSignalName, 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
  • onSwipe(flags:handler:) Extension method

    Emitted when the recognized gesture is finished.

    Velocity and direction are a product of previously recorded events.

    Note

    This represents the underlying swipe signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onSwipe(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GestureSwipeRef, _ velocityX: Double, _ velocityY: Double) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    velocityX

    velocity in the X axis, in pixels/sec
    velocityY

    velocity in the Y axis, in pixels/sec
    handler

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

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

    Declaration

    Swift

    static var swipeSignal: GestureSwipeSignalName { get }
    Show on GitHub

GestureSwipe Class: GestureSwipeProtocol extension (methods and fields)

  • Gets the current velocity.

    If the gesture is recognized, this function returns true and fills in velocity_x and velocity_y with the recorded velocity, as per the last events processed.

    Declaration

    Swift

    @inlinable
func getVelocity(velocityX: UnsafeMutablePointer<CDouble>!, velocityY: UnsafeMutablePointer<CDouble>!) -> Bool
    Show on GitHub