desktop user interface surface base interface More...

#include <wayland-client-protocol-extra.hpp>

Inheritance diagram for wayland::xdg_surface_t:

Collaboration diagram for wayland::xdg_surface_t:

Public Types
enum	wrapper_type { wrapper_type::standard, wrapper_type::display, wrapper_type::foreign, wrapper_type::proxy_wrapper }

Public Member Functions
xdg_toplevel_t	get_toplevel ()
	assign the xdg_toplevel surface role More...

xdg_popup_t	get_popup (xdg_surface_t parent, xdg_positioner_t positioner)
	assign the xdg_popup surface role More...

void	set_window_geometry (int32_t x, int32_t y, int32_t width, int32_t height)
	set the new window geometry More...

void	ack_configure (uint32_t serial)
	ack a configure event More...

std::function< void(uint32_t)> &	on_configure ()
	suggest a surface change More...

uint32_t	get_id () const
	Get the id of a proxy object. More...

std::string	get_class () const
	Get the interface name (class) of a proxy object. More...

uint32_t	get_version () const
	Get the protocol object version of a proxy object. More...

wrapper_type	get_wrapper_type () const
	Get the type of a proxy object. More...

void	set_queue (event_queue_t queue)
	Assign a proxy to an event queue. More...

wl_proxy *	c_ptr () const
	Get a pointer to the underlying C struct. More...

bool	proxy_has_object () const
	Check whether this wrapper actually wraps an object. More...

	operator bool () const
	Check whether this wrapper actually wraps an object. More...

bool	operator== (const proxy_t &right) const
	Check whether two wrappers refer to the same object. More...

bool	operator!= (const proxy_t &right) const
	Check whether two wrappers refer to different objects. More...

void	proxy_release ()
	Release the wrapped object (if any), making this an empty wrapper. More...

Static Public Attributes
static constexpr std::uint32_t	get_toplevel_since_version = 1
	Minimum protocol version required for the get_toplevel function. More...

static constexpr std::uint32_t	get_popup_since_version = 1
	Minimum protocol version required for the get_popup function. More...

static constexpr std::uint32_t	set_window_geometry_since_version = 1
	Minimum protocol version required for the set_window_geometry function. More...

static constexpr std::uint32_t	ack_configure_since_version = 1
	Minimum protocol version required for the ack_configure function. More...

Detailed Description

desktop user interface surface base interface

An interface that may be implemented by a wl_surface, for implementations that provide a desktop-style user interface.

It provides a base set of functionality required to construct user interface elements requiring management by the compositor, such as toplevel windows, menus, etc. The types of functionality are split into xdg_surface roles.

Creating an xdg_surface does not set the role for a wl_surface. In order to map an xdg_surface, the client must create a role-specific object using, e.g., get_toplevel, get_popup. The wl_surface for any given xdg_surface can have at most one role, and may not be assigned any role not based on xdg_surface.

A role must be assigned before any other requests are made to the xdg_surface object.

The client must call wl_surface.commit on the corresponding wl_surface for the xdg_surface state to take effect.

Creating an xdg_surface from a wl_surface which has a buffer attached or committed is a client error, and any attempts by a client to attach or manipulate a buffer prior to the first xdg_surface.configure call must also be treated as errors.

Mapping an xdg_surface-based role surface is defined as making it possible for the surface to be shown by the compositor. Note that a mapped surface is not guaranteed to be visible once it is mapped.

For an xdg_surface to be mapped by the compositor, the following conditions must be met: (1) the client has assigned an xdg_surface-based role to the surface (2) the client has set and committed the xdg_surface state and the role-dependent state to the surface (3) the client has committed a buffer to the surface

A newly-unmapped surface is considered to have met condition (1) out of the 3 required conditions for mapping a surface if its role surface has not been destroyed.

Examples: egl.cpp, and shm.cpp.

Definition at line 959 of file wayland-client-protocol-extra.hpp.

Member Enumeration Documentation

◆ wrapper_type

enum wayland::proxy_t::wrapper_type

stronginherited

Underlying wl_proxy type and properties of a proxy_t that affect construction, destruction, and event handling

Enumerator
standard	C pointer is a standard type compatible with wl_proxy*. Events are dispatched and it is destructed when the proxy_t is destructed. User data is set.
display	C pointer is a wl_display*. No events are dispatched, wl_display_disconnect is called when the proxy_t is destructed. User data is set.
foreign	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 proxy_t is destructed, user data is not touched. Consequently, there is no reference counting for the proxy_t. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl_proxy.
proxy_wrapper	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 proxy_t is destroyed. Reference counting is active. A reference to the proxy_t creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed.

Definition at line 105 of file wayland-client.hpp.

Member Function Documentation

◆ ack_configure()

void xdg_surface_t::ack_configure ( uint32_t serial )

ack a configure event

Parameters

serial the serial from the configure event

When a configure event is received, if a client commits the surface in response to the configure event, then the client must make an ack_configure request sometime before the commit request, passing along the serial of the configure event.

For instance, for toplevel surfaces the compositor might use this information to move a surface to the top left only when the client has drawn itself for the maximized or fullscreen state.

If the client receives multiple configure events before it can respond to one, it only has to ack the last configure event.

A client is not required to commit immediately after sending an ack_configure request - it may even ack_configure several times before its next surface commit.

A client may send multiple ack_configure requests before committing, but only the last request sent before a commit indicates which configure event the client really is responding to.

Examples: egl.cpp, and shm.cpp.

Definition at line 1156 of file wayland-client-protocol-extra.cpp.

◆ c_ptr()

wl_proxy* wayland::proxy_t::c_ptr ( ) const

inherited

Get a pointer to the underlying C struct.

Returns: The underlying wl_proxy wrapped by this proxy_t if it exists, otherwise an exception is thrown

◆ get_class()

std::string wayland::proxy_t::get_class ( ) const

inherited

Get the interface name (class) of a proxy object.

Returns: The interface name of the object associated with the proxy

◆ get_id()

uint32_t wayland::proxy_t::get_id ( ) const

inherited

Get the id of a proxy object.

Returns: The id the object associated with the proxy

Examples: dump.cpp.

◆ get_popup()

xdg_popup_t xdg_surface_t::get_popup	(	xdg_surface_t	parent,
		xdg_positioner_t	positioner
	)

assign the xdg_popup surface role

Parameters

parent
positioner

This creates an xdg_popup object for the given xdg_surface and gives the associated wl_surface the xdg_popup role.

If null is passed as a parent, a parent surface must be specified using some other protocol, before committing the initial state.

See the documentation of xdg_popup for more details about what an xdg_popup is and how it is used.

Definition at line 1145 of file wayland-client-protocol-extra.cpp.

◆ get_toplevel()

xdg_toplevel_t xdg_surface_t::get_toplevel ( )

assign the xdg_toplevel surface role

This creates an xdg_toplevel object for the given xdg_surface and gives the associated wl_surface the xdg_toplevel role.

See the documentation of xdg_toplevel for more details about what an xdg_toplevel is and how it is used.

Examples: egl.cpp, and shm.cpp.

Definition at line 1139 of file wayland-client-protocol-extra.cpp.

◆ get_version()

uint32_t wayland::proxy_t::get_version ( ) const

inherited

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.

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.

display_t will always return version 0.

Returns: The protocol object version of the proxy or 0

◆ get_wrapper_type()

wrapper_type wayland::proxy_t::get_wrapper_type ( ) const

inlineinherited

Get the type of a proxy object.

Definition at line 288 of file wayland-client.hpp.

◆ on_configure()

std::function< void(uint32_t)> & xdg_surface_t::on_configure ( )

suggest a surface change

Parameters

serial serial of the configure event

The configure event marks the end of a configure sequence. A configure sequence is a set of one or more events configuring the state of the xdg_surface, including the final xdg_surface.configure event.

Where applicable, xdg_surface surface roles will during a configure sequence extend this event as a latched state sent as events before the xdg_surface.configure event. Such events should be considered to make up a set of atomically applied configuration states, where the xdg_surface.configure commits the accumulated state.

Clients should arrange their surface for the new states, and then send an ack_configure request with the serial sent in this configure event at some point before committing the new surface.

If the client receives multiple configure events before it can respond to one, it is free to discard all but the last event it received.

Examples: egl.cpp, and shm.cpp.

Definition at line 1161 of file wayland-client-protocol-extra.cpp.

◆ operator bool()

wayland::proxy_t::operator bool ( ) const

inherited

Check whether this wrapper actually wraps an object.

Returns: true if there is an underlying object, false if this wrapper is empty

◆ operator!=()

bool wayland::proxy_t::operator!= ( const proxy_t & right ) const

inherited

Check whether two wrappers refer to different objects.

◆ operator==()

bool wayland::proxy_t::operator== ( const proxy_t & right ) const

inherited

Check whether two wrappers refer to the same object.

◆ proxy_has_object()

bool wayland::proxy_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

◆ proxy_release()

void wayland::proxy_t::proxy_release ( )

inherited

Release the wrapped object (if any), making this an empty wrapper.

Note that display_t instances cannot be released this way. Attempts to do so are ignored.

Examples: foreign_display.cpp.

◆ set_queue()

void wayland::proxy_t::set_queue ( event_queue_t queue )

inherited

Assign a proxy to an event queue.

Parameters

queue The event queue that will handle this proxy

Assign proxy to event queue. Events coming from proxy will be queued in queue instead of the display's main queue.

◆ set_window_geometry()

void xdg_surface_t::set_window_geometry	(	int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height
	)

set the new window geometry

Parameters

x
y
width
height

The window geometry of a surface is its "visible bounds" from the user's perspective. Client-side decorations often have invisible portions like drop-shadows which should be ignored for the purposes of aligning, placing and constraining windows.

The window geometry is double buffered, and will be applied at the time wl_surface.commit of the corresponding wl_surface is called.

When maintaining a position, the compositor should treat the (x, y) coordinate of the window geometry as the top left corner of the window. A client changing the (x, y) window geometry coordinate should in general not alter the position of the window.

Once the window geometry of the surface is set, it is not possible to unset it, and it will remain the same until set_window_geometry is called again, even if a new subsurface or buffer is attached.

If never set, the value is the full bounds of the surface, including any subsurfaces. This updates dynamically on every commit. This unset is meant for extremely simple clients.

The arguments are given in the surface-local coordinate space of the wl_surface associated with this xdg_surface.

The width and height must be greater than zero. Setting an invalid size will raise an error. When applied, the effective window geometry will be the set window geometry clamped to the bounding rectangle of the combined geometry of the surface of the xdg_surface and the associated subsurfaces.

Definition at line 1151 of file wayland-client-protocol-extra.cpp.

Member Data Documentation

◆ ack_configure_since_version

constexpr std::uint32_t wayland::xdg_surface_t::ack_configure_since_version = 1

staticconstexpr

Minimum protocol version required for the ack_configure function.

Definition at line 1088 of file wayland-client-protocol-extra.hpp.

◆ get_popup_since_version

constexpr std::uint32_t wayland::xdg_surface_t::get_popup_since_version = 1

staticconstexpr

Minimum protocol version required for the get_popup function.

Definition at line 1015 of file wayland-client-protocol-extra.hpp.

◆ get_toplevel_since_version

constexpr std::uint32_t wayland::xdg_surface_t::get_toplevel_since_version = 1

staticconstexpr

Minimum protocol version required for the get_toplevel function.

Definition at line 995 of file wayland-client-protocol-extra.hpp.

◆ set_window_geometry_since_version

constexpr std::uint32_t wayland::xdg_surface_t::set_window_geometry_since_version = 1

staticconstexpr

Minimum protocol version required for the set_window_geometry function.

Definition at line 1058 of file wayland-client-protocol-extra.hpp.

The documentation for this class was generated from the following files:

build/wayland-client-protocol-extra.hpp
build/wayland-client-protocol-extra.cpp

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ wrapper_type

Member Function Documentation

◆ ack_configure()

◆ c_ptr()

◆ get_class()

◆ get_id()

◆ get_popup()

◆ get_toplevel()

◆ get_version()

◆ get_wrapper_type()

◆ on_configure()

◆ operator bool()

◆ operator!=()

◆ operator==()

◆ proxy_has_object()

◆ proxy_release()

◆ set_queue()

◆ set_window_geometry()

Member Data Documentation

◆ ack_configure_since_version

◆ get_popup_since_version

◆ get_toplevel_since_version

◆ set_window_geometry_since_version