package oxbow

  1. Overview
  2. Docs
Dynamic window manager for the river Wayland compositor

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (1)

Authors

  1. 3
    3L0C

Maintainers

  1. 3
    3L0C

Sources

v0.1.0.tar.gz
md5=a637acaa0e19046cd65fff733874eb97
sha512=76230cbecd7510de7a05b5d1f335915ef7b6c4aa557d8dbfd23591606618d2cfa25082d17b93f2f4b53a118d1cbf6a80e4ad51cf0f099b4921fb83d6df0c9801

doc/oxbow.state/Oxbow_state/Seat/index.html

Module Oxbow_state.SeatSource

include module type of Types.Seat
Sourcemodule Lifecycle : sig ... end
Sourcemodule Layer_focus : sig ... end
Sourcemodule Position : sig ... end
Sourcemodule Focus_state : sig ... end
Sourcemodule Op : sig ... end
Sourcemodule Xkb_binding : sig ... end
Sourcemodule Pointer_binding : sig ... end
Sourcemodule Warp_request : sig ... end
type t = {
  1. obj : Wire.Obj.Window_management.Seat.t;
  2. layer_shell : Wire.Obj.Layer_shell.Seat.t;
  3. xkb_seat : Wire.Obj.Xkb.Bindings.Seat.t;
  4. mutable overview_watch : int32;
  5. mutable watch_sent : int32;
  6. mutable lifecycle : Lifecycle.t;
  7. mutable name : string option;
  8. mutable output : Types.Output.t option;
  9. mutable focus_cleared : bool;
  10. mutable position : Position.t;
  11. mutable layer_focus : Layer_focus.t option;
  12. mutable mode : Oxbow_core.Mode.t;
  13. mutable xkb_bindings : Xkb_binding.t list;
  14. mutable pointer_bindings : Pointer_binding.t list;
  15. mutable pending_requests : Pending_request.t Queue.t;
  16. mutable hovered : Types.Window.t option;
  17. mutable interacted : Types.Window.t option;
  18. mutable warp_request : Warp_request.t;
  19. mutable focus_state : Focus_state.t;
  20. mutable cursor_target : Types.Window.t option;
  21. mutable op : Op.t option;
}
Sourceval refresh_cursor_target : t -> unit

refresh_cursor_target seat syncs seat's cursor targed with seat's hovered if hovered is Some window. No-op when hovered is None.

Effects: mutates WM state

Sourceval queue_pending : t -> Pending_request.t -> unit

queue_pending seat request adds request to seat's queue.

Effects: mutates WM state

Sourceval drain_pending : t -> Pending_request.t option

drain_pending seat removes and returns the next pending request on seat, or None when the queue is empty.

Effects: mutates WM state

Sourceval clear_pending : t -> unit

clear_pending seat discards every pending request on seat.

Effects: mutates WM state

Sourceval set_output : t -> Types.Output.t option -> unit

set_output seat output sets seat's output to output.

Effects: mutates WM state

Sourceval set_focus_cleared : t -> bool -> unit

set_focus_cleared seat cleared sets seat's focus cleared state to cleared.

Effects: mutates WM state

Sourceval focus_output : t -> Types.Output.t option -> unit

focus_output seat output moves seat's focus to output if output is not already focused.

Effects: mutates WM state

Sourceval set_layer_focus : t -> Layer_focus.t option -> unit

set_layer_focus seat layer sets seat's focused layer to layer.

Effects: mutates WM state

Sourceval set_mode : t -> Oxbow_core.Mode.t -> (unit, string) result

set_mode seat mode sets seat's current mode to mode. Is Error msg when mode is Mode.locked.

Effects: mutates WM state

Sourceval set_position : t -> (int32 * int32) -> unit

set_position seat (x, y) positions seat at (x, y).

Effects: mutates WM state

Sourceval set_cursor_target : t -> Types.Window.t option -> unit

set_cursor_target seat cursor_target sets seat's cursor target to cursor_target.

Effects: mutates WM state

Sourceval set_focus_state : t -> Focus_state.t -> unit

set_focus_state seat state sets seat's focus state to state.

Effects: mutates WM state

Sourceval set_op : t -> Op.t -> unit

set_op seat op sets seat's current operation to op.

Effects: mutates WM state

Sourceval clear_op : t -> unit

clear_op seat clears the current operation on seat.

Effects: mutates WM state

Sourceval set_op_delta : t -> int32 -> int32 -> unit

set_op_delta seat dx dy updates seat's current operation deltas.

Effects: mutates WM state

Sourceval release_op : t -> unit

release_op seat flags seat's current operation for release. No-op when seat has no operation.

Effects: mutates WM state

Sourceval set_lifecycle : t -> Lifecycle.t -> unit

set_lifecycle seat lifecycle sets seat's lifecycle to lifecycle.

Effects: mutates WM state

Sourceval set_name : t -> string option -> unit

set_name seat name sets seat's name to name.

Effects: mutates WM state

Sourceval set_hovered : t -> Types.Window.t option -> unit

set_hovered seat hovered sets seat's hovered window to hovered.

Effects: mutates WM state

Sourceval set_interacted : t -> Types.Window.t option -> unit

set_interacted seat interacted sets seat's interacted window to interacted.

Effects: mutates WM state

Sourceval set_warp_request : t -> Warp_request.t -> unit

set_warp_pending seat pending sets seat's warp pending flag to pending.

Effects: mutates WM state

Sourceval set_overview_watch : t -> int32 -> unit

set_overview_watch seat watch sets watch as seat's watched modifiers for overview mode.

Effects: mutates WM state

Sourceval set_watch_sent : t -> int32 -> unit

set_watch_sent seat sent sets sent as seat's watched modifiers.

Effects: mutates WM state

Sourceval bind : Types.Wm.t -> t -> ?mode:Oxbow_core.Mode.t -> int32 -> Types.Key.t -> Oxbow_ipc.Command.t -> bool

bind wm seat ?mode mods key command binds the mods and key to command in mode (default Mode.normal). Replaces any existing binding for mods and key. Is true when an existing binding for mods and key was replaced.

Effects: mutates WM state

Sourceval unbind : t -> ?mode:Oxbow_core.Mode.t -> int32 -> Types.Key.t -> bool

unbind seat ?mode mods key unbinds the command bound to mods and key in mode (default Mode.normal). Is true when a binding was destroyed.

Effects: mutates WM state

Sourceval clear_bindings : t -> unit

clear_bindings s destroys every pointer and key bind of s.

Effects: mutates WM state

Sourceval focused_window : t -> Types.Window.t option

focused_window seat is the focused window on seat's output; None when the seat has no output.