GestureLongPressProtocol

public protocol GestureLongPressProtocol : GestureSingleProtocol

GtkGestureLongPress is a GtkGesture for long presses.

This gesture is also known as “Press and Hold”.

When the timeout is exceeded, the gesture is triggering the [signalGtk.GestureLongPress::pressed] signal.

If the touchpoint is lifted before the timeout passes, or if it drifts too far of the initial press point, the [signalGtk.GestureLongPress::cancelled] signal will be emitted.

How long the timeout is before the pressed signal gets emitted is determined by the [propertyGtk.Settings:gtk-long-press-time] setting. It can be modified by the [propertyGtk.GestureLongPress:delay-factor] property.

The GestureLongPressProtocol protocol exposes the methods and properties of an underlying GtkGestureLongPress 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 GestureLongPress. Alternatively, use GestureLongPressRef 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 GtkGestureLongPress instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkGestureLongPress instance.

    Default Implementation

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

    Declaration

    Swift

    var gesture_long_press_ptr: UnsafeMutablePointer<GtkGestureLongPress>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to GestureLongPressProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

GestureLongPress Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

GestureLongPress signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Emitted whenever a press moved too far, or was released before [signalGtk.GestureLongPress::pressed] happened.

    Note

    This represents the underlying cancelled signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onCancelled(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GestureLongPressRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

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

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

    Declaration

    Swift

    static var cancelledSignal: GestureLongPressSignalName { get }
    Show on GitHub
  • onPressed(flags:handler:) Extension method

    Emitted whenever a press goes unmoved/unreleased longer than what the GTK defaults tell.

    Note

    This represents the underlying pressed signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    x

    the X coordinate where the press happened, relative to the widget allocation
    y

    the Y coordinate where the press happened, relative to the widget allocation
    handler

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

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

    Declaration

    Swift

    static var pressedSignal: GestureLongPressSignalName { 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::delay-factor signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyDelayFactor(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: GestureLongPressRef, _ 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 notifyDelayFactor signal is emitted
    Show on GitHub
  • notifyDelayFactorSignal Extension method

    Typed notify::delay-factor signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyDelayFactorSignal: GestureLongPressSignalName { get }
    Show on GitHub

GestureLongPress Class: GestureLongPressProtocol extension (methods and fields)

  • getDelayFactor() Extension method

    Returns the delay factor.

    Declaration

    Swift

    @inlinable
func getDelayFactor() -> CDouble
    Show on GitHub
  • set(delayFactor:) Extension method

    Applies the given delay factor.

    The default long press time will be multiplied by this value. Valid values are in the range [0.5..2.0].

    Declaration

    Swift

    @inlinable
func set(delayFactor: CDouble)
    Show on GitHub
  • delayFactor Extension method

    Returns the delay factor.

    Declaration

    Swift

    @inlinable
var delayFactor: CDouble { get nonmutating set }
    Show on GitHub