Wayland++ 1.0.0
C++ Bindings for Wayland
|
interface for activating surfaces More...
#include <wayland-client-protocol-unstable.hpp>
Public Types | |
enum class | wrapper_type { standard , display , foreign , proxy_wrapper } |
Public Member Functions | |
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 Public Attributes | |
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 6671 of file wayland-client-protocol-unstable.hpp.
|
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 116 of file wayland-client.hpp.
void xdg_activation_v1_t::activate | ( | std::string const & | token, |
surface_t const & | surface | ||
) |
notify new interaction being available
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.
|
inherited |
Get a pointer to the underlying C struct.
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.
|
inherited |
Get the interface name (class) of a proxy object.
|
inherited |
Get the id of a proxy object.
|
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.
|
inlineinherited |
Get the type of a proxy object.
Definition at line 302 of file wayland-client.hpp.
|
inherited |
Check whether this wrapper actually wraps an object.
|
inherited |
Check whether two wrappers refer to different objects.
|
inherited |
Check whether two wrappers refer to the same object.
|
inherited |
Check whether this wrapper actually wraps an object.
|
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.
|
inherited |
Assign a proxy to an event queue.
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().
|
staticconstexpr |
Minimum protocol version required for the activate function.
Definition at line 6726 of file wayland-client-protocol-unstable.hpp.
|
staticconstexpr |
Minimum protocol version required for the get_activation_token function.
Definition at line 6704 of file wayland-client-protocol-unstable.hpp.