Source file cursor_shape_v1_client.ml

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

[@@@ocaml.warning "-27-34"]
open struct
  module Imports = struct
    include Cursor_shape_v1_proto
    include Wayland.Wayland_proto
    include Tablet_v2_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


(** Cursor shape manager.
    
    This global offers an alternative, optional way to set cursor images. This
    new way uses enumerated cursors instead of a wl_surface like
    wl_pointer.set_cursor does.
    
    Warning! The protocol described in this file is currently in the testing
    phase. Backward compatible changes may be added together with the
    corresponding interface version bump. Backward incompatible changes can
    only be done by creating a new major version of the extension. *)
module Wp_cursor_shape_manager_v1 = struct
  type 'v t = ([`Wp_cursor_shape_manager_v1], 'v, [`Client]) Proxy.t
  
  (** {2 Version 1, 2} *)
  
  (** Manage the cursor shape of a tablet tool device.
      
      Obtain a wp_cursor_shape_device_v1 for a zwp_tablet_tool_v2 object.
      
      When the zwp_tablet_tool_v2 is removed, the wp_cursor_shape_device_v1
      object becomes inert. *)
  let get_tablet_tool_v2 (_t:([< `V1 | `V2] as 'v) t) (cursor_shape_device:([`Wp_cursor_shape_device_v1], 'v, [`Client]) #Proxy.Handler.t) ~(tablet_tool:([`Zwp_tablet_tool_v2], _, [`Client]) Proxy.t) =
    let __cursor_shape_device = Proxy.spawn _t cursor_shape_device in
    let _msg = Proxy.alloc _t ~op:2 ~ints:2 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Proxy.id __cursor_shape_device);
    Msg.add_int _msg (Proxy.id tablet_tool);
    Proxy.send _t _msg;
    __cursor_shape_device
  
  (** Manage the cursor shape of a pointer device.
      
      Obtain a wp_cursor_shape_device_v1 for a wl_pointer object.
      
      When the pointer capability is removed from the wl_seat, the
      wp_cursor_shape_device_v1 object becomes inert. *)
  let get_pointer (_t:([< `V1 | `V2] as 'v) t) (cursor_shape_device:([`Wp_cursor_shape_device_v1], 'v, [`Client]) #Proxy.Handler.t) ~(pointer:([`Wl_pointer], _, [`Client]) Proxy.t) =
    let __cursor_shape_device = Proxy.spawn _t cursor_shape_device in
    let _msg = Proxy.alloc _t ~op:1 ~ints:2 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Proxy.id __cursor_shape_device);
    Msg.add_int _msg (Proxy.id pointer);
    Proxy.send _t _msg;
    __cursor_shape_device
  
  (** Destroy the manager.
      
      Destroy the cursor shape manager. *)
  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 ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Cursor_shape_v1_proto.Wp_cursor_shape_manager_v1)
    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

(** Cursor shape for a device.
    
    This interface allows clients to set the cursor shape. *)
module Wp_cursor_shape_device_v1 = struct
  type 'v t = ([`Wp_cursor_shape_device_v1], 'v, [`Client]) Proxy.t
  module Shape = Cursor_shape_v1_proto.Wp_cursor_shape_device_v1.Shape
  
  module Error = Cursor_shape_v1_proto.Wp_cursor_shape_device_v1.Error
  
  (** {2 Version 1, 2} *)
  
  (** Set device cursor to the shape.
      
      Sets the device cursor to the specified shape. The compositor will
      change the cursor image based on the specified shape.
      
      The cursor actually changes only if the input device focus is one of
      the requesting client's surfaces. If any, the previous cursor image
      (surface or shape) is replaced.
      
      The "shape" argument must be a valid enum entry, otherwise the
      invalid_shape protocol error is raised.
      
      This is similar to the wl_pointer.set_cursor and
      zwp_tablet_tool_v2.set_cursor requests, but this request accepts a
      shape instead of contents in the form of a surface. Clients can mix
      set_cursor and set_shape requests.
      
      The serial parameter must match the latest wl_pointer.enter or
      zwp_tablet_tool_v2.proximity_in serial number sent to the client.
      Otherwise the request will be ignored. *)
  let set_shape (_t:([< `V1 | `V2] as 'v) t) ~serial ~shape =
    let _msg = Proxy.alloc _t ~op:1 ~ints:2 ~strings:[] ~arrays:[] in
    Msg.add_int _msg serial;
    Msg.add_int _msg (Imports.Wp_cursor_shape_device_v1.Shape.to_int32 shape);
    Proxy.send _t _msg
  
  (** Destroy the cursor shape device.
      
      Destroy the cursor shape device.
      
      The device cursor shape remains unchanged. *)
  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 ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Cursor_shape_v1_proto.Wp_cursor_shape_device_v1)
    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
  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
  end
end