a swipe gesture object 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 | |
| std::function< void(uint32_t, uint32_t, surface_t, uint32_t)> & | on_begin () |
| multi-finger swipe begin More... | |
| std::function< void(uint32_t, double, double)> & | on_update () |
| multi-finger swipe motion More... | |
| std::function< void(uint32_t, uint32_t, int32_t)> & | on_end () |
| multi-finger swipe end 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... | |
Detailed Description
a swipe gesture object
A swipe gesture object notifies a client about a multi-finger swipe gesture detected on an indirect input device such as a touchpad. The gesture is usually initiated by multiple fingers moving in the same direction but once initiated the direction may change. The precise conditions of when such a gesture is detected are implementation-dependent.
A gesture consists of three stages: begin, update (optional) and end. There cannot be multiple simultaneous pinch or swipe gestures on a same pointer/seat, how compositors prevent these situations is implementation-dependent.
A gesture may be cancelled by the compositor or the hardware. Clients should not consider performing permanent or irreversible actions until the end of a gesture has been received.
Definition at line 2584 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.
◆ on_begin()
| std::function< void(uint32_t, uint32_t, surface_t, uint32_t)> & zwp_pointer_gesture_swipe_v1_t::on_begin | ( | ) |
multi-finger swipe begin
- Parameters
-
serial time timestamp with millisecond granularity surface fingers number of fingers
This event is sent when a multi-finger swipe gesture is detected on the device.
Definition at line 5616 of file wayland-client-protocol-unstable.cpp.
◆ on_end()
| std::function< void(uint32_t, uint32_t, int32_t)> & zwp_pointer_gesture_swipe_v1_t::on_end | ( | ) |
multi-finger swipe end
- Parameters
-
serial time timestamp with millisecond granularity cancelled 1 if the gesture was cancelled, 0 otherwise
This event is sent when a multi-finger swipe gesture ceases to be valid. This may happen when one or more fingers are lifted or the gesture is cancelled.
When a gesture is cancelled, the client should undo state changes caused by this gesture. What causes a gesture to be cancelled is implementation-dependent.
Definition at line 5626 of file wayland-client-protocol-unstable.cpp.
◆ on_update()
| std::function< void(uint32_t, double, double)> & zwp_pointer_gesture_swipe_v1_t::on_update | ( | ) |
multi-finger swipe motion
- Parameters
-
time timestamp with millisecond granularity dx delta x coordinate in surface coordinate space dy delta y coordinate in surface coordinate space
This event is sent when a multi-finger swipe gesture changes the position of the logical center.
The dx and dy coordinates are relative coordinates of the logical center of the gesture compared to the previous event.
Definition at line 5621 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.
The documentation for this class was generated from the following files:
