Data Fields
zxdg_positioner_v6_interface Struct Reference

Data Fields

void(* destroy )(struct wl_client *client, struct wl_resource *resource)
 destroy the xdg_positioner object More...
 
void(* set_size )(struct wl_client *client, struct wl_resource *resource, int32_t width, int32_t height)
 set the size of the to-be positioned rectangle More...
 
void(* set_anchor_rect )(struct wl_client *client, struct wl_resource *resource, int32_t x, int32_t y, int32_t width, int32_t height)
 set the anchor rectangle within the parent surface More...
 
void(* set_anchor )(struct wl_client *client, struct wl_resource *resource, uint32_t anchor)
 set anchor rectangle anchor edges More...
 
void(* set_gravity )(struct wl_client *client, struct wl_resource *resource, uint32_t gravity)
 set child surface gravity More...
 
void(* set_constraint_adjustment )(struct wl_client *client, struct wl_resource *resource, uint32_t constraint_adjustment)
 set the adjustment to be done when constrained More...
 
void(* set_offset )(struct wl_client *client, struct wl_resource *resource, int32_t x, int32_t y)
 set surface position offset More...
 

Field Documentation

◆ destroy

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

destroy the xdg_positioner object

Notify the compositor that the xdg_positioner will no longer be used.

◆ set_size

void(* zxdg_positioner_v6_interface::set_size) (struct wl_client *client, struct wl_resource *resource, int32_t width, int32_t height)

set the size of the to-be positioned rectangle

Set the size of the surface that is to be positioned with the positioner object. The size is in surface-local coordinates and corresponds to the window geometry. See xdg_surface.set_window_geometry.

If a zero or negative size is set the invalid_input error is raised.

Parameters
widthwidth of positioned rectangle
heightheight of positioned rectangle

◆ set_anchor_rect

void(* zxdg_positioner_v6_interface::set_anchor_rect) (struct wl_client *client, struct wl_resource *resource, int32_t x, int32_t y, int32_t width, int32_t height)

set the anchor rectangle within the parent surface

Specify the anchor rectangle within the parent surface that the child surface will be placed relative to. The rectangle is relative to the window geometry as defined by xdg_surface.set_window_geometry of the parent surface. The rectangle must be at least 1x1 large.

When the xdg_positioner object is used to position a child surface, the anchor rectangle may not extend outside the window geometry of the positioned child's parent surface.

If a zero or negative size is set the invalid_input error is raised.

Parameters
xx position of anchor rectangle
yy position of anchor rectangle
widthwidth of anchor rectangle
heightheight of anchor rectangle

◆ set_anchor

void(* zxdg_positioner_v6_interface::set_anchor) (struct wl_client *client, struct wl_resource *resource, uint32_t anchor)

set anchor rectangle anchor edges

Defines a set of edges for the anchor rectangle. These are used to derive an anchor point that the child surface will be positioned relative to. If two orthogonal edges are specified (e.g. 'top' and 'left'), then the anchor point will be the intersection of the edges (e.g. the top left position of the rectangle); otherwise, the derived anchor point will be centered on the specified edge, or in the center of the anchor rectangle if no edge is specified.

If two parallel anchor edges are specified (e.g. 'left' and 'right'), the invalid_input error is raised.

Parameters
anchorbit mask of anchor edges

◆ set_gravity

void(* zxdg_positioner_v6_interface::set_gravity) (struct wl_client *client, struct wl_resource *resource, uint32_t gravity)

set child surface gravity

Defines in what direction a surface should be positioned, relative to the anchor point of the parent surface. If two orthogonal gravities are specified (e.g. 'bottom' and 'right'), then the child surface will be placed in the specified direction; otherwise, the child surface will be centered over the anchor point on any axis that had no gravity specified.

If two parallel gravities are specified (e.g. 'left' and 'right'), the invalid_input error is raised.

Parameters
gravitybit mask of gravity directions

◆ set_constraint_adjustment

void(* zxdg_positioner_v6_interface::set_constraint_adjustment) (struct wl_client *client, struct wl_resource *resource, uint32_t constraint_adjustment)

set the adjustment to be done when constrained

Specify how the window should be positioned if the originally intended position caused the surface to be constrained, meaning at least partially outside positioning boundaries set by the compositor. The adjustment is set by constructing a bitmask describing the adjustment to be made when the surface is constrained on that axis.

If no bit for one axis is set, the compositor will assume that the child surface should not change its position on that axis when constrained.

If more than one bit for one axis is set, the order of how adjustments are applied is specified in the corresponding adjustment descriptions.

The default adjustment is none.

Parameters
constraint_adjustmentbit mask of constraint adjustments

◆ set_offset

void(* zxdg_positioner_v6_interface::set_offset) (struct wl_client *client, struct wl_resource *resource, int32_t x, int32_t y)

set surface position offset

Specify the surface position offset relative to the position of the anchor on the anchor rectangle and the anchor on the surface. For example if the anchor of the anchor rectangle is at (x, y), the surface has the gravity bottom|right, and the offset is (ox, oy), the calculated surface position will be (x + ox, y

  • oy). The offset position of the surface is the one used for constraint testing. See set_constraint_adjustment.

An example use case is placing a popup menu on top of a user interface element, while aligning the user interface element of the parent surface with some user interface element placed somewhere in the popup surface.

Parameters
xsurface position x offset
ysurface position y offset