--- name: "wayland_server_zwp_tablet_pad_strip_v2_t" section: "3" platform: "linux" package: "waylandpp-dev" version: "1.0.0-6+b2" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/wayland_server_zwp_tablet_pad_strip_v2_t" --- # wayland\_server\_zwp\_tablet\_pad\_strip\_v2\_t(3) pad strip ## NAME wayland::server::zwp\_tablet\_pad\_strip\_v2\_t - pad strip ## SYNOPSIS `#include ` Inherits wayland::server::resource\_t. ### Public Member Functions std::function\< void(std::string, uint32\_t)\> & **on\_set\_feedback** ()\ set compositor feedback std::function\< void()\> & **on\_destroy** ()\ destroy the strip object void **source** (zwp\_tablet\_pad\_strip\_v2\_source const &source, bool post=true)\ strip event source void **position** (uint32\_t position, bool post=true)\ position changed void **stop** (bool post=true)\ interaction stopped void **frame** (uint32\_t time, bool post=true)\ end of a strip event sequence bool **proxy\_has\_object** () const\ Check whether this wrapper actually wraps an object. void **post\_no\_memory** () const\ uint32\_t **get\_id** () const\ client\_t **get\_client** () const\ unsigned int **get\_version** () const\ std::string **get\_class** ()\ ### Static Public Attributes static constexpr std::uint32\_t **source\_since\_version** = 1\ Minimum protocol version required for the **source** function. static constexpr std::uint32\_t **position\_since\_version** = 1\ Minimum protocol version required for the **position** function. static constexpr std::uint32\_t **stop\_since\_version** = 1\ Minimum protocol version required for the **stop** function. static constexpr std::uint32\_t **frame\_since\_version** = 1\ Minimum protocol version required for the **frame** function. ## Detailed Description pad strip A linear interaction area, such as the strips found in Wacom Cintiq models. Events on a strip are logically grouped by the wl\_tablet\_pad\_strip.frame event. Definition at line **5804** of file **wayland-server-protocol-unstable.hpp**. ## Member Function Documentation ### void zwp\_tablet\_pad\_strip\_v2\_t::frame (uint32\_t time, bool post = `true`) end of a strip event sequence **Parameters** *time* timestamp with millisecond granularity Indicates the end of a set of events that represent one logical hardware strip event. A client is expected to accumulate the data in all events within the frame before proceeding. All wp\_tablet\_pad\_strip events before a wp\_tablet\_pad\_strip.frame event belong logically together. For example, on termination of a finger interaction on a strip the compositor will send a wp\_tablet\_pad\_strip.source event, a wp\_tablet\_pad\_strip.stop event and a wp\_tablet\_pad\_strip.frame event. A wp\_tablet\_pad\_strip.frame event is sent for every logical event group, even if the group only contains a single wp\_tablet\_pad\_strip event. Specifically, a client may get a sequence: position, frame, position, frame, etc. Definition at line **6793** of file **wayland-server-protocol-unstable.cpp**. ### std::string wayland::server::resource\_t::get\_class ()` [inherited]` Retrieve the interface name (class) of a resource object. **Returns** Interface name of the resource object. ### client\_t wayland::server::resource\_t::get\_client () const` [inherited]` Get the associated client **Returns** the client that owns the resource. ### uint32\_t wayland::server::resource\_t::get\_id () const` [inherited]` Get the internal ID of the resource **Returns** the internal ID of the resource ### unsigned int wayland::server::resource\_t::get\_version () const` [inherited]` Get interface version **Returns** Interface version this resource has been constructed with. ### std::function\< void()\> & zwp\_tablet\_pad\_strip\_v2\_t::on\_destroy () destroy the strip object This destroys the client's resource for this strip object. Definition at line **6772** of file **wayland-server-protocol-unstable.cpp**. ### std::function\< void(std::string, uint32\_t)\> & zwp\_tablet\_pad\_strip\_v2\_t::on\_set\_feedback () set compositor feedback **Parameters** *description* strip description \ *serial* serial of the mode switch event Requests the compositor to use the provided feedback string associated with this strip. This request should be issued immediately after a wp\_tablet\_pad\_group.mode\_switch event from the corresponding group is received, or whenever the strip is mapped to a different action. See wp\_tablet\_pad\_group.mode\_switch for more details. Clients are encouraged to provide context-aware descriptions for the actions associated with the strip, and compositors may use this information to offer visual feedback about the button layout (eg. on-screen displays). The provided string 'description' is a UTF-8 encoded string to be associated with this ring, and is considered user-visible; general internationalization rules apply. The serial argument will be that of the last wp\_tablet\_pad\_group.mode\_switch event received for the group of this strip. Requests providing other serials than the most recent one will be ignored. Definition at line **6766** of file **wayland-server-protocol-unstable.cpp**. ### void zwp\_tablet\_pad\_strip\_v2\_t::position (uint32\_t position, bool post = `true`) position changed **Parameters** *position* the current position Sent whenever the position on a strip changes. The position is normalized to a range of \[0, 65535\], the 0-value represents the top-most and/or left-most position of the strip in the pad's current rotation. Definition at line **6783** of file **wayland-server-protocol-unstable.cpp**. ### void wayland::server::resource\_t::post\_no\_memory () const` [inherited]` Post 'not enough memory' error to the client 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. ### bool wayland::server::resource\_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 zwp\_tablet\_pad\_strip\_v2\_t::source (zwp\_tablet\_pad\_strip\_v2\_source const & source, bool post = `true`) strip event source **Parameters** *source* the event source Source information for strip events. This event does not occur on its own. It is sent before a wp\_tablet\_pad\_strip.frame event and carries the source information for all events within that frame. The source specifies how this event was generated. If the source is wp\_tablet\_pad\_strip.source.finger, a wp\_tablet\_pad\_strip.stop event will be sent when the user lifts their finger off the device. This event is optional. If the source is unknown for an interaction, no event is sent. Definition at line **6778** of file **wayland-server-protocol-unstable.cpp**. ### void zwp\_tablet\_pad\_strip\_v2\_t::stop (bool post = `true`) interaction stopped Stop notification for strip events. For some wp\_tablet\_pad\_strip.source types, a wp\_tablet\_pad\_strip.stop event is sent to notify a client that the interaction with the strip has terminated. This enables the client to implement kinetic scrolling. See the wp\_tablet\_pad\_strip.source documentation for information on when this event may be generated. Any wp\_tablet\_pad\_strip.position events with the same source after this event should be considered as the start of a new interaction. Definition at line **6788** of file **wayland-server-protocol-unstable.cpp**. ## Member Data Documentation ### constexpr std::uint32\_t wayland::server::zwp\_tablet\_pad\_strip\_v2\_t::frame\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **frame** function. Definition at line **5947** of file **wayland-server-protocol-unstable.hpp**. ### constexpr std::uint32\_t wayland::server::zwp\_tablet\_pad\_strip\_v2\_t::position\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **position** function. Definition at line **5902** of file **wayland-server-protocol-unstable.hpp**. ### constexpr std::uint32\_t wayland::server::zwp\_tablet\_pad\_strip\_v2\_t::source\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **source** function. Definition at line **5886** of file **wayland-server-protocol-unstable.hpp**. ### constexpr std::uint32\_t wayland::server::zwp\_tablet\_pad\_strip\_v2\_t::stop\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **stop** function. Definition at line **5922** of file **wayland-server-protocol-unstable.hpp**. ## Author Generated automatically by Doxygen for Wayland++ from the source code.