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 (2)

Authors

  1. 3
    3L0C

Maintainers

  1. 3
    3L0C

Sources

v0.1.1.tar.gz
md5=a182e6d368a65e6752771e41e651713f
sha512=020d2c7f9f4e06966ca56695e24eb0b41dd12500aa65d2cd9b56e03068bbb6ea7770de0a33c04f0d054bd474bee8c2b36bb46af86266c9823490e1bd0810c027

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

Module Oxbow_state.ConfigSource

include module type of Types.Config
Sourcemodule Border : sig ... end
Sourcemodule Data : sig ... end
Sourcemodule Rules : sig ... end
Sourcemodule Spawn : sig ... end
Sourcetype t = {
  1. default_tag_config : Data.t;
  2. mutable default_overview_gaps : int;
  3. borders : Border.t;
  4. mutable cursor_theme : (string * int32) option;
  5. mutable modes : Oxbow_core.Mode.t list;
  6. mutable modkey : Wire.Modifiers.t;
  7. rules : Rules.t;
  8. spawn : Spawn.t;
  9. mutable focus_follows_pointer : Oxbow_core.Focus_follows_policy.t;
  10. mutable warp_on_focus : bool;
  11. mutable drag_retile : bool;
  12. mutable repeat_rate : int;
  13. mutable repeat_delay : int;
}
Sourceval create_tag_data : unit -> Data.t

create_tag_data () is the default Data.t configuration.

Sourceval default : unit -> t

default () is the default config.

Sourceval set_focus_follows_pointer : Types.Wm.t -> Oxbow_core.Focus_follows_policy.t -> unit

set_focus_follows_pointer wm policy sets the focus follows pointer policy for wm.

Effects: mutates WM state

Sourceval set_warp_on_focus : Types.Wm.t -> bool -> unit

set_warp_on_focus wm warp_on_focus sets wm's "warp on focus" flag to warp_on_focus.

Effects: mutates WM state

Sourceval set_drag_retile : Types.Wm.t -> bool -> unit

set_drag_retile wm b sets wm's drag retile flag to b.

Effects: mutates WM state

Sourceval set_border_width : Types.Wm.t -> int32 -> (Yojson.Safe.t option, string) result

set_border_width wm width sets wm's border width to width. Is Error msg when width is negative.

Effects: mutates WM state

Sourceval set_cursor_theme : Types.Wm.t -> (string * int32) option -> unit

set_cursor_theme wm cursor_theme sets wm's cursor theme to cursor_theme.

Effects: mutates WM state

Sourceval set_key_repeat : Types.Wm.t -> rate:int -> delay:int -> unit

set_key_repeat wm ~rate ~delay sets the key repeat rate and delay.

Effects: mutates WM state

set_border_color wm border color sets the target border type to color.

Effects: mutates WM state

Sourceval set_default_width : Data.t -> delta:float Oxbow_core.Delta.t -> unit

set_default_width td ~delta applies delta to the default column width of td.

Effects: mutates WM state

Sourceval set_float_seed : Data.t -> seed:Oxbow_core.Extent.t -> unit

set_float_seed td ~seed sets the float seed of td to seed.

Effects: mutates WM state

Sourceval set_spawn_position : Types.Wm.t -> Oxbow_core.Spawn_position.t -> unit

set_spawn_position wm position sets position as the spawn position of new windows for wm.

Effects: mutates WM state

Sourceval set_spawn_focus : Types.Wm.t -> bool -> unit

set_spawn_focus wm b sets wm's focus on spawn to b.

Effects: mutates WM state

Sourceval copy_tag_data : Data.t -> Data.t

copy_tag_data td is a copy of td that shares no mutable record with td.

Sourceval reset_data : Data.t -> unit

reset_data data restores every field of data to the defaults.

Sourceval reset : Types.Wm.t -> all:bool -> unit

reset wm ~all restores the configured tag data, and overview gaps of every output. When all is true rules, modes, and labels are also reset.

Effects: mutates WM state

Sourceval add_window_rule : Types.Wm.t -> Oxbow_core.Window_rule.t -> unit

add_window_rule wm rule adds window rule defined by rule to wm's configuration.

Effects: mutates WM state

Sourceval remove_window_rule : Types.Wm.t -> int -> unit

remove_window_rule wm index removes the window rule at index from wm's configuration.

Effects: mutates WM state

Sourceval replace_window_rule : Types.Wm.t -> Oxbow_core.Window_rule.t -> unit

replace_window_rule wm rule replaces any window rule in wm with the same pattern as rule.

Effects: mutates WM state

Sourceval add_input_rule : Types.Wm.t -> Oxbow_core.Input_rule.t -> unit

add_input_rule wm rule adds input rule defined by rule to wm's configuration.

Effects: mutates WM state

Sourceval remove_input_rule : Types.Wm.t -> int -> unit

remove_input_rule wm index removes the input rule at index from wm's configuration.

Effects: mutates WM state

Sourceval replace_input_rule : Types.Wm.t -> Oxbow_core.Input_rule.t -> unit

replace_input_rule wm rule replaces any input rule in wm that matches rule.

Effects: mutates WM state

Sourceval declare_mode : Types.Wm.t -> Oxbow_core.Mode.t -> unit

declare_mode wm name appends name to the declared modes.

Effects: mutates WM state

Sourceval remove_rules : Types.Wm.t -> [ `Window | `Input ] -> int list -> (Yojson.Safe.t option, string) result

remove_rules wm kind indices removes the rules based on kind indexed by indices. Is Error msg if indices contains any invalid index.

Effects: mutates WM state

Sourceval apply_default_overview_gaps : Types.Wm.t -> delta:int Oxbow_core.Delta.t -> unit

apply_default_overview_gaps wm ~delta applies delta to wm's default overview gaps.

Effects: mutates WM state