SDL 2.0
The xdg_toplevel interface

Data Structures

struct  xdg_toplevel_listener
 

Macros

#define XDG_TOPLEVEL_CONFIGURE_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_CLOSE_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_DESTROY_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_SET_PARENT_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_SET_TITLE_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_SET_APP_ID_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_SHOW_WINDOW_MENU_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_MOVE_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_RESIZE_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_SET_MAX_SIZE_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_SET_MIN_SIZE_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_SET_MAXIMIZED_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_UNSET_MAXIMIZED_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_SET_FULLSCREEN_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_UNSET_FULLSCREEN_SINCE_VERSION   1
 
#define XDG_TOPLEVEL_SET_MINIMIZED_SINCE_VERSION   1
 

Enumerations

enum  xdg_toplevel_resize_edge {
  XDG_TOPLEVEL_RESIZE_EDGE_NONE = 0 ,
  XDG_TOPLEVEL_RESIZE_EDGE_TOP = 1 ,
  XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM = 2 ,
  XDG_TOPLEVEL_RESIZE_EDGE_LEFT = 4 ,
  XDG_TOPLEVEL_RESIZE_EDGE_TOP_LEFT = 5 ,
  XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_LEFT = 6 ,
  XDG_TOPLEVEL_RESIZE_EDGE_RIGHT = 8 ,
  XDG_TOPLEVEL_RESIZE_EDGE_TOP_RIGHT = 9 ,
  XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_RIGHT = 10
}
 
enum  xdg_toplevel_state {
  XDG_TOPLEVEL_STATE_MAXIMIZED = 1 ,
  XDG_TOPLEVEL_STATE_FULLSCREEN = 2 ,
  XDG_TOPLEVEL_STATE_RESIZING = 3 ,
  XDG_TOPLEVEL_STATE_ACTIVATED = 4
}
 

Functions

static int xdg_toplevel_add_listener (struct xdg_toplevel *xdg_toplevel, const struct xdg_toplevel_listener *listener, void *data)
 
static void xdg_toplevel_set_user_data (struct xdg_toplevel *xdg_toplevel, void *user_data)
 
static voidxdg_toplevel_get_user_data (struct xdg_toplevel *xdg_toplevel)
 
static void xdg_toplevel_destroy (struct xdg_toplevel *xdg_toplevel)
 
static void xdg_toplevel_set_parent (struct xdg_toplevel *xdg_toplevel, struct xdg_toplevel *parent)
 
static void xdg_toplevel_set_title (struct xdg_toplevel *xdg_toplevel, const char *title)
 
static void xdg_toplevel_set_app_id (struct xdg_toplevel *xdg_toplevel, const char *app_id)
 
static void xdg_toplevel_show_window_menu (struct xdg_toplevel *xdg_toplevel, struct wl_seat *seat, uint32_t serial, int32_t x, int32_t y)
 
static void xdg_toplevel_move (struct xdg_toplevel *xdg_toplevel, struct wl_seat *seat, uint32_t serial)
 
static void xdg_toplevel_resize (struct xdg_toplevel *xdg_toplevel, struct wl_seat *seat, uint32_t serial, uint32_t edges)
 
static void xdg_toplevel_set_max_size (struct xdg_toplevel *xdg_toplevel, int32_t width, int32_t height)
 
static void xdg_toplevel_set_min_size (struct xdg_toplevel *xdg_toplevel, int32_t width, int32_t height)
 
static void xdg_toplevel_set_maximized (struct xdg_toplevel *xdg_toplevel)
 
static void xdg_toplevel_unset_maximized (struct xdg_toplevel *xdg_toplevel)
 
static void xdg_toplevel_set_fullscreen (struct xdg_toplevel *xdg_toplevel, struct wl_output *output)
 
static void xdg_toplevel_unset_fullscreen (struct xdg_toplevel *xdg_toplevel)
 
static void xdg_toplevel_set_minimized (struct xdg_toplevel *xdg_toplevel)
 

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.

Unmapping an xdg_toplevel means that the surface cannot be shown by the compositor until it is explicitly mapped again. All active operations (e.g., move, resize) are canceled and all attributes (e.g. title, state, stacking, ...) are discarded for an xdg_toplevel surface when it is unmapped.

Attaching a null buffer to a toplevel unmaps the surface.

Macro Definition Documentation

◆ XDG_TOPLEVEL_CLOSE_SINCE_VERSION

#define XDG_TOPLEVEL_CLOSE_SINCE_VERSION   1

Definition at line 1272 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_CONFIGURE_SINCE_VERSION

#define XDG_TOPLEVEL_CONFIGURE_SINCE_VERSION   1

Definition at line 1268 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_DESTROY_SINCE_VERSION

#define XDG_TOPLEVEL_DESTROY_SINCE_VERSION   1

Definition at line 1277 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_MOVE_SINCE_VERSION

#define XDG_TOPLEVEL_MOVE_SINCE_VERSION   1

Definition at line 1297 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_RESIZE_SINCE_VERSION

#define XDG_TOPLEVEL_RESIZE_SINCE_VERSION   1

Definition at line 1301 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_SET_APP_ID_SINCE_VERSION

#define XDG_TOPLEVEL_SET_APP_ID_SINCE_VERSION   1

Definition at line 1289 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_SET_FULLSCREEN_SINCE_VERSION

#define XDG_TOPLEVEL_SET_FULLSCREEN_SINCE_VERSION   1

Definition at line 1321 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_SET_MAX_SIZE_SINCE_VERSION

#define XDG_TOPLEVEL_SET_MAX_SIZE_SINCE_VERSION   1

Definition at line 1305 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_SET_MAXIMIZED_SINCE_VERSION

#define XDG_TOPLEVEL_SET_MAXIMIZED_SINCE_VERSION   1

Definition at line 1313 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_SET_MIN_SIZE_SINCE_VERSION

#define XDG_TOPLEVEL_SET_MIN_SIZE_SINCE_VERSION   1

Definition at line 1309 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_SET_MINIMIZED_SINCE_VERSION

#define XDG_TOPLEVEL_SET_MINIMIZED_SINCE_VERSION   1

Definition at line 1329 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_SET_PARENT_SINCE_VERSION

#define XDG_TOPLEVEL_SET_PARENT_SINCE_VERSION   1

Definition at line 1281 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_SET_TITLE_SINCE_VERSION

#define XDG_TOPLEVEL_SET_TITLE_SINCE_VERSION   1

Definition at line 1285 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_SHOW_WINDOW_MENU_SINCE_VERSION

#define XDG_TOPLEVEL_SHOW_WINDOW_MENU_SINCE_VERSION   1

Definition at line 1293 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_UNSET_FULLSCREEN_SINCE_VERSION

#define XDG_TOPLEVEL_UNSET_FULLSCREEN_SINCE_VERSION   1

Definition at line 1325 of file xdg-shell-client-protocol.h.

◆ XDG_TOPLEVEL_UNSET_MAXIMIZED_SINCE_VERSION

#define XDG_TOPLEVEL_UNSET_MAXIMIZED_SINCE_VERSION   1

Definition at line 1317 of file xdg-shell-client-protocol.h.

Enumeration Type Documentation

◆ xdg_toplevel_resize_edge

edge values for resizing

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

Enumerator
XDG_TOPLEVEL_RESIZE_EDGE_NONE 
XDG_TOPLEVEL_RESIZE_EDGE_TOP 
XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM 
XDG_TOPLEVEL_RESIZE_EDGE_LEFT 
XDG_TOPLEVEL_RESIZE_EDGE_TOP_LEFT 
XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_LEFT 
XDG_TOPLEVEL_RESIZE_EDGE_RIGHT 
XDG_TOPLEVEL_RESIZE_EDGE_TOP_RIGHT 
XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_RIGHT 

Definition at line 1119 of file xdg-shell-client-protocol.h.

◆ xdg_toplevel_state

types of state on the surface

The different state values used on the surface. This is designed for state values like maximized, fullscreen. It is paired with the configure event to ensure that both the client and the compositor setting the state can be synchronized.

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

Enumerator
XDG_TOPLEVEL_STATE_MAXIMIZED 

the surface is maximized the surface is maximized

The surface is maximized. The window geometry specified in the configure event must be obeyed by the client.

XDG_TOPLEVEL_STATE_FULLSCREEN 

the surface is fullscreen the surface is fullscreen

The surface is fullscreen. The window geometry specified in the configure event is a maximum; the client cannot resize beyond it. For a surface to cover the whole fullscreened area, the geometry dimensions must be obeyed by the client. For more details, see xdg_toplevel.set_fullscreen.

XDG_TOPLEVEL_STATE_RESIZING 

the surface is being resized the surface is being resized

The surface is being resized. The window geometry specified in the configure event is a maximum; the client cannot resize beyond it. Clients that have aspect ratio or cell sizing configuration can use a smaller size, however.

XDG_TOPLEVEL_STATE_ACTIVATED 

the surface is now activated 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.

Definition at line 1146 of file xdg-shell-client-protocol.h.

1146 {
1147 /**
1148 * the surface is maximized
1149 * the surface is maximized
1150 *
1151 * The surface is maximized. The window geometry specified in the
1152 * configure event must be obeyed by the client.
1153 */
1155 /**
1156 * the surface is fullscreen
1157 * the surface is fullscreen
1158 *
1159 * The surface is fullscreen. The window geometry specified in
1160 * the configure event is a maximum; the client cannot resize
1161 * beyond it. For a surface to cover the whole fullscreened area,
1162 * the geometry dimensions must be obeyed by the client. For more
1163 * details, see xdg_toplevel.set_fullscreen.
1164 */
1166 /**
1167 * the surface is being resized
1168 * the surface is being resized
1169 *
1170 * The surface is being resized. The window geometry specified in
1171 * the configure event is a maximum; the client cannot resize
1172 * beyond it. Clients that have aspect ratio or cell sizing
1173 * configuration can use a smaller size, however.
1174 */
1176 /**
1177 * the surface is now activated
1178 * the surface is now activated
1179 *
1180 * Client window decorations should be painted as if the window
1181 * is active. Do not assume this means that the window actually has
1182 * keyboard or pointer focus.
1183 */
1185};
@ XDG_TOPLEVEL_STATE_MAXIMIZED
@ XDG_TOPLEVEL_STATE_ACTIVATED
@ XDG_TOPLEVEL_STATE_FULLSCREEN
@ XDG_TOPLEVEL_STATE_RESIZING

Function Documentation

◆ xdg_toplevel_add_listener()

static int xdg_toplevel_add_listener ( struct xdg_toplevel *  xdg_toplevel,
const struct xdg_toplevel_listener listener,
void data 
)
inlinestatic

Definition at line 1243 of file xdg-shell-client-protocol.h.

1245{
1246 return wl_proxy_add_listener((struct wl_proxy *) xdg_toplevel,
1247 (void (**)(void)) listener, data);
1248}
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974

◆ xdg_toplevel_destroy()

static void xdg_toplevel_destroy ( struct xdg_toplevel *  xdg_toplevel)
inlinestatic

This request destroys the role surface and unmaps the surface; see "Unmapping" behavior in interface section for details.

Definition at line 1358 of file xdg-shell-client-protocol.h.

1359{
1360 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1361 XDG_TOPLEVEL_DESTROY, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), WL_MARSHAL_FLAG_DESTROY);
1362}
#define NULL
Definition: begin_code.h:167
#define XDG_TOPLEVEL_DESTROY

References NULL, and XDG_TOPLEVEL_DESTROY.

◆ xdg_toplevel_get_user_data()

static void * xdg_toplevel_get_user_data ( struct xdg_toplevel *  xdg_toplevel)
inlinestatic

Definition at line 1340 of file xdg-shell-client-protocol.h.

1341{
1342 return wl_proxy_get_user_data((struct wl_proxy *) xdg_toplevel);
1343}

◆ xdg_toplevel_move()

static void xdg_toplevel_move ( struct xdg_toplevel *  xdg_toplevel,
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.

Definition at line 1483 of file xdg-shell-client-protocol.h.

1484{
1485 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1486 XDG_TOPLEVEL_MOVE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, seat, serial);
1487}
#define XDG_TOPLEVEL_MOVE

References NULL, and XDG_TOPLEVEL_MOVE.

◆ xdg_toplevel_resize()

static void xdg_toplevel_resize ( struct xdg_toplevel *  xdg_toplevel,
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.

Definition at line 1524 of file xdg-shell-client-protocol.h.

1525{
1526 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1527 XDG_TOPLEVEL_RESIZE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, seat, serial, edges);
1528}
#define XDG_TOPLEVEL_RESIZE

References NULL, and XDG_TOPLEVEL_RESIZE.

◆ xdg_toplevel_set_app_id()

static void xdg_toplevel_set_app_id ( struct xdg_toplevel *  xdg_toplevel,
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/

Definition at line 1434 of file xdg-shell-client-protocol.h.

1435{
1436 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1437 XDG_TOPLEVEL_SET_APP_ID, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, app_id);
1438}
#define XDG_TOPLEVEL_SET_APP_ID

References NULL, and XDG_TOPLEVEL_SET_APP_ID.

◆ xdg_toplevel_set_fullscreen()

static void xdg_toplevel_set_fullscreen ( struct xdg_toplevel *  xdg_toplevel,
struct wl_output *  output 
)
inlinestatic

Make the surface fullscreen.

After requesting that the surface should be fullscreened, the compositor will respond by emitting a configure event with the "fullscreen" state and the fullscreen window geometry. The client must also acknowledge the configure when committing the new content (see ack_configure).

The output passed by the request indicates the client's preference as to which display it should be set fullscreen on. 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 with border fill covering the rest of the output. The content of the border fill is undefined, but should be assumed to be in some way that attempts to blend into the surrounding area (e.g. solid black).

If the fullscreened surface is not opaque, the compositor must make sure that other screen content not part of the same surface tree (made up of subsurfaces, popups or similarly coupled surfaces) are not visible below the fullscreened surface.

Definition at line 1711 of file xdg-shell-client-protocol.h.

1712{
1713 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1714 XDG_TOPLEVEL_SET_FULLSCREEN, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, output);
1715}
#define XDG_TOPLEVEL_SET_FULLSCREEN

References NULL, sort_controllers::output, and XDG_TOPLEVEL_SET_FULLSCREEN.

◆ xdg_toplevel_set_max_size()

static void xdg_toplevel_set_max_size ( struct xdg_toplevel *  xdg_toplevel,
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.

Definition at line 1569 of file xdg-shell-client-protocol.h.

1570{
1571 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1572 XDG_TOPLEVEL_SET_MAX_SIZE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, width, height);
1573}
GLint GLint GLsizei width
Definition: SDL_opengl.h:1572
GLint GLint GLsizei GLsizei height
Definition: SDL_opengl.h:1572
#define XDG_TOPLEVEL_SET_MAX_SIZE

References NULL, and XDG_TOPLEVEL_SET_MAX_SIZE.

◆ xdg_toplevel_set_maximized()

static void xdg_toplevel_set_maximized ( struct xdg_toplevel *  xdg_toplevel)
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.

If the surface is in a fullscreen state, this request has no direct effect. It will alter the state the surface is returned to when unmaximized if not overridden by the compositor.

Definition at line 1645 of file xdg-shell-client-protocol.h.

1646{
1647 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1648 XDG_TOPLEVEL_SET_MAXIMIZED, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0);
1649}
#define XDG_TOPLEVEL_SET_MAXIMIZED

References NULL, and XDG_TOPLEVEL_SET_MAXIMIZED.

◆ xdg_toplevel_set_min_size()

static void xdg_toplevel_set_min_size ( struct xdg_toplevel *  xdg_toplevel,
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.

Definition at line 1614 of file xdg-shell-client-protocol.h.

1615{
1616 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1617 XDG_TOPLEVEL_SET_MIN_SIZE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, width, height);
1618}
#define XDG_TOPLEVEL_SET_MIN_SIZE

References NULL, and XDG_TOPLEVEL_SET_MIN_SIZE.

◆ xdg_toplevel_set_minimized()

static void xdg_toplevel_set_minimized ( struct xdg_toplevel *  xdg_toplevel)
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.

Definition at line 1757 of file xdg-shell-client-protocol.h.

1758{
1759 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1760 XDG_TOPLEVEL_SET_MINIMIZED, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0);
1761}
#define XDG_TOPLEVEL_SET_MINIMIZED

References NULL, and XDG_TOPLEVEL_SET_MINIMIZED.

◆ xdg_toplevel_set_parent()

static void xdg_toplevel_set_parent ( struct xdg_toplevel *  xdg_toplevel,
struct xdg_toplevel *  parent 
)
inlinestatic

Set the "parent" of this surface. This surface should be stacked above the parent surface and all other ancestor surfaces.

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

Setting a null parent for a child window removes any parent-child relationship for the child. Setting a null parent for a window which currently has no parent is a no-op.

If the parent is unmapped then its children are managed as though the parent of the now-unmapped parent has become the parent of this surface. If no parent exists for the now-unmapped parent then the children are managed as though they have no parent surface.

Definition at line 1385 of file xdg-shell-client-protocol.h.

1386{
1387 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1388 XDG_TOPLEVEL_SET_PARENT, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, parent);
1389}
#define XDG_TOPLEVEL_SET_PARENT

References NULL, and XDG_TOPLEVEL_SET_PARENT.

◆ xdg_toplevel_set_title()

static void xdg_toplevel_set_title ( struct xdg_toplevel *  xdg_toplevel,
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.

Definition at line 1403 of file xdg-shell-client-protocol.h.

1404{
1405 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1406 XDG_TOPLEVEL_SET_TITLE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, title);
1407}
#define XDG_TOPLEVEL_SET_TITLE

References NULL, and XDG_TOPLEVEL_SET_TITLE.

◆ xdg_toplevel_set_user_data()

static void xdg_toplevel_set_user_data ( struct xdg_toplevel *  xdg_toplevel,
void user_data 
)
inlinestatic

Definition at line 1333 of file xdg-shell-client-protocol.h.

1334{
1335 wl_proxy_set_user_data((struct wl_proxy *) xdg_toplevel, user_data);
1336}

◆ xdg_toplevel_show_window_menu()

static void xdg_toplevel_show_window_menu ( struct xdg_toplevel *  xdg_toplevel,
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.

Definition at line 1456 of file xdg-shell-client-protocol.h.

1457{
1458 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1459 XDG_TOPLEVEL_SHOW_WINDOW_MENU, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, seat, serial, x, y);
1460}
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
#define XDG_TOPLEVEL_SHOW_WINDOW_MENU

References NULL, and XDG_TOPLEVEL_SHOW_WINDOW_MENU.

◆ xdg_toplevel_unset_fullscreen()

static void xdg_toplevel_unset_fullscreen ( struct xdg_toplevel *  xdg_toplevel)
inlinestatic

Make the surface no longer fullscreen.

After requesting that the surface should be unfullscreened, the compositor will respond by emitting a configure event without the "fullscreen" state.

Making a surface unfullscreen sets states for the surface based on the following:

  • the state(s) it may have had before becoming fullscreen
  • any state(s) decided by the compositor
  • any state(s) requested by the client while the surface was fullscreen

The compositor may include the previous window geometry dimensions in the configure event, if applicable.

The client must also acknowledge the configure when committing the new content (see ack_configure).

Definition at line 1738 of file xdg-shell-client-protocol.h.

1739{
1740 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1741 XDG_TOPLEVEL_UNSET_FULLSCREEN, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0);
1742}
#define XDG_TOPLEVEL_UNSET_FULLSCREEN

References NULL, and XDG_TOPLEVEL_UNSET_FULLSCREEN.

◆ xdg_toplevel_unset_maximized()

static void xdg_toplevel_unset_maximized ( struct xdg_toplevel *  xdg_toplevel)
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 event. 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.

If the surface is in a fullscreen state, this request has no direct effect. It will alter the state the surface is returned to when unmaximized if not overridden by the compositor.

Definition at line 1677 of file xdg-shell-client-protocol.h.

1678{
1679 wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel,
1680 XDG_TOPLEVEL_UNSET_MAXIMIZED, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0);
1681}
#define XDG_TOPLEVEL_UNSET_MAXIMIZED

References NULL, and XDG_TOPLEVEL_UNSET_MAXIMIZED.