GestureDragProtocol

public protocol GestureDragProtocol : GestureSingleProtocol

GtkGestureDrag is a GtkGesture implementation for drags.

The drag operation itself can be tracked throughout the [signalGtk.GestureDrag::drag-begin], [signalGtk.GestureDrag::drag-update] and [signalGtk.GestureDrag::drag-end] signals, and the relevant coordinates can be extracted through [methodGtk.GestureDrag.get_offset] and [methodGtk.GestureDrag.get_start_point].

The GestureDragProtocol protocol exposes the methods and properties of an underlying GtkGestureDrag 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 GestureDrag. Alternatively, use GestureDragRef 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 GtkGestureDrag instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkGestureDrag instance.

    Default Implementation

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

    Declaration

    Swift

    var gesture_drag_ptr: UnsafeMutablePointer<GtkGestureDrag>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to GestureDragProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

GestureDrag Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

GestureDrag signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Emitted whenever dragging starts.

    Note

    This represents the underlying drag-begin signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onDragBegin(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GestureDragRef, _ startX: Double, _ startY: Double) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    startX

    X coordinate, relative to the widget allocation
    startY

    Y coordinate, relative to the widget allocation
    handler

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

    Typed drag-begin signal for using the connect(signal:) methods

    Declaration

    Swift

    static var dragBeginSignal: GestureDragSignalName { get }
    Show on GitHub
  • onDragEnd(flags:handler:) Extension method

    Emitted whenever the dragging is finished.

    Note

    This represents the underlying drag-end signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onDragEnd(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GestureDragRef, _ offsetX: Double, _ offsetY: Double) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    offsetX

    X offset, relative to the start point
    offsetY

    Y offset, relative to the start point
    handler

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

    Typed drag-end signal for using the connect(signal:) methods

    Declaration

    Swift

    static var dragEndSignal: GestureDragSignalName { get }
    Show on GitHub
  • onDragUpdate(flags:handler:) Extension method

    Emitted whenever the dragging point moves.

    Note

    This represents the underlying drag-update signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onDragUpdate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GestureDragRef, _ offsetX: Double, _ offsetY: Double) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    offsetX

    X offset, relative to the start point
    offsetY

    Y offset, relative to the start point
    handler

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

    Typed drag-update signal for using the connect(signal:) methods

    Declaration

    Swift

    static var dragUpdateSignal: GestureDragSignalName { get }
    Show on GitHub

GestureDrag Class: GestureDragProtocol extension (methods and fields)

  • getOffset(x:y:) Extension method

    Gets the offset from the start point.

    If the gesture is active, this function returns true and fills in x and y with the coordinates of the current point, as an offset to the starting drag point.

    Declaration

    Swift

    @inlinable
func getOffset(x: UnsafeMutablePointer<CDouble>?, y: UnsafeMutablePointer<CDouble>?) -> Bool
    Show on GitHub
  • getStartPoint(x:y:) Extension method

    Gets the point where the drag started.

    If the gesture is active, this function returns true and fills in x and y with the drag start coordinates, in surface-relative coordinates.

    Declaration

    Swift

    @inlinable
func getStartPoint(x: UnsafeMutablePointer<CDouble>?, y: UnsafeMutablePointer<CDouble>?) -> Bool
    Show on GitHub