Add missing items to documentation for GET_TREE response in ipc.

A few items in the response for the get_tree ipc call were missing from
the documentation. This adds some documentation for them.
This commit is contained in:
Thayne McCombs 2020-01-05 00:20:02 -07:00 committed by Drew DeVault
parent 2aecf93fd7
commit e786eda2cb

View file

@ -315,6 +315,9 @@ node and will have the following properties:
: string : string
: The node's layout. It can either be _splith_, _splitv_, _stacked_, : The node's layout. It can either be _splith_, _splitv_, _stacked_,
_tabbed_, or _output_ _tabbed_, or _output_
|- orientation
: string
: The node's orientation. It can be _vertical_, _horizontal_, or _none_
|- percent |- percent
: float : float
: The percentage of the node's parent that it takes up or _null_ for the root : The percentage of the node's parent that it takes up or _null_ for the root
@ -337,6 +340,9 @@ node and will have the following properties:
: boolean : boolean
: Whether the node or any of its descendants has the urgent hint set. Note: : Whether the node or any of its descendants has the urgent hint set. Note:
This may not exist when compiled without _xwayland_ support This may not exist when compiled without _xwayland_ support
|- sticky
: boolean
: Whether the node is sticky (shows on all workspaces)
|- focused |- focused
: boolean : boolean
: Whether the node is currently focused by the default seat (_seat0_) : Whether the node is currently focused by the default seat (_seat0_)
@ -353,6 +359,10 @@ node and will have the following properties:
: string : string
: (Only workspaces) A string representation of the layout of the workspace : (Only workspaces) A string representation of the layout of the workspace
that can be used as an aid in submitting reproduction steps for bug reports that can be used as an aid in submitting reproduction steps for bug reports
|- fullscreen_mode
: integer
: (Only containers and views) The fullscreen mode of the node. 0 means none, 1 means
full workspace, and 2 means global fullscreen
|- app_id |- app_id
: string : string
: (Only views) For an xdg-shell view, the name of the application, if set. : (Only views) For an xdg-shell view, the name of the application, if set.
@ -360,6 +370,9 @@ node and will have the following properties:
|- pid |- pid
: integer : integer
: (Only views) The PID of the application that owns the view : (Only views) The PID of the application that owns the view
|- visible
: boolean
: (Only views) Whether the node is visible
|- window |- window
: integer : integer
: (Only xwayland views) The X11 window ID for the xwayland view : (Only xwayland views) The X11 window ID for the xwayland view
@ -387,6 +400,7 @@ node and will have the following properties:
"border": "none", "border": "none",
"current_border_width": 0, "current_border_width": 0,
"layout": "splith", "layout": "splith",
"orientation": "horizontal",
"percent": null, "percent": null,
"window_rect": { "window_rect": {
"x": 0, "x": 0,
@ -410,6 +424,7 @@ node and will have the following properties:
"urgent": false, "urgent": false,
"floating_nodes": [ "floating_nodes": [
], ],
"sticky": false,
"type": "root", "type": "root",
"nodes": [ "nodes": [
{ {
@ -428,6 +443,7 @@ node and will have the following properties:
"border": "none", "border": "none",
"current_border_width": 0, "current_border_width": 0,
"layout": "output", "layout": "output",
"orientation": "horizontal",
"percent": null, "percent": null,
"window_rect": { "window_rect": {
"x": 0, "x": 0,
@ -451,6 +467,7 @@ node and will have the following properties:
"urgent": false, "urgent": false,
"floating_nodes": [ "floating_nodes": [
], ],
"sticky": false,
"type": "output", "type": "output",
"nodes": [ "nodes": [
{ {
@ -468,6 +485,7 @@ node and will have the following properties:
"border": "none", "border": "none",
"current_border_width": 0, "current_border_width": 0,
"layout": "splith", "layout": "splith",
"orientation": "horizontal",
"percent": null, "percent": null,
"window_rect": { "window_rect": {
"x": 0, "x": 0,
@ -491,6 +509,7 @@ node and will have the following properties:
"urgent": false, "urgent": false,
"floating_nodes": [ "floating_nodes": [
], ],
"sticky": false,
"type": "workspace" "type": "workspace"
} }
] ]
@ -511,6 +530,7 @@ node and will have the following properties:
"border": "none", "border": "none",
"current_border_width": 0, "current_border_width": 0,
"layout": "output", "layout": "output",
"orientation": "none",
"percent": 1.0, "percent": 1.0,
"window_rect": { "window_rect": {
"x": 0, "x": 0,
@ -534,6 +554,7 @@ node and will have the following properties:
"urgent": false, "urgent": false,
"floating_nodes": [ "floating_nodes": [
], ],
"sticky": false,
"type": "output", "type": "output",
"active": true, "active": true,
"primary": false, "primary": false,
@ -573,6 +594,7 @@ node and will have the following properties:
"border": "none", "border": "none",
"current_border_width": 0, "current_border_width": 0,
"layout": "splith", "layout": "splith",
"orientation": "horizontal",
"percent": null, "percent": null,
"window_rect": { "window_rect": {
"x": 0, "x": 0,
@ -596,6 +618,7 @@ node and will have the following properties:
"urgent": false, "urgent": false,
"floating_nodes": [ "floating_nodes": [
], ],
"sticky": false,
"num": 1, "num": 1,
"output": "eDP-1", "output": "eDP-1",
"type": "workspace", "type": "workspace",
@ -616,6 +639,7 @@ node and will have the following properties:
"border": "normal", "border": "normal",
"current_border_width": 2, "current_border_width": 2,
"layout": "none", "layout": "none",
"orientation": "none",
"percent": 0.5, "percent": 0.5,
"window_rect": { "window_rect": {
"x": 2, "x": 2,
@ -639,9 +663,12 @@ node and will have the following properties:
"urgent": false, "urgent": false,
"floating_nodes": [ "floating_nodes": [
], ],
"sticky": false,
"type": "con", "type": "con",
"fullscreen_mode": 0,
"pid": 23959, "pid": 23959,
"app_id": null, "app_id": null,
"visible": true,
"window_properties": { "window_properties": {
"class": "URxvt", "class": "URxvt",
"instance": "urxvt", "instance": "urxvt",
@ -666,6 +693,7 @@ node and will have the following properties:
"border": "normal", "border": "normal",
"current_border_width": 2, "current_border_width": 2,
"layout": "none", "layout": "none",
"orientation": "none",
"percent": 0.5, "percent": 0.5,
"window_rect": { "window_rect": {
"x": 2, "x": 2,
@ -689,9 +717,12 @@ node and will have the following properties:
"urgent": false, "urgent": false,
"floating_nodes": [ "floating_nodes": [
], ],
"sticky": false,
"type": "con", "type": "con",
"fullscreen_mode": 0,
"pid": 25370, "pid": 25370,
"app_id": "termite", "app_id": "termite",
"visible": true,
"nodes": [ "nodes": [
] ]
} }