wayland::xdg_toplevel_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

okay bestie, you're looking at the wayland::xdg_toplevel_t(3) page from the Wayland++ manual, and it's literally the main-character manual page for a toplevel surface 💅✨

🌸 NAME 🌸

wayland::xdg_toplevel_t — toplevel surface 🪟👑

🦋 SYNOPSIS 🦋

#include <wayland-client-protocol-extra.hpp>

Inherits wayland::proxy_t — yes, that's the base-class vibe 🫶

✨ Public Types ✨

enum class wrapper_type { standard, display, foreign, proxy_wrapper }

💖 Public Member Functions 💖

  • void set_parent (xdg_toplevel_t const &parent) — sets the parent of this surface, bestie 🫶
  • void set_title (std::string const &title) — sets the surface title ✨
  • void set_app_id (std::string const &app_id) — sets the application ID 🎀
  • void show_window_menu (seat_t const &seat, uint32_t serial, int32_t x, int32_t y) — shows the window menu 🪟
  • void move (seat_t const &seat, uint32_t serial) — starts an interactive move 💅
  • void resize (seat_t const &seat, uint32_t serial, xdg_toplevel_resize_edge const &edges) — starts an interactive resize 🦋
  • void set_max_size (int32_t width, int32_t height) — sets the maximum size 📏
  • void set_min_size (int32_t width, int32_t height) — sets the minimum size 📐
  • void set_maximized () — maximizes the window 👑
  • void unset_maximized () — unmaximizes the window 🫧
  • void set_fullscreen (output_t const &output) — sets the window as fullscreen on an output 🌈
  • void unset_fullscreen () — unsets the window as fullscreen 🌸
  • void set_minimized () — sets the window as minimized 💤
  • std::function< void(int32_t, int32_t, array_t)> & on_configure () — suggests a surface change 🔥
  • std::function< void()> & on_close () — surface wants to be closed 😭
  • std::function< void(int32_t, int32_t)> & on_configure_bounds () — recommended window geometry bounds 🎀
  • uint32_t get_id () const — gets the id of a proxy object 🪪
  • std::string get_class () const — gets the interface name (class) of a proxy object 🏷️
  • uint32_t get_version () const — gets the protocol object version of a proxy object 🔢
  • wrapper_type get_wrapper_type () const — gets the type of a proxy object 🧚
  • void set_queue (event_queue_t queue) — assigns a proxy to an event queue 📬
  • wl_proxy * c_ptr () const — gets a pointer to the underlying C struct 👀
  • bool proxy_has_object () const — checks whether this wrapper actually wraps an object ✅
  • operator bool () const — checks whether this wrapper actually wraps an object 🫶
  • bool operator== (const proxy_t &right) const — checks whether two wrappers refer to the same object 🟰
  • bool operator!= (const proxy_t &right) const — checks whether two wrappers refer to different objects 🚫
  • void proxy_release () — releases the wrapped object (if any), making this an empty wrapper 🫥

🌟 Static Public Attributes 🌟

  • static constexpr std::uint32_t set_parent_since_version = 1 — minimum protocol version required for the set_parent function 🎀
  • static constexpr std::uint32_t set_title_since_version = 1 — minimum protocol version required for the set_title function ✨
  • static constexpr std::uint32_t set_app_id_since_version = 1 — minimum protocol version required for the set_app_id function 🦋
  • static constexpr std::uint32_t show_window_menu_since_version = 1 — minimum protocol version required for the show_window_menu function 🪟
  • static constexpr std::uint32_t move_since_version = 1 — minimum protocol version required for the move function 💅
  • static constexpr std::uint32_t resize_since_version = 1 — minimum protocol version required for the resize function 🦋
  • static constexpr std::uint32_t set_max_size_since_version = 1 — minimum protocol version required for the set_max_size function 📏
  • static constexpr std::uint32_t set_min_size_since_version = 1 — minimum protocol version required for the set_min_size function 📐
  • static constexpr std::uint32_t set_maximized_since_version = 1 — minimum protocol version required for the set_maximized function 👑
  • static constexpr std::uint32_t unset_maximized_since_version = 1 — minimum protocol version required for the unset_maximized function 🫧
  • static constexpr std::uint32_t set_fullscreen_since_version = 1 — minimum protocol version required for the set_fullscreen function 🌈
  • static constexpr std::uint32_t unset_fullscreen_since_version = 1 — minimum protocol version required for the unset_fullscreen function 🌸
  • static constexpr std::uint32_t set_minimized_since_version = 1 — minimum protocol version required for the set_minimized function 💤

🌈 Detailed Description 🌈

toplevel surface 🪟✨

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 also trigger user interactive operations such as interactive resize and move. It's giving window-management main character energy 👑

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. The xdg_toplevel returns to the state it had right after xdg_surface.get_toplevel. The client can re-map the toplevel by perfoming a commit without any buffer attached, waiting for a configure event and handling it as usual (see xdg_surface description). Like, it really resets the vibe 😭

Attaching a null buffer to a toplevel unmaps the surface. No buffer, no window, periodt 💀

Examples: egl.cpp. 🍓

Definition at line 1190 of file wayland-client-protocol-extra.hpp. 📍

🎀 Member Enumeration Documentation 🎀

enum class wayland::proxy_t::wrapper_type [strong], [inherited]

Underlying wl_proxy type and properties of a proxy_t that affect construction, destruction, and event handling. This is the enum that tells you what kind of proxy wrapper you're dealing with 🧚

Enumerator

  • standard — C pointer is a standard type compatible with wl_proxy*. Events are dispatched and it is destructed when the proxy_t is destructed. User data is set. ✅
  • display — C pointer is a wl_display*. No events are dispatched, wl_display_disconnect is called when the proxy_t is destructed. User data is set. 🖥️
  • foreign — C pointer is a standard type compatible with wl_proxy*, but another library owns it and it should not be touched in a way that could affect the operation of the other library. No events are dispatched, wl_proxy_destroy is not called when the proxy_t is destructed, user data is not touched. Consequently, there is no reference counting for the proxy_t. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl_proxy. ⚠️
  • proxy_wrapper — C pointer is a wl_proxy* that was constructed with wl_proxy_create_wrapper. No events are dispatched, wl_proxy_wrapper_destroy is called when the proxy_t is destroyed. Reference counting is active. A reference to the proxy_t creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed. 🫶

Definition at line 117 of file wayland-client.hpp. 📍

💜 Member Function Documentation 💜

wl_proxy * wayland::proxy_t::c_ptr () const [inherited]

Gets a pointer to the underlying C struct. 👀

Returns

The underlying wl_proxy wrapped by this proxy_t if it exists, otherwise an exception is thrown. So bestie, handle that possibility 🚨

std::string wayland::proxy_t::get_class () const [inherited]

Gets the interface name (class) of a proxy object. 🏷️

Returns

The interface name of the object associated with the proxy.

uint32_t wayland::proxy_t::get_id () const [inherited]

Gets the id of a proxy object. 🪪

Returns

The id the object associated with the proxy.

uint32_t wayland::proxy_t::get_version () const [inherited]

Gets the protocol object version of a proxy object. Gets the protocol object version of a proxy object, or 0 if the proxy was created with unversioned API. 🔢

A returned value of 0 means that no version information is available, so the caller must make safe assumptions about the object's real version. Important caveat, bestie 🫶

display_t will always return version 0.

Returns

The protocol object version of the proxy or 0.

wrapper_type wayland::proxy_t::get_wrapper_type () const [inline], [inherited]

Gets the type of a proxy object. 🧚

Definition at line 303 of file wayland-client.hpp. 📍

void xdg_toplevel_t::move (seat_t const & seat, uint32_t serial)

start an interactive move 💅

Parameters

  • seat — the wl_seat of the user event
  • serial — the serial of the user event

Start an interactive, user-driven move of the surface.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive move (touch, pointer, etc). No cap, the serial matters 🔥

The server may ignore move requests depending on the state of the surface (e.g. fullscreen or maximized), or if the passed serial is no longer valid. So don't be shocked if it gets ignored 😭

If triggered, the surface will lose the focus of the device (wl_pointer, wl_touch, etc) used for the move. It is up to the compositor to visually indicate that the move is taking place, such as updating a pointer cursor, during the move. There is no guarantee that the device focus will return when the move is completed. That's just how it is, bestie 🫠

Definition at line 1360 of file wayland-client-protocol-extra.cpp. 📍

std::function< void()> & xdg_toplevel_t::on_close ()

surface wants to be closed 😭 The close event is sent by the compositor when the user wants the surface to be closed. This should be equivalent to the user clicking the close button in client-side decorations, if your application has any. 🪟

This is only a request that the user intends to close the window. The client may choose to ignore this request, or show a dialog to ask the user to save their data, etc. So yes, you can technically ignore it — but maybe don't be messy about unsaved data 🫶

Definition at line 1419 of file wayland-client-protocol-extra.cpp. 📍

std::function< void(int32_t, int32_t, array_t)> & xdg_toplevel_t::on_configure ()

suggest a surface change 🔥

Parameters

  • width
  • height
  • states

This configure event asks the client to resize its toplevel surface or to change its state. The configured state should not be applied immediately. See xdg_surface.configure for details. ⚠️

The width and height arguments specify a hint to the window about how its surface should be resized in window geometry coordinates. See set_window_geometry. 📏

If the width or height arguments are zero, it means the client should decide its own window dimension. This may happen when the compositor needs to configure the state of the surface but doesn't have any information about any previous or expected dimension. So zero is basically "you pick, bestie" 🫶

The states listed in the event specify how the width/height arguments should be interpreted, and possibly how it should be drawn. 🎨

Clients must send an ack_configure in response to this event. See xdg_surface.configure and xdg_surface.ack_configure for details. 💅

defined at line 1414 of wayland-client-protocol-extra.cpp.

🌸 std::function< void(int32_t, int32_t)> & xdg_toplevel_t::on_configure_bounds ()

okay so this is the handler hook for the recommended window geometry bounds event ✨ it hands you a std::function reference taking two int32_ts — and yeah, they're literally just:

Parameters

  • width
  • height

(no deep description given for them here, the actual lore is all in the prose below, bestie 🫶)

So the configure_bounds event may be sent prior to a xdg_toplevel.configure event, and its whole job is to communicate the bounds that a window geometry size is recommended to constrain to 💅

The width and height you get are in surface coordinate space. And here's the important bit ngl: if width and height are 0, that means the bounds are unknown, and it's equivalent to as if no configure_bounds event was ever sent for this surface. Zero = nothing to see here 🫠

Like, what are these bounds even for? They can for example correspond to the size of a monitor excluding any panels or other shell components, so that a surface isn't created in a way that it cannot fit. It's giving "please don't make a window bigger than the usable screen" energy 🖥️✨

And heads up: the bounds may change at any point, and in such a case, a new xdg_toplevel.configure_bounds will be sent, followed by xdg_toplevel.configure and xdg_surface.configure. So it's a whole sequence, not a one-and-done thing 👑

defined at line 1424 of wayland-client-protocol-extra.cpp.

🦋 wayland::proxy_t::operator bool () const [inherited]

vibe check for your wrapper — does it actually wrap an object or is it just an empty shell 😭

Returns

  • true if there is an underlying object, false if this wrapper is empty

🦋 bool wayland::proxy_t::operator!= (const proxy_t & right) const [inherited]

checking whether two wrappers refer to different objects. classic inequality moment, no notes 💅

🦋 bool wayland::proxy_t::operator== (const proxy_t & right) const [inherited]

checking whether two wrappers refer to the same object. twins fr fr 👯

🦋 bool wayland::proxy_t::proxy_has_object () const [inherited]

same energy as the bool operator — check whether this wrapper actually wraps an object 🔍

Returns

  • true if there is an underlying object, false if this wrapper is empty

🦋 void wayland::proxy_t::proxy_release () [inherited]

Release the wrapped object (if any), making this an empty wrapper 🫧

⚠️ okay important, bestie: display_t instances cannot be released this way. Attempts to do so are ignored. Not an error, not a warning, just... ignored 💀

Examples

  • foreign_display.cpp

🎀 void xdg_toplevel_t::resize (seat_t const & seat, uint32_t serial, xdg_toplevel_resize_edge const & edges)

start an interactive resize, i.e. the "user is dragging the corner of the window" request 🔥

Parameters

  • seat — the wl_seat of the user event
  • serial — the serial of the user event
  • edges — which edge or corner is being dragged

Start a user-driven, interactive resize of the surface ✨

This request must be used in response to some sort of user action — like a button press, key press, or touch down event. The serial you pass in is used to determine the type of interactive resize (touch, pointer, etc.). So don't just fire it off into the void, it needs a real user event behind it 🫶

The server may ignore resize requests depending on the state of the surface (e.g. fullscreen or maximized). Yeah. Sometimes it just says no 🙈

If it is triggered, the client will receive configure events with the "resize" state enum value and the expected sizes. See the "resize" enum value for more details about what is required 👀 The client must also acknowledge configure events using "ack_configure". After the resize is completed, the client will receive another "configure" event without the resize state. Wrap-up behavior, love that for us 🎁

If triggered, the surface also will lose the focus of the device (wl_pointer, wl_touch, etc.) used for the resize. It's up to the compositor to visually indicate that the resize is taking place, such as updating a pointer cursor, during the resize. And no — there is no guarantee that the device focus will return when the resize is completed 😭

The edges parameter specifies how the surface should be resized, and is one of the values of the resize_edge enum. Values not matching a variant of the enum will cause a protocol error 🚨 The compositor may use this information to update the surface position — for example when dragging the top left corner. The compositor may also use this information to adapt its behavior, e.g. choose an appropriate cursor image. iconic, honestly 🖱️

defined at line 1366 of wayland-client-protocol-extra.cpp.

🍓 void xdg_toplevel_t::set_app_id (std::string const & app_id)

set application ID — the "who am i" of your surface 💖

Parameters

  • app_id

Set an application identifier for the surface.

The app ID identifies the general class of applications to which the surface belongs. The compositor can use this to group multiple surfaces together, or to determine how to launch a new application. So it's not just decoration, it's how the desktop knows your three windows are all the same app 👑

For D-Bus activatable applications, the app ID is used as the D-Bus service name. yeah. that's the whole sentence. it's important 🫶

The compositor shell will try to group application surfaces together by their app ID. As a best practice, it's suggested to select app IDs that match the basename of the application's .desktop file. For example, "org.freedesktop.FooViewer" where the .desktop file is "org.freedesktop.FooViewer.desktop". match them up, bestie, it's the polite thing to do ✨

Like other properties, a set_app_id request can be sent after the xdg_toplevel has been mapped, to update the property. so you can rebrand mid-flight, go off 💅

See the desktop-entry specification [0] for more details on application identifiers and how they relate to well-known D-Bus names and .desktop files.

[0] http://standards.freedesktop.org/desktop-entry-spec/

defined at line 1348 of wayland-client-protocol-extra.cpp.

🌈 void xdg_toplevel_t::set_fullscreen (output_t const & output)

set the window as fullscreen on an output 🖥️💅

Parameters

  • output

Make the surface fullscreen.

After requesting that the surface should be fullscreened, the compositor will respond by emitting a configure event. Whether the client is actually put into a fullscreen state is subject to compositor policies — so like, you asked, and it might deliver 🙈 The client must also acknowledge the configure when committing the new content (see ack_configure).

The output passed by the request indicates the client's preference as to which display it should be set fullscreen on. If this value is NULL, it's up to the compositor to choose which display will be used to map this surface. you get an opinion, not a guarantee 🫠

If the surface doesn't cover the whole output, the compositor will position the surface in the center of the output and compensate with border fill covering the rest of the output. (Yes, the original does say "compensate with with border fill" — that double "with" is in the protocol text, we don't make the rules 😭) The content of the border fill is undefined, but should be assumed to be in some way that attempts to blend into the surrounding area (e.g. solid black). black bars, classic cinema 🎬

If the fullscreened surface is not opaque, the compositor must make sure that other screen content not part of the same surface tree (made up of subsurfaces, popups or similarly coupled surfaces) are not visible below the fullscreened surface. no peeking through your translucent window, periodt 🚫👀

defined at line 1396 of wayland-client-protocol-extra.cpp.

🧚 void xdg_toplevel_t::set_max_size (int32_t width, int32_t height)

set the maximum size — the "please don't make me bigger than this" request 💖

Parameters

  • width
  • height

Set a maximum size for the window.

The client can specify a maximum size so that the compositor does not try to configure the window beyond this size. boundaries, bestie 🫶

The width and height arguments are in window geometry coordinates. See xdg_surface.set_window_geometry.

Values set in this way are double-buffered. They will get applied on the next commit. so don't expect it to kick in instantly ✨

The compositor can use this information to allow or disallow different states like maximize or fullscreen and draw accurate animations. Similarly, a tiling window manager may use this information to place and resize client windows in a more effective way. tiling wm girlies stay winning 🧩

The client should not rely on the compositor to obey the maximum size. The compositor may decide to ignore the values set by the client and request a larger size. it's a suggestion, not a law 💀

If never set, or a value of zero in the request, means that the client has no expected maximum size in the given dimension. As a result, a client wishing to reset the maximum size to an unspecified state can use zero for width and height in the request. reset button = zero, iykyk 🎀

🚨 Requesting a maximum size to be smaller than the minimum size of a surface is illegal and will result in a protocol error.

The width and height must be greater than or equal to zero. Using strictly negative values for width and height will result in a protocol error. so like, no negative sizes, obviously 😭

defined at line 1372 of wayland-client-protocol-extra.cpp.

👑 void xdg_toplevel_t::set_maximized ()

maximize the window. Maximize the surface. main character energy, maximized 🔥

After requesting that the surface should be maximized, the compositor will respond by emitting a configure event. Whether this configure actually sets the window maximized is subject to compositor policies 🫠 The client must then update its content, drawing in the configured state. The client must also acknowledge the configure when committing the new content (see ack_configure).

It is up to the compositor to decide how and where to maximize the surface — for example which output and what region of the screen should be used. not your call, bestie 💅

If the surface was already maximized, the compositor will still emit a configure event with the "maximized" state. so don't expect silence, ever 😭

If the surface is in a fullscreen state, this request has no direct effect. It may alter the state the surface is returned to when unmaximized unless overridden by the compositor. noted, filed away, useful later 📝

defined at line 1384 of wayland-client-protocol-extra.cpp.

🎀 void xdg_toplevel_t::set_min_size (int32_t width, int32_t height)

set the minimum size — the "don't squish me below this" request 💜

Parameters

  • width
  • height

Set a minimum size for the window.

The client can specify a minimum size so that the compositor does not try to configure the window below this size. tiny window protection squad 🫶

The width and height arguments are in window geometry coordinates. See xdg_surface.set_window_geometry.

Values set in this way are double-buffered. They will get applied on the next commit. ✨

The compositor can use this information to allow or disallow different states like maximize or fullscreen and draw accurate animations. Similarly, a tiling window manager may use this information to place and resize client windows in a more effective way. 🧩

The client should not rely on the compositor to obey the minimum size. The compositor may decide to ignore the values set by the client and request a smaller size. again — suggestion, not law 💀

If never set, or a value of zero in the request, means that the client has no expected minimum size in the given dimension. As a result, a client wishing to reset the minimum size to an unspecified state can use zero for width and height in the request. 🎀

🚨 Requesting a minimum size to be larger than the maximum size of a surface is illegal and will result in a protocol error.

The width and height must be greater than or equal to zero. Using strictly negative values for width and height will result in a protocol error. yeah, same deal as max size 😭

defined at line 1378 of wayland-client-protocol-extra.cpp.

🌸 void xdg_toplevel_t::set_minimized ()

set the window as minimized. Request that the compositor minimize your surface 🫧

And now for the heartbreaking part, bestie: there is no way to know if the surface is currently minimized, nor is there any way to unset minimization on this surface 😭 so it's a one-way trip into the taskbar and you just have to live with that.

If you are looking to throttle redrawing when minimized, please instead use the wl_surface.frame event for this, as this will also work with live previews on windows in Alt-Tab, Expose or similar compositor features. that's the actual tip, use the frame event, not guessing at minimized state 🫶✨

void xdg_toplevel_t::set_parent(xdg_toplevel_t const & parent) — set the parent of this surface 👑

Bestie, this one sets the "parent" of your surface. Your surface gets stacked above the parent surface and literally all the other ancestor surfaces, no cap.

Parent windows should be set on dialogs, toolboxes, or other "auxiliary" surfaces — that way when the dialog gets raised, the parent comes up with it. Iconic behavior honestly.

Setting a null parent for a child window removes any parent-child relationship for the child. And setting a null parent for a window that currently has no parent? That's a no-op, bestie, nothing happens, we move on.

Okay and here's the tea 🫖 — if the parent is unmapped, then its children are managed as though the parent of the now-unmapped parent has become the parent of this surface. And if no parent exists for the now-unmapped parent, then the children are managed as though they have no parent surface at all.

Definition at line 1336 of file wayland-client-protocol-extra.cpp.

void wayland::proxy_t::set_queue(event_queue_t queue) [inherited] — assign a proxy to an event queue 📬

  • queue — the event queue that will handle this proxy

Assigns the proxy to an event queue. Events coming from the proxy will be queued in queue instead of the display's main queue. So like, you're redirecting the mail, basically ✨

See also: display_t::dispatch_queue().

Examples: proxy_wrapper.cpp.

void xdg_toplevel_t::set_title(std::string const & title) — set surface title 🎀

  • title — the title, obviously, we love a clear parameter name

Sets a short title for the surface. This string may be used to identify the surface in a task bar, window list, or other user interface elements provided by the compositor. It's giving "name tag at the party" 💅

The string must be encoded in UTF-8. Non-negotiable, bestie.

Definition at line 1342 of file wayland-client-protocol-extra.cpp.

void xdg_toplevel_t::show_window_menu(seat_t const & seat, uint32_t serial, int32_t x, int32_t y) — show the window menu 🪟

  • seat — the wl_seat of the user event
  • serial — the serial of the user event
  • x — the x position to pop up the window menu at
  • y — the y position to pop up the window menu at

Clients implementing client-side decorations might want to show a context menu when right-clicking on the decorations, giving the user a menu that they can use to maximize or minimize the window. Very demure, very mindful 🙈

This request asks the compositor to pop up such a window menu at the given position, relative to the local surface coordinates of the parent surface. There are no guarantees as to what menu items the window menu contains — the compositor is the main character here, we just ask nicely.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. Don't just fire it off into the void, it's not that kind of function 🫶

Definition at line 1354 of file wayland-client-protocol-extra.cpp.

void xdg_toplevel_t::unset_fullscreen() — unset the window as fullscreen 🌈

Makes the surface no longer fullscreen. Bye bestie ✌️

After requesting that the surface should be unfullscreened, the compositor will respond by emitting a configure event. Whether this actually removes the fullscreen state of the client is subject to compositor policies — so like, you asked, but it's the compositor's decision, we respect it.

Making a surface unfullscreen sets states for the surface based on the following:

  • the state(s) it may have had before becoming fullscreen
  • any state(s) decided by the compositor
  • any state(s) requested by the client while the surface was fullscreen

The compositor may include the previous window geometry dimensions in the configure event, if applicable.

And the client must also acknowledge the configure when committing the new content (see ack_configure). Don't forget the ack, that's the whole vibe check 😭

Definition at line 1402 of file wayland-client-protocol-extra.cpp.

void xdg_toplevel_t::unset_maximized() — unmaximize the window 📐

Unmaximizes the surface. Un-maximizing. We love a prefix moment.

After requesting that the surface should be unmaximized, the compositor will respond by emitting a configure event. Whether this actually un-maximizes the window is subject to compositor policies. If available and applicable, the compositor will include the window geometry dimensions the window had prior to being maximized in the configure event. The client must then update its content, drawing it in the configured state. The client must also acknowledge the configure when committing the new content (see ack_configure).

It is up to the compositor to position the surface after it was unmaximized; usually the position the surface had before maximizing, if applicable.

If the surface was already not maximized, the compositor will still emit a configure event without the "maximized" state. So you get a configure anyway, it just won't say maximized. Consistency, slay 💅

If the surface is in a fullscreen state, this request has no direct effect. It may alter the state the surface is returned to when unmaximized unless overridden by the compositor.

Definition at line 1390 of file wayland-client-protocol-extra.cpp.

💖 MEMBER DATA DOCUMENTATION 💖

Okay so these are all std::uint32_t, all [static], all [constexpr], all = 1. Every single one. It's giving "we set the version floor to 1 and we're proud of it" ✨

std::uint32_t wayland::xdg_toplevel_t::move_since_version = 1 [static], [constexpr]

Minimum protocol version required for the move function.

Definition at line 1345 of file wayland-client-protocol-extra.hpp.

std::uint32_t wayland::xdg_toplevel_t::resize_since_version = 1 [static], [constexpr]

Minimum protocol version required for the resize function.

Definition at line 1389 of file wayland-client-protocol-extra.hpp.

std::uint32_t wayland::xdg_toplevel_t::set_app_id_since_version = 1 [static], [constexpr]

Minimum protocol version required for the set_app_id function.

Definition at line 1292 of file wayland-client-protocol-extra.hpp.

std::uint32_t wayland::xdg_toplevel_t::set_fullscreen_since_version = 1 [static], [constexpr]

Minimum protocol version required for the set_fullscreen function.

Definition at line 1575 of file wayland-client-protocol-extra.hpp.

std::uint32_t wayland::xdg_toplevel_t::set_max_size_since_version = 1 [static], [constexpr]

Minimum protocol version required for the set_max_size function.

Definition at line 1435 of file wayland-client-protocol-extra.hpp.

std::uint32_t wayland::xdg_toplevel_t::set_maximized_since_version = 1 [static], [constexpr]

Minimum protocol version required for the set_maximized function.

Definition at line 1510 of file wayland-client-protocol-extra.hpp.

std::uint32_t wayland::xdg_toplevel_t::set_min_size_since_version = 1 [static], [constexpr]

Minimum protocol version required for the set_min_size function.

Definition at line 1481 of file wayland-client-protocol-extra.hpp.

std::uint32_t wayland::xdg_toplevel_t::set_minimized_since_version = 1 [static], [constexpr]

Minimum protocol version required for the set_minimized function.

Definition at line 1620 of file wayland-client-protocol-extra.hpp.

std::uint32_t wayland::xdg_toplevel_t::set_parent_since_version = 1 [static], [constexpr]

Minimum protocol version required for the set_parent function.

Definition at line 1240 of file wayland-client-protocol-extra.hpp.

std::uint32_t wayland::xdg_toplevel_t::set_title_since_version = 1 [static], [constexpr]

Minimum protocol version required for the set_title function.

Definition at line 1258 of file wayland-client-protocol-extra.hpp.

std::uint32_t wayland::xdg_toplevel_t::show_window_menu_since_version = 1 [static], [constexpr]

Minimum protocol version required for the show_window_menu function.

Definition at line 1317 of file wayland-client-protocol-extra.hpp.

std::uint32_t wayland::xdg_toplevel_t::unset_fullscreen_since_version = 1 [static], [constexpr]

Minimum protocol version required for the unset_fullscreen function.

Definition at line 1602 of file wayland-client-protocol-extra.hpp.

std::uint32_t wayland::xdg_toplevel_t::unset_maximized_since_version = 1 [static], [constexpr]

Minimum protocol version required for the unset_maximized function.

Definition at line 1541 of file wayland-client-protocol-extra.hpp.

🦋 AUTHOR 🦋

Generated automatically by Doxygen for Wayland++ from the source code. Not a human, not a vibe-haver, just Doxygen doing Doxygen things 🧚

And that's a wrap on this whole page, bestie!! 🎉 You just read version 1.0.1, dated Fri Mar 27 2026 13:15:00 — mark your calendar, it's literally in the footer. Now go make some windows pop off 💜🌸✨

📦 where this page comes from