Package org.gnome.gdk

Interface Toplevel

All Superinterfaces:

Proxy

All Known Implementing Classes:

Toplevel.Toplevel$Impl

@Generated("io.github.jwharm.JavaGI")
public interface Toplevel
extends Proxy

A freestanding toplevel surface.

The GdkToplevel interface provides useful APIs for interacting with the windowing system, such as controlling maximization and size of the surface, setting icons and transient parents for dialogs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Toplevel.Builder<B extends Builder<B>>
static interface	Toplevel.ComputeSizeCallback	Functional interface declaration of the ComputeSizeCallback callback.
static class	Toplevel.Toplevel$Impl	The Toplevel$Impl type represents a native instance of the Toplevel interface.
static class	Toplevel.ToplevelInterface

Method Summary

Modifier and Type	Method	Description
default void	beginMove(Device device, int button, double x, double y, int timestamp)	Begins an interactive move operation.
default void	beginResize(SurfaceEdge edge, @Nullable Device device, int button, double x, double y, int timestamp)	Begins an interactive resize operation.
default void	emitComputeSize(@Nullable ToplevelSize size)	Emits the "compute-size" signal.
default void	focus(int timestamp)	Sets keyboard focus to surface.
default Set<ToplevelCapabilities>	getCapabilities()	The capabilities that are available for this toplevel.
default Gravity	getGravity()	Returns the gravity that is used when changing the toplevel size programmatically.
default Set<ToplevelState>	getState()	Gets the bitwise or of the currently active surface state flags, from the GdkToplevelState enumeration.
static @Nullable Type	getType()	Get the GType of the Toplevel class
default void	inhibitSystemShortcuts(@Nullable Event event)	Requests that the this Toplevel inhibit the system shortcuts.
default boolean	lower()	Asks to lower the this Toplevel below other windows.
default boolean	minimize()	Asks to minimize the toplevel.
default SignalConnection<Toplevel.ComputeSizeCallback>	onComputeSize(Toplevel.ComputeSizeCallback handler)	Emitted when the size for the surface needs to be computed, when it is present.
default void	present(ToplevelLayout layout)	Present this Toplevel after having processed the GdkToplevelLayout rules.
default void	restoreSystemShortcuts()	Restore default system keyboard shortcuts which were previously inhibited.
default void	setDecorated(boolean decorated)	Sets the toplevel to be decorated.
default void	setDeletable(boolean deletable)	Sets the toplevel to be deletable.
default void	setGravity(Gravity gravity)	Sets the gravity that is used when changing the toplevel size programmatically.
default void	setIconList(List<Texture> surfaces)	Sets a list of icons for the surface.
default void	setModal(boolean modal)	Sets the toplevel to be modal.
default void	setStartupId(String startupId)	Sets the startup notification ID.
default void	setTitle(String title)	Sets the title of a toplevel surface.
default void	setTransientFor(Surface parent)	Sets a transient-for parent.
default boolean	showWindowMenu(Event event)	Asks the windowing system to show the window menu.
default boolean	supportsEdgeConstraints()	Returns whether the desktop environment supports tiled window states.
default boolean	titlebarGesture(TitlebarGesture gesture)	Performs a title bar gesture.

Methods inherited from interface org.javagi.base.Proxy

handle

Method Details

getType

static @Nullable Type getType()

Get the GType of the Toplevel class

Returns:

the GType

beginMove

default void beginMove(Device device,
 int button,
 double x,
 double y,
 int timestamp)

Begins an interactive move operation.

You might use this function to implement draggable titlebars.

Parameters:

device - the device used for the operation

button - the button being used to drag, or 0 for a keyboard-initiated drag

x - surface X coordinate of mouse click that began the drag

y - surface Y coordinate of mouse click that began the drag

timestamp - timestamp of mouse click that began the drag (use Event.getTime())

beginResize

default void beginResize(SurfaceEdge edge,
 @Nullable Device device,
 int button,
 double x,
 double y,
 int timestamp)

Begins an interactive resize operation.

You might use this function to implement a “window resize grip.”

Parameters:

edge - the edge or corner from which the drag is started

device - the device used for the operation

button - the button being used to drag, or 0 for a keyboard-initiated drag

x - surface X coordinate of mouse click that began the drag

y - surface Y coordinate of mouse click that began the drag

timestamp - timestamp of mouse click that began the drag (use Event.getTime())

focus

default void focus(int timestamp)

Sets keyboard focus to surface.

In most cases, gtk_window_present_with_time() should be used on a GtkWindow, rather than calling this function.

Parameters:

timestamp - timestamp of the event triggering the surface focus

getCapabilities

default Set<ToplevelCapabilities> getCapabilities()

The capabilities that are available for this toplevel.

Since:

4.20

getGravity

default Gravity getGravity()

Returns the gravity that is used when changing the toplevel size programmatically.

Returns:

the gravity

Since:

4.20

getState

default Set<ToplevelState> getState()

Gets the bitwise or of the currently active surface state flags, from the GdkToplevelState enumeration.

Returns:

surface state bitfield

inhibitSystemShortcuts

default void inhibitSystemShortcuts(@Nullable Event event)

Requests that the this Toplevel inhibit the system shortcuts.

This is asking the desktop environment/windowing system to let all keyboard events reach the surface, as long as it is focused, instead of triggering system actions.

If granted, the rerouting remains active until the default shortcuts processing is restored with restoreSystemShortcuts(), or the request is revoked by the desktop environment, windowing system or the user.

A typical use case for this API is remote desktop or virtual machine viewers which need to inhibit the default system keyboard shortcuts so that the remote session or virtual host gets those instead of the local environment.

The windowing system or desktop environment may ask the user to grant or deny the request or even choose to ignore the request entirely.

The caller can be notified whenever the request is granted or revoked by listening to the Gdk.Toplevel:shortcuts-inhibited property.

Parameters:

event - the GdkEvent that is triggering the inhibit request, or null if none is available

lower

default boolean lower()

Asks to lower the this Toplevel below other windows.

The windowing system may choose to ignore the request.

Returns:

true if the surface was lowered

minimize

default boolean minimize()

Asks to minimize the toplevel.

The windowing system may choose to ignore the request.

Returns:

true if the surface was minimized

present

default void present(ToplevelLayout layout)

Present this Toplevel after having processed the GdkToplevelLayout rules.

If the toplevel was previously not showing, it will be showed, otherwise it will change layout according to layout.

GDK may emit the Gdk.Toplevel::compute-size signal to let the user of this toplevel compute the preferred size of the toplevel surface.

Presenting is asynchronous and the specified layout parameters are not guaranteed to be respected.

Parameters:

layout - the GdkToplevelLayout object used to layout

restoreSystemShortcuts

default void restoreSystemShortcuts()

Restore default system keyboard shortcuts which were previously inhibited.

This undoes the effect of inhibitSystemShortcuts(org.gnome.gdk.Event).

setDecorated

default void setDecorated(boolean decorated)

Sets the toplevel to be decorated.

Setting decorated to false hints the desktop environment that the surface has its own, client-side decorations and does not need to have window decorations added.

Parameters:

decorated - true to request decorations

setDeletable

default void setDeletable(boolean deletable)

Sets the toplevel to be deletable.

Setting deletable to true hints the desktop environment that it should offer the user a way to close the surface.

Parameters:

deletable - true to request a delete button

setGravity

default void setGravity(Gravity gravity)

Sets the gravity that is used when changing the toplevel size programmatically.

Parameters:

gravity - the new gravity

Since:

4.20

setIconList

default void setIconList(List<Texture> surfaces)

Sets a list of icons for the surface.

One of these will be used to represent the surface in iconic form. The icon may be shown in window lists or task bars. Which icon size is shown depends on the window manager. The window manager can scale the icon but setting several size icons can give better image quality.

Note that some platforms don't support surface icons.

Parameters:

surfaces - A list of textures to use as icon, of different sizes

setModal

default void setModal(boolean modal)

Sets the toplevel to be modal.

The application can use this hint to tell the window manager that a certain surface has modal behaviour. The window manager can use this information to handle modal surfaces in a special way.

You should only use this on surfaces for which you have previously called setTransientFor(org.gnome.gdk.Surface).

Parameters:

modal - true if the surface is modal, false otherwise.

setStartupId

default void setStartupId(String startupId)

Sets the startup notification ID.

When using GTK, typically you should use gtk_window_set_startup_id() instead of this low-level function.

Parameters:

startupId - a string with startup-notification identifier

setTitle

default void setTitle(String title)

Sets the title of a toplevel surface.

The title maybe be displayed in the titlebar, in lists of windows, etc.

Parameters:

title - title of surface

setTransientFor

default void setTransientFor(Surface parent)

Sets a transient-for parent.

Indicates to the window manager that surface is a transient dialog associated with the application surface parent. This allows the window manager to do things like center surface on parent and keep surface above parent.

See gtk_window_set_transient_for() if you’re using GtkWindow.

Parameters:

parent - another toplevel GdkSurface

showWindowMenu

default boolean showWindowMenu(Event event)

Asks the windowing system to show the window menu.

The window menu is the menu shown when right-clicking the titlebar on traditional windows managed by the window manager. This is useful for windows using client-side decorations, activating it with a right-click on the window decorations.

Parameters:

event - a GdkEvent to show the menu for

Returns:

true if the window menu was shown and false otherwise.

supportsEdgeConstraints

default boolean supportsEdgeConstraints()

Returns whether the desktop environment supports tiled window states.

Returns:

true if the desktop environment supports tiled window states

titlebarGesture

default boolean titlebarGesture(TitlebarGesture gesture)

Performs a title bar gesture.

Parameters:

gesture - a GdkTitlebarGesture

Returns:

whether the gesture was performed

Since:

4.4

onComputeSize

default SignalConnection<Toplevel.ComputeSizeCallback> onComputeSize(Toplevel.ComputeSizeCallback handler)

Emitted when the size for the surface needs to be computed, when it is present.

This signal will normally be emitted during or after a call to present(org.gnome.gdk.ToplevelLayout), depending on the configuration received by the windowing system. It may also be emitted at any other point in time, in response to the windowing system spontaneously changing the configuration of the toplevel surface.

It is the responsibility of the toplevel user to handle this signal and compute the desired size of the toplevel, given the information passed via the Gdk.ToplevelSize object. Failing to do so will result in an arbitrary size being used as a result.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Toplevel.ComputeSizeCallback.run(org.gnome.gdk.ToplevelSize)

emitComputeSize

default void emitComputeSize(@Nullable ToplevelSize size)

Emits the "compute-size" signal. See onComputeSize(org.gnome.gdk.Toplevel.ComputeSizeCallback).