diff options
author | Thayne McCombs <astrothayne@gmail.com> | 2020-01-05 00:20:02 -0700 |
---|---|---|
committer | Simon Ser <contact@emersion.fr> | 2020-01-05 10:53:16 +0100 |
commit | 218950c88d5011823fc4e9595ba670d9e63d46ac (patch) | |
tree | 848065251db1f16d11fd959acbcae765a165282c | |
parent | xwayland: handle size_hints == NULL (diff) | |
download | sway-218950c88d5011823fc4e9595ba670d9e63d46ac.tar.gz sway-218950c88d5011823fc4e9595ba670d9e63d46ac.tar.zst sway-218950c88d5011823fc4e9595ba670d9e63d46ac.zip |
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.
-rw-r--r-- | sway/sway-ipc.7.scd | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/sway/sway-ipc.7.scd b/sway/sway-ipc.7.scd index b8b02221..44408818 100644 --- a/sway/sway-ipc.7.scd +++ b/sway/sway-ipc.7.scd | |||
@@ -315,6 +315,9 @@ node and will have the following properties: | |||
315 | : string | 315 | : string |
316 | : The node's layout. It can either be _splith_, _splitv_, _stacked_, | 316 | : The node's layout. It can either be _splith_, _splitv_, _stacked_, |
317 | _tabbed_, or _output_ | 317 | _tabbed_, or _output_ |
318 | |- orientation | ||
319 | : string | ||
320 | : The node's orientation. It can be _vertical_, _horizontal_, or _none_ | ||
318 | |- percent | 321 | |- percent |
319 | : float | 322 | : float |
320 | : The percentage of the node's parent that it takes up or _null_ for the root | 323 | : 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: | |||
337 | : boolean | 340 | : boolean |
338 | : Whether the node or any of its descendants has the urgent hint set. Note: | 341 | : Whether the node or any of its descendants has the urgent hint set. Note: |
339 | This may not exist when compiled without _xwayland_ support | 342 | This may not exist when compiled without _xwayland_ support |
343 | |- sticky | ||
344 | : boolean | ||
345 | : Whether the node is sticky (shows on all workspaces) | ||
340 | |- focused | 346 | |- focused |
341 | : boolean | 347 | : boolean |
342 | : Whether the node is currently focused by the default seat (_seat0_) | 348 | : Whether the node is currently focused by the default seat (_seat0_) |
@@ -353,6 +359,10 @@ node and will have the following properties: | |||
353 | : string | 359 | : string |
354 | : (Only workspaces) A string representation of the layout of the workspace | 360 | : (Only workspaces) A string representation of the layout of the workspace |
355 | that can be used as an aid in submitting reproduction steps for bug reports | 361 | that can be used as an aid in submitting reproduction steps for bug reports |
362 | |- fullscreen_mode | ||
363 | : integer | ||
364 | : (Only containers and views) The fullscreen mode of the node. 0 means none, 1 means | ||
365 | full workspace, and 2 means global fullscreen | ||
356 | |- app_id | 366 | |- app_id |
357 | : string | 367 | : string |
358 | : (Only views) For an xdg-shell view, the name of the application, if set. | 368 | : (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: | |||
360 | |- pid | 370 | |- pid |
361 | : integer | 371 | : integer |
362 | : (Only views) The PID of the application that owns the view | 372 | : (Only views) The PID of the application that owns the view |
373 | |- visible | ||
374 | : boolean | ||
375 | : (Only views) Whether the node is visible | ||
363 | |- window | 376 | |- window |
364 | : integer | 377 | : integer |
365 | : (Only xwayland views) The X11 window ID for the xwayland view | 378 | : (Only xwayland views) The X11 window ID for the xwayland view |
@@ -387,6 +400,7 @@ node and will have the following properties: | |||
387 | "border": "none", | 400 | "border": "none", |
388 | "current_border_width": 0, | 401 | "current_border_width": 0, |
389 | "layout": "splith", | 402 | "layout": "splith", |
403 | "orientation": "horizontal", | ||
390 | "percent": null, | 404 | "percent": null, |
391 | "window_rect": { | 405 | "window_rect": { |
392 | "x": 0, | 406 | "x": 0, |
@@ -410,6 +424,7 @@ node and will have the following properties: | |||
410 | "urgent": false, | 424 | "urgent": false, |
411 | "floating_nodes": [ | 425 | "floating_nodes": [ |
412 | ], | 426 | ], |
427 | "sticky": false, | ||
413 | "type": "root", | 428 | "type": "root", |
414 | "nodes": [ | 429 | "nodes": [ |
415 | { | 430 | { |
@@ -428,6 +443,7 @@ node and will have the following properties: | |||
428 | "border": "none", | 443 | "border": "none", |
429 | "current_border_width": 0, | 444 | "current_border_width": 0, |
430 | "layout": "output", | 445 | "layout": "output", |
446 | "orientation": "horizontal", | ||
431 | "percent": null, | 447 | "percent": null, |
432 | "window_rect": { | 448 | "window_rect": { |
433 | "x": 0, | 449 | "x": 0, |
@@ -451,6 +467,7 @@ node and will have the following properties: | |||
451 | "urgent": false, | 467 | "urgent": false, |
452 | "floating_nodes": [ | 468 | "floating_nodes": [ |
453 | ], | 469 | ], |
470 | "sticky": false, | ||
454 | "type": "output", | 471 | "type": "output", |
455 | "nodes": [ | 472 | "nodes": [ |
456 | { | 473 | { |
@@ -468,6 +485,7 @@ node and will have the following properties: | |||
468 | "border": "none", | 485 | "border": "none", |
469 | "current_border_width": 0, | 486 | "current_border_width": 0, |
470 | "layout": "splith", | 487 | "layout": "splith", |
488 | "orientation": "horizontal", | ||
471 | "percent": null, | 489 | "percent": null, |
472 | "window_rect": { | 490 | "window_rect": { |
473 | "x": 0, | 491 | "x": 0, |
@@ -491,6 +509,7 @@ node and will have the following properties: | |||
491 | "urgent": false, | 509 | "urgent": false, |
492 | "floating_nodes": [ | 510 | "floating_nodes": [ |
493 | ], | 511 | ], |
512 | "sticky": false, | ||
494 | "type": "workspace" | 513 | "type": "workspace" |
495 | } | 514 | } |
496 | ] | 515 | ] |
@@ -511,6 +530,7 @@ node and will have the following properties: | |||
511 | "border": "none", | 530 | "border": "none", |
512 | "current_border_width": 0, | 531 | "current_border_width": 0, |
513 | "layout": "output", | 532 | "layout": "output", |
533 | "orientation": "none", | ||
514 | "percent": 1.0, | 534 | "percent": 1.0, |
515 | "window_rect": { | 535 | "window_rect": { |
516 | "x": 0, | 536 | "x": 0, |
@@ -534,6 +554,7 @@ node and will have the following properties: | |||
534 | "urgent": false, | 554 | "urgent": false, |
535 | "floating_nodes": [ | 555 | "floating_nodes": [ |
536 | ], | 556 | ], |
557 | "sticky": false, | ||
537 | "type": "output", | 558 | "type": "output", |
538 | "active": true, | 559 | "active": true, |
539 | "primary": false, | 560 | "primary": false, |
@@ -573,6 +594,7 @@ node and will have the following properties: | |||
573 | "border": "none", | 594 | "border": "none", |
574 | "current_border_width": 0, | 595 | "current_border_width": 0, |
575 | "layout": "splith", | 596 | "layout": "splith", |
597 | "orientation": "horizontal", | ||
576 | "percent": null, | 598 | "percent": null, |
577 | "window_rect": { | 599 | "window_rect": { |
578 | "x": 0, | 600 | "x": 0, |
@@ -596,6 +618,7 @@ node and will have the following properties: | |||
596 | "urgent": false, | 618 | "urgent": false, |
597 | "floating_nodes": [ | 619 | "floating_nodes": [ |
598 | ], | 620 | ], |
621 | "sticky": false, | ||
599 | "num": 1, | 622 | "num": 1, |
600 | "output": "eDP-1", | 623 | "output": "eDP-1", |
601 | "type": "workspace", | 624 | "type": "workspace", |
@@ -616,6 +639,7 @@ node and will have the following properties: | |||
616 | "border": "normal", | 639 | "border": "normal", |
617 | "current_border_width": 2, | 640 | "current_border_width": 2, |
618 | "layout": "none", | 641 | "layout": "none", |
642 | "orientation": "none", | ||
619 | "percent": 0.5, | 643 | "percent": 0.5, |
620 | "window_rect": { | 644 | "window_rect": { |
621 | "x": 2, | 645 | "x": 2, |
@@ -639,9 +663,12 @@ node and will have the following properties: | |||
639 | "urgent": false, | 663 | "urgent": false, |
640 | "floating_nodes": [ | 664 | "floating_nodes": [ |
641 | ], | 665 | ], |
666 | "sticky": false, | ||
642 | "type": "con", | 667 | "type": "con", |
668 | "fullscreen_mode": 0, | ||
643 | "pid": 23959, | 669 | "pid": 23959, |
644 | "app_id": null, | 670 | "app_id": null, |
671 | "visible": true, | ||
645 | "window_properties": { | 672 | "window_properties": { |
646 | "class": "URxvt", | 673 | "class": "URxvt", |
647 | "instance": "urxvt", | 674 | "instance": "urxvt", |
@@ -666,6 +693,7 @@ node and will have the following properties: | |||
666 | "border": "normal", | 693 | "border": "normal", |
667 | "current_border_width": 2, | 694 | "current_border_width": 2, |
668 | "layout": "none", | 695 | "layout": "none", |
696 | "orientation": "none", | ||
669 | "percent": 0.5, | 697 | "percent": 0.5, |
670 | "window_rect": { | 698 | "window_rect": { |
671 | "x": 2, | 699 | "x": 2, |
@@ -689,9 +717,12 @@ node and will have the following properties: | |||
689 | "urgent": false, | 717 | "urgent": false, |
690 | "floating_nodes": [ | 718 | "floating_nodes": [ |
691 | ], | 719 | ], |
720 | "sticky": false, | ||
692 | "type": "con", | 721 | "type": "con", |
722 | "fullscreen_mode": 0, | ||
693 | "pid": 25370, | 723 | "pid": 25370, |
694 | "app_id": "termite", | 724 | "app_id": "termite", |
725 | "visible": true, | ||
695 | "nodes": [ | 726 | "nodes": [ |
696 | ] | 727 | ] |
697 | } | 728 | } |