Struct wayland_protocols::wp::cursor_shape::v1::client::wp_cursor_shape_device_v1::WpCursorShapeDeviceV1

pub struct WpCursorShapeDeviceV1 { /* private fields */ }

cursor shape for a device

This interface advertises the list of supported cursor shapes for a device, and allows clients to set the cursor shape.

This interface has no events.

Implementations

impl WpCursorShapeDeviceV1

pub fn destroy(&self)

destroy the cursor shape device

Destroy the cursor shape device.

The device cursor shape remains unchanged.

pub fn set_shape(&self, serial: u32, shape: Shape)

set device cursor to the shape

Sets the device cursor to the specified shape. The compositor will change the cursor image based on the specified shape.

The cursor actually changes only if the input device focus is one of the requesting client’s surfaces. If any, the previous cursor image (surface or shape) is replaced.

The “shape” argument must be a valid enum entry, otherwise the invalid_shape protocol error is raised.

This is similar to the wl_pointer.set_cursor and zwp_tablet_tool_v2.set_cursor requests, but this request accepts a shape instead of contents in the form of a surface. Clients can mix set_cursor and set_shape requests.

The serial parameter must match the latest wl_pointer.enter or zwp_tablet_tool_v2.proximity_in serial number sent to the client. Otherwise the request will be ignored.

Trait Implementations

impl Borrow<ObjectId> for WpCursorShapeDeviceV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpCursorShapeDeviceV1

fn clone(&self) -> WpCursorShapeDeviceV1

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WpCursorShapeDeviceV1

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for WpCursorShapeDeviceV1

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<WpCursorShapeDeviceV1>> for WpCursorShapeDeviceV1

fn eq(&self, other: &Weak<WpCursorShapeDeviceV1>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for WpCursorShapeDeviceV1

fn eq(&self, other: &WpCursorShapeDeviceV1) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Proxy for WpCursorShapeDeviceV1

type Request<'request> = Request<'request>

The request enum for this interface

type Event = Event

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U: Send + Sync + 'static>(&self) -> Option<&U>

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData> ) -> Result<I, InvalidId>

Send a request for this object that creates another object.

fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> Self

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd> ) -> Result<(Self, Self::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: Self::Request<'a> ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for WpCursorShapeDeviceV1