Toplevel
- class Toplevel(*args, **kwargs)
A GdkToplevel
is 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.
Methods
- class Toplevel
- begin_move(device: Device, button: int, x: float, y: float, timestamp: int) None
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
get_time
)
- begin_resize(edge: SurfaceEdge, device: Device | None, button: int, x: float, y: float, timestamp: int) None
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
get_time
)
- focus(timestamp: int) None
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
- get_state() ToplevelState
Gets the bitwise or of the currently active surface state flags, from the
GdkToplevelState
enumeration.
- inhibit_system_shortcuts(event: Event | None = None) None
Requests that the
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
restore_system_shortcuts
, 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
shortcuts_inhibited
property.- Parameters:
event – the
GdkEvent
that is triggering the inhibit request, orNone
if none is available
- lower() bool
Asks to lower the
toplevel
below other windows.The windowing system may choose to ignore the request.
- minimize() bool
Asks to minimize the
toplevel
.The windowing system may choose to ignore the request.
- present(layout: ToplevelLayout) None
Present
toplevel
after having processed theGdkToplevelLayout
rules.If the toplevel was previously not showing, it will be showed, otherwise it will change layout according to
layout
.GDK may emit the
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
- restore_system_shortcuts() None
Restore default system keyboard shortcuts which were previously inhibited.
This undoes the effect of
inhibit_system_shortcuts
.
- set_decorated(decorated: bool) None
Sets the toplevel to be decorated.
Setting
decorated
toFalse
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
- set_deletable(deletable: bool) None
Sets the toplevel to be deletable.
Setting
deletable
toTrue
hints the desktop environment that it should offer the user a way to close the surface.- Parameters:
deletable –
True
to request a delete button
- set_icon_list(surfaces: list[Texture]) None
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
- set_modal(modal: bool) None
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
set_transient_for
.- Parameters:
modal –
True
if the surface is modal,False
otherwise.
- set_startup_id(startup_id: str) None
Sets the startup notification ID.
When using GTK, typically you should use gtk_window_set_startup_id() instead of this low-level function.
- Parameters:
startup_id – a string with startup-notification identifier
- set_title(title: str) None
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
- set_transient_for(parent: Surface) None
Sets a transient-for parent.
Indicates to the window manager that
surface
is a transient dialog associated with the application surfaceparent
. This allows the window manager to do things like centersurface
onparent
and keepsurface
aboveparent
.See gtk_window_set_transient_for() if you’re using GtkWindow.
- Parameters:
parent – another toplevel
GdkSurface
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
- supports_edge_constraints() bool
Returns whether the desktop environment supports tiled window states.
- titlebar_gesture(gesture: TitlebarGesture) bool
Added in version 4.4.
- Parameters:
gesture – a
GdkTitlebarGesture
Properties
- class Toplevel
-
- props.fullscreen_mode: FullscreenMode
The fullscreen mode of the surface.
- props.startup_id: str
The startup ID of the surface.
See
AppLaunchContext
for more information about startup feedback.
- props.state: ToplevelState
The state of the toplevel.
Signals
- class Toplevel.signals
- compute_size(size: ToplevelSize) None
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
, 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
ToplevelSize
object. Failing to do so will result in an arbitrary size being used as a result.- Parameters:
size – a
GdkToplevelSize