Data Structures | Macros | Enumerations | Functions
The zxdg_toplevel_v6 interface

This interface defines an xdg_surface role which allows a surface to, among other things, set window-like properties such as maximize, fullscreen, and minimize, set application-specific metadata like title and id, and well as trigger user interactive operations such as interactive resize and move. More...

Data Structures

struct  zxdg_toplevel_v6_listener
 

Macros

#define ZXDG_TOPLEVEL_V6_CONFIGURE_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_CLOSE_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_DESTROY_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_SET_PARENT_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_SET_TITLE_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_SET_APP_ID_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_SHOW_WINDOW_MENU_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_MOVE_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_RESIZE_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_SET_MAX_SIZE_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_SET_MIN_SIZE_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_SET_MAXIMIZED_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_UNSET_MAXIMIZED_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_SET_FULLSCREEN_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_UNSET_FULLSCREEN_SINCE_VERSION   1
 
#define ZXDG_TOPLEVEL_V6_SET_MINIMIZED_SINCE_VERSION   1
 

Enumerations

enum  zxdg_toplevel_v6_resize_edge {
  ZXDG_TOPLEVEL_V6_RESIZE_EDGE_NONE = 0,
  ZXDG_TOPLEVEL_V6_RESIZE_EDGE_TOP = 1,
  ZXDG_TOPLEVEL_V6_RESIZE_EDGE_BOTTOM = 2,
  ZXDG_TOPLEVEL_V6_RESIZE_EDGE_LEFT = 4,
  ZXDG_TOPLEVEL_V6_RESIZE_EDGE_TOP_LEFT = 5,
  ZXDG_TOPLEVEL_V6_RESIZE_EDGE_BOTTOM_LEFT = 6,
  ZXDG_TOPLEVEL_V6_RESIZE_EDGE_RIGHT = 8,
  ZXDG_TOPLEVEL_V6_RESIZE_EDGE_TOP_RIGHT = 9,
  ZXDG_TOPLEVEL_V6_RESIZE_EDGE_BOTTOM_RIGHT = 10
}
 edge values for resizing More...
 
enum  zxdg_toplevel_v6_state {
  ZXDG_TOPLEVEL_V6_STATE_MAXIMIZED = 1,
  ZXDG_TOPLEVEL_V6_STATE_FULLSCREEN = 2,
  ZXDG_TOPLEVEL_V6_STATE_RESIZING = 3,
  ZXDG_TOPLEVEL_V6_STATE_ACTIVATED = 4
}
 the surface is now activated More...
 

Functions

static int zxdg_toplevel_v6_add_listener (struct zxdg_toplevel_v6 *zxdg_toplevel_v6, const struct zxdg_toplevel_v6_listener *listener, void *data)
 
static void zxdg_toplevel_v6_set_user_data (struct zxdg_toplevel_v6 *zxdg_toplevel_v6, void *user_data)
 
static void * zxdg_toplevel_v6_get_user_data (struct zxdg_toplevel_v6 *zxdg_toplevel_v6)
 
static void zxdg_toplevel_v6_destroy (struct zxdg_toplevel_v6 *zxdg_toplevel_v6)
 Unmap and destroy the window. More...
 
static void zxdg_toplevel_v6_set_parent (struct zxdg_toplevel_v6 *zxdg_toplevel_v6, struct zxdg_toplevel_v6 *parent)
 Set the "parent" of this surface. More...
 
static void zxdg_toplevel_v6_set_title (struct zxdg_toplevel_v6 *zxdg_toplevel_v6, const char *title)
 Set a short title for the surface. More...
 
static void zxdg_toplevel_v6_set_app_id (struct zxdg_toplevel_v6 *zxdg_toplevel_v6, const char *app_id)
 Set an application identifier for the surface. More...
 
static void zxdg_toplevel_v6_show_window_menu (struct zxdg_toplevel_v6 *zxdg_toplevel_v6, struct wl_seat *seat, uint32_t serial, int32_t x, int32_t y)
 Clients implementing client-side decorations might want to show a context menu when right-clicking on the decorations, giving the user a menu that they can use to maximize or minimize the window. More...
 
static void zxdg_toplevel_v6_move (struct zxdg_toplevel_v6 *zxdg_toplevel_v6, struct wl_seat *seat, uint32_t serial)
 Start an interactive, user-driven move of the surface. More...
 
static void zxdg_toplevel_v6_resize (struct zxdg_toplevel_v6 *zxdg_toplevel_v6, struct wl_seat *seat, uint32_t serial, uint32_t edges)
 Start a user-driven, interactive resize of the surface. More...
 
static void zxdg_toplevel_v6_set_max_size (struct zxdg_toplevel_v6 *zxdg_toplevel_v6, int32_t width, int32_t height)
 Set a maximum size for the window. More...
 
static void zxdg_toplevel_v6_set_min_size (struct zxdg_toplevel_v6 *zxdg_toplevel_v6, int32_t width, int32_t height)
 Set a minimum size for the window. More...
 
static void zxdg_toplevel_v6_set_maximized (struct zxdg_toplevel_v6 *zxdg_toplevel_v6)
 Maximize the surface. More...
 
static void zxdg_toplevel_v6_unset_maximized (struct zxdg_toplevel_v6 *zxdg_toplevel_v6)
 Unmaximize the surface. More...
 
static void zxdg_toplevel_v6_set_fullscreen (struct zxdg_toplevel_v6 *zxdg_toplevel_v6, struct wl_output *output)
 Make the surface fullscreen. More...
 
static void zxdg_toplevel_v6_unset_fullscreen (struct zxdg_toplevel_v6 *zxdg_toplevel_v6)
 
static void zxdg_toplevel_v6_set_minimized (struct zxdg_toplevel_v6 *zxdg_toplevel_v6)
 Request that the compositor minimize your surface. More...
 

Detailed Description

This interface defines an xdg_surface role which allows a surface to, among other things, set window-like properties such as maximize, fullscreen, and minimize, set application-specific metadata like title and id, and well as trigger user interactive operations such as interactive resize and move.

Enumeration Type Documentation

◆ zxdg_toplevel_v6_resize_edge

edge values for resizing

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

◆ zxdg_toplevel_v6_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_TOPLEVEL_V6_STATE_MAXIMIZED 

the surface is maximized

ZXDG_TOPLEVEL_V6_STATE_FULLSCREEN 

the surface is fullscreen

ZXDG_TOPLEVEL_V6_STATE_RESIZING 

the surface is being resized

ZXDG_TOPLEVEL_V6_STATE_ACTIVATED 

the surface is now activated

Function Documentation

◆ zxdg_toplevel_v6_destroy()

static void zxdg_toplevel_v6_destroy ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6)
inlinestatic

Unmap and destroy the window.

The window will be effectively hidden from the user's point of view, and all state like maximization, fullscreen, and so on, will be lost.

◆ zxdg_toplevel_v6_set_parent()

static void zxdg_toplevel_v6_set_parent ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6,
struct zxdg_toplevel_v6 *  parent 
)
inlinestatic

Set the "parent" of this surface.

This window should be stacked above a parent. The parent surface must be mapped as long as this surface is mapped.

Parent windows should be set on dialogs, toolboxes, or other "auxiliary" surfaces, so that the parent is raised when the dialog is raised.

◆ zxdg_toplevel_v6_set_title()

static void zxdg_toplevel_v6_set_title ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6,
const char *  title 
)
inlinestatic

Set a short title for the surface.

This string may be used to identify the surface in a task bar, window list, or other user interface elements provided by the compositor.

The string must be encoded in UTF-8.

◆ zxdg_toplevel_v6_set_app_id()

static void zxdg_toplevel_v6_set_app_id ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6,
const char *  app_id 
)
inlinestatic

Set an application identifier for the surface.

The app ID identifies the general class of applications to which the surface belongs. The compositor can use this to group multiple surfaces together, or to determine how to launch a new application.

For D-Bus activatable applications, the app ID is used as the D-Bus service name.

The compositor shell will try to group application surfaces together by their app ID. As a best practice, it is suggested to select app ID's that match the basename of the application's .desktop file. For example, "org.freedesktop.FooViewer" where the .desktop file is "org.freedesktop.FooViewer.desktop".

See the desktop-entry specification [0] for more details on application identifiers and how they relate to well-known D-Bus names and .desktop files.

[0] http://standards.freedesktop.org/desktop-entry-spec/

◆ zxdg_toplevel_v6_show_window_menu()

static void zxdg_toplevel_v6_show_window_menu ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6,
struct wl_seat *  seat,
uint32_t  serial,
int32_t  x,
int32_t  y 
)
inlinestatic

Clients implementing client-side decorations might want to show a context menu when right-clicking on the decorations, giving the user a menu that they can use to maximize or minimize the window.

This request asks the compositor to pop up such a window menu at the given position, relative to the local surface coordinates of the parent surface. There are no guarantees as to what menu items the window menu contains.

This request must be used in response to some sort of user action like a button press, key press, or touch down event.

◆ zxdg_toplevel_v6_move()

static void zxdg_toplevel_v6_move ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6,
struct wl_seat *  seat,
uint32_t  serial 
)
inlinestatic

Start an interactive, user-driven move of the surface.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive move (touch, pointer, etc).

The server may ignore move requests depending on the state of the surface (e.g. fullscreen or maximized), or if the passed serial is no longer valid.

If triggered, the surface will lose the focus of the device (wl_pointer, wl_touch, etc) used for the move. It is up to the compositor to visually indicate that the move is taking place, such as updating a pointer cursor, during the move. There is no guarantee that the device focus will return when the move is completed.

◆ zxdg_toplevel_v6_resize()

static void zxdg_toplevel_v6_resize ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6,
struct wl_seat *  seat,
uint32_t  serial,
uint32_t  edges 
)
inlinestatic

Start a user-driven, interactive resize of the surface.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive resize (touch, pointer, etc).

The server may ignore resize requests depending on the state of the surface (e.g. fullscreen or maximized).

If triggered, the client will receive configure events with the "resize" state enum value and the expected sizes. See the "resize" enum value for more details about what is required. The client must also acknowledge configure events using "ack_configure". After the resize is completed, the client will receive another "configure" event without the resize state.

If triggered, the surface also will lose the focus of the device (wl_pointer, wl_touch, etc) used for the resize. It is up to the compositor to visually indicate that the resize is taking place, such as updating a pointer cursor, during the resize. There is no guarantee that the device focus will return when the resize is completed.

The edges parameter specifies how the surface should be resized, and is one of the values of the resize_edge enum. The compositor may use this information to update the surface position for example when dragging the top left corner. The compositor may also use this information to adapt its behavior, e.g. choose an appropriate cursor image.

◆ zxdg_toplevel_v6_set_max_size()

static void zxdg_toplevel_v6_set_max_size ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6,
int32_t  width,
int32_t  height 
)
inlinestatic

Set a maximum size for the window.

The client can specify a maximum size so that the compositor does not try to configure the window beyond this size.

The width and height arguments are in window geometry coordinates. See xdg_surface.set_window_geometry.

Values set in this way are double-buffered. They will get applied on the next commit.

The compositor can use this information to allow or disallow different states like maximize or fullscreen and draw accurate animations.

Similarly, a tiling window manager may use this information to place and resize client windows in a more effective way.

The client should not rely on the compositor to obey the maximum size. The compositor may decide to ignore the values set by the client and request a larger size.

If never set, or a value of zero in the request, means that the client has no expected maximum size in the given dimension. As a result, a client wishing to reset the maximum size to an unspecified state can use zero for width and height in the request.

Requesting a maximum size to be smaller than the minimum size of a surface is illegal and will result in a protocol error.

The width and height must be greater than or equal to zero. Using strictly negative values for width and height will result in a protocol error.

◆ zxdg_toplevel_v6_set_min_size()

static void zxdg_toplevel_v6_set_min_size ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6,
int32_t  width,
int32_t  height 
)
inlinestatic

Set a minimum size for the window.

The client can specify a minimum size so that the compositor does not try to configure the window below this size.

The width and height arguments are in window geometry coordinates. See xdg_surface.set_window_geometry.

Values set in this way are double-buffered. They will get applied on the next commit.

The compositor can use this information to allow or disallow different states like maximize or fullscreen and draw accurate animations.

Similarly, a tiling window manager may use this information to place and resize client windows in a more effective way.

The client should not rely on the compositor to obey the minimum size. The compositor may decide to ignore the values set by the client and request a smaller size.

If never set, or a value of zero in the request, means that the client has no expected minimum size in the given dimension. As a result, a client wishing to reset the minimum size to an unspecified state can use zero for width and height in the request.

Requesting a minimum size to be larger than the maximum size of a surface is illegal and will result in a protocol error.

The width and height must be greater than or equal to zero. Using strictly negative values for width and height will result in a protocol error.

◆ zxdg_toplevel_v6_set_maximized()

static void zxdg_toplevel_v6_set_maximized ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6)
inlinestatic

Maximize the surface.

After requesting that the surface should be maximized, the compositor will respond by emitting a configure event with the "maximized" state and the required window geometry. The client should then update its content, drawing it in a maximized state, i.e. without shadow or other decoration outside of the window geometry. The client must also acknowledge the configure when committing the new content (see ack_configure).

It is up to the compositor to decide how and where to maximize the surface, for example which output and what region of the screen should be used.

If the surface was already maximized, the compositor will still emit a configure event with the "maximized" state.

◆ zxdg_toplevel_v6_unset_maximized()

static void zxdg_toplevel_v6_unset_maximized ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6)
inlinestatic

Unmaximize the surface.

After requesting that the surface should be unmaximized, the compositor will respond by emitting a configure event without the "maximized" state. If available, the compositor will include the window geometry dimensions the window had prior to being maximized in the configure request. The client must then update its content, drawing it in a regular state, i.e. potentially with shadow, etc. The client must also acknowledge the configure when committing the new content (see ack_configure).

It is up to the compositor to position the surface after it was unmaximized; usually the position the surface had before maximizing, if applicable.

If the surface was already not maximized, the compositor will still emit a configure event without the "maximized" state.

◆ zxdg_toplevel_v6_set_fullscreen()

static void zxdg_toplevel_v6_set_fullscreen ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6,
struct wl_output *  output 
)
inlinestatic

Make the surface fullscreen.

You can specify an output that you would prefer to be fullscreen. If this value is NULL, it's up to the compositor to choose which display will be used to map this surface.

If the surface doesn't cover the whole output, the compositor will position the surface in the center of the output and compensate with black borders filling the rest of the output.

◆ zxdg_toplevel_v6_set_minimized()

static void zxdg_toplevel_v6_set_minimized ( struct zxdg_toplevel_v6 *  zxdg_toplevel_v6)
inlinestatic

Request that the compositor minimize your surface.

There is no way to know if the surface is currently minimized, nor is there any way to unset minimization on this surface.

If you are looking to throttle redrawing when minimized, please instead use the wl_surface.frame event for this, as this will also work with live previews on windows in Alt-Tab, Expose or similar compositor features.