]> git.sur5r.net Git - i3/i3/commitdiff
ipc: tree reply: document focus, nodes and floating_nodes (#2955)
authorMichael Stapelberg <stapelberg@users.noreply.github.com>
Sat, 16 Sep 2017 15:28:44 +0000 (17:28 +0200)
committerGitHub <noreply@github.com>
Sat, 16 Sep 2017 15:28:44 +0000 (17:28 +0200)
These haven’t ever changed, but were only included in the example, not in the
list, so people might not have realized that these are safe for use.

docs/ipc

index 6572357704a92064a0b33cb7c830f22f10623e5d..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