wayland_server_zxdg_popup_v6_t - Man Page

short-lived, popup surfaces for menus

Synopsis

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

Inherits wayland::server::resource_t.

Public Member Functions

std::function< void()> & on_destroy ()
remove xdg_popup interface
std::function< void(seat_t, uint32_t)> & on_grab ()
make the popup take an explicit grab
void configure (int32_t x, int32_t y, int32_t width, int32_t height, bool post=true)
configure the popup surface
void popup_done (bool post=true)
popup interaction is done
void post_invalid_grab (std::string const &msg)
Post error: tried to grab after being mapped.
bool proxy_has_object () const
Check whether this wrapper actually wraps an object.
void post_no_memory () const
uint32_t get_id () const
client_t get_client () const
unsigned int get_version () const
std::string get_class ()

Static Public Attributes

static constexpr std::uint32_t configure_since_version = 1
Minimum protocol version required for the configure function.
static constexpr std::uint32_t popup_done_since_version = 1
Minimum protocol version required for the popup_done 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 9872 of file wayland-server-protocol-unstable.hpp.

Member Function Documentation

void zxdg_popup_v6_t::configure (int32_t x, int32_t y, int32_t width, int32_t height, bool post = true)

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 8683 of file wayland-server-protocol-unstable.cpp.

std::string wayland::server::resource_t::get_class () [inherited]

Retrieve the interface name (class) of a resource object.

Returns

Interface name of the resource object.

client_t wayland::server::resource_t::get_client () const [inherited]

Get the associated client

Returns

the client that owns the resource.

uint32_t wayland::server::resource_t::get_id () const [inherited]

Get the internal ID of the resource

Returns

the internal ID of the resource

unsigned int wayland::server::resource_t::get_version () const [inherited]

Get interface version

Returns

Interface version this resource has been constructed with.

std::function< void()> & zxdg_popup_v6_t::on_destroy ()

remove xdg_popup interface This destroys the popup. Explicitly destroying the xdg_popup object will also dismiss the popup, and unmap the surface.

If this xdg_popup is not the 'topmost' popup, a protocol error will be sent.

Definition at line 8671 of file wayland-server-protocol-unstable.cpp.

std::function< void(seat_t, uint32_t)> & zxdg_popup_v6_t::on_grab ()

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 8677 of file wayland-server-protocol-unstable.cpp.

void zxdg_popup_v6_t::popup_done (bool post = true)

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 8688 of file wayland-server-protocol-unstable.cpp.

void zxdg_popup_v6_t::post_invalid_grab (std::string const & msg)

Post error: tried to grab after being mapped.

Definition at line 8693 of file wayland-server-protocol-unstable.cpp.

void wayland::server::resource_t::post_no_memory () const [inherited]

Post 'not enough memory' error to the client

If the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance.

bool wayland::server::resource_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

Member Data Documentation

constexpr std::uint32_t wayland::server::zxdg_popup_v6_t::configure_since_version = 1 [static], [constexpr]

Minimum protocol version required for the configure function.

Definition at line 9978 of file wayland-server-protocol-unstable.hpp.

constexpr std::uint32_t wayland::server::zxdg_popup_v6_t::popup_done_since_version = 1 [static], [constexpr]

Minimum protocol version required for the popup_done function.

Definition at line 9991 of file wayland-server-protocol-unstable.hpp.

Author

Generated automatically by Doxygen for Wayland++ from the source code.

Info

Wed Oct 5 2022 Version 1.0.0 Wayland++