ipc: tree reply: document focus, nodes and floating_nodes (#2955)

[i3/i3] / docs / ipc

diff --git a/docs/ipc b/docs/ipc
index 25961f78ec790c328e3bd0a62f305aa8923fe250..ab2997fd4f72292b0a683740bc82aa9bd142f5a6 100644 (file)
--- a/docs/ipc
+++ b/docs/ipc
@@ -338,6 +338,16 @@ urgent (bool)::
        Whether this container (window or workspace) has the urgency hint set.
 focused (bool)::
        Whether this container is currently focused.
+focus (array of integer)::
+       List of child node IDs (see +nodes+, +floating_nodes+ and +id+) in focus
+       order. Traversing the tree by following the first entry in this array
+       will result in eventually reaching the one node with +focused+ set to
+       true.
+nodes (array of node)::
+       The tiling (i.e. non-floating) child containers of this node.
+floating_nodes (array of node)::
+       The floating child containers of this node. Only non-empty on nodes with
+       type +workspace+.
 
 Please note that in the following example, I have left out some keys/values
 which are not relevant for the type of the node. Otherwise, the example would
@@ -698,9 +708,9 @@ if ($is_event) {
 
 This event consists of a single serialized map containing a property
 +change (string)+ which indicates the type of the change ("focus", "init",
-"empty", "urgent", "reload", "rename", "restored"). A +current (object)+
-property will be present with the affected workspace whenever the type of event
-affects a workspace (otherwise, it will be +null).
+"empty", "urgent", "reload", "rename", "restored", "move"). A
++current (object)+ property will be present with the affected workspace
+whenever the type of event affects a workspace (otherwise, it will be +null).
 
 When the change is "focus", an +old (object)+ property will be present with the
 previous workspace.  When the first switch occurs (when i3 focuses the
@@ -795,7 +805,7 @@ same as a +GET_BAR_CONFIG+ reply for the bar with the given id.
 === binding event
 
 This event consists of a single serialized map reporting on the details of a
-binding that ran a command because of user input. The +change (sring)+ field
+binding that ran a command because of user input. The +change (string)+ field
 indicates what sort of binding event was triggered (right now it will always be
 +"run"+ but may be expanded in the future).
 
@@ -877,3 +887,5 @@ Ruby::
        * https://github.com/badboy/i3-ipc (not maintained)
 Rust::
        * https://github.com/tmerr/i3ipc-rs
+OCaml::
+       * https://github.com/Armael/ocaml-i3ipc