interface for importing surfaces More...
#include <wayland-client-protocol-unstable.hpp>
Public Types | |
| enum | wrapper_type { wrapper_type::standard, wrapper_type::display, wrapper_type::foreign, wrapper_type::proxy_wrapper } |
Public Member Functions | |
| zxdg_imported_v2_t | import_toplevel (std::string handle) |
| import a toplevel surface 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 | import_toplevel_since_version = 1 |
| Minimum protocol version required for the import_toplevel function. More... | |
Detailed Description
interface for importing surfaces
A global interface used for importing surfaces exported by xdg_exporter. With this interface, a client can create a reference to a surface of another client.
Definition at line 6690 of file wayland-client-protocol-unstable.hpp.
Member Enumeration Documentation
◆ 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()
|
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()
|
inherited |
Get the interface name (class) of a proxy object.
- Returns
- The interface name of the object associated with the proxy
◆ get_id()
|
inherited |
◆ get_version()
|
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()
|
inlineinherited |
Get the type of a proxy object.
Definition at line 288 of file wayland-client.hpp.
◆ import_toplevel()
| zxdg_imported_v2_t zxdg_importer_v2_t::import_toplevel | ( | std::string | handle | ) |
import a toplevel surface
- Returns
- the new xdg_imported object
- Parameters
-
handle the exported surface handle
The import_toplevel request imports a surface from any client given a handle retrieved by exporting said surface using xdg_exporter.export_toplevel. When called, a new xdg_imported object will be created. This new object represents the imported surface, and the importing client can manipulate its relationship using it. See xdg_imported for details.
Definition at line 8546 of file wayland-client-protocol-unstable.cpp.
◆ operator bool()
|
inherited |
Check whether this wrapper actually wraps an object.
- Returns
- true if there is an underlying object, false if this wrapper is empty
◆ operator!=()
|
inherited |
Check whether two wrappers refer to different objects.
◆ operator==()
|
inherited |
Check whether two wrappers refer to the same object.
◆ proxy_has_object()
|
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()
|
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()
|
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.
See also: display_t::dispatch_queue().
- Examples
- proxy_wrapper.cpp.
Member Data Documentation
◆ import_toplevel_since_version
|
staticconstexpr |
Minimum protocol version required for the import_toplevel function.
Definition at line 6727 of file wayland-client-protocol-unstable.hpp.
The documentation for this class was generated from the following files:
