ZxdgPopupV6

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.

final

class ZxdgPopupV6 : WlProxy {

enum ver;

static immutable(WlProxyInterface) iface [@property getter];

enum destroyOpCode;

enum grabOpCode;

enum destroySinceVersion;

enum grabSinceVersion;

enum onConfigureSinceVersion;

enum onPopupDoneSinceVersion;

alias OnConfigureEventDg = void delegate(ZxdgPopupV6 zxdgPopupV6, int x, int y, int width, int height);

alias OnPopupDoneEventDg = void delegate(ZxdgPopupV6 zxdgPopupV6);

enum Error;

void destroy();

void grab(WlSeat seat, uint serial);

OnConfigureEventDg onConfigure [@property setter];

OnPopupDoneEventDg onPopupDone [@property setter];

}

Members

Aliases

OnConfigureEventDg alias OnConfigureEventDg = void delegate(ZxdgPopupV6 zxdgPopupV6, int x, int y, int width, int height): Event delegate signature of ZxdgPopupV6.onConfigure.
OnPopupDoneEventDg alias OnPopupDoneEventDg = void delegate(ZxdgPopupV6 zxdgPopupV6): Event delegate signature of ZxdgPopupV6.onPopupDone.

Enums

Error enum Error: Undocumented in source.

Functions

destroy void destroy(): remove xdg_popup interface
grab void grab(WlSeat seat, uint serial): make the popup take an explicit grab

Manifest constants

destroyOpCode enum destroyOpCode;: Op-code of ZxdgPopupV6.destroy.
destroySinceVersion enum destroySinceVersion;: Version of xdg_shell_unstable_v6 protocol introducing ZxdgPopupV6.destroy.
grabOpCode enum grabOpCode;: Op-code of ZxdgPopupV6.grab.
grabSinceVersion enum grabSinceVersion;: Version of xdg_shell_unstable_v6 protocol introducing ZxdgPopupV6.grab.
onConfigureSinceVersion enum onConfigureSinceVersion;: xdg_shell_unstable_v6 protocol version introducing ZxdgPopupV6.onConfigure.
onPopupDoneSinceVersion enum onPopupDoneSinceVersion;: xdg_shell_unstable_v6 protocol version introducing ZxdgPopupV6.onPopupDone.
ver enum ver;: Version of xdg_shell_unstable_v6.zxdg_popup_v6

Properties

iface immutable(WlProxyInterface) iface [@property getter]: Interface object that creates ZxdgPopupV6 objects.
onConfigure OnConfigureEventDg onConfigure [@property setter]: configure the popup surface
onPopupDone OnPopupDoneEventDg onPopupDone [@property setter]: popup interaction is done