wayland::zxdg_toplevel_v6_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 wayland::zxdg_toplevel_v6_t(3) — Wayland++ 💅

okay so bestie, this is the wayland::zxdg_toplevel_v6_t(3) page from the Wayland++ manual — it's the toplevel surface interface and it's giving main-character window energy fr fr. Let's get into it.

✨ NAME ✨

wayland::zxdg_toplevel_v6_t — toplevel surface 🪟✨

🌈 SYNOPSIS 🌈

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

Inherits wayland::proxy_t.

🎀 Public Types 🎀

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the wrapper-type enum, inherited from proxy_t.

💖 Public Member Functions 💖

  • void set_parent (zxdg_toplevel_v6_t const &parent) — set the parent of this surface
  • void set_title (std::string const &title) — set surface title
  • void set_app_id (std::string const &app_id) — set application ID
  • void show_window_menu (seat_t const &seat, uint32_t serial, int32_t x, int32_t y) — show the window menu
  • void move (seat_t const &seat, uint32_t serial) — start an interactive move
  • void resize (seat_t const &seat, uint32_t serial, zxdg_toplevel_v6_resize_edge const &edges) — start an interactive resize
  • void set_max_size (int32_t width, int32_t height) — set the maximum size
  • void set_min_size (int32_t width, int32_t height) — set the minimum size
  • void set_maximized () — maximize the window
  • void unset_maximized () — unmaximize the window
  • void set_fullscreen (output_t const &output) — set the window as fullscreen on a monitor
  • void set_minimized () — set the window as minimized
  • std::function< void(int32_t, int32_t, array_t)> & on_configure () — suggest a surface change
  • std::function< void()> & on_close () — surface wants to be closed
  • uint32_t get_id () const — Get the id of a proxy object.
  • std::string get_class () const — Get the interface name (class) of a proxy object.
  • uint32_t get_version () const — Get the protocol object version of a proxy object.
  • wrapper_type get_wrapper_type () const — Get the type of a proxy object.
  • void set_queue (event_queue_t queue) — Assign a proxy to an event queue.
  • wl_proxy * c_ptr () const — Get a pointer to the underlying C struct.
  • bool proxy_has_object () const — Check whether this wrapper actually wraps an object.
  • operator bool () const — Check whether this wrapper actually wraps an object.
  • bool operator== (const proxy_t &right) const — Check whether two wrappers refer to the same object.
  • bool operator!= (const proxy_t &right) const — Check whether two wrappers refer to different objects.
  • void proxy_release () — Release 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.

Definition at line 8258 of file wayland-client-protocol-unstable.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.

Enumerators:

  • 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]

Get 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.

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

Get 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]

Get the id of a proxy object.

Returns: The id the object associated with the proxy.

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

Get 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.

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]

Get the type of a proxy object.

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

void zxdg_toplevel_v6_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).

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.

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.

Definition at line 10000 of file wayland-client-protocol-unstable.cpp.

std::function< void()> & zxdg_toplevel_v6_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.

Definition at line 10059 of file wayland-client-protocol-unstable.cpp.

std::function< void(int32_t, int32_t, array_t)> & zxdg_toplevel_v6_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.

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.

Definition at line 10054 of file wayland-client-protocol-unstable.cpp.

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

Check whether this wrapper actually wraps an object.

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]

Check whether two wrappers refer to different objects.

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

Check whether two wrappers refer to the same object.

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

Check whether this wrapper actually wraps an object.

Returns: true if there is an underlying object, false if this wrapper is empty.

🫧 proxy_release — the yeet-the-wrapper move, inherited

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

Okay so this one lets go of the wrapped object (if there even is one), and boom — your wrapper is now empty. Just an empty little shell. 💀

Real talk though: display_t instances cannot be released this way, bestie. If you try, it just... ignores you. Like the group chat when you ask a genuine question. 🙈

Examples: foreign_display.cpp.

🎀 resize — grab an edge and start the interactive resize

void zxdg_toplevel_v6_t::resize (seat_t const & seat, uint32_t serial,
    zxdg_toplevel_v6_resize_edge const & edges)

Starts a user-driven, interactive resize of the surface. It's giving "the user is literally dragging the corner right now" energy. ✨

Parameters:

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

So here's the vibe: this request must be used in response to some sort of user action — a button press, a key press, a touch down event, you know the drill. The serial you pass in is what the compositor uses to figure out the type of interactive resize (touch, pointer, etc.).

The server is fully allowed to ignore your resize request depending on the state of the surface — like if it's fullscreen or maximized. Don't take it personally. 🥲

If it does trigger, the client will get configure events with the "resize" state enum value and the expected sizes. Peep the "resize" enum value for the whole rundown on what's required. And the client must also acknowledge configure events using "ack_configure". After the resize is done, the client gets another "configure" event — this time without the resize state.

Also, not me warning you: if triggered, the surface also loses 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 happening — updating a pointer cursor is the classic move. And ngl, there is no guarantee that device focus comes back when the resize is finished. 🙃

The edges parameter says how the surface should be resized, and it's one of the values of the resize_edge enum. The compositor may use that info to update the surface position — for example when you're dragging the top-left corner — and it may also adapt its behavior, like picking an appropriate cursor image.

Definition at line 10006 of file wayland-client-protocol-unstable.cpp.

🍓 set_app_id — give your surface an identity

void zxdg_toplevel_v6_t::set_app_id (std::string const & app_id)

Parameters:

  • app_id

Sets an application identifier for the surface. This is your surface's whole personality, basically. 💅

The app ID identifies the general class of applications to which the surface belongs. The compositor can use it to group multiple surfaces together, or to figure out how to launch a new application.

For D-Bus activatable applications, the app ID is used as the D-Bus service name. Iconic.

The compositor shell will try to group application surfaces together by their app ID. Best practice? Pick 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". Slay, matching sets. ✨

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/

Definition at line 9988 of file wayland-client-protocol-unstable.cpp.

🌈 set_fullscreen — full screen, no crumbs

void zxdg_toplevel_v6_t::set_fullscreen (output_t const & output)

Parameters:

  • output

Makes the surface fullscreen. Main character takes the whole screen, periodt. 👑

You can specify an output that you'd prefer to be fullscreen. If this value is NULL, it's up to the compositor to choose which display will be used to map this surface. Let them cook, ig. 🍳

If the surface doesn't cover the whole output, the compositor will position the surface in the center of the output and compensate with black borders filling the rest of the output. Cinema vibes. 🎬

Definition at line 10036 of file wayland-client-protocol-unstable.cpp.

🦋 set_max_size — cap the size, bestie

void zxdg_toplevel_v6_t::set_max_size (int32_t width, int32_t height)

Parameters:

  • width
  • height

Sets a maximum size for the window. You're basically saying "this is my limit, don't push me." 😤

The client can specify a max size so the compositor doesn't try to configure the window beyond it.

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

Values set this way are double-buffered — they get applied on the next commit. (Yes, like every other buffered thing in your life. 🙈)

The compositor can use this info to allow or disallow different states like maximize or fullscreen, and to draw accurate animations. Similarly, a tiling window manager may use it to place and resize client windows more effectively. Teamwork, honestly.

⚠️ The client should not rely on the compositor to obey the maximum size. The compositor may straight up decide to ignore the values you set and request a larger size. Rude but legal. 💀

If never set, or if you send a value of zero, that means the client has no expected maximum size in that dimension. So if you want to reset the max size to an unspecified state, just use zero for width and height in the request. Easy.

Requesting a max size 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. Don't do it, bestie.

Definition at line 10012 of file wayland-client-protocol-unstable.cpp.

💜 set_maximized — maximize the window

void zxdg_toplevel_v6_t::set_maximized ()

Maximizes the surface. Big mode activated. 🔥

So after you request that the surface should be maximized, the compositor responds by emitting a configure event with the "maximized" state and the required window geometry. Then the client should update its content, drawing it in a maximized state — i.e. without shadow or other decoration outside of the window geometry. And the client must also acknowledge the configure when committing the new content (see ack_configure). Don't forget, or it's giving unfinished business. 😭

It's up to the compositor to decide how and where to maximize the surface — for example which output and what region of the screen gets used.

And if the surface was already maximized? The compositor will still emit a configure event with the "maximized" state. Consistency, we love to see it. ✨

Definition at line 10024 of file wayland-client-protocol-unstable.cpp.

🧚 set_min_size — the floor, not the ceiling

void zxdg_toplevel_v6_t::set_min_size (int32_t width, int32_t height)

Parameters:

  • width
  • height

Sets a minimum size for the window. So the compositor doesn't try to configure the window below this size. It's giving "respect my boundaries." 🌸

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

Values set this way are double-buffered — they get applied on the next commit.

The compositor can use this info to allow or disallow different states like maximize or fullscreen, and to draw accurate animations. Similarly, a tiling window manager may use this info to place and resize client windows more effectively. Iconic collaboration. 🫶

⚠️ Again, the client should not rely on the compositor to obey the minimum size. The compositor may decide to ignore your values and request a smaller size. Betrayal, honestly. 😭

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

Requesting a minimum size 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.

Definition at line 10018 of file wayland-client-protocol-unstable.cpp.

💅 set_minimized — down bad (literally minimized)

void zxdg_toplevel_v6_t::set_minimized ()

Requests that the compositor minimize your surface. That's it. That's the whole ask. 🙈

⚠️ Important caveat, bestie: there is no way to know if the surface is currently minimized, and there's no way to unset minimization on this surface. One-way trip.

If you're looking to throttle redrawing when minimized, please instead use the wl_surface.frame event for this — because that will also work with live previews on windows in Alt-Tab, Expose or similar compositor features. Bestie, that's the move. 🎀

Definition at line 10048 of file wayland-client-protocol-unstable.cpp.

🌸 set_parent — stack me above my parent

void zxdg_toplevel_v6_t::set_parent (zxdg_toplevel_v6_t const & parent)

Parameters:

  • parent

Sets the "parent" of this surface. This window should be stacked above its parent, and the parent surface must be mapped as long as this surface is mapped. No leaving your parent behind. 👑

Parent windows should be set on dialogs, toolboxes, or other "auxiliary" surfaces, so that the parent gets raised when the dialog is raised. Family stacks together, periodt.

Definition at line 9976 of file wayland-client-protocol-unstable.cpp.

🌟 set_queue — give this proxy its own event queue, inherited

void wayland::proxy_t::set_queue (event_queue_t queue) [inherited]

Assigns a proxy to an event queue. Very "you sit with us now" energy. 💅

Parameters:

  • queue — The event queue that will handle this proxy

So you assign the proxy to an event queue, and events coming from that proxy will be queued in queue instead of the display's main queue. Clean separation, we stan.

See also: display_t::dispatch_queue().

Examples: proxy_wrapper.cpp.

⭐ set_title — give the surface a name tag

void zxdg_toplevel_v6_t::set_title (std::string const & title)

Parameters:

  • title

Sets a short title for the surface. This little string is how the surface gets identified in a task bar, window list, or other user interface elements the compositor provides. It's the name on the group chat, basically. 🎀

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

Definition at line 9982 of file wayland-client-protocol-unstable.cpp.

🍓 show_window_menu — pop up the menu, right there

void zxdg_toplevel_v6_t::show_window_menu (seat_t const & seat, uint32_t
    serial, int32_t x, int32_t y)

Parameters:

  • 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

If you're out here implementing client-side decorations, you might want to show a context menu when the user right-clicks on those decorations — giving them a menu to maximize or minimize the window with. Very thoughtful of you. 🫶

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 actually contains. Surprise menu. 🙈

And like the other interactive stuff, this request must be used in response to some sort of user action — a button press, a key press, or a touch down event.

Definition at line 9994 of file wayland-client-protocol-unstable.cpp.

🌙 unset_maximized — unmaximize the window

void zxdg_toplevel_v6_t::unset_maximized ()

Unmaximizes the surface.

okay so once you've asked for that un-maximize, the compositor's gonna respond by emitting a configure event without the "maximized" state. And if it's available, the compositor will slide the window geometry dimensions your window had before it got maximized right into that configure request. Then you, the client, gotta update your content — draw it in a regular state, i.e. potentially with shadow, etc. And bestie, you also have to acknowledge the configure when you commit the new content (see ack_configure, iykyk).

Where the surface ends up after it's unmaximized? Compositor's call, not yours. Usually it's the position the surface had before maximizing, if applicable. 🫶

And if the surface was already not maximized? Compositor's still gonna emit a configure event without the "maximized" state. No cap. ✨

Definition at line 10030 of file wayland-client-protocol-unstable.cpp.

✨ Member Data Documentation ✨

These are the version gates, bestie — every single one of them is a std::uint32_t, static, constexpr, and sitting at = 1. It's giving "minimum protocol version required", and it's giving it thirteen times. 💅

🎀 move_since_version

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

Minimum protocol version required for the move function.

Definition at line 8400 of file wayland-client-protocol-unstable.hpp.

🎀 resize_since_version

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

Minimum protocol version required for the resize function.

Definition at line 8443 of file wayland-client-protocol-unstable.hpp.

🎀 set_app_id_since_version

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

Minimum protocol version required for the set_app_id function.

Definition at line 8347 of file wayland-client-protocol-unstable.hpp.

🎀 set_fullscreen_since_version

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

Minimum protocol version required for the set_fullscreen function.

Definition at line 8608 of file wayland-client-protocol-unstable.hpp.

🎀 set_max_size_since_version

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

Minimum protocol version required for the set_max_size function.

Definition at line 8489 of file wayland-client-protocol-unstable.hpp.

🎀 set_maximized_since_version

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

Minimum protocol version required for the set_maximized function.

Definition at line 8561 of file wayland-client-protocol-unstable.hpp.

🎀 set_min_size_since_version

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

Minimum protocol version required for the set_min_size function.

Definition at line 8535 of file wayland-client-protocol-unstable.hpp.

🎀 set_minimized_since_version

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

Minimum protocol version required for the set_minimized function.

Definition at line 8635 of file wayland-client-protocol-unstable.hpp.

🎀 set_parent_since_version

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

Minimum protocol version required for the set_parent function.

Definition at line 8298 of file wayland-client-protocol-unstable.hpp.

🎀 set_title_since_version

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

Minimum protocol version required for the set_title function.

Definition at line 8316 of file wayland-client-protocol-unstable.hpp.

🎀 show_window_menu_since_version

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

Minimum protocol version required for the show_window_menu function.

Definition at line 8372 of file wayland-client-protocol-unstable.hpp.

🎀 unset_fullscreen_since_version

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

Minimum protocol version required for the unset_fullscreen function.

Definition at line 8617 of file wayland-client-protocol-unstable.hpp.

🎀 unset_maximized_since_version

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

Minimum protocol version required for the unset_maximized function.

Definition at line 8588 of file wayland-client-protocol-unstable.hpp.

👑 Author 👑

Generated automatically by Doxygen for Wayland++ from the source code. Not a human wrote this one, bestie — the robots did it, and honestly? They ate. 💀✨

and that's the whole page, fr fr 🦋 Source: generated automatically by Doxygen for Wayland++ from the source code, version 1.0.1, dated Fri Mar 27 2026 13:15. Bye bestie, go un-maximize something 💜🎀

📦 where this page comes from