cursor_shape_v1 Module
**********************


WpCursorShapeDeviceV1
=====================

class pywayland.protocol.cursor_shape_v1.WpCursorShapeDeviceV1

   Cursor shape for a device

   This interface allows clients to set the cursor shape.

   destroy() -> 'None'

      -[ Request -- opcode 0 (attached to "Resource" instance) ]-

      Destroy the cursor shape device

      Destroy the cursor shape device.

      The device cursor shape remains unchanged.

   set_shape(serial: 'int', shape: 'int') -> 'None'

      -[ Request -- opcode 1 (attached to "Resource" instance) ]-

      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 "WlPointer.set_cursor()" and
      "ZwpTabletToolV2.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 "WlPointer.enter()"
      or "ZwpTabletToolV2.proximity_in()" serial number sent to the
      client. Otherwise the request will be ignored.

      Parameters:
         * **serial** (*ArgumentType.Uint*) -- serial number of the
           enter event

         * **shape** (*ArgumentType.Uint*)


WpCursorShapeManagerV1
======================

class pywayland.protocol.cursor_shape_v1.WpCursorShapeManagerV1

   Cursor shape manager

   This global offers an alternative, optional way to set cursor
   images. This new way uses enumerated cursors instead of a
   "WlSurface" like "WlPointer.set_cursor()" does.

   Warning! The protocol described in this file is currently in the
   testing phase. Backward compatible changes may be added together
   with the corresponding interface version bump. Backward
   incompatible changes can only be done by creating a new major
   version of the extension.

   destroy() -> 'None'

      -[ Request -- opcode 0 (attached to "Resource" instance) ]-

      Destroy the manager

      Destroy the cursor shape manager.

   get_pointer(pointer: 'WlPointerProxy') -> 'WpCursorShapeDeviceV1Proxy'

      -[ Request -- opcode 1 (attached to "Resource" instance) ]-

      Manage the cursor shape of a pointer device

      Obtain a "WpCursorShapeDeviceV1" for a "WlPointer" object.

      When the pointer capability is removed from the "WlSeat", the
      "WpCursorShapeDeviceV1" object becomes inert.

      Parameters:
         **pointer** ("WlPointer")

      Returns:
         "WpCursorShapeDeviceV1"

   get_tablet_tool_v2(tablet_tool: 'ZwpTabletToolV2Proxy') -> 'WpCursorShapeDeviceV1Proxy'

      -[ Request -- opcode 2 (attached to "Resource" instance) ]-

      Manage the cursor shape of a tablet tool device

      Obtain a "WpCursorShapeDeviceV1" for a "ZwpTabletToolV2" object.

      When the "ZwpTabletToolV2" is removed, the
      "WpCursorShapeDeviceV1" object becomes inert.

      Parameters:
         **tablet_tool** ("ZwpTabletToolV2")

      Returns:
         "WpCursorShapeDeviceV1"
