GesturePanProtocol

public protocol GesturePanProtocol : GestureDragProtocol

GtkGesturePan is a GtkGesture for pan gestures.

These are drags that are locked to happen along one axis. The axis that a GtkGesturePan handles is defined at construct time, and can be changed through [methodGtk.GesturePan.set_orientation].

When the gesture starts to be recognized, GtkGesturePan will attempt to determine as early as possible whether the sequence is moving in the expected direction, and denying the sequence if this does not happen.

Once a panning gesture along the expected axis is recognized, the [signalGtk.GesturePan::pan] signal will be emitted as input events are received, containing the offset in the given axis.

The GesturePanProtocol protocol exposes the methods and properties of an underlying GtkGesturePan 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 GesturePan. Alternatively, use GesturePanRef 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 GtkGesturePan instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkGesturePan instance.

    Default Implementation

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

    Declaration

    Swift

    var gesture_pan_ptr: UnsafeMutablePointer<GtkGesturePan>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to GesturePanProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

GesturePan Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

GesturePan signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Emitted once a panning gesture along the expected axis is detected.

    Note

    This represents the underlying pan signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onPan(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GesturePanRef, _ direction: PanDirection, _ offset: Double) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    direction

    current direction of the pan gesture
    offset

    Offset along the gesture orientation
    handler

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

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

    Declaration

    Swift

    static var panSignal: GesturePanSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::orientation signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyOrientation(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GesturePanRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

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

    Typed notify::orientation signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyOrientationSignal: GesturePanSignalName { get }
    Show on GitHub

GesturePan Class: GesturePanProtocol extension (methods and fields)

  • getOrientation() Extension method

    Returns the orientation of the pan gestures that this gesture expects.

    Declaration

    Swift

    @inlinable
func getOrientation() -> GtkOrientation
    Show on GitHub
  • set(orientation:) Extension method

    Sets the orientation to be expected on pan gestures.

    Declaration

    Swift

    @inlinable
func set(orientation: GtkOrientation)
    Show on GitHub
  • orientation Extension method

    The expected orientation of pan gestures.

    Declaration

    Swift

    @inlinable
var orientation: GtkOrientation { get nonmutating set }
    Show on GitHub