From 5062dd61bc991988a146f298f4b8ed4ea81290a8 Mon Sep 17 00:00:00 2001 From: Michael Stapelberg Date: Sat, 16 Sep 2017 17:28:44 +0200 Subject: [PATCH] ipc: tree reply: document focus, nodes and floating_nodes (#2955) MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit 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 | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/ipc b/docs/ipc index 65723577..ab2997fd 100644 --- 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 -- 2.39.2