KWayland

The xdg_surface interface

Macros

#define ZXDG_SURFACE_V5_ACK_CONFIGURE_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_CLOSE_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_CONFIGURE_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_DESTROY_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_MOVE_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_RESIZE_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_SET_APP_ID_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_SET_FULLSCREEN_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_SET_MAXIMIZED_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_SET_MINIMIZED_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_SET_PARENT_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_SET_TITLE_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_SET_WINDOW_GEOMETRY_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_SHOW_WINDOW_MENU_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_UNSET_FULLSCREEN_SINCE_VERSION   1
 
#define ZXDG_SURFACE_V5_UNSET_MAXIMIZED_SINCE_VERSION   1
 

Enumerations

enum  zxdg_surface_v5_resize_edge {
  ZXDG_SURFACE_V5_RESIZE_EDGE_NONE = 0, ZXDG_SURFACE_V5_RESIZE_EDGE_TOP = 1, ZXDG_SURFACE_V5_RESIZE_EDGE_BOTTOM = 2, ZXDG_SURFACE_V5_RESIZE_EDGE_LEFT = 4,
  ZXDG_SURFACE_V5_RESIZE_EDGE_TOP_LEFT = 5, ZXDG_SURFACE_V5_RESIZE_EDGE_BOTTOM_LEFT = 6, ZXDG_SURFACE_V5_RESIZE_EDGE_RIGHT = 8, ZXDG_SURFACE_V5_RESIZE_EDGE_TOP_RIGHT = 9,
  ZXDG_SURFACE_V5_RESIZE_EDGE_BOTTOM_RIGHT = 10, ZXDG_SURFACE_V5_RESIZE_EDGE_NONE = 0, ZXDG_SURFACE_V5_RESIZE_EDGE_TOP = 1, ZXDG_SURFACE_V5_RESIZE_EDGE_BOTTOM = 2,
  ZXDG_SURFACE_V5_RESIZE_EDGE_LEFT = 4, ZXDG_SURFACE_V5_RESIZE_EDGE_TOP_LEFT = 5, ZXDG_SURFACE_V5_RESIZE_EDGE_BOTTOM_LEFT = 6, ZXDG_SURFACE_V5_RESIZE_EDGE_RIGHT = 8,
  ZXDG_SURFACE_V5_RESIZE_EDGE_TOP_RIGHT = 9, ZXDG_SURFACE_V5_RESIZE_EDGE_BOTTOM_RIGHT = 10
}
 
enum  zxdg_surface_v5_state {
  ZXDG_SURFACE_V5_STATE_MAXIMIZED = 1, ZXDG_SURFACE_V5_STATE_FULLSCREEN = 2, ZXDG_SURFACE_V5_STATE_RESIZING = 3, ZXDG_SURFACE_V5_STATE_ACTIVATED = 4,
  ZXDG_SURFACE_V5_STATE_MAXIMIZED = 1, ZXDG_SURFACE_V5_STATE_FULLSCREEN = 2, ZXDG_SURFACE_V5_STATE_RESIZING = 3, ZXDG_SURFACE_V5_STATE_ACTIVATED = 4
}
 

Functions

static void * zxdg_surface_v5_get_user_data (struct xdg_surface *xdg_surface)
 
static void zxdg_surface_v5_send_close (struct wl_resource *resource_)
 
static void zxdg_surface_v5_send_configure (struct wl_resource *resource_, int32_t width, int32_t height, struct wl_array *states, uint32_t serial)
 
static void zxdg_surface_v5_set_user_data (struct xdg_surface *xdg_surface, void *user_data)
 

Detailed Description

An interface that may be implemented by a wl_surface, for implementations that provide a desktop-style user interface.

It provides requests to treat surfaces like windows, allowing to set properties like maximized, fullscreen, minimized, and to move and resize them, and associate metadata like title and app id.

The client must call wl_surface.commit on the corresponding wl_surface for the xdg_surface state to take effect. Prior to committing the new state, it can set up initial configuration, such as maximizing or setting a window geometry.

Even without attaching a buffer the compositor must respond to initial committed configuration, for instance sending a configure event with expected window geometry if the client maximized its surface during initialization.

For a surface to be mapped by the compositor the client must have committed both an xdg_surface state and a buffer.

Enumeration Type Documentation

enum zxdg_surface_v5_resize_edge

edge values for resizing

These values are used to indicate which edge of a surface is being dragged in a resize operation.

Definition at line 401 of file wayland-xdg-shell-v5-server-protocol.h.

enum zxdg_surface_v5_state

the surface is now activated

Client window decorations should be painted as if the window is active. Do not assume this means that the window actually has keyboard or pointer focus.

Enumerator
ZXDG_SURFACE_V5_STATE_MAXIMIZED 

the surface is maximized

ZXDG_SURFACE_V5_STATE_FULLSCREEN 

the surface is fullscreen

ZXDG_SURFACE_V5_STATE_RESIZING 

the surface is being resized

ZXDG_SURFACE_V5_STATE_ACTIVATED 

the surface is now activated

ZXDG_SURFACE_V5_STATE_MAXIMIZED 

the surface is maximized

ZXDG_SURFACE_V5_STATE_FULLSCREEN 

the surface is fullscreen

ZXDG_SURFACE_V5_STATE_RESIZING 

the surface is being resized

ZXDG_SURFACE_V5_STATE_ACTIVATED 

the surface is now activated

Definition at line 424 of file wayland-xdg-shell-v5-server-protocol.h.

Function Documentation

static void zxdg_surface_v5_send_close ( struct wl_resource *  resource_)
inlinestatic

Sends an close event to the client owning the resource.

Parameters
resource_The client's resource

Definition at line 839 of file wayland-xdg-shell-v5-server-protocol.h.

static void zxdg_surface_v5_send_configure ( struct wl_resource *  resource_,
int32_t  width,
int32_t  height,
struct wl_array *  states,
uint32_t  serial 
)
inlinestatic

Sends an configure event to the client owning the resource.

Parameters
resource_The client's resource

Definition at line 828 of file wayland-xdg-shell-v5-server-protocol.h.

This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Wed Apr 14 2021 22:50:16 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.