EventControllerMotionProtocol

public protocol EventControllerMotionProtocol : EventControllerProtocol

GtkEventControllerMotion is an event controller meant for situations where you need to track the position of the pointer.

This object was added in 3.24.

The EventControllerMotionProtocol protocol exposes the methods and properties of an underlying GtkEventControllerMotion 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 EventControllerMotion. Alternatively, use EventControllerMotionRef 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 GtkEventControllerMotion instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkEventControllerMotion instance.

    Default Implementation

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

    Declaration

    Swift

    var event_controller_motion_ptr: UnsafeMutablePointer<GtkEventControllerMotion>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to EventControllerMotionProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

EventControllerMotion Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

EventControllerMotion signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Signals that the pointer has entered the widget.

    Note

    This represents the underlying enter signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    x

    the x coordinate
    y

    the y coordinate
    handler

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

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

    Declaration

    Swift

    static var enterSignal: EventControllerMotionSignalName { get }
    Show on GitHub
  • onLeave(flags:handler:) Extension method

    Signals that pointer has left the widget.

    Note

    This represents the underlying leave signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

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

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

    Declaration

    Swift

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

    Emitted when the pointer moves inside the widget.

    Note

    This represents the underlying motion signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    x

    the x coordinate
    y

    the y coordinate
    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: EventControllerMotionSignalName { get }
    Show on GitHub