Source file wlr_layer_shell_unstable_v1_client.ml

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

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


(** Create surfaces that are layers of the desktop.
    
    Clients can use this interface to assign the surface_layer role to
    wl_surfaces. Such surfaces are assigned to a "layer" of the output and
    rendered with a defined z-depth respective to each other. They may also be
    anchored to the edges and corners of a screen and specify input handling
    semantics. This interface should be suitable for the implementation of
    many desktop shell components, and a broad number of other applications
    that interact with the desktop. *)
module Zwlr_layer_shell_v1 = struct
  type 'v t = ([`Zwlr_layer_shell_v1], 'v, [`Client]) Proxy.t
  module Error = Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_shell_v1.Error
  
  module Layer = Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_shell_v1.Layer
  
  (** {2 Version 1, 2} *)
  
  (** Create a layer_surface from a surface.
      
      Create a layer surface for an existing surface. This assigns the role of
      layer_surface, or raises a protocol error if another role is already
      assigned.
      
      Creating a layer surface from a wl_surface which has a buffer attached
      or committed is a client error, and any attempts by a client to attach
      or manipulate a buffer prior to the first layer_surface.configure call
      must also be treated as errors.
      
      After creating a layer_surface object and setting it up, the client
      must perform an initial commit without any buffer attached.
      The compositor will reply with a layer_surface.configure event.
      The client must acknowledge it and is then allowed to attach a buffer
      to map the surface.
      
      You may pass NULL for output to allow the compositor to decide which
      output to use. Generally this will be the one that the user most
      recently interacted with.
      
      Clients can specify a namespace that defines the purpose of the layer
      surface. *)
  let get_layer_surface (_t:([< `V1 | `V2 | `V3 | `V4 | `V5] as 'v) t) 
    (id:([`Zwlr_layer_surface_v1], 'v, [`Client]) #Proxy.Handler.t) ~(surface:([`Wl_surface], _, [`Client]) Proxy.t) ~(output:([`Wl_output], _, [`Client]) Proxy.t option) ~layer ~namespace =
    let __id = Proxy.spawn _t id in
    let _msg = Proxy.alloc _t ~op:0 ~ints:5 ~strings:[(Some namespace)] ~arrays:[] in
    Msg.add_int _msg (Proxy.id __id);
    Msg.add_int _msg (Proxy.id surface);
    Msg.add_int _msg (Proxy.id_opt output);
    Msg.add_int _msg (Imports.Zwlr_layer_shell_v1.Layer.to_int32 layer);
    Msg.add_string _msg namespace;
    Proxy.send _t _msg;
    __id
  
  
  (** {2 Version 3, 4, 5} *)
  
  (** Destroy the layer_shell object.
      
      This request indicates that the client will not use the layer_shell
      object any more. Objects that have been created through this instance
      are not affected. *)
  let destroy (_t:([< `V3 | `V4 | `V5] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:1 ~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 Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_shell_v1)
    method max_version = 5l
    
    
    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 | `V3 | `V4 | `V5] 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 | `V3 | `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method min_version = 2l
    method bind_version : [`V2] = `V2
  end
  
  (** Handler for a proxy with version >= 3. *)
  class ['v] v3 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V3 | `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method min_version = 3l
    method bind_version : [`V3] = `V3
  end
  
  (** Handler for a proxy with version >= 4. *)
  class ['v] v4 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method min_version = 4l
    method bind_version : [`V4] = `V4
  end
  
  (** Handler for a proxy with version >= 5. *)
  class ['v] v5 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V5] as 'v] _handlers_unsafe
    (**/**)
    method min_version = 5l
    method bind_version : [`V5] = `V5
  end
end

(** Layer metadata interface.
    
    An interface that may be implemented by a wl_surface, for surfaces that
    are designed to be rendered as a layer of a stacked desktop-like
    environment.
    
    Layer surface state (layer, size, anchor, exclusive zone,
    margin, interactivity) is double-buffered, and will be applied at the
    time wl_surface.commit of the corresponding wl_surface is called.
    
    Attaching a null buffer to a layer surface unmaps it.
    
    Unmapping a layer_surface means that the surface cannot be shown by the
    compositor until it is explicitly mapped again. The layer_surface
    returns to the state it had right after layer_shell.get_layer_surface.
    The client can re-map the surface by performing a commit without any
    buffer attached, waiting for a configure event and handling it as usual. *)
module Zwlr_layer_surface_v1 = struct
  type 'v t = ([`Zwlr_layer_surface_v1], 'v, [`Client]) Proxy.t
  module Keyboard_interactivity = Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_surface_v1.Keyboard_interactivity
  
  module Error = Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_surface_v1.Error
  
  module Anchor = Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_surface_v1.Anchor
  
  (** {2 Version 1} *)
  
  (** Destroy the layer_surface.
      
      This request destroys the layer surface. *)
  let destroy (_t:([< `V1 | `V2 | `V3 | `V4 | `V5] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:7 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg;
    Proxy.shutdown_send _t
  
  (** Ack a configure event.
      
      When a configure event is received, if a client commits the
      surface in response to the configure event, then the client
      must make an ack_configure request sometime before the commit
      request, passing along the serial of the configure event.
      
      If the client receives multiple configure events before it
      can respond to one, it only has to ack the last configure event.
      
      A client is not required to commit immediately after sending
      an ack_configure request - it may even ack_configure several times
      before its next surface commit.
      
      A client may send multiple ack_configure requests before committing, but
      only the last request sent before a commit indicates which configure
      event the client really is responding to. *)
  let ack_configure (_t:([< `V1 | `V2 | `V3 | `V4 | `V5] as 'v) t) ~serial =
    let _msg = Proxy.alloc _t ~op:6 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg serial;
    Proxy.send _t _msg
  
  (** Assign this layer_surface as an xdg_popup parent.
      
      This assigns an xdg_popup's parent to this layer_surface.  This popup
      should have been created via xdg_surface::get_popup with the parent set
      to NULL, and this request must be invoked before committing the popup's
      initial state.
      
      See the documentation of xdg_popup for more details about what an
      xdg_popup is and how it is used. *)
  let get_popup (_t:([< `V1 | `V2 | `V3 | `V4 | `V5] as 'v) t) ~(popup:([`Xdg_popup], _, [`Client]) Proxy.t) =
    let _msg = Proxy.alloc _t ~op:5 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Proxy.id popup);
    Proxy.send _t _msg
  
  (** Requests keyboard events.
      
      Set how keyboard events are delivered to this surface. By default,
      layer shell surfaces do not receive keyboard events; this request can
      be used to change this.
      
      This setting is inherited by child surfaces set by the get_popup
      request.
      
      Layer surfaces receive pointer, touch, and tablet events normally. If
      you do not want to receive them, set the input region on your surface
      to an empty region.
      
      Keyboard interactivity is double-buffered, see wl_surface.commit. *)
  let set_keyboard_interactivity (_t:([< `V1 | `V2 | `V3 | `V4 | `V5] as 'v) t) 
    ~keyboard_interactivity =
    let _msg = Proxy.alloc _t ~op:4 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Imports.Zwlr_layer_surface_v1.Keyboard_interactivity.to_int32 keyboard_interactivity);
    Proxy.send _t _msg
  
  (** Sets a margin from the anchor point.
      
      Requests that the surface be placed some distance away from the anchor
      point on the output, in surface-local coordinates. Setting this value
      for edges you are not anchored to has no effect.
      
      The exclusive zone includes the margin.
      
      Margin is double-buffered, see wl_surface.commit. *)
  let set_margin (_t:([< `V1 | `V2 | `V3 | `V4 | `V5] as 'v) t) ~top ~right ~bottom ~left =
    let _msg = Proxy.alloc _t ~op:3 ~ints:4 ~strings:[] ~arrays:[] in
    Msg.add_int _msg top;
    Msg.add_int _msg right;
    Msg.add_int _msg bottom;
    Msg.add_int _msg left;
    Proxy.send _t _msg
  
  (** Configures the exclusive geometry of this surface.
      
      Requests that the compositor avoids occluding an area with other
      surfaces. The compositor's use of this information is
      implementation-dependent - do not assume that this region will not
      actually be occluded.
      
      A positive value is only meaningful if the surface is anchored to one
      edge or an edge and both perpendicular edges. If the surface is not
      anchored, anchored to only two perpendicular edges (a corner), anchored
      to only two parallel edges or anchored to all edges, a positive value
      will be treated the same as zero.
      
      A positive zone is the distance from the edge in surface-local
      coordinates to consider exclusive.
      
      Surfaces that do not wish to have an exclusive zone may instead specify
      how they should interact with surfaces that do. If set to zero, the
      surface indicates that it would like to be moved to avoid occluding
      surfaces with a positive exclusive zone. If set to -1, the surface
      indicates that it would not like to be moved to accommodate for other
      surfaces, and the compositor should extend it all the way to the edges
      it is anchored to.
      
      For example, a panel might set its exclusive zone to 10, so that
      maximized shell surfaces are not shown on top of it. A notification
      might set its exclusive zone to 0, so that it is moved to avoid
      occluding the panel, but shell surfaces are shown underneath it. A
      wallpaper or lock screen might set their exclusive zone to -1, so that
      they stretch below or over the panel.
      
      The default value is 0.
      
      Exclusive zone is double-buffered, see wl_surface.commit. *)
  let set_exclusive_zone (_t:([< `V1 | `V2 | `V3 | `V4 | `V5] as 'v) t) 
    ~zone =
    let _msg = Proxy.alloc _t ~op:2 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg zone;
    Proxy.send _t _msg
  
  (** Configures the anchor point of the surface.
      
      Requests that the compositor anchor the surface to the specified edges
      and corners. If two orthogonal edges are specified (e.g. 'top' and
      'left'), then the anchor point will be the intersection of the edges
      (e.g. the top left corner of the output); otherwise the anchor point
      will be centered on that edge, or in the center if none is specified.
      
      Anchor is double-buffered, see wl_surface.commit. *)
  let set_anchor (_t:([< `V1 | `V2 | `V3 | `V4 | `V5] as 'v) t) ~anchor =
    let _msg = Proxy.alloc _t ~op:1 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Imports.Zwlr_layer_surface_v1.Anchor.to_int32 anchor);
    Proxy.send _t _msg
  
  (** Sets the size of the surface.
      
      Sets the size of the surface in surface-local coordinates. The
      compositor will display the surface centered with respect to its
      anchors.
      
      If you pass 0 for either value, the compositor will assign it and
      inform you of the assignment in the configure event. You must set your
      anchor to opposite edges in the dimensions you omit; not doing so is a
      protocol error. Both values are 0 by default.
      
      Size is double-buffered, see wl_surface.commit. *)
  let set_size (_t:([< `V1 | `V2 | `V3 | `V4 | `V5] as 'v) t) ~width ~height =
    let _msg = Proxy.alloc _t ~op:0 ~ints:2 ~strings:[] ~arrays:[] in
    Msg.add_int _msg width;
    Msg.add_int _msg height;
    Proxy.send _t _msg
  
  
  (** {2 Version 2, 3, 4} *)
  
  (** Change the layer of the surface.
      
      Change the layer that the surface is rendered on.
      
      Layer is double-buffered, see wl_surface.commit. *)
  let set_layer (_t:([< `V2 | `V3 | `V4 | `V5] as 'v) t) ~layer =
    let _msg = Proxy.alloc _t ~op:8 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Imports.Zwlr_layer_shell_v1.Layer.to_int32 layer);
    Proxy.send _t _msg
  
  
  (** {2 Version 5} *)
  
  (** Set the edge the exclusive zone will be applied to.
      
      Requests an edge for the exclusive zone to apply. The exclusive
      edge will be automatically deduced from anchor points when possible,
      but when the surface is anchored to a corner, it will be necessary
      to set it explicitly to disambiguate, as it is not possible to deduce
      which one of the two corner edges should be used.
      
      The edge must be one the surface is anchored to, otherwise the
      invalid_exclusive_edge protocol error will be raised. *)
  let set_exclusive_edge (_t:([< `V5] as 'v) t) ~edge =
    let _msg = Proxy.alloc _t ~op:9 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Imports.Zwlr_layer_surface_v1.Anchor.to_int32 edge);
    Proxy.send _t _msg
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Wlr_layer_shell_unstable_v1_proto.Zwlr_layer_surface_v1)
    method max_version = 5l
    
    method private virtual on_configure : [> ] t -> serial:int32 -> width:int32 -> height:int32 -> unit
    
    method private virtual on_closed : [> ] t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let serial = Msg.get_int _msg in
        let width = Msg.get_int _msg in
        let height = Msg.get_int _msg in
        _self#on_configure _proxy ~serial ~width ~height
      | 1 ->
        _self#on_closed _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 | `V3 | `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_configure : [> `V1 | `V2 | `V3 | `V4 | `V5] t -> serial:int32 -> width:int32 ->
                                          height:int32 -> unit
    
    (** Suggest a surface change.
        
        The configure event asks the client to resize its surface.
        
        Clients should arrange their surface for the new states, and then send
        an ack_configure request with the serial sent in this configure event at
        some point before committing the new surface.
        
        The client is free to dismiss all but the last configure event it
        received.
        
        The width and height arguments specify the size of the window in
        surface-local coordinates.
        
        The size is a hint, in the sense that the client is free to ignore it if
        it doesn't resize, pick a smaller size (to satisfy aspect ratio or
        resize in steps of NxM pixels). If the client picks a smaller size and
        is anchored to two opposite anchors (e.g. 'top' and 'bottom'), the
        surface will be centered on this axis.
        
        If the width or height arguments are zero, it means the client should
        decide its own window dimension. *)
    
    method private virtual on_closed : [> `V1 | `V2 | `V3 | `V4 | `V5] t -> unit
    
    (** Surface should be closed.
        
        The closed event is sent by the compositor when the surface will no
        longer be shown. The output may have been destroyed or the user may
        have asked for it to be removed. Further changes to the surface will be
        ignored. The client should destroy the resource after receiving this
        event, and create a new surface if they so choose. *)
    
    method min_version = 1l
  end
  
  (** Handler for a proxy with version >= 2. *)
  class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V2 | `V3 | `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_configure : [> `V2 | `V3 | `V4 | `V5] t -> serial:int32 -> width:int32 -> height:int32 ->
                                          unit
    
    (** Suggest a surface change.
        
        The configure event asks the client to resize its surface.
        
        Clients should arrange their surface for the new states, and then send
        an ack_configure request with the serial sent in this configure event at
        some point before committing the new surface.
        
        The client is free to dismiss all but the last configure event it
        received.
        
        The width and height arguments specify the size of the window in
        surface-local coordinates.
        
        The size is a hint, in the sense that the client is free to ignore it if
        it doesn't resize, pick a smaller size (to satisfy aspect ratio or
        resize in steps of NxM pixels). If the client picks a smaller size and
        is anchored to two opposite anchors (e.g. 'top' and 'bottom'), the
        surface will be centered on this axis.
        
        If the width or height arguments are zero, it means the client should
        decide its own window dimension. *)
    
    method private virtual on_closed : [> `V2 | `V3 | `V4 | `V5] t -> unit
    
    (** Surface should be closed.
        
        The closed event is sent by the compositor when the surface will no
        longer be shown. The output may have been destroyed or the user may
        have asked for it to be removed. Further changes to the surface will be
        ignored. The client should destroy the resource after receiving this
        event, and create a new surface if they so choose. *)
    
    method min_version = 2l
  end
  
  (** Handler for a proxy with version >= 3. *)
  class virtual ['v] v3 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V3 | `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_configure : [> `V3 | `V4 | `V5] t -> serial:int32 -> width:int32 -> height:int32 -> unit
    
    (** Suggest a surface change.
        
        The configure event asks the client to resize its surface.
        
        Clients should arrange their surface for the new states, and then send
        an ack_configure request with the serial sent in this configure event at
        some point before committing the new surface.
        
        The client is free to dismiss all but the last configure event it
        received.
        
        The width and height arguments specify the size of the window in
        surface-local coordinates.
        
        The size is a hint, in the sense that the client is free to ignore it if
        it doesn't resize, pick a smaller size (to satisfy aspect ratio or
        resize in steps of NxM pixels). If the client picks a smaller size and
        is anchored to two opposite anchors (e.g. 'top' and 'bottom'), the
        surface will be centered on this axis.
        
        If the width or height arguments are zero, it means the client should
        decide its own window dimension. *)
    
    method private virtual on_closed : [> `V3 | `V4 | `V5] t -> unit
    
    (** Surface should be closed.
        
        The closed event is sent by the compositor when the surface will no
        longer be shown. The output may have been destroyed or the user may
        have asked for it to be removed. Further changes to the surface will be
        ignored. The client should destroy the resource after receiving this
        event, and create a new surface if they so choose. *)
    
    method min_version = 3l
  end
  
  (** Handler for a proxy with version >= 4. *)
  class virtual ['v] v4 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V4 | `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_configure : [> `V4 | `V5] t -> serial:int32 -> width:int32 -> height:int32 -> unit
    
    (** Suggest a surface change.
        
        The configure event asks the client to resize its surface.
        
        Clients should arrange their surface for the new states, and then send
        an ack_configure request with the serial sent in this configure event at
        some point before committing the new surface.
        
        The client is free to dismiss all but the last configure event it
        received.
        
        The width and height arguments specify the size of the window in
        surface-local coordinates.
        
        The size is a hint, in the sense that the client is free to ignore it if
        it doesn't resize, pick a smaller size (to satisfy aspect ratio or
        resize in steps of NxM pixels). If the client picks a smaller size and
        is anchored to two opposite anchors (e.g. 'top' and 'bottom'), the
        surface will be centered on this axis.
        
        If the width or height arguments are zero, it means the client should
        decide its own window dimension. *)
    
    method private virtual on_closed : [> `V4 | `V5] t -> unit
    
    (** Surface should be closed.
        
        The closed event is sent by the compositor when the surface will no
        longer be shown. The output may have been destroyed or the user may
        have asked for it to be removed. Further changes to the surface will be
        ignored. The client should destroy the resource after receiving this
        event, and create a new surface if they so choose. *)
    
    method min_version = 4l
  end
  
  (** Handler for a proxy with version >= 5. *)
  class virtual ['v] v5 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V5] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_configure : [> `V5] t -> serial:int32 -> width:int32 -> height:int32 -> unit
    
    (** Suggest a surface change.
        
        The configure event asks the client to resize its surface.
        
        Clients should arrange their surface for the new states, and then send
        an ack_configure request with the serial sent in this configure event at
        some point before committing the new surface.
        
        The client is free to dismiss all but the last configure event it
        received.
        
        The width and height arguments specify the size of the window in
        surface-local coordinates.
        
        The size is a hint, in the sense that the client is free to ignore it if
        it doesn't resize, pick a smaller size (to satisfy aspect ratio or
        resize in steps of NxM pixels). If the client picks a smaller size and
        is anchored to two opposite anchors (e.g. 'top' and 'bottom'), the
        surface will be centered on this axis.
        
        If the width or height arguments are zero, it means the client should
        decide its own window dimension. *)
    
    method private virtual on_closed : [> `V5] t -> unit
    
    (** Surface should be closed.
        
        The closed event is sent by the compositor when the surface will no
        longer be shown. The output may have been destroyed or the user may
        have asked for it to be removed. Further changes to the surface will be
        ignored. The client should destroy the resource after receiving this
        event, and create a new surface if they so choose. *)
    
    method min_version = 5l
  end
end