wayland::zwp_p...ture_hold_v1_t(3)

💖 NAME 💖

wayland::zwp_p...ture_hold_v1_t — a hold gesture object. This is the Wayland++ manual page wayland::zwp_p...ture_hold_v1_t(3), bestie. 🫶

✨ SYNOPSIS ✨

okay so here's the include:

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

Inherits wayland::proxy_t.

🎀 Public Types 🎀

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

🌸 Public Member Functions 🌸

• std::function< void(uint32_t, uint32_t, surface_t, uint32_t)> & on_begin () — multi-finger hold begin
• std::function< void(uint32_t, uint32_t, int32_t)> & on_end () — multi-finger hold 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 🦋

Okay so a hold gesture object is the little notifier that tells a client about a single- or multi-finger hold gesture detected on an indirect input device such as a touchpad. The gesture is usually initiated by one or more fingers being held down without significant movement. The precise conditions of when such a gesture is detected are implementation-dependent — like, nobody's promising exact thresholds here. 🙈

In particular, this gesture may be used to cancel kinetic scrolling. Iconic.

A hold gesture consists of two stages: begin and end. Unlike pinch and swipe, there is no update stage. There cannot be multiple simultaneous hold, pinch or swipe gestures on a same pointer/seat, and 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. That part is important, bestie. 🚨

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

🧚 Member Enumeration Documentation 🧚

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

This enum is all about the 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 117 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 of the object associated with the proxy.

🌟 uint32_t wayland::proxy_t::get_version () const [inherited] 🌟

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

🌟 std::function< void(uint32_t, uint32_t, surface_t, uint32_t)> & zwp_pointer_gesture_hold_v1_t::on_begin () 🌟

multi-finger hold begin

Parameters

• serial
• time — timestamp with millisecond granularity
• surface
• fingers — number of fingers

This event is sent when a hold gesture is detected on the device.

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

🌟 std::function< void(uint32_t, uint32_t, int32_t)> & zwp_pointer_gesture_hold_v1_t::on_end () 🌟

multi-finger hold end

Parameters

• serial
• time — timestamp with millisecond granularity
• cancelled — 1 if the gesture was cancelled, 0 otherwise

This event is sent when a hold gesture ceases to be valid. This may happen when the holding fingers are lifted or the gesture is cancelled, for example if the fingers move past an implementation-defined threshold, the finger count changes or the hold gesture changes into a different type of gesture.

When a gesture is cancelled, the client may need to undo state changes caused by this gesture. What causes a gesture to be cancelled is implementation-dependent.

Definition at line 6261 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.

💌 okay that's the whole page, bestie. This gem is from Wayland++, version 1.0.1, dated Fri Mar 27 2026; the footer also shows 1wayland::zwp_p...ture_hold_v1_t(3). Periodt. 💅