Interface Root

All Superinterfaces:

Native, Proxy

All Known Implementing Classes:

AboutDialog, AboutWindow, AppChooserDialog, ApplicationWindow, ApplicationWindow, Assistant, ColorChooserDialog, Dialog, DragIcon, FileChooserDialog, FontChooserDialog, MessageDialog, MessageDialog, PageSetupUnixDialog, PreferencesWindow, PrintUnixDialog, Root.Root$Impl, ShortcutsWindow, Window, Window

@Generated("org.javagi.JavaGI")
public interface Root
extends Proxy, Native

An interface for widgets that can act as the root of a widget hierarchy.

The root widget takes care of providing the connection to the windowing system and manages layout, drawing and event delivery for its widget hierarchy.

The obvious example of a GtkRoot is GtkWindow.

To get the display to which a GtkRoot belongs, use getDisplay().

GtkRoot also maintains the location of keyboard focus inside its widget hierarchy, with setFocus(Widget) and getFocus().

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Root.Root$Impl	The Root$Impl type represents a native instance of the Root interface.
static class	Root.RootInterface

Nested classes/interfaces inherited from interface Native

Native.Native$Impl, Native.NativeInterface

Method Summary

Modifier and Type	Method	Description
default Display	getDisplay()	Returns the display that this GtkRoot is on.
default @Nullable Widget	getFocus()	Retrieves the current focused widget within the root.
static @Nullable Type	getType()	Get the GType of the Root class.
default void	setFocus(@Nullable Widget focus)	If focus is not the current focus widget, and is focusable, sets it as the focus widget for the root.

Methods inherited from interface Native

getRenderer, getSurface, getSurfaceTransform, realize, unrealize

Methods inherited from interface Proxy

handle

Method Details

getType

static @Nullable Type getType()

Get the GType of the Root class.

Returns:

the GType

getDisplay

default Display getDisplay()

Returns the display that this GtkRoot is on.

Returns:

the display of root

getFocus

default @Nullable Widget getFocus()

Retrieves the current focused widget within the root.

Note that this is the widget that would have the focus if the root is active; if the root is not focused then gtk_widget_has_focus (widget) will be false for the widget.

Returns:

the currently focused widget

setFocus

default void setFocus(@Nullable Widget focus)

If focus is not the current focus widget, and is focusable, sets it as the focus widget for the root.

If focus is null, unsets the focus widget for the root.

To set the focus to a particular widget in the root, it is usually more convenient to use Widget.grabFocus() instead of this function.

Parameters:

focus - widget to be the new focus widget, or null to unset the focus widget