gtk4/org.gtkkn.bindings.gtk/EventControllerFocus

EventControllerFocus

open class EventControllerFocus(pointer: <Error class: unknown class><<Error class: unknown class>>) : EventController

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

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

Skipped during bindings generation

method contains-focus: Property has no getter nor setter
method is-focus: Property has no getter nor setter

Constructors

EventControllerFocus

constructor()

Creates a new event controller that will handle focus events.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

object Companion

Properties

gtkEventControllerFocusPointer

val gtkEventControllerFocusPointer: <Error class: unknown class><<Error class: unknown class>>

gtkEventControllerPointer

val gtkEventControllerPointer: <Error class: unknown class><<Error class: unknown class>>

open var name: String?

The name for this controller, typically used for debugging purposes.

propagationLimit

open var propagationLimit: PropagationLimit

The limit for which events this controller will handle.

propagationPhase

open var propagationPhase: PropagationPhase

The propagation phase at which this controller will handle events.

open val widget: Widget?

The widget receiving the GdkEvents that the controller will handle.

Functions

fun connectEnter(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

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

fun connectLeave(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

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

open fun containsFocus(): Boolean

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

getCurrentEvent

open fun getCurrentEvent(): <Error class: unknown class>?

Returns the event that is currently being handled by the controller.

getCurrentEventDevice

open fun getCurrentEventDevice(): <Error class: unknown class>?

Returns the device of the event that is currently being handled by the controller.

getCurrentEventState

open fun getCurrentEventState(): <Error class: unknown class>

Returns the modifier state of the event that is currently being handled by the controller.

getCurrentEventTime

open fun getCurrentEventTime(): <Error class: unknown class>

Returns the timestamp of the event that is currently being handled by the controller.

open fun getName(): String?

Gets the name of @controller.

getPropagationLimit

open fun getPropagationLimit(): PropagationLimit

Gets the propagation limit of the event controller.

getPropagationPhase

open fun getPropagationPhase(): PropagationPhase

Gets the propagation phase at which @controller handles events.

open fun getWidget(): Widget?

Returns the GtkWidget this controller relates to.

open fun isFocus(): Boolean

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

open fun reset()

Resets the @controller to a clean state.

open fun setName(name: String? = null)

Sets a name on the controller that can be used for debugging.

setPropagationLimit

open fun setPropagationLimit(limit: PropagationLimit)

Sets the event propagation limit on the event controller.

setPropagationPhase

open fun setPropagationPhase(phase: PropagationPhase)

Sets the propagation phase at which a controller handles events.

open fun setStaticName(name: String? = null)

Sets a name on the controller that can be used for debugging.