--- name: "wayland_zxdg_popup_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_popup_v6_t" --- # wayland\_zxdg\_popup\_v6\_t(3) short-lived, popup surfaces for menus ## NAME wayland::zxdg\_popup\_v6\_t - short-lived, popup surfaces for menus ## SYNOPSIS `#include ` Inherits **wayland::proxy\_t**. ### Public Types enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\ ### Public Member Functions void **grab** (**seat\_t** const &seat, uint32\_t serial)\ make the popup take an explicit grab std::function\< void(int32\_t, int32\_t, int32\_t, int32\_t)\> & **on\_configure** ()\ configure the popup surface std::function\< void()\> & **on\_popup\_done** ()\ popup interaction is done 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 **grab\_since\_version** = 1\ Minimum protocol version required for the **grab** function. ## Detailed Description short-lived, popup surfaces for menus A popup surface is a short-lived, temporary surface. It can be used to implement for example menus, popovers, tooltips and other similar user interface concepts. A popup can be made to take an explicit grab. See xdg\_popup.grab for details. When the popup is dismissed, a popup\_done event will be sent out, and at the same time the surface will be unmapped. See the xdg\_popup.popup\_done event for details. Explicitly destroying the xdg\_popup object will also dismiss the popup and unmap the surface. Clients that want to dismiss the popup when another surface of their own is clicked should dismiss the popup using the destroy request. The parent surface must have either the xdg\_toplevel or xdg\_popup surface role. A newly created xdg\_popup will be stacked on top of all previously created xdg\_popup surfaces associated with the same xdg\_toplevel. The parent of an xdg\_popup must be mapped (see the xdg\_surface description) before the xdg\_popup itself. The x and y arguments passed when creating the popup object specify where the top left of the popup should be placed, relative to the local surface coordinates of the parent surface. See xdg\_surface.get\_popup. An xdg\_popup must intersect with or be at least partially adjacent to its parent surface. The client must call wl\_surface.commit on the corresponding wl\_surface for the xdg\_popup state to take effect. Definition at line **8764** 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 ### 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* **302** *of file* **wayland-client.hpp***.* ### void zxdg\_popup\_v6\_t::grab (seat\_t const & seat, uint32\_t serial) *make the popup take an explicit grab* **Parameters** *seat the wl\_seat of the user event* \ *serial the serial of the user event* *This request makes the created popup take an explicit grab. An explicit grab will be dismissed when the user dismisses the popup, or when the client destroys the xdg\_popup. This can be done by the user clicking outside the surface, using the keyboard, or even locking the screen through closing the lid or a timeout.* *If the compositor denies the grab, the popup will be immediately dismissed.* *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 number of the event should be passed as 'serial'.* *The parent of a grabbing popup must either be an xdg\_toplevel surface or another xdg\_popup with an explicit grab. If the parent is another xdg\_popup it means that the popups are nested, with this popup now being the topmost popup.* *Nested popups must be destroyed in the reverse order they were created in, e.g. the only popup you are allowed to destroy at all times is the topmost one.* *When compositors choose to dismiss a popup, they may dismiss every nested grabbing popup as well. When a compositor dismisses popups, it will follow the same dismissing order as required from the client.* *The parent of a grabbing popup must either be another xdg\_popup with an active explicit grab, or an xdg\_popup or xdg\_toplevel, if there are no explicit grabs already taken.* *If the topmost grabbing popup is destroyed, the grab will be returned to the parent of the popup, if that parent previously had an explicit grab.* *If the parent is a grabbing popup which has already been dismissed, this popup will be immediately dismissed. If the parent is a popup that did not take an explicit grab, an error will be raised.* *During a popup grab, the client owning the grab will receive pointer and touch events for all their surfaces as normal (similar to an 'owner-events' grab in X11 parlance), while the top most grabbing popup will always have keyboard focus.* *Definition at line* **10141** *of file* **wayland-client-protocol-unstable.cpp***.* ### std::function\< void(int32\_t, int32\_t, int32\_t, int32\_t)\> & zxdg\_popup\_v6\_t::on\_configure () *configure the popup surface* **Parameters** *x x position relative to parent surface window geometry* \ *y y position relative to parent surface window geometry* \ *width window geometry width* \ *height window geometry height* *This event asks the popup surface to configure itself given the configuration. The configured state should not be applied immediately. See xdg\_surface.configure for details.* *The x and y arguments represent the position the popup was placed at given the xdg\_positioner rule, relative to the upper left corner of the window geometry of the parent surface.* *Definition at line* **10147** *of file* **wayland-client-protocol-unstable.cpp***.* ### std::function\< void()\> & zxdg\_popup\_v6\_t::on\_popup\_done () *popup interaction is done The popup\_done event is sent out when a popup is dismissed by the compositor. The client should destroy the xdg\_popup object at this point.* *Definition at line* **10152** *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***.* ## Member Data Documentation ### constexpr std::uint32\_t wayland::zxdg\_popup\_v6\_t::grab\_since\_version = 1` [static]`, ` [constexpr]` *Minimum protocol version required for the* **grab** *function.* *Definition at line* **8839** *of file* **wayland-client-protocol-unstable.hpp***.* ## Author *Generated automatically by Doxygen for Wayland++ from the source code.*