--- name: "wayland_zxdg_surface_v6_t" section: "3" platform: "linux" package: "waylandpp-dev" version: "1.0.0-6+b2" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/wayland_zxdg_surface_v6_t" --- # wayland\_zxdg\_surface\_v6\_t(3) desktop user interface surface base interface ## NAME wayland::zxdg\_surface\_v6\_t - desktop user interface surface base interface ## SYNOPSIS `#include ` Inherits **wayland::proxy\_t**. ### Public Types enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\ ### Public Member Functions **zxdg\_toplevel\_v6\_t** **get\_toplevel** ()\ assign the xdg\_toplevel surface role **zxdg\_popup\_v6\_t** **get\_popup** (**zxdg\_surface\_v6\_t** const &parent, **zxdg\_positioner\_v6\_t** const &positioner)\ assign the xdg\_popup surface role void **set\_window\_geometry** (int32\_t x, int32\_t y, int32\_t width, int32\_t height)\ set the new window geometry void **ack\_configure** (uint32\_t serial)\ ack a configure event std::function\< void(uint32\_t)\> & **on\_configure** ()\ suggest a surface change 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 **get\_toplevel\_since\_version** = 1\ Minimum protocol version required for the **get\_toplevel** function. static constexpr std::uint32\_t **get\_popup\_since\_version** = 1\ Minimum protocol version required for the **get\_popup** function. static constexpr std::uint32\_t **set\_window\_geometry\_since\_version** = 1\ Minimum protocol version required for the **set\_window\_geometry** function. static constexpr std::uint32\_t **ack\_configure\_since\_version** = 1\ Minimum protocol version required for the **ack\_configure** function. ## Detailed Description desktop user interface surface base interface An interface that may be implemented by a wl\_surface, for implementations that provide a desktop-style user interface. It provides a base set of functionality required to construct user interface elements requiring management by the compositor, such as toplevel windows, menus, etc. The types of functionality are split into xdg\_surface roles. Creating an xdg\_surface does not set the role for a wl\_surface. In order to map an xdg\_surface, the client must create a role-specific object using, e.g., get\_toplevel, get\_popup. The wl\_surface for any given xdg\_surface can have at most one role, and may not be assigned any role not based on xdg\_surface. A role must be assigned before any other requests are made to the xdg\_surface object. The client must call wl\_surface.commit on the corresponding wl\_surface for the xdg\_surface state to take effect. Creating an xdg\_surface from a wl\_surface which has a buffer attached or committed is a client error, and any attempts by a client to attach or manipulate a buffer prior to the first xdg\_surface.configure call must also be treated as errors. For a surface to be mapped by the compositor, the following conditions must be met: (1) the client has assigned an xdg\_surface based role to the surface, (2) the client has set and committed the xdg\_surface state and the role dependent state to the surface and (3) the client has committed a buffer to the surface. Definition at line **8089** 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 **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* **116** *of file* **wayland-client.hpp***.* ## Member Function Documentation ### void zxdg\_surface\_v6\_t::ack\_configure (uint32\_t serial) *ack a configure event* **Parameters** *serial the serial from the configure event* *When a configure event is received, if a client commits the surface in response to the configure event, then the client must make an ack\_configure request sometime before the commit request, passing along the serial of the configure event.* *For instance, for toplevel surfaces the compositor might use this information to move a surface to the top left only when the client has drawn itself for the maximized or fullscreen state.* *If the client receives multiple configure events before it can respond to one, it only has to ack the last configure event.* *A client is not required to commit immediately after sending an ack\_configure request - it may even ack\_configure several times before its next surface commit.* *A client may send multiple ack\_configure requests before committing, but only the last request sent before a commit indicates which configure event the client really is responding to.* *Definition at line* **9901** *of file* **wayland-client-protocol-unstable.cpp***.* ### 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* ### zxdg\_popup\_v6\_t zxdg\_surface\_v6\_t::get\_popup (zxdg\_surface\_v6\_t const & parent, zxdg\_positioner\_v6\_t const & positioner) *assign the xdg\_popup surface role* **Parameters** *parent* \ *positioner* *This creates an xdg\_popup object for the given xdg\_surface and gives the associated wl\_surface the xdg\_popup role.* *See the documentation of xdg\_popup for more details about what an xdg\_popup is and how it is used.* *Definition at line* **9888** *of file* **wayland-client-protocol-unstable.cpp***.* ### zxdg\_toplevel\_v6\_t zxdg\_surface\_v6\_t::get\_toplevel () *assign the xdg\_toplevel surface role This creates an xdg\_toplevel object for the given xdg\_surface and gives the associated wl\_surface the xdg\_toplevel role.* *See the documentation of xdg\_toplevel for more details about what an xdg\_toplevel is and how it is used.* *Definition at line* **9881** *of file* **wayland-client-protocol-unstable.cpp***.* ### 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* **302** *of file* **wayland-client.hpp***.* ### std::function\< void(uint32\_t)\> & zxdg\_surface\_v6\_t::on\_configure () *suggest a surface change* **Parameters** *serial serial of the configure event* *The configure event marks the end of a configure sequence. A configure sequence is a set of one or more events configuring the state of the xdg\_surface, including the final xdg\_surface.configure event.* *Where applicable, xdg\_surface surface roles will during a configure sequence extend this event as a latched state sent as events before the xdg\_surface.configure event. Such events should be considered to make up a set of atomically applied configuration states, where the xdg\_surface.configure commits the accumulated state.* *Clients should arrange their surface for the new states, and then send an ack\_configure request with the serial sent in this configure event at some point before committing the new surface.* *If the client receives multiple configure events before it can respond to one, it is free to discard all but the last event it received.* *Definition at line* **9907** *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* ### void wayland::proxy\_t::proxy\_release ()` [inherited]` *Release the wrapped object (if any), making this an empty wrapper. Note that* **display\_t** *instances cannot be released this way. Attempts to do so are ignored.* **Examples** **foreign\_display.cpp***.* ### void wayland::proxy\_t::set\_queue (event\_queue\_t queue)` [inherited]` *Assign a proxy to an event queue.* **Parameters** *queue The event queue that will handle this proxy* *Assign proxy to event queue. Events coming from proxy will be queued in queue instead of the display's main queue.* *See also:* **display\_t::dispatch\_queue()***.* **Examples** **proxy\_wrapper.cpp***.* ### void zxdg\_surface\_v6\_t::set\_window\_geometry (int32\_t x, int32\_t y, int32\_t width, int32\_t height) *set the new window geometry* **Parameters** *x* \ *y* \ *width* \ *height* *The window geometry of a surface is its 'visible bounds' from the user's perspective. Client-side decorations often have invisible portions like drop-shadows which should be ignored for the purposes of aligning, placing and constraining windows.* *The window geometry is double buffered, and will be applied at the time wl\_surface.commit of the corresponding wl\_surface is called.* *Once the window geometry of the surface is set, it is not possible to unset it, and it will remain the same until set\_window\_geometry is called again, even if a new subsurface or buffer is attached.* *If never set, the value is the full bounds of the surface, including any subsurfaces. This updates dynamically on every commit. This unset is meant for extremely simple clients.* *The arguments are given in the surface-local coordinate space of the wl\_surface associated with this xdg\_surface.* *The width and height must be greater than zero. Setting an invalid size will raise an error. When applied, the effective window geometry will be the set window geometry clamped to the bounding rectangle of the combined geometry of the surface of the xdg\_surface and the associated subsurfaces.* *Definition at line* **9895** *of file* **wayland-client-protocol-unstable.cpp***.* ## Member Data Documentation ### constexpr std::uint32\_t wayland::zxdg\_surface\_v6\_t::ack\_configure\_since\_version = 1` [static]`, ` [constexpr]` *Minimum protocol version required for the* **ack\_configure** *function.* *Definition at line* **8210** *of file* **wayland-client-protocol-unstable.hpp***.* ### constexpr std::uint32\_t wayland::zxdg\_surface\_v6\_t::get\_popup\_since\_version = 1` [static]`, ` [constexpr]` *Minimum protocol version required for the* **get\_popup** *function.* *Definition at line* **8142** *of file* **wayland-client-protocol-unstable.hpp***.* ### constexpr std::uint32\_t wayland::zxdg\_surface\_v6\_t::get\_toplevel\_since\_version = 1` [static]`, ` [constexpr]` *Minimum protocol version required for the* **get\_toplevel** *function.* *Definition at line* **8125** *of file* **wayland-client-protocol-unstable.hpp***.* ### constexpr std::uint32\_t wayland::zxdg\_surface\_v6\_t::set\_window\_geometry\_since\_version = 1` [static]`, ` [constexpr]` *Minimum protocol version required for the* **set\_window\_geometry** *function.* *Definition at line* **8180** *of file* **wayland-client-protocol-unstable.hpp***.* ## Author *Generated automatically by Doxygen for Wayland++ from the source code.*