EventControllerLegacyProtocol

public protocol EventControllerLegacyProtocol : EventControllerProtocol

GtkEventControllerLegacy is an event controller that provides raw access to the event stream.

It should only be used as a last resort if none of the other event controllers or gestures do the job.

The EventControllerLegacyProtocol protocol exposes the methods and properties of an underlying GtkEventControllerLegacy 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 EventControllerLegacy. Alternatively, use EventControllerLegacyRef 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 GtkEventControllerLegacy instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkEventControllerLegacy instance.

    Default Implementation

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

    Declaration

    Swift

    var event_controller_legacy_ptr: UnsafeMutablePointer<GtkEventControllerLegacy>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to EventControllerLegacyProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

EventControllerLegacy Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

EventControllerLegacy signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Emitted for each GDK event delivered to controller.

    Note

    This represents the underlying event signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onEvent(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: EventControllerLegacyRef, _ event: Gdk.EventRef) -> Bool) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    event

    the GdkEvent which triggered this signal
    handler

    true to stop other handlers from being invoked for the event and the emission of this signal. false to propagate the event further. Run the given callback whenever the event signal is emitted
    Show on GitHub
  • eventSignal Extension method

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

    Declaration

    Swift

    static var eventSignal: EventControllerLegacySignalName { get }
    Show on GitHub