plucky (3) wayland_server_zxdg_positioner_v6_t.3.gz
NAME
wayland::server::zxdg_positioner_v6_t - child surface positioner
SYNOPSIS
#include <wayland-server-protocol-unstable.hpp>
Inherits wayland::server::resource_t.
Public Member Functions
std::function< void()> & on_destroy ()
destroy the xdg_positioner object
std::function< void(int32_t, int32_t)> & on_set_size ()
set the size of the to-be positioned rectangle
std::function< void(int32_t, int32_t, int32_t, int32_t)> & on_set_anchor_rect ()
set the anchor rectangle within the parent surface
std::function< void(zxdg_positioner_v6_anchor)> & on_set_anchor ()
set anchor rectangle anchor edges
std::function< void(zxdg_positioner_v6_gravity)> & on_set_gravity ()
set child surface gravity
std::function< void(zxdg_positioner_v6_constraint_adjustment)> & on_set_constraint_adjustment ()
set the adjustment to be done when constrained
std::function< void(int32_t, int32_t)> & on_set_offset ()
set surface position offset
void post_invalid_input (std::string const &msg)
Post error: invalid input provided.
bool proxy_has_object () const
Check whether this wrapper actually wraps an object.
void post_no_memory () const
uint32_t get_id () const
client_t get_client () const
unsigned int get_version () const
std::string get_class ()
Detailed Description
child surface positioner
The xdg_positioner provides a collection of rules for the placement of a child surface relative to a
parent surface. Rules can be defined to ensure the child surface remains within the visible area's
borders, and to specify how the child surface changes its position, such as sliding along an axis, or
flipping around a rectangle. These positioner-created rules are constrained by the requirement that a
child surface must intersect with or be at least partially adjacent to its parent surface.
See the various requests for details about possible rules.
At the time of the request, the compositor makes a copy of the rules specified by the xdg_positioner.
Thus, after the request is complete the xdg_positioner object can be destroyed or reused; further changes
to the object will have no effect on previous usages.
For an xdg_positioner object to be considered complete, it must have a non-zero size set by set_size, and
a non-zero anchor rectangle set by set_anchor_rect. Passing an incomplete xdg_positioner object when
positioning a surface raises an error.
Definition at line 8928 of file wayland-server-protocol-unstable.hpp.
Member Function Documentation
std::string wayland::server::resource_t::get_class () [inherited]
Retrieve the interface name (class) of a resource object.
Returns
Interface name of the resource object.
client_t wayland::server::resource_t::get_client () const [inherited]
Get the associated client
Returns
the client that owns the resource.
uint32_t wayland::server::resource_t::get_id () const [inherited]
Get the internal ID of the resource
Returns
the internal ID of the resource
unsigned int wayland::server::resource_t::get_version () const [inherited]
Get interface version
Returns
Interface version this resource has been constructed with.
std::function< void()> & zxdg_positioner_v6_t::on_destroy ()
destroy the xdg_positioner object Notify the compositor that the xdg_positioner will no longer be used.
Definition at line 8285 of file wayland-server-protocol-unstable.cpp.
std::function< void(zxdg_positioner_v6_anchor)> & zxdg_positioner_v6_t::on_set_anchor ()
set anchor rectangle anchor edges
Parameters
anchor bit mask of 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.
Definition at line 8303 of file wayland-server-protocol-unstable.cpp.
std::function< void(int32_t, int32_t, int32_t, int32_t)> & zxdg_positioner_v6_t::on_set_anchor_rect ()
set the anchor rectangle within the parent surface
Parameters
x x position of anchor rectangle
y y position of anchor rectangle
width width of anchor rectangle
height height of anchor rectangle
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.
Definition at line 8297 of file wayland-server-protocol-unstable.cpp.
std::function< void(zxdg_positioner_v6_constraint_adjustment)> &
zxdg_positioner_v6_t::on_set_constraint_adjustment ()
set the adjustment to be done when constrained
Parameters
constraint_adjustment bit mask of constraint adjustments
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.
Definition at line 8315 of file wayland-server-protocol-unstable.cpp.
std::function< void(zxdg_positioner_v6_gravity)> & zxdg_positioner_v6_t::on_set_gravity ()
set child surface gravity
Parameters
gravity bit mask of gravity directions
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.
Definition at line 8309 of file wayland-server-protocol-unstable.cpp.
std::function< void(int32_t, int32_t)> & zxdg_positioner_v6_t::on_set_offset ()
set surface position offset
Parameters
x surface position x offset
y surface position y 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.
Definition at line 8321 of file wayland-server-protocol-unstable.cpp.
std::function< void(int32_t, int32_t)> & zxdg_positioner_v6_t::on_set_size ()
set the size of the to-be positioned rectangle
Parameters
width width of positioned rectangle
height height of 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.
Definition at line 8291 of file wayland-server-protocol-unstable.cpp.
void zxdg_positioner_v6_t::post_invalid_input (std::string const & msg)
Post error: invalid input provided.
Definition at line 8327 of file wayland-server-protocol-unstable.cpp.
void wayland::server::resource_t::post_no_memory () const [inherited]
Post 'not enough memory' error to the client
If the compositor has not enough memory to fulfill a certail request of the client, this function can be
called to notify the client of this circumstance.
bool wayland::server::resource_t::proxy_has_object () const [inherited]
Check whether this wrapper actually wraps an object.
Returns
true if there is an underlying object, false if this wrapper is empty
Author
Generated automatically by Doxygen for Wayland++ from the source code.