Package org.gnome.gtk

Class EventControllerFocus

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.EventController

org.gnome.gtk.EventControllerFocus

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class EventControllerFocus
extends EventController

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventControllerFocus.Builder<B extends EventControllerFocus.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	EventControllerFocus.EnterCallback	Functional interface declaration of the EnterCallback callback.
static class	EventControllerFocus.EventControllerFocusClass
static interface	EventControllerFocus.LeaveCallback	Functional interface declaration of the LeaveCallback callback.

Nested classes/interfaces inherited from class org.gnome.gtk.EventController

EventController.EventControllerClass, EventController.EventControllerImpl

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
EventControllerFocus()	Creates a new event controller that will handle focus events.
EventControllerFocus(MemorySegment address)	Create a EventControllerFocus proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected EventControllerFocus	asParent()	Returns this instance as if it were its parent type.
static EventControllerFocus.Builder<? extends EventControllerFocus.Builder>	builder()	A EventControllerFocus.Builder object constructs a EventControllerFocus with the specified properties.
boolean	containsFocus()	Returns true if focus is within this EventControllerFocus or one of its children.
void	emitEnter()	Emits the "enter" signal.
void	emitLeave()	Emits the "leave" signal.
static Type	getType()	Get the GType of the EventControllerFocus class
boolean	isFocus()	Returns true if focus is within this EventControllerFocus, but not one of its children.
SignalConnection<EventControllerFocus.EnterCallback>	onEnter(EventControllerFocus.EnterCallback handler)	Emitted whenever the focus enters into the widget or one of its descendents.
SignalConnection<EventControllerFocus.LeaveCallback>	onLeave(EventControllerFocus.LeaveCallback handler)	Emitted whenever the focus leaves the widget hierarchy that is rooted at the widget that the controller is attached to.

Methods inherited from class org.gnome.gtk.EventController

getCurrentEvent, getCurrentEventDevice, getCurrentEventState, getCurrentEventTime, getName, getPropagationLimit, getPropagationPhase, getWidget, reset, setName, setPropagationLimit, setPropagationPhase, setStaticName

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EventControllerFocus

public EventControllerFocus(MemorySegment address)

Create a EventControllerFocus proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

EventControllerFocus

public EventControllerFocus()

Creates a new event controller that will handle focus events.

Method Details

getType

public static Type getType()

Get the GType of the EventControllerFocus class

Returns:

the GType

asParent

protected EventControllerFocus asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class EventController

containsFocus

public boolean containsFocus()

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

Returns:

true if focus is within this EventControllerFocus or one of its children

isFocus

public boolean isFocus()

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

Returns:

true if focus is within this EventControllerFocus, but not one of its children

onEnter

public SignalConnection<EventControllerFocus.EnterCallback> onEnter(EventControllerFocus.EnterCallback handler)

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 Gtk.EventControllerFocus:is-focus property for changes.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• EventControllerFocus.EnterCallback.run()

emitEnter

public void emitEnter()

Emits the "enter" signal. See onEnter(org.gnome.gtk.EventControllerFocus.EnterCallback).

onLeave

public SignalConnection<EventControllerFocus.LeaveCallback> onLeave(EventControllerFocus.LeaveCallback handler)

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 Gtk.EventControllerFocus:is-focus property for changes.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• EventControllerFocus.LeaveCallback.run()

emitLeave

public void emitLeave()

Emits the "leave" signal. See onLeave(org.gnome.gtk.EventControllerFocus.LeaveCallback).

builder

public static EventControllerFocus.Builder<? extends EventControllerFocus.Builder> builder()

A EventControllerFocus.Builder object constructs a EventControllerFocus with the specified properties. Use the various set...() methods to set properties, and finish construction with EventControllerFocus.Builder.build().