.TH "wayland::xdg_positioner_t" 3 "Wed May 3 2023" "Version 1.0.0" "Wayland++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
wayland::xdg_positioner_t \- child surface positioner  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <wayland\-client\-protocol\-extra\&.hpp>\fP
.PP
Inherits \fBwayland::proxy_t\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum class \fBwrapper_type\fP { \fBstandard\fP, \fBdisplay\fP, \fBforeign\fP, \fBproxy_wrapper\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "void \fBset_size\fP (int32_t width, int32_t height)"
.br
.RI "set the size of the to-be positioned rectangle "
.ti -1c
.RI "void \fBset_anchor_rect\fP (int32_t x, int32_t y, int32_t width, int32_t height)"
.br
.RI "set the anchor rectangle within the parent surface "
.ti -1c
.RI "void \fBset_anchor\fP (xdg_positioner_anchor const &anchor)"
.br
.RI "set anchor rectangle anchor "
.ti -1c
.RI "void \fBset_gravity\fP (xdg_positioner_gravity const &gravity)"
.br
.RI "set child surface gravity "
.ti -1c
.RI "void \fBset_constraint_adjustment\fP (\fBxdg_positioner_constraint_adjustment\fP const &constraint_adjustment)"
.br
.RI "set the adjustment to be done when constrained "
.ti -1c
.RI "void \fBset_offset\fP (int32_t x, int32_t y)"
.br
.RI "set surface position offset "
.ti -1c
.RI "void \fBset_reactive\fP ()"
.br
.RI "continuously reconstrain the surface "
.ti -1c
.RI "bool \fBcan_set_reactive\fP () const"
.br
.RI "Check whether the \fBset_reactive\fP function is available with the currently bound version of the protocol\&. "
.ti -1c
.RI "void \fBset_parent_size\fP (int32_t parent_width, int32_t parent_height)"
.br
.ti -1c
.RI "bool \fBcan_set_parent_size\fP () const"
.br
.RI "Check whether the \fBset_parent_size\fP function is available with the currently bound version of the protocol\&. "
.ti -1c
.RI "void \fBset_parent_configure\fP (uint32_t serial)"
.br
.RI "set parent configure this is a response to "
.ti -1c
.RI "bool \fBcan_set_parent_configure\fP () const"
.br
.RI "Check whether the \fBset_parent_configure\fP function is available with the currently bound version of the protocol\&. "
.ti -1c
.RI "uint32_t \fBget_id\fP () const"
.br
.RI "Get the id of a proxy object\&. "
.ti -1c
.RI "std::string \fBget_class\fP () const"
.br
.RI "Get the interface name (class) of a proxy object\&. "
.ti -1c
.RI "uint32_t \fBget_version\fP () const"
.br
.RI "Get the protocol object version of a proxy object\&. "
.ti -1c
.RI "\fBwrapper_type\fP \fBget_wrapper_type\fP () const"
.br
.RI "Get the type of a proxy object\&. "
.ti -1c
.RI "void \fBset_queue\fP (\fBevent_queue_t\fP queue)"
.br
.RI "Assign a proxy to an event queue\&. "
.ti -1c
.RI "wl_proxy * \fBc_ptr\fP () const"
.br
.RI "Get a pointer to the underlying C struct\&. "
.ti -1c
.RI "bool \fBproxy_has_object\fP () const"
.br
.RI "Check whether this wrapper actually wraps an object\&. "
.ti -1c
.RI "\fBoperator bool\fP () const"
.br
.RI "Check whether this wrapper actually wraps an object\&. "
.ti -1c
.RI "bool \fBoperator==\fP (const \fBproxy_t\fP &right) const"
.br
.RI "Check whether two wrappers refer to the same object\&. "
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBproxy_t\fP &right) const"
.br
.RI "Check whether two wrappers refer to different objects\&. "
.ti -1c
.RI "void \fBproxy_release\fP ()"
.br
.RI "Release the wrapped object (if any), making this an empty wrapper\&. "
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static constexpr std::uint32_t \fBset_size_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBset_size\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBset_anchor_rect_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBset_anchor_rect\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBset_anchor_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBset_anchor\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBset_gravity_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBset_gravity\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBset_constraint_adjustment_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBset_constraint_adjustment\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBset_offset_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBset_offset\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBset_reactive_since_version\fP = 3"
.br
.RI "Minimum protocol version required for the \fBset_reactive\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBset_parent_size_since_version\fP = 3"
.br
.RI "Minimum protocol version required for the \fBset_parent_size\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBset_parent_configure_since_version\fP = 3"
.br
.RI "Minimum protocol version required for the \fBset_parent_configure\fP function\&. "
.in -1c
.SH "Detailed Description"
.PP 
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\&.
.PP
See the various requests for details about possible rules\&.
.PP
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\&.
.PP
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\&. 
.PP
Definition at line \fB669\fP of file \fBwayland\-client\-protocol\-extra\&.hpp\fP\&.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum class \fBwayland::proxy_t::wrapper_type\fP\fC [strong]\fP, \fC [inherited]\fP"
Underlying wl_proxy type and properties of a \fBproxy_t\fP that affect construction, destruction, and event handling 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIstandard \fP\fP
C pointer is a standard type compatible with wl_proxy*\&. Events are dispatched and it is destructed when the \fBproxy_t\fP is destructed\&. User data is set\&. 
.TP
\fB\fIdisplay \fP\fP
C pointer is a wl_display*\&. No events are dispatched, wl_display_disconnect is called when the \fBproxy_t\fP is destructed\&. User data is set\&. 
.TP
\fB\fIforeign \fP\fP
C pointer is a standard type compatible with wl_proxy*, but another library owns it and it should not be touched in a way that could affect the operation of the other library\&. No events are dispatched, wl_proxy_destroy is not called when the \fBproxy_t\fP is destructed, user data is not touched\&. Consequently, there is no reference counting for the \fBproxy_t\fP\&. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl_proxy\&. 
.TP
\fB\fIproxy_wrapper \fP\fP
C pointer is a wl_proxy* that was constructed with wl_proxy_create_wrapper\&. No events are dispatched, wl_proxy_wrapper_destroy is called when the \fBproxy_t\fP is destroyed\&. Reference counting is active\&. A reference to the \fBproxy_t\fP creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed\&. 
.PP
Definition at line \fB115\fP of file \fBwayland\-client\&.hpp\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "wl_proxy * wayland::proxy_t::c_ptr () const\fC [inherited]\fP"

.PP
Get a pointer to the underlying C struct\&. 
.PP
\fBReturns\fP
.RS 4
The underlying wl_proxy wrapped by this \fBproxy_t\fP if it exists, otherwise an exception is thrown 
.RE
.PP

.SS "bool xdg_positioner_t::can_set_parent_configure () const"

.PP
Check whether the \fBset_parent_configure\fP function is available with the currently bound version of the protocol\&. 
.PP
Definition at line \fB1168\fP of file \fBwayland\-client\-protocol\-extra\&.cpp\fP\&.
.SS "bool xdg_positioner_t::can_set_parent_size () const"

.PP
Check whether the \fBset_parent_size\fP function is available with the currently bound version of the protocol\&. 
.PP
Definition at line \fB1157\fP of file \fBwayland\-client\-protocol\-extra\&.cpp\fP\&.
.SS "bool xdg_positioner_t::can_set_reactive () const"

.PP
Check whether the \fBset_reactive\fP function is available with the currently bound version of the protocol\&. 
.PP
Definition at line \fB1146\fP of file \fBwayland\-client\-protocol\-extra\&.cpp\fP\&.
.SS "std::string wayland::proxy_t::get_class () const\fC [inherited]\fP"

.PP
Get the interface name (class) of a proxy object\&. 
.PP
\fBReturns\fP
.RS 4
The interface name of the object associated with the proxy 
.RE
.PP

.SS "uint32_t wayland::proxy_t::get_id () const\fC [inherited]\fP"

.PP
Get the id of a proxy object\&. 
.PP
\fBReturns\fP
.RS 4
The id the object associated with the proxy 
.RE
.PP

.SS "uint32_t wayland::proxy_t::get_version () const\fC [inherited]\fP"

.PP
Get the protocol object version of a proxy object\&. Gets the protocol object version of a proxy object, or 0 if the proxy was created with unversioned API\&.
.PP
A returned value of 0 means that no version information is available, so the caller must make safe assumptions about the object's real version\&.
.PP
\fBdisplay_t\fP will always return version 0\&.
.PP
\fBReturns\fP
.RS 4
The protocol object version of the proxy or 0 
.RE
.PP

.SS "\fBwrapper_type\fP wayland::proxy_t::get_wrapper_type () const\fC [inline]\fP, \fC [inherited]\fP"

.PP
Get the type of a proxy object\&. 
.PP
Definition at line \fB301\fP of file \fBwayland\-client\&.hpp\fP\&.
.SS "wayland::proxy_t::operator bool () const\fC [inherited]\fP"

.PP
Check whether this wrapper actually wraps an object\&. 
.PP
\fBReturns\fP
.RS 4
true if there is an underlying object, false if this wrapper is empty 
.RE
.PP

.SS "bool wayland::proxy_t::operator!= (const \fBproxy_t\fP & right) const\fC [inherited]\fP"

.PP
Check whether two wrappers refer to different objects\&. 
.SS "bool wayland::proxy_t::operator== (const \fBproxy_t\fP & right) const\fC [inherited]\fP"

.PP
Check whether two wrappers refer to the same object\&. 
.SS "bool wayland::proxy_t::proxy_has_object () const\fC [inherited]\fP"

.PP
Check whether this wrapper actually wraps an object\&. 
.PP
\fBReturns\fP
.RS 4
true if there is an underlying object, false if this wrapper is empty 
.RE
.PP

.SS "void wayland::proxy_t::proxy_release ()\fC [inherited]\fP"

.PP
Release the wrapped object (if any), making this an empty wrapper\&. Note that \fBdisplay_t\fP instances cannot be released this way\&. Attempts to do so are ignored\&. 
.PP
\fBExamples\fP
.in +1c
\fBforeign_display\&.cpp\fP\&.
.SS "void xdg_positioner_t::set_anchor (xdg_positioner_anchor const & anchor)"

.PP
set anchor rectangle anchor 
.PP
\fBParameters\fP
.RS 4
\fIanchor\fP anchor
.RE
.PP
Defines the anchor point for the anchor rectangle\&. The specified anchor is used derive an anchor point that the child surface will be positioned relative to\&. If a corner anchor is set (e\&.g\&. 'top_left' or 'bottom_right'), the anchor point will be at the specified corner; 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\&. 
.PP
Definition at line \fB1117\fP of file \fBwayland\-client\-protocol\-extra\&.cpp\fP\&.
.SS "void xdg_positioner_t::set_anchor_rect (int32_t x, int32_t y, int32_t width, int32_t height)"

.PP
set the anchor rectangle within the parent surface 
.PP
\fBParameters\fP
.RS 4
\fIx\fP x position of anchor rectangle 
.br
\fIy\fP y position of anchor rectangle 
.br
\fIwidth\fP width of anchor rectangle 
.br
\fIheight\fP height of anchor rectangle
.RE
.PP
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\&.
.PP
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\&.
.PP
If a negative size is set the invalid_input error is raised\&. 
.PP
Definition at line \fB1111\fP of file \fBwayland\-client\-protocol\-extra\&.cpp\fP\&.
.SS "void xdg_positioner_t::set_constraint_adjustment (\fBxdg_positioner_constraint_adjustment\fP const & constraint_adjustment)"

.PP
set the adjustment to be done when constrained 
.PP
\fBParameters\fP
.RS 4
\fIconstraint_adjustment\fP bit mask of constraint adjustments
.RE
.PP
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\&.
.PP
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\&.
.PP
If more than one bit for one axis is set, the order of how adjustments are applied is specified in the corresponding adjustment descriptions\&.
.PP
The default adjustment is none\&. 
.PP
Definition at line \fB1129\fP of file \fBwayland\-client\-protocol\-extra\&.cpp\fP\&.
.SS "void xdg_positioner_t::set_gravity (xdg_positioner_gravity const & gravity)"

.PP
set child surface gravity 
.PP
\fBParameters\fP
.RS 4
\fIgravity\fP gravity direction
.RE
.PP
Defines in what direction a surface should be positioned, relative to the anchor point of the parent surface\&. If a corner gravity is specified (e\&.g\&. 'bottom_right' or 'top_left'), then the child surface will be placed towards the specified gravity; otherwise, the child surface will be centered over the anchor point on any axis that had no gravity specified\&. 
.PP
Definition at line \fB1123\fP of file \fBwayland\-client\-protocol\-extra\&.cpp\fP\&.
.SS "void xdg_positioner_t::set_offset (int32_t x, int32_t y)"

.PP
set surface position offset 
.PP
\fBParameters\fP
.RS 4
\fIx\fP surface position x offset 
.br
\fIy\fP surface position y offset
.RE
.PP
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\&.
.PP
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\&. 
.PP
Definition at line \fB1135\fP of file \fBwayland\-client\-protocol\-extra\&.cpp\fP\&.
.SS "void xdg_positioner_t::set_parent_configure (uint32_t serial)"

.PP
set parent configure this is a response to 
.PP
\fBParameters\fP
.RS 4
\fIserial\fP serial of parent configure event
.RE
.PP
Set the serial of an xdg_surface\&.configure event this positioner will be used in response to\&. The compositor may use this information together with set_parent_size to determine what future state the popup should be constrained using\&. 
.PP
Definition at line \fB1163\fP of file \fBwayland\-client\-protocol\-extra\&.cpp\fP\&.
.SS "void xdg_positioner_t::set_parent_size (int32_t parent_width, int32_t parent_height)"

.PP
\fBParameters\fP
.RS 4
\fIparent_width\fP future window geometry width of parent 
.br
\fIparent_height\fP future window geometry height of parent
.RE
.PP
Set the parent window geometry the compositor should use when positioning the popup\&. The compositor may use this information to determine the future state the popup should be constrained using\&. If this doesn't match the dimension of the parent the popup is eventually positioned against, the behavior is undefined\&.
.PP
The arguments are given in the surface-local coordinate space\&. 
.PP
Definition at line \fB1152\fP of file \fBwayland\-client\-protocol\-extra\&.cpp\fP\&.
.SS "void wayland::proxy_t::set_queue (\fBevent_queue_t\fP queue)\fC [inherited]\fP"

.PP
Assign a proxy to an event queue\&. 
.PP
\fBParameters\fP
.RS 4
\fIqueue\fP The event queue that will handle this proxy
.RE
.PP
Assign proxy to event queue\&. Events coming from proxy will be queued in queue instead of the display's main queue\&.
.PP
See also: \fBdisplay_t::dispatch_queue()\fP\&. 
.PP
\fBExamples\fP
.in +1c
\fBproxy_wrapper\&.cpp\fP\&.
.SS "void xdg_positioner_t::set_reactive ()"

.PP
continuously reconstrain the surface When set reactive, the surface is reconstrained if the conditions used for constraining changed, e\&.g\&. the parent window moved\&.
.PP
If the conditions changed and the popup was reconstrained, an xdg_popup\&.configure event is sent with updated geometry, followed by an xdg_surface\&.configure event\&. 
.PP
Definition at line \fB1141\fP of file \fBwayland\-client\-protocol\-extra\&.cpp\fP\&.
.SS "void xdg_positioner_t::set_size (int32_t width, int32_t height)"

.PP
set the size of the to-be positioned rectangle 
.PP
\fBParameters\fP
.RS 4
\fIwidth\fP width of positioned rectangle 
.br
\fIheight\fP height of positioned rectangle
.RE
.PP
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\&.
.PP
If a zero or negative size is set the invalid_input error is raised\&. 
.PP
Definition at line \fB1105\fP of file \fBwayland\-client\-protocol\-extra\&.cpp\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "constexpr std::uint32_t wayland::xdg_positioner_t::set_anchor_rect_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_anchor_rect\fP function\&. 
.PP
Definition at line \fB730\fP of file \fBwayland\-client\-protocol\-extra\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::xdg_positioner_t::set_anchor_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_anchor\fP function\&. 
.PP
Definition at line \fB747\fP of file \fBwayland\-client\-protocol\-extra\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::xdg_positioner_t::set_constraint_adjustment_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_constraint_adjustment\fP function\&. 
.PP
Definition at line \fB788\fP of file \fBwayland\-client\-protocol\-extra\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::xdg_positioner_t::set_gravity_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_gravity\fP function\&. 
.PP
Definition at line \fB764\fP of file \fBwayland\-client\-protocol\-extra\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::xdg_positioner_t::set_offset_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_offset\fP function\&. 
.PP
Definition at line \fB811\fP of file \fBwayland\-client\-protocol\-extra\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::xdg_positioner_t::set_parent_configure_since_version = 3\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_parent_configure\fP function\&. 
.PP
Definition at line \fB871\fP of file \fBwayland\-client\-protocol\-extra\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::xdg_positioner_t::set_parent_size_since_version = 3\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_parent_size\fP function\&. 
.PP
Definition at line \fB851\fP of file \fBwayland\-client\-protocol\-extra\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::xdg_positioner_t::set_reactive_since_version = 3\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_reactive\fP function\&. 
.PP
Definition at line \fB827\fP of file \fBwayland\-client\-protocol\-extra\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::xdg_positioner_t::set_size_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_size\fP function\&. 
.PP
Definition at line \fB706\fP of file \fBwayland\-client\-protocol\-extra\&.hpp\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Wayland++ from the source code\&.