wayland::xdg_activation_v1_t(3) Wayland++ wayland::xdg_activation_v1_t(3)

wayland::xdg_activation_v1_t - interface for activating surfaces

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

Inherits wayland::proxy_t.


enum class wrapper_type { standard, display, foreign, proxy_wrapper }


xdg_activation_token_v1_t get_activation_token ()
requests a token void activate (std::string const &token, surface_t const &surface)
notify new interaction being available uint32_t get_id () const
Get the id of a proxy object. std::string get_class () const
Get the interface name (class) of a proxy object. uint32_t get_version () const
Get the protocol object version of a proxy object. wrapper_type get_wrapper_type () const
Get the type of a proxy object. void set_queue (event_queue_t queue)
Assign a proxy to an event queue. wl_proxy * c_ptr () const
Get a pointer to the underlying C struct. bool proxy_has_object () const
Check whether this wrapper actually wraps an object. operator bool () const
Check whether this wrapper actually wraps an object. bool operator== (const proxy_t &right) const
Check whether two wrappers refer to the same object. bool operator!= (const proxy_t &right) const
Check whether two wrappers refer to different objects. void proxy_release ()
Release the wrapped object (if any), making this an empty wrapper.


static constexpr std::uint32_t get_activation_token_since_version = 1
Minimum protocol version required for the get_activation_token function. static constexpr std::uint32_t activate_since_version = 1
Minimum protocol version required for the activate function.

interface for activating surfaces

A global interface used for informing the compositor about applications being activated or started, or for applications to request to be activated.

Definition at line 6670 of file wayland-client-protocol-unstable.hpp.

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

Enumerator

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.
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.
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.
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 116 of file wayland-client.hpp.

notify new interaction being available

Parameters

token the activation token of the initiating client
surface the wl_surface to activate

Requests surface activation. It's up to the compositor to display this information as desired, for example by placing the surface above the rest.

The compositor may know who requested this by checking the activation token and might decide not to follow through with the activation if it's considered unwanted.

Compositors can ignore unknown presentation tokens when an invalid token is passed.

Definition at line 8678 of file wayland-client-protocol-unstable.cpp.

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

xdg_activation_token_v1_t xdg_activation_v1_t::get_activation_token ()

requests a token Creates an xdg_activation_token_v1 object that will provide the initiating client with a unique token for this activation. This token should be offered to the clients to be activated.

Definition at line 8671 of file wayland-client-protocol-unstable.cpp.

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

Returns

The interface name of the object associated with the proxy

Get the id of a proxy object.

Returns

The id the object associated with the proxy

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

wrapper_type wayland::proxy_t::get_wrapper_type () const [inline], [inherited]

Get the type of a proxy object.

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

Check whether this wrapper actually wraps an object.

Returns

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

Check whether two wrappers refer to different objects.

Check whether two wrappers refer to the same object.

Check whether this wrapper actually wraps an object.

Returns

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

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.

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.

See also: display_t::dispatch_queue().

Examples
proxy_wrapper.cpp.

Minimum protocol version required for the activate function.

Definition at line 6725 of file wayland-client-protocol-unstable.hpp.

Minimum protocol version required for the get_activation_token function.

Definition at line 6703 of file wayland-client-protocol-unstable.hpp.

Generated automatically by Doxygen for Wayland++ from the source code.

Mon Apr 22 2024 09:52:15 Version 1.0.0