Class XdgToplevel
toplevel surface
class XdgToplevel
: wayland
This interface defines an xdg_surface role which allows a surface to, among other things, set window-like properties such as maximize, fullscreen, and minimize, set application-specific metadata like title and id, and well as trigger user interactive operations such as interactive resize and move.
Unmapping an xdg_toplevel means that the surface cannot be shown by the compositor until it is explicitly mapped again. All active operations (e.g., move, resize) are canceled and all attributes (e.g. title, state, stacking, ...) are discarded for an xdg_toplevel surface when it is unmapped.
Attaching a null buffer to a toplevel unmaps the surface.
Properties
| Name | Type | Description |
|---|---|---|
iface[get]
|
immutable(wayland | Interface object that creates XdgToplevel objects. |
onClose[set]
|
void delegate(XdgToplevel) | surface wants to be closed |
onConfigure[set]
|
void delegate(XdgToplevel, int, int, wayland | suggest a surface change |
Methods
| Name | Description |
|---|---|
destroy
()
|
destroy the xdg_toplevel |
move
(seat, serial)
|
start an interactive move |
resize
(seat, serial, edges)
|
start an interactive resize |
setAppId
(appId)
|
set application ID |
setFullscreen
(output)
|
set the window as fullscreen on an output |
setMaximized
()
|
maximize the window |
setMaxSize
(width, height)
|
set the maximum size |
setMinimized
()
|
set the window as minimized |
setMinSize
(width, height)
|
set the minimum size |
setParent
(parent)
|
set the parent of this surface |
setTitle
(title)
|
set surface title |
showWindowMenu
(seat, serial, x, y)
|
show the window menu |
unsetFullscreen
()
|
unset the window as fullscreen |
unsetMaximized
()
|
unmaximize the window |
Enums
| Name | Description |
|---|---|
ResizeEdge
|
edge values for resizing |
State
|
types of state on the surface |
Aliases
| Name | Description |
|---|---|
OnCloseEventDg
|
Event delegate signature of XdgToplevel.onClose. |
OnConfigureEventDg
|
Event delegate signature of XdgToplevel.onConfigure. |