Source file tablet_v2_client.ml

(* This file was generated automatically by wayland-scanner-ocaml *)

[@@@ocaml.warning "-27-34"]
open struct
  module Imports = struct
    include Tablet_v2_proto
    include Wayland.Wayland_proto
  end
  
  module Proxy = Wayland.Proxy
  module Msg = Wayland.Msg
  module Fixed = Wayland.Fixed
  module Iface_reg = Wayland.Iface_reg
  module S = Wayland.S
end


(** Controller object for graphic tablet devices.
    
    An object that provides access to the graphics tablets available on this
    system. All tablets are associated with a seat, to get access to the
    actual tablets, use zwp_tablet_manager_v2.get_tablet_seat. *)
module Zwp_tablet_manager_v2 = struct
  type 'v t = ([`Zwp_tablet_manager_v2], 'v, [`Client]) Proxy.t
  
  (** {2 Version 1, 2} *)
  
  (** Release the memory for the tablet manager object.
      
      Destroy the zwp_tablet_manager_v2 object. Objects created from this
      object are unaffected and should be destroyed separately. *)
  let destroy (_t:([< `V1 | `V2] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:1 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg;
    Proxy.shutdown_send _t
  
  (** Get the tablet seat.
      
      Get the zwp_tablet_seat_v2 object for the given seat. This object
      provides access to all graphics tablets in this seat. *)
  let get_tablet_seat (_t:([< `V1 | `V2] as 'v) t) (tablet_seat:([`Zwp_tablet_seat_v2], 'v, [`Client]) #Proxy.Handler.t) ~(seat:([`Wl_seat], _, [`Client]) Proxy.t) =
    let __tablet_seat = Proxy.spawn _t tablet_seat in
    let _msg = Proxy.alloc _t ~op:0 ~ints:2 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Proxy.id __tablet_seat);
    Msg.add_int _msg (Proxy.id seat);
    Proxy.send _t _msg;
    __tablet_seat
  
  (**/**)
  class ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_manager_v2)
    method max_version = 2l
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1 | `V2] as 'v] _handlers_unsafe
    (**/**)
    method min_version = 1l
    method bind_version : [`V1] = `V1
  end
  
  (** Handler for a proxy with version >= 2. *)
  class ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V2] as 'v] _handlers_unsafe
    (**/**)
    method min_version = 2l
    method bind_version : [`V2] = `V2
  end
end

(** Controller object for graphic tablet devices of a seat.
    
    An object that provides access to the graphics tablets available on this
    seat. After binding to this interface, the compositor sends a set of
    zwp_tablet_seat_v2.tablet_added and zwp_tablet_seat_v2.tool_added events. *)
module Zwp_tablet_seat_v2 = struct
  type 'v t = ([`Zwp_tablet_seat_v2], 'v, [`Client]) Proxy.t
  
  (** {2 Version 1, 2} *)
  
  (** Release the memory for the tablet seat object.
      
      Destroy the zwp_tablet_seat_v2 object. Objects created from this
      object are unaffected and should be destroyed separately. *)
  let destroy (_t:([< `V1 | `V2] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:0 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg;
    Proxy.shutdown_send _t
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_seat_v2)
    method max_version = 2l
    
    method private virtual on_tablet_added : [> ] t -> ([`Zwp_tablet_v2], 'v, [`Client]) Proxy.t -> unit
    
    method private virtual on_tool_added : [> ] t -> ([`Zwp_tablet_tool_v2], 'v, [`Client]) Proxy.t -> unit
    
    method private virtual on_pad_added : [> ] t -> ([`Zwp_tablet_pad_v2], 'v, [`Client]) Proxy.t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let id : ([`Zwp_tablet_v2], _, _) Proxy.t =
          Msg.get_int _msg |> Proxy.Handler.accept_new _proxy (module Imports.Zwp_tablet_v2) in
        _self#on_tablet_added _proxy id
      | 1 ->
        let id : ([`Zwp_tablet_tool_v2], _, _) Proxy.t =
          Msg.get_int _msg |> Proxy.Handler.accept_new _proxy (module Imports.Zwp_tablet_tool_v2) in
        _self#on_tool_added _proxy id
      | 2 ->
        let id : ([`Zwp_tablet_pad_v2], _, _) Proxy.t =
          Msg.get_int _msg |> Proxy.Handler.accept_new _proxy (module Imports.Zwp_tablet_pad_v2) in
        _self#on_pad_added _proxy id
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1 | `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_tablet_added : [> `V1 | `V2] t -> ([`Zwp_tablet_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** New device notification.
        
        This event is sent whenever a new tablet becomes available on this
        seat. This event only provides the object id of the tablet, any
        static information about the tablet (device name, vid/pid, etc.) is
        sent through the zwp_tablet_v2 interface. *)
    
    method private virtual on_tool_added : [> `V1 | `V2] t -> ([`Zwp_tablet_tool_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** A new tool has been used with a tablet.
        
        This event is sent whenever a tool that has not previously been used
        with a tablet comes into use. This event only provides the object id
        of the tool; any static information about the tool (capabilities,
        type, etc.) is sent through the zwp_tablet_tool_v2 interface. *)
    
    method private virtual on_pad_added : [> `V1 | `V2] t -> ([`Zwp_tablet_pad_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** New pad notification.
        
        This event is sent whenever a new pad is known to the system. Typically,
        pads are physically attached to tablets and a pad_added event is
        sent immediately after the zwp_tablet_seat_v2.tablet_added.
        However, some standalone pad devices logically attach to tablets at
        runtime, and the client must wait for zwp_tablet_pad_v2.enter to know
        the tablet a pad is attached to.
        
        This event only provides the object id of the pad. All further
        features (buttons, strips, rings) are sent through the zwp_tablet_pad_v2
        interface. *)
    
    method min_version = 1l
  end
  
  (** Handler for a proxy with version >= 2. *)
  class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_tablet_added : [> `V2] t -> ([`Zwp_tablet_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** New device notification.
        
        This event is sent whenever a new tablet becomes available on this
        seat. This event only provides the object id of the tablet, any
        static information about the tablet (device name, vid/pid, etc.) is
        sent through the zwp_tablet_v2 interface. *)
    
    method private virtual on_tool_added : [> `V2] t -> ([`Zwp_tablet_tool_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** A new tool has been used with a tablet.
        
        This event is sent whenever a tool that has not previously been used
        with a tablet comes into use. This event only provides the object id
        of the tool; any static information about the tool (capabilities,
        type, etc.) is sent through the zwp_tablet_tool_v2 interface. *)
    
    method private virtual on_pad_added : [> `V2] t -> ([`Zwp_tablet_pad_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** New pad notification.
        
        This event is sent whenever a new pad is known to the system. Typically,
        pads are physically attached to tablets and a pad_added event is
        sent immediately after the zwp_tablet_seat_v2.tablet_added.
        However, some standalone pad devices logically attach to tablets at
        runtime, and the client must wait for zwp_tablet_pad_v2.enter to know
        the tablet a pad is attached to.
        
        This event only provides the object id of the pad. All further
        features (buttons, strips, rings) are sent through the zwp_tablet_pad_v2
        interface. *)
    
    method min_version = 2l
  end
end

(** A physical tablet tool.
    
    An object that represents a physical tool that has been, or is
    currently in use with a tablet in this seat. Each zwp_tablet_tool_v2
    object stays valid until the client destroys it; the compositor
    reuses the zwp_tablet_tool_v2 object to indicate that the object's
    respective physical tool has come into proximity of a tablet again.
    
    A zwp_tablet_tool_v2 object's relation to a physical tool depends on the
    tablet's ability to report serial numbers. If the tablet supports
    this capability, then the object represents a specific physical tool
    and can be identified even when used on multiple tablets.
    
    A tablet tool has a number of static characteristics, e.g. tool type,
    hardware_serial and capabilities. These capabilities are sent in an
    event sequence after the zwp_tablet_seat_v2.tool_added event before any
    actual events from this tool. This initial event sequence is
    terminated by a zwp_tablet_tool_v2.done event.
    
    Tablet tool events are grouped by zwp_tablet_tool_v2.frame events.
    Any events received before a zwp_tablet_tool_v2.frame event should be
    considered part of the same hardware state change. *)
module Zwp_tablet_tool_v2 = struct
  type 'v t = ([`Zwp_tablet_tool_v2], 'v, [`Client]) Proxy.t
  module Type = Tablet_v2_proto.Zwp_tablet_tool_v2.Type
  
  module Capability = Tablet_v2_proto.Zwp_tablet_tool_v2.Capability
  
  module Button_state = Tablet_v2_proto.Zwp_tablet_tool_v2.Button_state
  
  module Error = Tablet_v2_proto.Zwp_tablet_tool_v2.Error
  
  (** {2 Version 1, 2} *)
  
  (** Destroy the tool object.
      
      This destroys the client's resource for this tool object. *)
  let destroy (_t:([< `V1 | `V2] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:1 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg;
    Proxy.shutdown_send _t
  
  (** Set the tablet tool's surface.
      
      Sets the surface of the cursor used for this tool on the given
      tablet. This request only takes effect if the tool is in proximity
      of one of the requesting client's surfaces or the surface parameter
      is the current pointer surface. If there was a previous surface set
      with this request it is replaced. If surface is NULL, the cursor
      image is hidden.
      
      The parameters hotspot_x and hotspot_y define the position of the
      pointer surface relative to the pointer location. Its top-left corner
      is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the
      coordinates of the pointer location, in surface-local coordinates.
      
      On surface.attach requests to the pointer surface, hotspot_x and
      hotspot_y are decremented by the x and y parameters passed to the
      request. Attach must be confirmed by wl_surface.commit as usual.
      
      The hotspot can also be updated by passing the currently set pointer
      surface to this request with new values for hotspot_x and hotspot_y.
      
      The current and pending input regions of the wl_surface are cleared,
      and wl_surface.set_input_region is ignored until the wl_surface is no
      longer used as the cursor. When the use as a cursor ends, the current
      and pending input regions become undefined, and the wl_surface is
      unmapped.
      
      This request gives the surface the role of a zwp_tablet_tool_v2 cursor. A
      surface may only ever be used as the cursor surface for one
      zwp_tablet_tool_v2. If the surface already has another role or has
      previously been used as cursor surface for a different tool, a
      protocol error is raised. *)
  let set_cursor (_t:([< `V1 | `V2] as 'v) t) ~serial ~(surface:([`Wl_surface], _, [`Client]) Proxy.t option) ~hotspot_x ~hotspot_y =
    let _msg = Proxy.alloc _t ~op:0 ~ints:4 ~strings:[] ~arrays:[] in
    Msg.add_int _msg serial;
    Msg.add_int _msg (Proxy.id_opt surface);
    Msg.add_int _msg hotspot_x;
    Msg.add_int _msg hotspot_y;
    Proxy.send _t _msg
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_tool_v2)
    method max_version = 2l
    
    method private virtual on_type : [> ] t -> tool_type:Imports.Zwp_tablet_tool_v2.Type.t -> unit
    
    method private virtual on_hardware_serial : [> ] t -> hardware_serial_hi:int32 -> hardware_serial_lo:int32 -> unit
    
    method private virtual on_hardware_id_wacom : [> ] t -> hardware_id_hi:int32 -> hardware_id_lo:int32 -> unit
    
    method private virtual on_capability : [> ] t -> capability:Imports.Zwp_tablet_tool_v2.Capability.t -> unit
    
    method private virtual on_done : [> ] t -> unit
    
    method private virtual on_removed : [> ] t -> unit
    
    method private virtual on_proximity_in : [> ] t -> serial:int32 ->
                                             tablet:([`Zwp_tablet_v2], [> Imports.Zwp_tablet_v2.versions], [`Client]) Proxy.t ->
                                             surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Client]) Proxy.t ->
                                             unit
    
    method private virtual on_proximity_out : [> ] t -> unit
    
    method private virtual on_down : [> ] t -> serial:int32 -> unit
    
    method private virtual on_up : [> ] t -> unit
    
    method private virtual on_motion : [> ] t -> x:Fixed.t -> y:Fixed.t -> unit
    
    method private virtual on_pressure : [> ] t -> pressure:int32 -> unit
    
    method private virtual on_distance : [> ] t -> distance:int32 -> unit
    
    method private virtual on_tilt : [> ] t -> tilt_x:Fixed.t -> tilt_y:Fixed.t -> unit
    
    method private virtual on_rotation : [> ] t -> degrees:Fixed.t -> unit
    
    method private virtual on_slider : [> ] t -> position:int32 -> unit
    
    method private virtual on_wheel : [> ] t -> degrees:Fixed.t -> clicks:int32 -> unit
    
    method private virtual on_button : [> ] t -> serial:int32 -> button:int32 ->
                                       state:Imports.Zwp_tablet_tool_v2.Button_state.t -> unit
    
    method private virtual on_frame : [> ] t -> time:int32 -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let tool_type = Msg.get_int _msg |> Imports.Zwp_tablet_tool_v2.Type.of_int32 in
        _self#on_type _proxy ~tool_type
      | 1 ->
        let hardware_serial_hi = Msg.get_int _msg in
        let hardware_serial_lo = Msg.get_int _msg in
        _self#on_hardware_serial _proxy ~hardware_serial_hi ~hardware_serial_lo
      | 2 ->
        let hardware_id_hi = Msg.get_int _msg in
        let hardware_id_lo = Msg.get_int _msg in
        _self#on_hardware_id_wacom _proxy ~hardware_id_hi ~hardware_id_lo
      | 3 ->
        let capability = Msg.get_int _msg |> Imports.Zwp_tablet_tool_v2.Capability.of_int32 in
        _self#on_capability _proxy ~capability
      | 4 ->
        _self#on_done _proxy 
      | 5 ->
        _self#on_removed _proxy 
      | 6 ->
        let serial = Msg.get_int _msg in
        let tablet : ([`Zwp_tablet_v2], _, _) Proxy.t =
          let Proxy.Proxy p = Msg.get_int _msg |> Proxy.lookup_other _proxy in
          match Proxy.ty p with
          | Imports.Zwp_tablet_v2.T -> p
          | _ -> Proxy.wrong_type ~parent:_proxy ~expected:"zwp_tablet_v2" p
          in
        let surface : ([`Wl_surface], _, _) Proxy.t =
          let Proxy.Proxy p = Msg.get_int _msg |> Proxy.lookup_other _proxy in
          match Proxy.ty p with
          | Imports.Wl_surface.T -> p
          | _ -> Proxy.wrong_type ~parent:_proxy ~expected:"wl_surface" p
          in
        _self#on_proximity_in _proxy ~serial ~tablet ~surface
      | 7 ->
        _self#on_proximity_out _proxy 
      | 8 ->
        let serial = Msg.get_int _msg in
        _self#on_down _proxy ~serial
      | 9 ->
        _self#on_up _proxy 
      | 10 ->
        let x = Msg.get_fixed _msg in
        let y = Msg.get_fixed _msg in
        _self#on_motion _proxy ~x ~y
      | 11 ->
        let pressure = Msg.get_int _msg in
        _self#on_pressure _proxy ~pressure
      | 12 ->
        let distance = Msg.get_int _msg in
        _self#on_distance _proxy ~distance
      | 13 ->
        let tilt_x = Msg.get_fixed _msg in
        let tilt_y = Msg.get_fixed _msg in
        _self#on_tilt _proxy ~tilt_x ~tilt_y
      | 14 ->
        let degrees = Msg.get_fixed _msg in
        _self#on_rotation _proxy ~degrees
      | 15 ->
        let position = Msg.get_int _msg in
        _self#on_slider _proxy ~position
      | 16 ->
        let degrees = Msg.get_fixed _msg in
        let clicks = Msg.get_int _msg in
        _self#on_wheel _proxy ~degrees ~clicks
      | 17 ->
        let serial = Msg.get_int _msg in
        let button = Msg.get_int _msg in
        let state = Msg.get_int _msg |> Imports.Zwp_tablet_tool_v2.Button_state.of_int32 in
        _self#on_button _proxy ~serial ~button ~state
      | 18 ->
        let time = Msg.get_int _msg in
        _self#on_frame _proxy ~time
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1 | `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_type : [> `V1 | `V2] t -> tool_type:Imports.Zwp_tablet_tool_v2.Type.t -> unit
    
    (** Tool type.
        
        The tool type is the high-level type of the tool and usually decides
        the interaction expected from this tool.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_tool_v2.done event. *)
    
    method private virtual on_hardware_serial : [> `V1 | `V2] t -> hardware_serial_hi:int32 ->
                                                hardware_serial_lo:int32 -> unit
    
    (** Unique hardware serial number of the tool.
        
        If the physical tool can be identified by a unique 64-bit serial
        number, this event notifies the client of this serial number.
        
        If multiple tablets are available in the same seat and the tool is
        uniquely identifiable by the serial number, that tool may move
        between tablets.
        
        Otherwise, if the tool has no serial number and this event is
        missing, the tool is tied to the tablet it first comes into
        proximity with. Even if the physical tool is used on multiple
        tablets, separate zwp_tablet_tool_v2 objects will be created, one per
        tablet.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_tool_v2.done event. *)
    
    method private virtual on_hardware_id_wacom : [> `V1 | `V2] t -> hardware_id_hi:int32 -> hardware_id_lo:int32 ->
                                                  unit
    
    (** Hardware id notification in Wacom's format.
        
        This event notifies the client of a hardware id available on this tool.
        
        The hardware id is a device-specific 64-bit id that provides extra
        information about the tool in use, beyond the wl_tool.type
        enumeration. The format of the id is specific to tablets made by
        Wacom Inc. For example, the hardware id of a Wacom Grip
        Pen (a stylus) is 0x802.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_tool_v2.done event. *)
    
    method private virtual on_capability : [> `V1 | `V2] t -> capability:Imports.Zwp_tablet_tool_v2.Capability.t ->
                                           unit
    
    (** Tool capability notification.
        
        This event notifies the client of any capabilities of this tool,
        beyond the main set of x/y axes and tip up/down detection.
        
        One event is sent for each extra capability available on this tool.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_tool_v2.done event. *)
    
    method private virtual on_done : [> `V1 | `V2] t -> unit
    
    (** Tool description events sequence complete.
        
        This event signals the end of the initial burst of descriptive
        events. A client may consider the static description of the tool to
        be complete and finalize initialization of the tool. *)
    
    method private virtual on_removed : [> `V1 | `V2] t -> unit
    
    (** Tool removed.
        
        This event is sent when the tool is removed from the system and will
        send no further events. Should the physical tool come back into
        proximity later, a new zwp_tablet_tool_v2 object will be created.
        
        It is compositor-dependent when a tool is removed. A compositor may
        remove a tool on proximity out, tablet removal or any other reason.
        A compositor may also keep a tool alive until shutdown.
        
        If the tool is currently in proximity, a proximity_out event will be
        sent before the removed event. See zwp_tablet_tool_v2.proximity_out for
        the handling of any buttons logically down.
        
        When this event is received, the client must zwp_tablet_tool_v2.destroy
        the object. *)
    
    method private virtual on_proximity_in : [> `V1 | `V2] t -> serial:int32 ->
                                             tablet:([`Zwp_tablet_v2], [> Imports.Zwp_tablet_v2.versions], [`Client]) Proxy.t ->
                                             surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Client]) Proxy.t ->
                                             unit
    
    (** Proximity in event.
        
        Notification that this tool is focused on a certain surface.
        
        This event can be received when the tool has moved from one surface to
        another, or when the tool has come back into proximity above the
        surface.
        
        If any button is logically down when the tool comes into proximity,
        the respective button event is sent after the proximity_in event but
        within the same frame as the proximity_in event. *)
    
    method private virtual on_proximity_out : [> `V1 | `V2] t -> unit
    
    (** Proximity out event.
        
        Notification that this tool has either left proximity, or is no
        longer focused on a certain surface.
        
        When the tablet tool leaves proximity of the tablet, button release
        events are sent for each button that was held down at the time of
        leaving proximity. These events are sent before the proximity_out
        event but within the same zwp_tablet_v2.frame.
        
        If the tool stays within proximity of the tablet, but the focus
        changes from one surface to another, a button release event may not
        be sent until the button is actually released or the tool leaves the
        proximity of the tablet. *)
    
    method private virtual on_down : [> `V1 | `V2] t -> serial:int32 -> unit
    
    (** Tablet tool is making contact.
        
        Sent whenever the tablet tool comes in contact with the surface of the
        tablet.
        
        If the tool is already in contact with the tablet when entering the
        input region, the client owning said region will receive a
        zwp_tablet_v2.proximity_in event, followed by a zwp_tablet_v2.down
        event and a zwp_tablet_v2.frame event.
        
        Note that this event describes logical contact, not physical
        contact. On some devices, a compositor may not consider a tool in
        logical contact until a minimum physical pressure threshold is
        exceeded. *)
    
    method private virtual on_up : [> `V1 | `V2] t -> unit
    
    (** Tablet tool is no longer making contact.
        
        Sent whenever the tablet tool stops making contact with the surface of
        the tablet, or when the tablet tool moves out of the input region
        and the compositor grab (if any) is dismissed.
        
        If the tablet tool moves out of the input region while in contact
        with the surface of the tablet and the compositor does not have an
        ongoing grab on the surface, the client owning said region will
        receive a zwp_tablet_v2.up event, followed by a zwp_tablet_v2.proximity_out
        event and a zwp_tablet_v2.frame event. If the compositor has an ongoing
        grab on this device, this event sequence is sent whenever the grab
        is dismissed in the future.
        
        Note that this event describes logical contact, not physical
        contact. On some devices, a compositor may not consider a tool out
        of logical contact until physical pressure falls below a specific
        threshold. *)
    
    method private virtual on_motion : [> `V1 | `V2] t -> x:Fixed.t -> y:Fixed.t -> unit
    
    (** Motion event.
        
        Sent whenever a tablet tool moves. *)
    
    method private virtual on_pressure : [> `V1 | `V2] t -> pressure:int32 -> unit
    
    (** Pressure change event.
        
        Sent whenever the pressure axis on a tool changes. The value of this
        event is normalized to a value between 0 and 65535.
        
        Note that pressure may be nonzero even when a tool is not in logical
        contact. See the down and up events for more details. *)
    
    method private virtual on_distance : [> `V1 | `V2] t -> distance:int32 -> unit
    
    (** Distance change event.
        
        Sent whenever the distance axis on a tool changes. The value of this
        event is normalized to a value between 0 and 65535.
        
        Note that distance may be nonzero even when a tool is not in logical
        contact. See the down and up events for more details. *)
    
    method private virtual on_tilt : [> `V1 | `V2] t -> tilt_x:Fixed.t -> tilt_y:Fixed.t -> unit
    
    (** Tilt change event.
        
        Sent whenever one or both of the tilt axes on a tool change. Each tilt
        value is in degrees, relative to the z-axis of the tablet.
        The angle is positive when the top of a tool tilts along the
        positive x or y axis. *)
    
    method private virtual on_rotation : [> `V1 | `V2] t -> degrees:Fixed.t -> unit
    
    (** Z-rotation change event.
        
        Sent whenever the z-rotation axis on the tool changes. The
        rotation value is in degrees clockwise from the tool's
        logical neutral position. *)
    
    method private virtual on_slider : [> `V1 | `V2] t -> position:int32 -> unit
    
    (** Slider position change event.
        
        Sent whenever the slider position on the tool changes. The
        value is normalized between -65535 and 65535, with 0 as the logical
        neutral position of the slider.
        
        The slider is available on e.g. the Wacom Airbrush tool. *)
    
    method private virtual on_wheel : [> `V1 | `V2] t -> degrees:Fixed.t -> clicks:int32 -> unit
    
    (** Wheel delta event.
        
        Sent whenever the wheel on the tool emits an event. This event
        contains two values for the same axis change. The degrees value is
        in the same orientation as the wl_pointer.vertical_scroll axis. The
        clicks value is in discrete logical clicks of the mouse wheel. This
        value may be zero if the movement of the wheel was less
        than one logical click.
        
        Clients should choose either value and avoid mixing degrees and
        clicks. The compositor may accumulate values smaller than a logical
        click and emulate click events when a certain threshold is met.
        Thus, zwp_tablet_tool_v2.wheel events with non-zero clicks values may
        have different degrees values. *)
    
    method private virtual on_button : [> `V1 | `V2] t -> serial:int32 -> button:int32 ->
                                       state:Imports.Zwp_tablet_tool_v2.Button_state.t -> unit
    
    (** Button event.
        
        Sent whenever a button on the tool is pressed or released.
        
        If a button is held down when the tool moves in or out of proximity,
        button events are generated by the compositor. See
        zwp_tablet_tool_v2.proximity_in and zwp_tablet_tool_v2.proximity_out for
        details. *)
    
    method private virtual on_frame : [> `V1 | `V2] t -> time:int32 -> unit
    
    (** Frame event.
        
        Marks the end of a series of axis and/or button updates from the
        tablet. The Wayland protocol requires axis updates to be sent
        sequentially, however all events within a frame should be considered
        one hardware event. *)
    
    method min_version = 1l
  end
  
  (** Handler for a proxy with version >= 2. *)
  class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_type : [> `V2] t -> tool_type:Imports.Zwp_tablet_tool_v2.Type.t -> unit
    
    (** Tool type.
        
        The tool type is the high-level type of the tool and usually decides
        the interaction expected from this tool.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_tool_v2.done event. *)
    
    method private virtual on_hardware_serial : [> `V2] t -> hardware_serial_hi:int32 -> hardware_serial_lo:int32 ->
                                                unit
    
    (** Unique hardware serial number of the tool.
        
        If the physical tool can be identified by a unique 64-bit serial
        number, this event notifies the client of this serial number.
        
        If multiple tablets are available in the same seat and the tool is
        uniquely identifiable by the serial number, that tool may move
        between tablets.
        
        Otherwise, if the tool has no serial number and this event is
        missing, the tool is tied to the tablet it first comes into
        proximity with. Even if the physical tool is used on multiple
        tablets, separate zwp_tablet_tool_v2 objects will be created, one per
        tablet.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_tool_v2.done event. *)
    
    method private virtual on_hardware_id_wacom : [> `V2] t -> hardware_id_hi:int32 -> hardware_id_lo:int32 -> unit
    
    (** Hardware id notification in Wacom's format.
        
        This event notifies the client of a hardware id available on this tool.
        
        The hardware id is a device-specific 64-bit id that provides extra
        information about the tool in use, beyond the wl_tool.type
        enumeration. The format of the id is specific to tablets made by
        Wacom Inc. For example, the hardware id of a Wacom Grip
        Pen (a stylus) is 0x802.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_tool_v2.done event. *)
    
    method private virtual on_capability : [> `V2] t -> capability:Imports.Zwp_tablet_tool_v2.Capability.t -> unit
    
    (** Tool capability notification.
        
        This event notifies the client of any capabilities of this tool,
        beyond the main set of x/y axes and tip up/down detection.
        
        One event is sent for each extra capability available on this tool.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_tool_v2.done event. *)
    
    method private virtual on_done : [> `V2] t -> unit
    
    (** Tool description events sequence complete.
        
        This event signals the end of the initial burst of descriptive
        events. A client may consider the static description of the tool to
        be complete and finalize initialization of the tool. *)
    
    method private virtual on_removed : [> `V2] t -> unit
    
    (** Tool removed.
        
        This event is sent when the tool is removed from the system and will
        send no further events. Should the physical tool come back into
        proximity later, a new zwp_tablet_tool_v2 object will be created.
        
        It is compositor-dependent when a tool is removed. A compositor may
        remove a tool on proximity out, tablet removal or any other reason.
        A compositor may also keep a tool alive until shutdown.
        
        If the tool is currently in proximity, a proximity_out event will be
        sent before the removed event. See zwp_tablet_tool_v2.proximity_out for
        the handling of any buttons logically down.
        
        When this event is received, the client must zwp_tablet_tool_v2.destroy
        the object. *)
    
    method private virtual on_proximity_in : [> `V2] t -> serial:int32 ->
                                             tablet:([`Zwp_tablet_v2], [> Imports.Zwp_tablet_v2.versions], [`Client]) Proxy.t ->
                                             surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Client]) Proxy.t ->
                                             unit
    
    (** Proximity in event.
        
        Notification that this tool is focused on a certain surface.
        
        This event can be received when the tool has moved from one surface to
        another, or when the tool has come back into proximity above the
        surface.
        
        If any button is logically down when the tool comes into proximity,
        the respective button event is sent after the proximity_in event but
        within the same frame as the proximity_in event. *)
    
    method private virtual on_proximity_out : [> `V2] t -> unit
    
    (** Proximity out event.
        
        Notification that this tool has either left proximity, or is no
        longer focused on a certain surface.
        
        When the tablet tool leaves proximity of the tablet, button release
        events are sent for each button that was held down at the time of
        leaving proximity. These events are sent before the proximity_out
        event but within the same zwp_tablet_v2.frame.
        
        If the tool stays within proximity of the tablet, but the focus
        changes from one surface to another, a button release event may not
        be sent until the button is actually released or the tool leaves the
        proximity of the tablet. *)
    
    method private virtual on_down : [> `V2] t -> serial:int32 -> unit
    
    (** Tablet tool is making contact.
        
        Sent whenever the tablet tool comes in contact with the surface of the
        tablet.
        
        If the tool is already in contact with the tablet when entering the
        input region, the client owning said region will receive a
        zwp_tablet_v2.proximity_in event, followed by a zwp_tablet_v2.down
        event and a zwp_tablet_v2.frame event.
        
        Note that this event describes logical contact, not physical
        contact. On some devices, a compositor may not consider a tool in
        logical contact until a minimum physical pressure threshold is
        exceeded. *)
    
    method private virtual on_up : [> `V2] t -> unit
    
    (** Tablet tool is no longer making contact.
        
        Sent whenever the tablet tool stops making contact with the surface of
        the tablet, or when the tablet tool moves out of the input region
        and the compositor grab (if any) is dismissed.
        
        If the tablet tool moves out of the input region while in contact
        with the surface of the tablet and the compositor does not have an
        ongoing grab on the surface, the client owning said region will
        receive a zwp_tablet_v2.up event, followed by a zwp_tablet_v2.proximity_out
        event and a zwp_tablet_v2.frame event. If the compositor has an ongoing
        grab on this device, this event sequence is sent whenever the grab
        is dismissed in the future.
        
        Note that this event describes logical contact, not physical
        contact. On some devices, a compositor may not consider a tool out
        of logical contact until physical pressure falls below a specific
        threshold. *)
    
    method private virtual on_motion : [> `V2] t -> x:Fixed.t -> y:Fixed.t -> unit
    
    (** Motion event.
        
        Sent whenever a tablet tool moves. *)
    
    method private virtual on_pressure : [> `V2] t -> pressure:int32 -> unit
    
    (** Pressure change event.
        
        Sent whenever the pressure axis on a tool changes. The value of this
        event is normalized to a value between 0 and 65535.
        
        Note that pressure may be nonzero even when a tool is not in logical
        contact. See the down and up events for more details. *)
    
    method private virtual on_distance : [> `V2] t -> distance:int32 -> unit
    
    (** Distance change event.
        
        Sent whenever the distance axis on a tool changes. The value of this
        event is normalized to a value between 0 and 65535.
        
        Note that distance may be nonzero even when a tool is not in logical
        contact. See the down and up events for more details. *)
    
    method private virtual on_tilt : [> `V2] t -> tilt_x:Fixed.t -> tilt_y:Fixed.t -> unit
    
    (** Tilt change event.
        
        Sent whenever one or both of the tilt axes on a tool change. Each tilt
        value is in degrees, relative to the z-axis of the tablet.
        The angle is positive when the top of a tool tilts along the
        positive x or y axis. *)
    
    method private virtual on_rotation : [> `V2] t -> degrees:Fixed.t -> unit
    
    (** Z-rotation change event.
        
        Sent whenever the z-rotation axis on the tool changes. The
        rotation value is in degrees clockwise from the tool's
        logical neutral position. *)
    
    method private virtual on_slider : [> `V2] t -> position:int32 -> unit
    
    (** Slider position change event.
        
        Sent whenever the slider position on the tool changes. The
        value is normalized between -65535 and 65535, with 0 as the logical
        neutral position of the slider.
        
        The slider is available on e.g. the Wacom Airbrush tool. *)
    
    method private virtual on_wheel : [> `V2] t -> degrees:Fixed.t -> clicks:int32 -> unit
    
    (** Wheel delta event.
        
        Sent whenever the wheel on the tool emits an event. This event
        contains two values for the same axis change. The degrees value is
        in the same orientation as the wl_pointer.vertical_scroll axis. The
        clicks value is in discrete logical clicks of the mouse wheel. This
        value may be zero if the movement of the wheel was less
        than one logical click.
        
        Clients should choose either value and avoid mixing degrees and
        clicks. The compositor may accumulate values smaller than a logical
        click and emulate click events when a certain threshold is met.
        Thus, zwp_tablet_tool_v2.wheel events with non-zero clicks values may
        have different degrees values. *)
    
    method private virtual on_button : [> `V2] t -> serial:int32 -> button:int32 ->
                                       state:Imports.Zwp_tablet_tool_v2.Button_state.t -> unit
    
    (** Button event.
        
        Sent whenever a button on the tool is pressed or released.
        
        If a button is held down when the tool moves in or out of proximity,
        button events are generated by the compositor. See
        zwp_tablet_tool_v2.proximity_in and zwp_tablet_tool_v2.proximity_out for
        details. *)
    
    method private virtual on_frame : [> `V2] t -> time:int32 -> unit
    
    (** Frame event.
        
        Marks the end of a series of axis and/or button updates from the
        tablet. The Wayland protocol requires axis updates to be sent
        sequentially, however all events within a frame should be considered
        one hardware event. *)
    
    method min_version = 2l
  end
end

(** Graphics tablet device.
    
    The zwp_tablet_v2 interface represents one graphics tablet device. The
    tablet interface itself does not generate events; all events are
    generated by zwp_tablet_tool_v2 objects when in proximity above a tablet.
    
    A tablet has a number of static characteristics, e.g. device name and
    pid/vid. These capabilities are sent in an event sequence after the
    zwp_tablet_seat_v2.tablet_added event. This initial event sequence is
    terminated by a zwp_tablet_v2.done event. *)
module Zwp_tablet_v2 = struct
  type 'v t = ([`Zwp_tablet_v2], 'v, [`Client]) Proxy.t
  module Bustype = Tablet_v2_proto.Zwp_tablet_v2.Bustype
  
  (** {2 Version 1} *)
  
  (** Destroy the tablet object.
      
      This destroys the client's resource for this tablet object. *)
  let destroy (_t:([< `V1 | `V2] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:0 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg;
    Proxy.shutdown_send _t
  
  
  (** {2 Version 2} *)
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_v2)
    method max_version = 2l
    
    method private virtual on_name : [> ] t -> name:string -> unit
    
    method private virtual on_id : [> ] t -> vid:int32 -> pid:int32 -> unit
    
    method private virtual on_path : [> ] t -> path:string -> unit
    
    method private virtual on_done : [> ] t -> unit
    
    method private virtual on_removed : [> ] t -> unit
    
    method private virtual on_bustype : [> ] t -> bustype:Imports.Zwp_tablet_v2.Bustype.t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let name = Msg.get_string _msg in
        _self#on_name _proxy ~name
      | 1 ->
        let vid = Msg.get_int _msg in
        let pid = Msg.get_int _msg in
        _self#on_id _proxy ~vid ~pid
      | 2 ->
        let path = Msg.get_string _msg in
        _self#on_path _proxy ~path
      | 3 ->
        _self#on_done _proxy 
      | 4 ->
        _self#on_removed _proxy 
      | 5 ->
        let bustype = Msg.get_int _msg |> Imports.Zwp_tablet_v2.Bustype.of_int32 in
        _self#on_bustype _proxy ~bustype
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1 | `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_name : [> `V1 | `V2] t -> name:string -> unit
    
    (** Tablet device name.
        
        A descriptive name for the tablet device.
        
        If the device has no descriptive name, this event is not sent.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_v2.done event. *)
    
    method private virtual on_id : [> `V1 | `V2] t -> vid:int32 -> pid:int32 -> unit
    
    (** Tablet device vendor/product id.
        
        The vendor and product IDs for the tablet device.
        
        The interpretation of the id depends on the zwp_tablet_v2.bustype.
        Prior to version v2 of this protocol, the id was implied to be a USB
        vendor and product ID. If no zwp_tablet_v2.bustype is sent, the ID
        is to be interpreted as USB vendor and product ID.
        
        If the device has no vendor/product ID, this event is not sent.
        This can happen for virtual devices or non-USB devices, for instance.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_v2.done event. *)
    
    method private virtual on_path : [> `V1 | `V2] t -> path:string -> unit
    
    (** Path to the device.
        
        A system-specific device path that indicates which device is behind
        this zwp_tablet_v2. This information may be used to gather additional
        information about the device, e.g. through libwacom.
        
        A device may have more than one device path. If so, multiple
        zwp_tablet_v2.path events are sent. A device may be emulated and not
        have a device path, and in that case this event will not be sent.
        
        The format of the path is unspecified, it may be a device node, a
        sysfs path, or some other identifier. It is up to the client to
        identify the string provided.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_v2.done event. *)
    
    method private virtual on_done : [> `V1 | `V2] t -> unit
    
    (** Tablet description events sequence complete.
        
        This event is sent immediately to signal the end of the initial
        burst of descriptive events. A client may consider the static
        description of the tablet to be complete and finalize initialization
        of the tablet. *)
    
    method private virtual on_removed : [> `V1 | `V2] t -> unit
    
    (** Tablet removed event.
        
        Sent when the tablet has been removed from the system. When a tablet
        is removed, some tools may be removed.
        
        When this event is received, the client must zwp_tablet_v2.destroy
        the object. *)
    
    method private virtual on_bustype : [> `V2] t -> bustype:Imports.Zwp_tablet_v2.Bustype.t -> unit
    
    (** Tablet device bus type.
        
        The bustype argument is one of the BUS_ defines in the Linux kernel's
        linux/input.h
        
        If the device has no known bustype or the bustype cannot be
        queried, this event is not sent.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_v2.done event. *)
    
    method min_version = 1l
  end
  
  (** Handler for a proxy with version >= 2. *)
  class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_name : [> `V2] t -> name:string -> unit
    
    (** Tablet device name.
        
        A descriptive name for the tablet device.
        
        If the device has no descriptive name, this event is not sent.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_v2.done event. *)
    
    method private virtual on_id : [> `V2] t -> vid:int32 -> pid:int32 -> unit
    
    (** Tablet device vendor/product id.
        
        The vendor and product IDs for the tablet device.
        
        The interpretation of the id depends on the zwp_tablet_v2.bustype.
        Prior to version v2 of this protocol, the id was implied to be a USB
        vendor and product ID. If no zwp_tablet_v2.bustype is sent, the ID
        is to be interpreted as USB vendor and product ID.
        
        If the device has no vendor/product ID, this event is not sent.
        This can happen for virtual devices or non-USB devices, for instance.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_v2.done event. *)
    
    method private virtual on_path : [> `V2] t -> path:string -> unit
    
    (** Path to the device.
        
        A system-specific device path that indicates which device is behind
        this zwp_tablet_v2. This information may be used to gather additional
        information about the device, e.g. through libwacom.
        
        A device may have more than one device path. If so, multiple
        zwp_tablet_v2.path events are sent. A device may be emulated and not
        have a device path, and in that case this event will not be sent.
        
        The format of the path is unspecified, it may be a device node, a
        sysfs path, or some other identifier. It is up to the client to
        identify the string provided.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_v2.done event. *)
    
    method private virtual on_done : [> `V2] t -> unit
    
    (** Tablet description events sequence complete.
        
        This event is sent immediately to signal the end of the initial
        burst of descriptive events. A client may consider the static
        description of the tablet to be complete and finalize initialization
        of the tablet. *)
    
    method private virtual on_removed : [> `V2] t -> unit
    
    (** Tablet removed event.
        
        Sent when the tablet has been removed from the system. When a tablet
        is removed, some tools may be removed.
        
        When this event is received, the client must zwp_tablet_v2.destroy
        the object. *)
    
    method private virtual on_bustype : [> `V2] t -> bustype:Imports.Zwp_tablet_v2.Bustype.t -> unit
    
    (** Tablet device bus type.
        
        The bustype argument is one of the BUS_ defines in the Linux kernel's
        linux/input.h
        
        If the device has no known bustype or the bustype cannot be
        queried, this event is not sent.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_v2.done event. *)
    
    method min_version = 2l
  end
end

(** Pad ring.
    
    A circular interaction area, such as the touch ring on the Wacom Intuos
    Pro series tablets.
    
    Events on a ring are logically grouped by the zwp_tablet_pad_ring_v2.frame
    event. *)
module Zwp_tablet_pad_ring_v2 = struct
  type 'v t = ([`Zwp_tablet_pad_ring_v2], 'v, [`Client]) Proxy.t
  module Source = Tablet_v2_proto.Zwp_tablet_pad_ring_v2.Source
  
  (** {2 Version 1, 2} *)
  
  (** Destroy the ring object.
      
      This destroys the client's resource for this ring object. *)
  let destroy (_t:([< `V1 | `V2] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:1 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg;
    Proxy.shutdown_send _t
  
  (** Set compositor feedback.
      
      Request that the compositor use the provided feedback string
      associated with this ring. This request should be issued immediately
      after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
      group is received, or whenever the ring is mapped to a different
      action. See zwp_tablet_pad_group_v2.mode_switch for more details.
      
      Clients are encouraged to provide context-aware descriptions for
      the actions associated with the ring; 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
      zwp_tablet_pad_group_v2.mode_switch event received for the group of this
      ring. Requests providing other serials than the most recent one will be
      ignored. *)
  let set_feedback (_t:([< `V1 | `V2] as 'v) t) ~description ~serial =
    let _msg = Proxy.alloc _t ~op:0 ~ints:2 ~strings:[(Some description)] ~arrays:[] in
    Msg.add_string _msg description;
    Msg.add_int _msg serial;
    Proxy.send _t _msg
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_pad_ring_v2)
    method max_version = 2l
    
    method private virtual on_source : [> ] t -> source:Imports.Zwp_tablet_pad_ring_v2.Source.t -> unit
    
    method private virtual on_angle : [> ] t -> degrees:Fixed.t -> unit
    
    method private virtual on_stop : [> ] t -> unit
    
    method private virtual on_frame : [> ] t -> time:int32 -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let source = Msg.get_int _msg |> Imports.Zwp_tablet_pad_ring_v2.Source.of_int32 in
        _self#on_source _proxy ~source
      | 1 ->
        let degrees = Msg.get_fixed _msg in
        _self#on_angle _proxy ~degrees
      | 2 ->
        _self#on_stop _proxy 
      | 3 ->
        let time = Msg.get_int _msg in
        _self#on_frame _proxy ~time
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1 | `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_source : [> `V1 | `V2] t -> source:Imports.Zwp_tablet_pad_ring_v2.Source.t -> unit
    
    (** Ring event source.
        
        Source information for ring events.
        
        This event does not occur on its own. It is sent before a
        zwp_tablet_pad_ring_v2.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
        zwp_tablet_pad_ring_v2.source.finger, a zwp_tablet_pad_ring_v2.stop event
        will be sent when the user lifts the finger off the device.
        
        This event is optional. If the source is unknown for an interaction,
        no event is sent. *)
    
    method private virtual on_angle : [> `V1 | `V2] t -> degrees:Fixed.t -> unit
    
    (** Angle changed.
        
        Sent whenever the angle on a ring changes.
        
        The angle is provided in degrees clockwise from the logical
        north of the ring in the pad's current rotation. *)
    
    method private virtual on_stop : [> `V1 | `V2] t -> unit
    
    (** Interaction stopped.
        
        Stop notification for ring events.
        
        For some zwp_tablet_pad_ring_v2.source types, a zwp_tablet_pad_ring_v2.stop
        event is sent to notify a client that the interaction with the ring
        has terminated. This enables the client to implement kinetic scrolling.
        See the zwp_tablet_pad_ring_v2.source documentation for information on
        when this event may be generated.
        
        Any zwp_tablet_pad_ring_v2.angle events with the same source after this
        event should be considered as the start of a new interaction. *)
    
    method private virtual on_frame : [> `V1 | `V2] t -> time:int32 -> unit
    
    (** End of a ring event sequence.
        
        Indicates the end of a set of ring events that logically belong
        together. A client is expected to accumulate the data in all events
        within the frame before proceeding.
        
        All zwp_tablet_pad_ring_v2 events before a zwp_tablet_pad_ring_v2.frame event belong
        logically together. For example, on termination of a finger interaction
        on a ring the compositor will send a zwp_tablet_pad_ring_v2.source event,
        a zwp_tablet_pad_ring_v2.stop event and a zwp_tablet_pad_ring_v2.frame event.
        
        A zwp_tablet_pad_ring_v2.frame event is sent for every logical event
        group, even if the group only contains a single zwp_tablet_pad_ring_v2
        event. Specifically, a client may get a sequence: angle, frame,
        angle, frame, etc. *)
    
    method min_version = 1l
  end
  
  (** Handler for a proxy with version >= 2. *)
  class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_source : [> `V2] t -> source:Imports.Zwp_tablet_pad_ring_v2.Source.t -> unit
    
    (** Ring event source.
        
        Source information for ring events.
        
        This event does not occur on its own. It is sent before a
        zwp_tablet_pad_ring_v2.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
        zwp_tablet_pad_ring_v2.source.finger, a zwp_tablet_pad_ring_v2.stop event
        will be sent when the user lifts the finger off the device.
        
        This event is optional. If the source is unknown for an interaction,
        no event is sent. *)
    
    method private virtual on_angle : [> `V2] t -> degrees:Fixed.t -> unit
    
    (** Angle changed.
        
        Sent whenever the angle on a ring changes.
        
        The angle is provided in degrees clockwise from the logical
        north of the ring in the pad's current rotation. *)
    
    method private virtual on_stop : [> `V2] t -> unit
    
    (** Interaction stopped.
        
        Stop notification for ring events.
        
        For some zwp_tablet_pad_ring_v2.source types, a zwp_tablet_pad_ring_v2.stop
        event is sent to notify a client that the interaction with the ring
        has terminated. This enables the client to implement kinetic scrolling.
        See the zwp_tablet_pad_ring_v2.source documentation for information on
        when this event may be generated.
        
        Any zwp_tablet_pad_ring_v2.angle events with the same source after this
        event should be considered as the start of a new interaction. *)
    
    method private virtual on_frame : [> `V2] t -> time:int32 -> unit
    
    (** End of a ring event sequence.
        
        Indicates the end of a set of ring events that logically belong
        together. A client is expected to accumulate the data in all events
        within the frame before proceeding.
        
        All zwp_tablet_pad_ring_v2 events before a zwp_tablet_pad_ring_v2.frame event belong
        logically together. For example, on termination of a finger interaction
        on a ring the compositor will send a zwp_tablet_pad_ring_v2.source event,
        a zwp_tablet_pad_ring_v2.stop event and a zwp_tablet_pad_ring_v2.frame event.
        
        A zwp_tablet_pad_ring_v2.frame event is sent for every logical event
        group, even if the group only contains a single zwp_tablet_pad_ring_v2
        event. Specifically, a client may get a sequence: angle, frame,
        angle, frame, etc. *)
    
    method min_version = 2l
  end
end

(** Pad strip.
    
    A linear interaction area, such as the strips found in Wacom Cintiq
    models.
    
    Events on a strip are logically grouped by the zwp_tablet_pad_strip_v2.frame
    event. *)
module Zwp_tablet_pad_strip_v2 = struct
  type 'v t = ([`Zwp_tablet_pad_strip_v2], 'v, [`Client]) Proxy.t
  module Source = Tablet_v2_proto.Zwp_tablet_pad_strip_v2.Source
  
  (** {2 Version 1, 2} *)
  
  (** Destroy the strip object.
      
      This destroys the client's resource for this strip object. *)
  let destroy (_t:([< `V1 | `V2] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:1 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg;
    Proxy.shutdown_send _t
  
  (** Set compositor feedback.
      
      Requests the compositor to use the provided feedback string
      associated with this strip. This request should be issued immediately
      after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
      group is received, or whenever the strip is mapped to a different
      action. See zwp_tablet_pad_group_v2.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
      zwp_tablet_pad_group_v2.mode_switch event received for the group of this
      strip. Requests providing other serials than the most recent one will be
      ignored. *)
  let set_feedback (_t:([< `V1 | `V2] as 'v) t) ~description ~serial =
    let _msg = Proxy.alloc _t ~op:0 ~ints:2 ~strings:[(Some description)] ~arrays:[] in
    Msg.add_string _msg description;
    Msg.add_int _msg serial;
    Proxy.send _t _msg
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_pad_strip_v2)
    method max_version = 2l
    
    method private virtual on_source : [> ] t -> source:Imports.Zwp_tablet_pad_strip_v2.Source.t -> unit
    
    method private virtual on_position : [> ] t -> position:int32 -> unit
    
    method private virtual on_stop : [> ] t -> unit
    
    method private virtual on_frame : [> ] t -> time:int32 -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let source = Msg.get_int _msg |> Imports.Zwp_tablet_pad_strip_v2.Source.of_int32 in
        _self#on_source _proxy ~source
      | 1 ->
        let position = Msg.get_int _msg in
        _self#on_position _proxy ~position
      | 2 ->
        _self#on_stop _proxy 
      | 3 ->
        let time = Msg.get_int _msg in
        _self#on_frame _proxy ~time
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1 | `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_source : [> `V1 | `V2] t -> source:Imports.Zwp_tablet_pad_strip_v2.Source.t -> unit
    
    (** Strip event source.
        
        Source information for strip events.
        
        This event does not occur on its own. It is sent before a
        zwp_tablet_pad_strip_v2.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
        zwp_tablet_pad_strip_v2.source.finger, a zwp_tablet_pad_strip_v2.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. *)
    
    method private virtual on_position : [> `V1 | `V2] t -> position:int32 -> unit
    
    (** Position changed.
        
        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. *)
    
    method private virtual on_stop : [> `V1 | `V2] t -> unit
    
    (** Interaction stopped.
        
        Stop notification for strip events.
        
        For some zwp_tablet_pad_strip_v2.source types, a zwp_tablet_pad_strip_v2.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 zwp_tablet_pad_strip_v2.source documentation for
        information on when this event may be generated.
        
        Any zwp_tablet_pad_strip_v2.position events with the same source after this
        event should be considered as the start of a new interaction. *)
    
    method private virtual on_frame : [> `V1 | `V2] t -> time:int32 -> unit
    
    (** End of a strip event sequence.
        
        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 zwp_tablet_pad_strip_v2 events before a zwp_tablet_pad_strip_v2.frame event belong
        logically together. For example, on termination of a finger interaction
        on a strip the compositor will send a zwp_tablet_pad_strip_v2.source event,
        a zwp_tablet_pad_strip_v2.stop event and a zwp_tablet_pad_strip_v2.frame
        event.
        
        A zwp_tablet_pad_strip_v2.frame event is sent for every logical event
        group, even if the group only contains a single zwp_tablet_pad_strip_v2
        event. Specifically, a client may get a sequence: position, frame,
        position, frame, etc. *)
    
    method min_version = 1l
  end
  
  (** Handler for a proxy with version >= 2. *)
  class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_source : [> `V2] t -> source:Imports.Zwp_tablet_pad_strip_v2.Source.t -> unit
    
    (** Strip event source.
        
        Source information for strip events.
        
        This event does not occur on its own. It is sent before a
        zwp_tablet_pad_strip_v2.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
        zwp_tablet_pad_strip_v2.source.finger, a zwp_tablet_pad_strip_v2.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. *)
    
    method private virtual on_position : [> `V2] t -> position:int32 -> unit
    
    (** Position changed.
        
        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. *)
    
    method private virtual on_stop : [> `V2] t -> unit
    
    (** Interaction stopped.
        
        Stop notification for strip events.
        
        For some zwp_tablet_pad_strip_v2.source types, a zwp_tablet_pad_strip_v2.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 zwp_tablet_pad_strip_v2.source documentation for
        information on when this event may be generated.
        
        Any zwp_tablet_pad_strip_v2.position events with the same source after this
        event should be considered as the start of a new interaction. *)
    
    method private virtual on_frame : [> `V2] t -> time:int32 -> unit
    
    (** End of a strip event sequence.
        
        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 zwp_tablet_pad_strip_v2 events before a zwp_tablet_pad_strip_v2.frame event belong
        logically together. For example, on termination of a finger interaction
        on a strip the compositor will send a zwp_tablet_pad_strip_v2.source event,
        a zwp_tablet_pad_strip_v2.stop event and a zwp_tablet_pad_strip_v2.frame
        event.
        
        A zwp_tablet_pad_strip_v2.frame event is sent for every logical event
        group, even if the group only contains a single zwp_tablet_pad_strip_v2
        event. Specifically, a client may get a sequence: position, frame,
        position, frame, etc. *)
    
    method min_version = 2l
  end
end

(** A set of buttons, rings and strips.
    
    A pad group describes a distinct (sub)set of buttons, rings and strips
    present in the tablet. The criteria of this grouping is usually positional,
    eg. if a tablet has buttons on the left and right side, 2 groups will be
    presented. The physical arrangement of groups is undisclosed and may
    change on the fly.
    
    Pad groups will announce their features during pad initialization. Between
    the corresponding zwp_tablet_pad_v2.group event and zwp_tablet_pad_group_v2.done, the
    pad group will announce the buttons, rings and strips contained in it,
    plus the number of supported modes.
    
    Modes are a mechanism to allow multiple groups of actions for every element
    in the pad group. The number of groups and available modes in each is
    persistent across device plugs. The current mode is user-switchable, it
    will be announced through the zwp_tablet_pad_group_v2.mode_switch event both
    whenever it is switched, and after zwp_tablet_pad_v2.enter.
    
    The current mode logically applies to all elements in the pad group,
    although it is at clients' discretion whether to actually perform different
    actions, and/or issue the respective .set_feedback requests to notify the
    compositor. See the zwp_tablet_pad_group_v2.mode_switch event for more details. *)
module Zwp_tablet_pad_group_v2 = struct
  type 'v t = ([`Zwp_tablet_pad_group_v2], 'v, [`Client]) Proxy.t
  
  (** {2 Version 1} *)
  
  (** Destroy the pad object.
      
      Destroy the zwp_tablet_pad_group_v2 object. Objects created from this object
      are unaffected and should be destroyed separately. *)
  let destroy (_t:([< `V1 | `V2] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:0 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg;
    Proxy.shutdown_send _t
  
  
  (** {2 Version 2} *)
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_pad_group_v2)
    method max_version = 2l
    
    method private virtual on_buttons : [> ] t -> buttons:string -> unit
    
    method private virtual on_ring : [> ] t -> ([`Zwp_tablet_pad_ring_v2], 'v, [`Client]) Proxy.t -> unit
    
    method private virtual on_strip : [> ] t -> ([`Zwp_tablet_pad_strip_v2], 'v, [`Client]) Proxy.t -> unit
    
    method private virtual on_modes : [> ] t -> modes:int32 -> unit
    
    method private virtual on_done : [> ] t -> unit
    
    method private virtual on_mode_switch : [> ] t -> time:int32 -> serial:int32 -> mode:int32 -> unit
    
    method private virtual on_dial : [> ] t -> ([`Zwp_tablet_pad_dial_v2], 'v, [`Client]) Proxy.t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let buttons = Msg.get_array _msg in
        _self#on_buttons _proxy ~buttons
      | 1 ->
        let ring : ([`Zwp_tablet_pad_ring_v2], _, _) Proxy.t =
          Msg.get_int _msg |> Proxy.Handler.accept_new _proxy (module Imports.Zwp_tablet_pad_ring_v2) in
        _self#on_ring _proxy ring
      | 2 ->
        let strip : ([`Zwp_tablet_pad_strip_v2], _, _) Proxy.t =
          Msg.get_int _msg |> Proxy.Handler.accept_new _proxy (module Imports.Zwp_tablet_pad_strip_v2) in
        _self#on_strip _proxy strip
      | 3 ->
        let modes = Msg.get_int _msg in
        _self#on_modes _proxy ~modes
      | 4 ->
        _self#on_done _proxy 
      | 5 ->
        let time = Msg.get_int _msg in
        let serial = Msg.get_int _msg in
        let mode = Msg.get_int _msg in
        _self#on_mode_switch _proxy ~time ~serial ~mode
      | 6 ->
        let dial : ([`Zwp_tablet_pad_dial_v2], _, _) Proxy.t =
          Msg.get_int _msg |> Proxy.Handler.accept_new _proxy (module Imports.Zwp_tablet_pad_dial_v2) in
        _self#on_dial _proxy dial
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1 | `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_buttons : [> `V1 | `V2] t -> buttons:string -> unit
    
    (** Buttons announced.
        
        Sent on zwp_tablet_pad_group_v2 initialization to announce the available
        buttons in the group. Button indices start at 0, a button may only be
        in one group at a time.
        
        This event is first sent in the initial burst of events before the
        zwp_tablet_pad_group_v2.done event.
        
        Some buttons are reserved by the compositor. These buttons may not be
        assigned to any zwp_tablet_pad_group_v2. Compositors may broadcast this
        event in the case of changes to the mapping of these reserved buttons.
        If the compositor happens to reserve all buttons in a group, this event
        will be sent with an empty array. *)
    
    method private virtual on_ring : [> `V1 | `V2] t -> ([`Zwp_tablet_pad_ring_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** Ring announced.
        
        Sent on zwp_tablet_pad_group_v2 initialization to announce available rings.
        One event is sent for each ring available on this pad group.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_group_v2.done event. *)
    
    method private virtual on_strip : [> `V1 | `V2] t -> ([`Zwp_tablet_pad_strip_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** Strip announced.
        
        Sent on zwp_tablet_pad_v2 initialization to announce available strips.
        One event is sent for each strip available on this pad group.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_group_v2.done event. *)
    
    method private virtual on_modes : [> `V1 | `V2] t -> modes:int32 -> unit
    
    (** Mode-switch ability announced.
        
        Sent on zwp_tablet_pad_group_v2 initialization to announce that the pad
        group may switch between modes. A client may use a mode to store a
        specific configuration for buttons, rings and strips and use the
        zwp_tablet_pad_group_v2.mode_switch event to toggle between these
        configurations. Mode indices start at 0.
        
        Switching modes is compositor-dependent. See the
        zwp_tablet_pad_group_v2.mode_switch event for more details.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_group_v2.done event. This event is only sent when
        more than one mode is available. *)
    
    method private virtual on_done : [> `V1 | `V2] t -> unit
    
    (** Tablet group description events sequence complete.
        
        This event is sent immediately to signal the end of the initial
        burst of descriptive events. A client may consider the static
        description of the tablet to be complete and finalize initialization
        of the tablet group. *)
    
    method private virtual on_mode_switch : [> `V1 | `V2] t -> time:int32 -> serial:int32 -> mode:int32 -> unit
    
    (** Mode switch event.
        
        Notification that the mode was switched.
        
        A mode applies to all buttons, rings, strips and dials in a group
        simultaneously, but a client is not required to assign different actions
        for each mode. For example, a client may have mode-specific button
        mappings but map the ring to vertical scrolling in all modes. Mode
        indices start at 0.
        
        Switching modes is compositor-dependent. The compositor may provide
        visual cues to the user about the mode, e.g. by toggling LEDs on
        the tablet device. Mode-switching may be software-controlled or
        controlled by one or more physical buttons. For example, on a Wacom
        Intuos Pro, the button inside the ring may be assigned to switch
        between modes.
        
        The compositor will also send this event after zwp_tablet_pad_v2.enter on
        each group in order to notify of the current mode. Groups that only
        feature one mode will use mode=0 when emitting this event.
        
        If a button action in the new mode differs from the action in the
        previous mode, the client should immediately issue a
        zwp_tablet_pad_v2.set_feedback request for each changed button.
        
        If a ring, strip or dial action in the new mode differs from the action
        in the previous mode, the client should immediately issue a
        zwp_tablet_ring_v2.set_feedback, zwp_tablet_strip_v2.set_feedback or
        zwp_tablet_dial_v2.set_feedback request for each changed ring, strip or dial. *)
    
    method private virtual on_dial : [> `V2] t -> ([`Zwp_tablet_pad_dial_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** Dial announced.
        
        Sent on zwp_tablet_pad_v2 initialization to announce available dials.
        One event is sent for each dial available on this pad group.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_group_v2.done event. *)
    
    method min_version = 1l
  end
  
  (** Handler for a proxy with version >= 2. *)
  class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_buttons : [> `V2] t -> buttons:string -> unit
    
    (** Buttons announced.
        
        Sent on zwp_tablet_pad_group_v2 initialization to announce the available
        buttons in the group. Button indices start at 0, a button may only be
        in one group at a time.
        
        This event is first sent in the initial burst of events before the
        zwp_tablet_pad_group_v2.done event.
        
        Some buttons are reserved by the compositor. These buttons may not be
        assigned to any zwp_tablet_pad_group_v2. Compositors may broadcast this
        event in the case of changes to the mapping of these reserved buttons.
        If the compositor happens to reserve all buttons in a group, this event
        will be sent with an empty array. *)
    
    method private virtual on_ring : [> `V2] t -> ([`Zwp_tablet_pad_ring_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** Ring announced.
        
        Sent on zwp_tablet_pad_group_v2 initialization to announce available rings.
        One event is sent for each ring available on this pad group.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_group_v2.done event. *)
    
    method private virtual on_strip : [> `V2] t -> ([`Zwp_tablet_pad_strip_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** Strip announced.
        
        Sent on zwp_tablet_pad_v2 initialization to announce available strips.
        One event is sent for each strip available on this pad group.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_group_v2.done event. *)
    
    method private virtual on_modes : [> `V2] t -> modes:int32 -> unit
    
    (** Mode-switch ability announced.
        
        Sent on zwp_tablet_pad_group_v2 initialization to announce that the pad
        group may switch between modes. A client may use a mode to store a
        specific configuration for buttons, rings and strips and use the
        zwp_tablet_pad_group_v2.mode_switch event to toggle between these
        configurations. Mode indices start at 0.
        
        Switching modes is compositor-dependent. See the
        zwp_tablet_pad_group_v2.mode_switch event for more details.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_group_v2.done event. This event is only sent when
        more than one mode is available. *)
    
    method private virtual on_done : [> `V2] t -> unit
    
    (** Tablet group description events sequence complete.
        
        This event is sent immediately to signal the end of the initial
        burst of descriptive events. A client may consider the static
        description of the tablet to be complete and finalize initialization
        of the tablet group. *)
    
    method private virtual on_mode_switch : [> `V2] t -> time:int32 -> serial:int32 -> mode:int32 -> unit
    
    (** Mode switch event.
        
        Notification that the mode was switched.
        
        A mode applies to all buttons, rings, strips and dials in a group
        simultaneously, but a client is not required to assign different actions
        for each mode. For example, a client may have mode-specific button
        mappings but map the ring to vertical scrolling in all modes. Mode
        indices start at 0.
        
        Switching modes is compositor-dependent. The compositor may provide
        visual cues to the user about the mode, e.g. by toggling LEDs on
        the tablet device. Mode-switching may be software-controlled or
        controlled by one or more physical buttons. For example, on a Wacom
        Intuos Pro, the button inside the ring may be assigned to switch
        between modes.
        
        The compositor will also send this event after zwp_tablet_pad_v2.enter on
        each group in order to notify of the current mode. Groups that only
        feature one mode will use mode=0 when emitting this event.
        
        If a button action in the new mode differs from the action in the
        previous mode, the client should immediately issue a
        zwp_tablet_pad_v2.set_feedback request for each changed button.
        
        If a ring, strip or dial action in the new mode differs from the action
        in the previous mode, the client should immediately issue a
        zwp_tablet_ring_v2.set_feedback, zwp_tablet_strip_v2.set_feedback or
        zwp_tablet_dial_v2.set_feedback request for each changed ring, strip or dial. *)
    
    method private virtual on_dial : [> `V2] t -> ([`Zwp_tablet_pad_dial_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** Dial announced.
        
        Sent on zwp_tablet_pad_v2 initialization to announce available dials.
        One event is sent for each dial available on this pad group.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_group_v2.done event. *)
    
    method min_version = 2l
  end
end

(** A set of buttons, rings, strips and dials.
    
    A pad device is a set of buttons, rings, strips and dials
    usually physically present on the tablet device itself. Some
    exceptions exist where the pad device is physically detached, e.g. the
    Wacom ExpressKey Remote.
    
    Pad devices have no axes that control the cursor and are generally
    auxiliary devices to the tool devices used on the tablet surface.
    
    A pad device has a number of static characteristics, e.g. the number
    of rings. These capabilities are sent in an event sequence after the
    zwp_tablet_seat_v2.pad_added event before any actual events from this pad.
    This initial event sequence is terminated by a zwp_tablet_pad_v2.done
    event.
    
    All pad features (buttons, rings, strips and dials) are logically divided into
    groups and all pads have at least one group. The available groups are
    notified through the zwp_tablet_pad_v2.group event; the compositor will
    emit one event per group before emitting zwp_tablet_pad_v2.done.
    
    Groups may have multiple modes. Modes allow clients to map multiple
    actions to a single pad feature. Only one mode can be active per group,
    although different groups may have different active modes. *)
module Zwp_tablet_pad_v2 = struct
  type 'v t = ([`Zwp_tablet_pad_v2], 'v, [`Client]) Proxy.t
  module Button_state = Tablet_v2_proto.Zwp_tablet_pad_v2.Button_state
  
  (** {2 Version 1, 2} *)
  
  (** Destroy the pad object.
      
      Destroy the zwp_tablet_pad_v2 object. Objects created from this object
      are unaffected and should be destroyed separately. *)
  let destroy (_t:([< `V1 | `V2] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:1 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg;
    Proxy.shutdown_send _t
  
  (** Set compositor feedback.
      
      Requests the compositor to use the provided feedback string
      associated with this button. This request should be issued immediately
      after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
      group is received, or whenever a button is mapped to a different
      action. See zwp_tablet_pad_group_v2.mode_switch for more details.
      
      Clients are encouraged to provide context-aware descriptions for
      the actions associated with each button, and compositors may use
      this information to offer visual feedback on the button layout
      (e.g. on-screen displays).
      
      Button indices start at 0. Setting the feedback string on a button
      that is reserved by the compositor (i.e. not belonging to any
      zwp_tablet_pad_group_v2) does not generate an error but the compositor
      is free to ignore the request.
      
      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
      zwp_tablet_pad_group_v2.mode_switch event received for the group of this
      button. Requests providing other serials than the most recent one will
      be ignored. *)
  let set_feedback (_t:([< `V1 | `V2] as 'v) t) ~button ~description ~serial =
    let _msg = Proxy.alloc _t ~op:0 ~ints:3 ~strings:[(Some description)] ~arrays:[] in
    Msg.add_int _msg button;
    Msg.add_string _msg description;
    Msg.add_int _msg serial;
    Proxy.send _t _msg
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_pad_v2)
    method max_version = 2l
    
    method private virtual on_group : [> ] t -> ([`Zwp_tablet_pad_group_v2], 'v, [`Client]) Proxy.t -> unit
    
    method private virtual on_path : [> ] t -> path:string -> unit
    
    method private virtual on_buttons : [> ] t -> buttons:int32 -> unit
    
    method private virtual on_done : [> ] t -> unit
    
    method private virtual on_button : [> ] t -> time:int32 -> button:int32 ->
                                       state:Imports.Zwp_tablet_pad_v2.Button_state.t -> unit
    
    method private virtual on_enter : [> ] t -> serial:int32 ->
                                      tablet:([`Zwp_tablet_v2], [> Imports.Zwp_tablet_v2.versions], [`Client]) Proxy.t ->
                                      surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Client]) Proxy.t ->
                                      unit
    
    method private virtual on_leave : [> ] t -> serial:int32 ->
                                      surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Client]) Proxy.t ->
                                      unit
    
    method private virtual on_removed : [> ] t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let pad_group : ([`Zwp_tablet_pad_group_v2], _, _) Proxy.t =
          Msg.get_int _msg |> Proxy.Handler.accept_new _proxy (module Imports.Zwp_tablet_pad_group_v2) in
        _self#on_group _proxy pad_group
      | 1 ->
        let path = Msg.get_string _msg in
        _self#on_path _proxy ~path
      | 2 ->
        let buttons = Msg.get_int _msg in
        _self#on_buttons _proxy ~buttons
      | 3 ->
        _self#on_done _proxy 
      | 4 ->
        let time = Msg.get_int _msg in
        let button = Msg.get_int _msg in
        let state = Msg.get_int _msg |> Imports.Zwp_tablet_pad_v2.Button_state.of_int32 in
        _self#on_button _proxy ~time ~button ~state
      | 5 ->
        let serial = Msg.get_int _msg in
        let tablet : ([`Zwp_tablet_v2], _, _) Proxy.t =
          let Proxy.Proxy p = Msg.get_int _msg |> Proxy.lookup_other _proxy in
          match Proxy.ty p with
          | Imports.Zwp_tablet_v2.T -> p
          | _ -> Proxy.wrong_type ~parent:_proxy ~expected:"zwp_tablet_v2" p
          in
        let surface : ([`Wl_surface], _, _) Proxy.t =
          let Proxy.Proxy p = Msg.get_int _msg |> Proxy.lookup_other _proxy in
          match Proxy.ty p with
          | Imports.Wl_surface.T -> p
          | _ -> Proxy.wrong_type ~parent:_proxy ~expected:"wl_surface" p
          in
        _self#on_enter _proxy ~serial ~tablet ~surface
      | 6 ->
        let serial = Msg.get_int _msg in
        let surface : ([`Wl_surface], _, _) Proxy.t =
          let Proxy.Proxy p = Msg.get_int _msg |> Proxy.lookup_other _proxy in
          match Proxy.ty p with
          | Imports.Wl_surface.T -> p
          | _ -> Proxy.wrong_type ~parent:_proxy ~expected:"wl_surface" p
          in
        _self#on_leave _proxy ~serial ~surface
      | 7 ->
        _self#on_removed _proxy 
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1 | `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_group : [> `V1 | `V2] t -> ([`Zwp_tablet_pad_group_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** Group announced.
        
        Sent on zwp_tablet_pad_v2 initialization to announce available groups.
        One event is sent for each pad group available.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_v2.done event. At least one group will be announced. *)
    
    method private virtual on_path : [> `V1 | `V2] t -> path:string -> unit
    
    (** Path to the device.
        
        A system-specific device path that indicates which device is behind
        this zwp_tablet_pad_v2. This information may be used to gather additional
        information about the device, e.g. through libwacom.
        
        The format of the path is unspecified, it may be a device node, a
        sysfs path, or some other identifier. It is up to the client to
        identify the string provided.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_v2.done event. *)
    
    method private virtual on_buttons : [> `V1 | `V2] t -> buttons:int32 -> unit
    
    (** Buttons announced.
        
        Sent on zwp_tablet_pad_v2 initialization to announce the available
        buttons.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_v2.done event. This event is only sent when at least one
        button is available. *)
    
    method private virtual on_done : [> `V1 | `V2] t -> unit
    
    (** Pad description event sequence complete.
        
        This event signals the end of the initial burst of descriptive
        events. A client may consider the static description of the pad to
        be complete and finalize initialization of the pad. *)
    
    method private virtual on_button : [> `V1 | `V2] t -> time:int32 -> button:int32 ->
                                       state:Imports.Zwp_tablet_pad_v2.Button_state.t -> unit
    
    (** Physical button state.
        
        Sent whenever the physical state of a button changes. *)
    
    method private virtual on_enter : [> `V1 | `V2] t -> serial:int32 ->
                                      tablet:([`Zwp_tablet_v2], [> Imports.Zwp_tablet_v2.versions], [`Client]) Proxy.t ->
                                      surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Client]) Proxy.t ->
                                      unit
    
    (** Enter event.
        
        Notification that this pad is focused on the specified surface. *)
    
    method private virtual on_leave : [> `V1 | `V2] t -> serial:int32 ->
                                      surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Client]) Proxy.t ->
                                      unit
    
    (** Leave event.
        
        Notification that this pad is no longer focused on the specified
        surface. *)
    
    method private virtual on_removed : [> `V1 | `V2] t -> unit
    
    (** Pad removed event.
        
        Sent when the pad has been removed from the system. When a tablet
        is removed its pad(s) will be removed too.
        
        When this event is received, the client must destroy all rings, strips
        and groups that were offered by this pad, and issue zwp_tablet_pad_v2.destroy
        the pad itself. *)
    
    method min_version = 1l
  end
  
  (** Handler for a proxy with version >= 2. *)
  class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_group : [> `V2] t -> ([`Zwp_tablet_pad_group_v2], 'v, [`Client]) Proxy.t -> unit
    
    (** Group announced.
        
        Sent on zwp_tablet_pad_v2 initialization to announce available groups.
        One event is sent for each pad group available.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_v2.done event. At least one group will be announced. *)
    
    method private virtual on_path : [> `V2] t -> path:string -> unit
    
    (** Path to the device.
        
        A system-specific device path that indicates which device is behind
        this zwp_tablet_pad_v2. This information may be used to gather additional
        information about the device, e.g. through libwacom.
        
        The format of the path is unspecified, it may be a device node, a
        sysfs path, or some other identifier. It is up to the client to
        identify the string provided.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_v2.done event. *)
    
    method private virtual on_buttons : [> `V2] t -> buttons:int32 -> unit
    
    (** Buttons announced.
        
        Sent on zwp_tablet_pad_v2 initialization to announce the available
        buttons.
        
        This event is sent in the initial burst of events before the
        zwp_tablet_pad_v2.done event. This event is only sent when at least one
        button is available. *)
    
    method private virtual on_done : [> `V2] t -> unit
    
    (** Pad description event sequence complete.
        
        This event signals the end of the initial burst of descriptive
        events. A client may consider the static description of the pad to
        be complete and finalize initialization of the pad. *)
    
    method private virtual on_button : [> `V2] t -> time:int32 -> button:int32 ->
                                       state:Imports.Zwp_tablet_pad_v2.Button_state.t -> unit
    
    (** Physical button state.
        
        Sent whenever the physical state of a button changes. *)
    
    method private virtual on_enter : [> `V2] t -> serial:int32 ->
                                      tablet:([`Zwp_tablet_v2], [> Imports.Zwp_tablet_v2.versions], [`Client]) Proxy.t ->
                                      surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Client]) Proxy.t ->
                                      unit
    
    (** Enter event.
        
        Notification that this pad is focused on the specified surface. *)
    
    method private virtual on_leave : [> `V2] t -> serial:int32 ->
                                      surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Client]) Proxy.t ->
                                      unit
    
    (** Leave event.
        
        Notification that this pad is no longer focused on the specified
        surface. *)
    
    method private virtual on_removed : [> `V2] t -> unit
    
    (** Pad removed event.
        
        Sent when the pad has been removed from the system. When a tablet
        is removed its pad(s) will be removed too.
        
        When this event is received, the client must destroy all rings, strips
        and groups that were offered by this pad, and issue zwp_tablet_pad_v2.destroy
        the pad itself. *)
    
    method min_version = 2l
  end
end

(** Pad dial.
    
    A rotary control, e.g. a dial or a wheel.
    
    Events on a dial are logically grouped by the zwp_tablet_pad_dial_v2.frame
    event. *)
module Zwp_tablet_pad_dial_v2 = struct
  type 'v t = ([`Zwp_tablet_pad_dial_v2], 'v, [`Client]) Proxy.t
  
  (** {2 Version 1, 2} *)
  
  (** Destroy the dial object.
      
      This destroys the client's resource for this dial object. *)
  let destroy (_t:([< `V1 | `V2] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:1 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg;
    Proxy.shutdown_send _t
  
  (** Set compositor feedback.
      
      Requests the compositor to use the provided feedback string
      associated with this dial. This request should be issued immediately
      after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
      group is received, or whenever the dial is mapped to a different
      action. See zwp_tablet_pad_group_v2.mode_switch for more details.
      
      Clients are encouraged to provide context-aware descriptions for
      the actions associated with the dial, 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
      zwp_tablet_pad_group_v2.mode_switch event received for the group of this
      dial. Requests providing other serials than the most recent one will be
      ignored. *)
  let set_feedback (_t:([< `V1 | `V2] as 'v) t) ~description ~serial =
    let _msg = Proxy.alloc _t ~op:0 ~ints:2 ~strings:[(Some description)] ~arrays:[] in
    Msg.add_string _msg description;
    Msg.add_int _msg serial;
    Proxy.send _t _msg
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_pad_dial_v2)
    method max_version = 2l
    
    method private virtual on_delta : [> ] t -> value120:int32 -> unit
    
    method private virtual on_frame : [> ] t -> time:int32 -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let value120 = Msg.get_int _msg in
        _self#on_delta _proxy ~value120
      | 1 ->
        let time = Msg.get_int _msg in
        _self#on_frame _proxy ~time
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1 | `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_delta : [> `V1 | `V2] t -> value120:int32 -> unit
    
    (** Delta movement.
        
        Sent whenever the position on a dial changes.
        
        This event carries the wheel delta as multiples or fractions
        of 120 with each multiple of 120 representing one logical wheel detent.
        For example, an axis_value120 of 30 is one quarter of
        a logical wheel step in the positive direction, a value120 of
        -240 are two logical wheel steps in the negative direction within the
        same hardware event. See the wl_pointer.axis_value120 for more details.
        
        The value120 must not be zero. *)
    
    method private virtual on_frame : [> `V1 | `V2] t -> time:int32 -> unit
    
    (** End of a dial event sequence.
        
        Indicates the end of a set of events that represent one logical
        hardware dial event. A client is expected to accumulate the data
        in all events within the frame before proceeding.
        
        All zwp_tablet_pad_dial_v2 events before a zwp_tablet_pad_dial_v2.frame event belong
        logically together.
        
        A zwp_tablet_pad_dial_v2.frame event is sent for every logical event
        group, even if the group only contains a single zwp_tablet_pad_dial_v2
        event. Specifically, a client may get a sequence: delta, frame,
        delta, frame, etc. *)
    
    method min_version = 1l
  end
  
  (** Handler for a proxy with version >= 2. *)
  class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V2] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_delta : [> `V2] t -> value120:int32 -> unit
    
    (** Delta movement.
        
        Sent whenever the position on a dial changes.
        
        This event carries the wheel delta as multiples or fractions
        of 120 with each multiple of 120 representing one logical wheel detent.
        For example, an axis_value120 of 30 is one quarter of
        a logical wheel step in the positive direction, a value120 of
        -240 are two logical wheel steps in the negative direction within the
        same hardware event. See the wl_pointer.axis_value120 for more details.
        
        The value120 must not be zero. *)
    
    method private virtual on_frame : [> `V2] t -> time:int32 -> unit
    
    (** End of a dial event sequence.
        
        Indicates the end of a set of events that represent one logical
        hardware dial event. A client is expected to accumulate the data
        in all events within the frame before proceeding.
        
        All zwp_tablet_pad_dial_v2 events before a zwp_tablet_pad_dial_v2.frame event belong
        logically together.
        
        A zwp_tablet_pad_dial_v2.frame event is sent for every logical event
        group, even if the group only contains a single zwp_tablet_pad_dial_v2
        event. Specifically, a client may get a sequence: delta, frame,
        delta, frame, etc. *)
    
    method min_version = 2l
  end
end