.TH "wayland::server::zwp_pointer_gesture_hold_v1_t" 3 "Wed May 3 2023" "Version 1.0.0" "Wayland++" \" -*- nroff -*- .ad l .nh .SH NAME wayland::server::zwp_pointer_gesture_hold_v1_t \- a hold gesture object .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits wayland::server::resource_t\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "std::function< void()> & \fBon_destroy\fP ()" .br .RI "destroy the hold gesture object " .ti -1c .RI "void \fBbegin\fP (uint32_t serial, uint32_t time, \fBsurface_t\fP const &surface, uint32_t fingers, bool post=true)" .br .RI "multi-finger hold begin " .ti -1c .RI "bool \fBcan_begin\fP () const" .br .RI "Check whether the \fBbegin\fP function is available with the currently bound version of the protocol\&. " .ti -1c .RI "void \fBend\fP (uint32_t serial, uint32_t time, int32_t cancelled, bool post=true)" .br .RI "multi-finger hold end " .ti -1c .RI "bool \fBcan_end\fP () const" .br .RI "Check whether the \fBend\fP function is available with the currently bound version of the protocol\&. " .ti -1c .RI "bool \fBproxy_has_object\fP () const" .br .RI "Check whether this wrapper actually wraps an object\&. " .ti -1c .RI "void \fBpost_no_memory\fP () const" .br .ti -1c .RI "uint32_t \fBget_id\fP () const" .br .ti -1c .RI "client_t \fBget_client\fP () const" .br .ti -1c .RI "unsigned int \fBget_version\fP () const" .br .ti -1c .RI "std::string \fBget_class\fP ()" .br .in -1c .SS "Static Public Attributes" .in +1c .ti -1c .RI "static constexpr std::uint32_t \fBbegin_since_version\fP = 3" .br .RI "Minimum protocol version required for the \fBbegin\fP function\&. " .ti -1c .RI "static constexpr std::uint32_t \fBend_since_version\fP = 3" .br .RI "Minimum protocol version required for the \fBend\fP function\&. " .in -1c .SH "Detailed Description" .PP a hold gesture object A hold gesture object notifies 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\&. .PP In particular, this gesture may be used to cancel kinetic scrolling\&. .PP 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, how compositors prevent these situations is implementation-dependent\&. .PP 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\&. .PP Definition at line \fB3432\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SH "Member Function Documentation" .PP .SS "void zwp_pointer_gesture_hold_v1_t::begin (uint32_t serial, uint32_t time, \fBsurface_t\fP const & surface, uint32_t fingers, bool post = \fCtrue\fP)" .PP multi-finger hold begin .PP \fBParameters\fP .RS 4 \fIserial\fP .br \fItime\fP timestamp with millisecond granularity .br \fIsurface\fP .br \fIfingers\fP number of fingers .RE .PP This event is sent when a hold gesture is detected on the device\&. .PP Definition at line \fB5727\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "bool zwp_pointer_gesture_hold_v1_t::can_begin () const" .PP Check whether the \fBbegin\fP function is available with the currently bound version of the protocol\&. .PP Definition at line \fB5732\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "bool zwp_pointer_gesture_hold_v1_t::can_end () const" .PP Check whether the \fBend\fP function is available with the currently bound version of the protocol\&. .PP Definition at line \fB5742\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_pointer_gesture_hold_v1_t::end (uint32_t serial, uint32_t time, int32_t cancelled, bool post = \fCtrue\fP)" .PP multi-finger hold end .PP \fBParameters\fP .RS 4 \fIserial\fP .br \fItime\fP timestamp with millisecond granularity .br \fIcancelled\fP 1 if the gesture was cancelled, 0 otherwise .RE .PP 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\&. .PP 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\&. .PP Definition at line \fB5737\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "std::string wayland::server::resource_t::get_class ()\fC [inherited]\fP" Retrieve the interface name (class) of a resource object\&. .PP \fBReturns\fP .RS 4 Interface name of the resource object\&. .RE .PP .SS "client_t wayland::server::resource_t::get_client () const\fC [inherited]\fP" Get the associated client .PP \fBReturns\fP .RS 4 the client that owns the resource\&. .RE .PP .SS "uint32_t wayland::server::resource_t::get_id () const\fC [inherited]\fP" Get the internal ID of the resource .PP \fBReturns\fP .RS 4 the internal ID of the resource .RE .PP .SS "unsigned int wayland::server::resource_t::get_version () const\fC [inherited]\fP" Get interface version .PP \fBReturns\fP .RS 4 Interface version this resource has been constructed with\&. .RE .PP .SS "std::function< void()> & zwp_pointer_gesture_hold_v1_t::on_destroy ()" .PP destroy the hold gesture object .PP Definition at line \fB5721\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void wayland::server::resource_t::post_no_memory () const\fC [inherited]\fP" Post 'not enough memory' error to the client .PP If the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance\&. .SS "bool wayland::server::resource_t::proxy_has_object () const\fC [inherited]\fP" .PP Check whether this wrapper actually wraps an object\&. .PP \fBReturns\fP .RS 4 true if there is an underlying object, false if this wrapper is empty .RE .PP .SH "Member Data Documentation" .PP .SS "constexpr std::uint32_t wayland::server::zwp_pointer_gesture_hold_v1_t::begin_since_version = 3\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBbegin\fP function\&. .PP Definition at line \fB3476\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::server::zwp_pointer_gesture_hold_v1_t::end_since_version = 3\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBend\fP function\&. .PP Definition at line \fB3503\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Wayland++ from the source code\&.