EventControllerFocusProtocol

public protocol EventControllerFocusProtocol : EventControllerProtocol

GtkEventControllerFocus is an event controller to keep track of keyboard focus.

The event controller offers [signalGtk.EventControllerFocus::enter] and [signalGtk.EventControllerFocus::leave] signals, as well as [propertyGtk.EventControllerFocus:is-focus] and [propertyGtk.EventControllerFocus:contains-focus] properties which are updated to reflect focus changes inside the widget hierarchy that is rooted at the controllers widget.

The EventControllerFocusProtocol protocol exposes the methods and properties of an underlying GtkEventControllerFocus 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 EventControllerFocus. Alternatively, use EventControllerFocusRef 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 GtkEventControllerFocus instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkEventControllerFocus instance.

    Default Implementation

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

    Declaration

    Swift

    var event_controller_focus_ptr: UnsafeMutablePointer<GtkEventControllerFocus>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to EventControllerFocusProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

EventControllerFocus Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

EventControllerFocus signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Emitted whenever the focus enters into the widget or one of its descendents.

    Note that this means you may not get an enter signal even though the widget becomes the focus location, in certain cases (such as when the focus moves from a descendent of the widget to the widget itself). If you are interested in these cases, you can monitor the [propertyGtk.EventControllerFocus:is-focus] property for changes.

    Note

    This represents the underlying enter signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    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: EventControllerFocusSignalName { get }
    Show on GitHub
  • onLeave(flags:handler:) Extension method

    Emitted whenever the focus leaves the widget hierarchy that is rooted at the widget that the controller is attached to.

    Note that this means you may not get a leave signal even though the focus moves away from the widget, in certain cases (such as when the focus moves from the widget to a descendent). If you are interested in these cases, you can monitor the [propertyGtk.EventControllerFocus:is-focus] property for changes.

    Note

    This represents the underlying leave signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onLeave(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: EventControllerFocusRef) -> 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: EventControllerFocusSignalName { 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::contains-focus signal

    Declaration

    Swift

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

    Typed notify::contains-focus signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyContainsFocusSignal: EventControllerFocusSignalName { 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::is-focus signal

    Declaration

    Swift

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

    Typed notify::is-focus signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyIsFocusSignal: EventControllerFocusSignalName { get }
    Show on GitHub

EventControllerFocus Class: EventControllerFocusProtocol extension (methods and fields)

  • containsFocus() Extension method

    Returns true if focus is within self or one of its children.

    Declaration

    Swift

    @inlinable
func containsFocus() -> Bool
    Show on GitHub
  • isFocus Extension method

    Returns true if focus is within self, but not one of its children.

    Declaration

    Swift

    @inlinable
var isFocus: Bool { get }
    Show on GitHub