create desktop-style surfaces More...

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

Inheritance diagram for wayland::xdg_wm_base_t:

Collaboration diagram for wayland::xdg_wm_base_t:

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

Public Member Functions
xdg_positioner_t	create_positioner ()
	create a positioner object More...

xdg_surface_t	get_xdg_surface (surface_t surface)
	create a shell surface from a surface More...

void	pong (uint32_t serial)
	respond to a ping event More...

std::function< void(uint32_t)> &	on_ping ()
	check if the client is alive 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	create_positioner_since_version = 1
	Minimum protocol version required for the create_positioner function. More...

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

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

Detailed Description

create desktop-style surfaces

The xdg_wm_base interface is exposed as a global object enabling clients to turn their wl_surfaces into windows in a desktop environment. It defines the basic functionality needed for clients and the compositor to create windows that can be dragged, resized, maximized, etc, as well as creating transient windows such as popup menus.

Examples: egl.cpp, and shm.cpp.

Definition at line 564 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

◆ 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

◆ create_positioner()

xdg_positioner_t xdg_wm_base_t::create_positioner ( )

create a positioner object

Create a positioner object. A positioner object is used to position surfaces relative to some parent surface. See the interface description and xdg_surface.get_popup for details.

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

◆ 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_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.

◆ get_xdg_surface()

xdg_surface_t xdg_wm_base_t::get_xdg_surface ( surface_t surface )

create a shell surface from a surface

Parameters

surface

This creates an xdg_surface for the given surface. While xdg_surface itself is not a role, the corresponding surface may only be assigned a role extending xdg_surface, such as xdg_toplevel or xdg_popup.

This creates an xdg_surface for the given surface. An xdg_surface is used as basis to define a role to a given surface, such as xdg_toplevel or xdg_popup. It also manages functionality shared between xdg_surface based surface roles.

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

Examples: egl.cpp, and shm.cpp.

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

◆ on_ping()

std::function< void(uint32_t)> & xdg_wm_base_t::on_ping ( )

check if the client is alive

Parameters

serial pass this to the pong request

The ping event asks the client if it's still alive. Pass the serial specified in the event back to the compositor by sending a "pong" request back with the specified serial. See xdg_wm_base.pong.

Compositors can use this to determine if the client is still alive. It's unspecified what will happen if the client doesn't respond to the ping request, or in what timeframe. Clients should try to respond in a reasonable amount of time.

A compositor is free to ping in any way it wants, but a client must always respond to any xdg_wm_base object it created.

Examples: egl.cpp, and shm.cpp.

Definition at line 973 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.

◆ pong()

void xdg_wm_base_t::pong ( uint32_t serial )

respond to a ping event

Parameters

serial serial of the ping event

A client must respond to a ping event with a pong request or the client may be deemed unresponsive. See xdg_wm_base.ping.

Examples: egl.cpp, and shm.cpp.

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

◆ 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.

Member Data Documentation

◆ create_positioner_since_version

constexpr std::uint32_t wayland::xdg_wm_base_t::create_positioner_since_version = 1

staticconstexpr

Minimum protocol version required for the create_positioner function.

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

◆ get_xdg_surface_since_version

constexpr std::uint32_t wayland::xdg_wm_base_t::get_xdg_surface_since_version = 1

staticconstexpr

Minimum protocol version required for the get_xdg_surface function.

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

◆ pong_since_version

constexpr std::uint32_t wayland::xdg_wm_base_t::pong_since_version = 1

staticconstexpr

Minimum protocol version required for the pong function.

Definition at line 633 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

◆ c_ptr()

◆ create_positioner()

◆ get_class()

◆ get_id()

◆ get_version()

◆ get_wrapper_type()

◆ get_xdg_surface()

◆ on_ping()

◆ operator bool()

◆ operator!=()

◆ operator==()

◆ pong()

◆ proxy_has_object()

◆ proxy_release()

◆ set_queue()

Member Data Documentation

◆ create_positioner_since_version

◆ get_xdg_surface_since_version

◆ pong_since_version