i3ipc 0.2 · OCaml Package

Type definitions for the command replies.

type command_outcome = {

success : bool;
error : string option;

}

type rect = {

x : int;
y : int;
width : int;
height : int;

}

type workspace = {

num : int;
name : string;
visible : bool;
focused : bool;
urgent : bool;
rect : rect;
output : string;

}

type output = {

name : string;
active : bool;
primary : bool;
current_workspace : string option;
rect : rect;

}

type node_type =

| Root
| Output
| Con
| Floating_con
| Workspace
| Dockarea

type node_border =

| Border_normal
| Border_none
| Border_pixel

type node_layout =

| SplitH
| SplitV
| Stacked
| Tabbed
| Dockarea
| Output
| Unknown of string

type window_properties = {

class_ : string option;
instance : string option;
title : string option;
transient_for : string option;
window_role : string option;

}

type node_id = string

type node = {

nodes : node list;
floating_nodes : node list;
id : node_id;
name : string option;
num : int option;
nodetype : node_type;
border : node_border;
current_border_width : int;
layout : node_layout;
percent : float option;
rect : rect;
window_rect : rect;
deco_rect : rect;
geometry : rect;
window : int option;
window_properties : window_properties option;
urgent : bool;
focused : bool;
focus : node_id list;

}

type mark = string

type bar_id = string

type colorable_bar_part =

| Background
| Statusline
| Separator
| FocusedBackground
| FocusedStatusline
| FocusedSeparator
| FocusedWorkspaceText
| FocusedWorkspaceBackground
| FocusedWorkspaceBorder
| ActiveWorkspaceText
| ActiveWorkspaceBackground
| ActiveWorkspaceBorder
| InactiveWorkspaceText
| InactiveWorkspaceBackground
| InactiveWorkspaceBorder
| UrgentWorkspaceText
| UrgentWorkspaceBackground
| UrgentWorkspaceBorder
| BindingModeText
| BindingModeBackground
| BindingModeBorder
| Undocumented of string

module Bar_parts_map : Stdlib.Map.S with type key = colorable_bar_part

type bar_colors = string Bar_parts_map.t

type bar_config = {

id : string;
mode : string;
position : string;
status_command : string;
font : string;
workspace_buttons : bool;
binding_mode_indicator : bool;
verbose : bool;
colors : bar_colors;

}

type version = {

major : int;
minor : int;
patch : int;
human_readable : string;
loaded_config_file_name : string;

}

type binding_modes = string list

type config = {

config : string;

}

Pretty-printing

val pp_command_outcome : Stdlib.Format.formatter -> command_outcome -> unit

val pp_rect : Stdlib.Format.formatter -> rect -> unit

val pp_workspace : Stdlib.Format.formatter -> workspace -> unit

val pp_output : Stdlib.Format.formatter -> output -> unit

val pp_node_type : Stdlib.Format.formatter -> node_type -> unit

val pp_node_border : Stdlib.Format.formatter -> node_border -> unit

val pp_node_layout : Stdlib.Format.formatter -> node_layout -> unit

val pp_node : Stdlib.Format.formatter -> node -> unit

val pp_colorable_bar_part : 
  Stdlib.Format.formatter ->
  colorable_bar_part ->
  unit

val pp_bar_colors : Stdlib.Format.formatter -> bar_colors -> unit

val pp_bar_config : Stdlib.Format.formatter -> bar_config -> unit

val pp_version : Stdlib.Format.formatter -> version -> unit

val pp_binding_modes : Stdlib.Format.formatter -> binding_modes -> unit

val pp_config : Stdlib.Format.formatter -> config -> unit

package i3ipc

Pretty-printing