wayland_zwp_pointer_gesture_swipe_v1_t - Man Page

a swipe gesture object

Synopsis

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

Inherits wayland::proxy_t.

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
std::function< void(uint32_t, double, double)> & on_update ()
multi-finger swipe motion
std::function< void(uint32_t, uint32_t, int32_t)> & on_end ()
multi-finger swipe end
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.

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

enum wayland::proxy_t::wrapper_type [strong], [inherited]

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

Member Function Documentation

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

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

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.

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

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

Get the type of a proxy object.

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

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.

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.

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.

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

bool wayland::proxy_t::operator!= (const proxy_t & right) const [inherited]

Check whether two wrappers refer to different objects.

bool wayland::proxy_t::operator== (const proxy_t & right) const [inherited]

Check whether two wrappers refer to the same 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

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.

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.

See also: display_t::dispatch_queue().

Examples proxy_wrapper.cpp.

Author

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

Info

Wed Aug 5 2020 Version 0.2.8 Wayland++