Data Fields
zxdg_shell_v6_interface Struct Reference

Data Fields

void(* destroy )(struct wl_client *client, struct wl_resource *resource)
 destroy xdg_shell More...
 
void(* create_positioner )(struct wl_client *client, struct wl_resource *resource, uint32_t id)
 create a positioner object More...
 
void(* get_xdg_surface )(struct wl_client *client, struct wl_resource *resource, uint32_t id, struct wl_resource *surface)
 create a shell surface from a surface More...
 
void(* pong )(struct wl_client *client, struct wl_resource *resource, uint32_t serial)
 respond to a ping event More...
 

Field Documentation

◆ destroy

void(* zxdg_shell_v6_interface::destroy) (struct wl_client *client, struct wl_resource *resource)

destroy xdg_shell

Destroy this xdg_shell object.

Destroying a bound xdg_shell object while there are surfaces still alive created by this xdg_shell object instance is illegal and will result in a protocol error.

◆ create_positioner

void(* zxdg_shell_v6_interface::create_positioner) (struct wl_client *client, struct wl_resource *resource, uint32_t id)

create a positioner object

Create a positioner object. A positioner object is used to position surfaces relative to some parent surface. See the interface description and xdg_surface.get_popup for details.

◆ get_xdg_surface

void(* zxdg_shell_v6_interface::get_xdg_surface) (struct wl_client *client, struct wl_resource *resource, uint32_t id, struct wl_resource *surface)

create a shell surface from a surface

This creates an xdg_surface for the given surface. While xdg_surface itself is not a role, the corresponding surface may only be assigned a role extending xdg_surface, such as xdg_toplevel or xdg_popup.

This creates an xdg_surface for the given surface. An xdg_surface is used as basis to define a role to a given surface, such as xdg_toplevel or xdg_popup. It also manages functionality shared between xdg_surface based surface roles.

See the documentation of xdg_surface for more details about what an xdg_surface is and how it is used.

◆ pong

void(* zxdg_shell_v6_interface::pong) (struct wl_client *client, struct wl_resource *resource, uint32_t serial)

respond to a ping event

A client must respond to a ping event with a pong request or the client may be deemed unresponsive. See xdg_shell.ping.

Parameters
serialserial of the ping event