EHS
Loading...
Searching...
No Matches
xdg_popup_listener Struct Reference

#include <xdg-shell-client-protocol.h>

Public Attributes

void(* configure )(void *data, struct xdg_popup *xdg_popup, int32_t x, int32_t y, int32_t width, int32_t height)
 
void(* popup_done )(void *data, struct xdg_popup *xdg_popup)
 
void(* repositioned )(void *data, struct xdg_popup *xdg_popup, uint32_t token)
 

Member Data Documentation

◆ configure

void(* xdg_popup_listener::configure) (void *data, struct xdg_popup *xdg_popup, int32_t x, int32_t y, int32_t width, int32_t height)

configure the popup surface

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.

For version 2 or older, the configure event for an xdg_popup is only ever sent once for the initial configuration. Starting with version 3, it may be sent again if the popup is setup with an xdg_positioner with set_reactive requested, or in response to xdg_popup.reposition requests.

Parameters
xx position relative to parent surface window geometry
yy position relative to parent surface window geometry
widthwindow geometry width
heightwindow geometry height

◆ popup_done

void(* xdg_popup_listener::popup_done) (void *data, struct xdg_popup *xdg_popup)

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.

◆ repositioned

void(* xdg_popup_listener::repositioned) (void *data, struct xdg_popup *xdg_popup, uint32_t token)

signal the completion of a repositioned request

The repositioned event is sent as part of a popup configuration sequence, together with xdg_popup.configure and lastly xdg_surface.configure to notify the completion of a reposition request.

The repositioned event is to notify about the completion of a xdg_popup.reposition request. The token argument is the token passed in the xdg_popup.reposition request.

Immediately after this event is emitted, xdg_popup.configure and xdg_surface.configure will be sent with the updated size and position, as well as a new configure serial.

The client should optionally update the content of the popup, but must acknowledge the new popup configuration for the new position to take effect. See xdg_surface.ack_configure for details.

Parameters
tokenreposition request token
Since
3

The documentation for this struct was generated from the following file: