short-lived, popup surfaces for menus More...
#include <wayland-client-protocol-extra.hpp>
Public Types | |
| enum | wrapper_type { wrapper_type::standard, wrapper_type::display, wrapper_type::foreign, wrapper_type::proxy_wrapper } |
Public Member Functions | |
| void | grab (seat_t seat, uint32_t serial) |
| make the popup take an explicit grab More... | |
| std::function< void(int32_t, int32_t, int32_t, int32_t)> & | on_configure () |
| configure the popup surface More... | |
| std::function< void()> & | on_popup_done () |
| popup interaction is done More... | |
| uint32_t | get_id () const |
| Get the id of a proxy object. More... | |
| std::string | get_class () const |
| Get the interface name (class) of a proxy object. More... | |
| uint32_t | get_version () const |
| Get the protocol object version of a proxy object. More... | |
| wrapper_type | get_wrapper_type () const |
| Get the type of a proxy object. More... | |
| void | set_queue (event_queue_t queue) |
| Assign a proxy to an event queue. More... | |
| wl_proxy * | c_ptr () const |
| Get a pointer to the underlying C struct. More... | |
| bool | proxy_has_object () const |
| Check whether this wrapper actually wraps an object. More... | |
| operator bool () const | |
| Check whether this wrapper actually wraps an object. More... | |
| bool | operator== (const proxy_t &right) const |
| Check whether two wrappers refer to the same object. More... | |
| bool | operator!= (const proxy_t &right) const |
| Check whether two wrappers refer to different objects. More... | |
| void | proxy_release () |
| Release the wrapped object (if any), making this an empty wrapper. More... | |
Static Public Attributes | |
| static constexpr std::uint32_t | grab_since_version = 1 |
| Minimum protocol version required for the grab function. More... | |
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.
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 1702 of file wayland-client-protocol-extra.hpp.
Member Enumeration Documentation
◆ wrapper_type
|
stronginherited |
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 105 of file wayland-client.hpp.
Member Function Documentation
◆ c_ptr()
|
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
◆ get_class()
|
inherited |
Get the interface name (class) of a proxy object.
- Returns
- The interface name of the object associated with the proxy
◆ get_id()
|
inherited |
◆ get_version()
|
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
◆ get_wrapper_type()
|
inlineinherited |
Get the type of a proxy object.
Definition at line 288 of file wayland-client.hpp.
◆ grab()
| void xdg_popup_t::grab | ( | seat_t | 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 1382 of file wayland-client-protocol-extra.cpp.
◆ on_configure()
| std::function< void(int32_t, int32_t, int32_t, int32_t)> & xdg_popup_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 1387 of file wayland-client-protocol-extra.cpp.
◆ on_popup_done()
| std::function< void()> & xdg_popup_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 1392 of file wayland-client-protocol-extra.cpp.
◆ operator bool()
|
inherited |
Check whether this wrapper actually wraps an object.
- Returns
- true if there is an underlying object, false if this wrapper is empty
◆ operator!=()
|
inherited |
Check whether two wrappers refer to different objects.
◆ operator==()
|
inherited |
Check whether two wrappers refer to the same object.
◆ proxy_has_object()
|
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()
|
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.
◆ set_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
◆ grab_since_version
|
staticconstexpr |
Minimum protocol version required for the grab function.
Definition at line 1777 of file wayland-client-protocol-extra.hpp.
The documentation for this class was generated from the following files:
