package i3ipc

  1. Overview
  2. Docs
On This Page
  1. Pretty-printing
package i3ipc
Legend:
Library
Module
Module type
Parameter
Class
Class type

Type definitions for the command replies.

type command_outcome = {
  1. success : bool;
  2. error : string option;
}
type rect = {
  1. x : int;
  2. y : int;
  3. width : int;
  4. height : int;
}
type workspace = {
  1. num : int;
  2. name : string;
  3. visible : bool;
  4. focused : bool;
  5. urgent : bool;
  6. rect : rect;
  7. output : string;
}
type output = {
  1. name : string;
  2. active : bool;
  3. primary : bool;
  4. current_workspace : string option;
  5. rect : rect;
}
type node_type =
  1. | Root
  2. | Output
  3. | Con
  4. | Floating_con
  5. | Workspace
  6. | Dockarea
type node_border =
  1. | Border_normal
  2. | Border_none
  3. | Border_pixel
type node_layout =
  1. | SplitH
  2. | SplitV
  3. | Stacked
  4. | Tabbed
  5. | Dockarea
  6. | Output
  7. | Unknown of string
type x11_window_id = int
type window_properties = {
  1. class_ : string option;
  2. instance : string option;
  3. title : string option;
  4. transient_for : x11_window_id option;
  5. window_role : string option;
}
type node_id = string
type node = {
  1. nodes : node list;
  2. floating_nodes : node list;
  3. id : node_id;
  4. name : string option;
  5. num : int option;
  6. nodetype : node_type;
  7. border : node_border;
  8. current_border_width : int;
  9. layout : node_layout;
  10. percent : float option;
  11. rect : rect;
  12. window_rect : rect;
  13. deco_rect : rect;
  14. geometry : rect;
  15. window : x11_window_id option;
  16. window_properties : window_properties option;
  17. urgent : bool;
  18. focused : bool;
  19. focus : node_id list;
}
type mark = string
type bar_id = string
type colorable_bar_part =
  1. | Background
  2. | Statusline
  3. | Separator
  4. | FocusedBackground
  5. | FocusedStatusline
  6. | FocusedSeparator
  7. | FocusedWorkspaceText
  8. | FocusedWorkspaceBackground
  9. | FocusedWorkspaceBorder
  10. | ActiveWorkspaceText
  11. | ActiveWorkspaceBackground
  12. | ActiveWorkspaceBorder
  13. | InactiveWorkspaceText
  14. | InactiveWorkspaceBackground
  15. | InactiveWorkspaceBorder
  16. | UrgentWorkspaceText
  17. | UrgentWorkspaceBackground
  18. | UrgentWorkspaceBorder
  19. | BindingModeText
  20. | BindingModeBackground
  21. | BindingModeBorder
  22. | Undocumented of string
type bar_colors = string Bar_parts_map.t
type bar_config = {
  1. id : string;
  2. mode : string;
  3. position : string;
  4. status_command : string;
  5. font : string;
  6. workspace_buttons : bool;
  7. binding_mode_indicator : bool;
  8. verbose : bool;
  9. colors : bar_colors;
}
type version = {
  1. major : int;
  2. minor : int;
  3. patch : int;
  4. human_readable : string;
  5. loaded_config_file_name : string;
}
type binding_modes = string list
type config = {
  1. config : string;
}

Pretty-printing

val pp_command_outcome : Format.formatter -> command_outcome -> unit
val pp_rect : Format.formatter -> rect -> unit
val pp_workspace : Format.formatter -> workspace -> unit
val pp_output : Format.formatter -> output -> unit
val pp_node_type : Format.formatter -> node_type -> unit
val pp_node_border : Format.formatter -> node_border -> unit
val pp_node_layout : Format.formatter -> node_layout -> unit
val pp_node : Format.formatter -> node -> unit
val pp_colorable_bar_part : Format.formatter -> colorable_bar_part -> unit
val pp_bar_colors : Format.formatter -> bar_colors -> unit
val pp_bar_config : Format.formatter -> bar_config -> unit
val pp_version : Format.formatter -> version -> unit
val pp_binding_modes : Format.formatter -> binding_modes -> unit
val pp_config : Format.formatter -> config -> unit
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct