Project

General

Profile

Dock » History » Version 19

Per Amundsen, 02/16/2023 12:16 PM

1 1 Per Amundsen
_Added in 4.3_
2
3 16 Per Amundsen
*/dock [-ug] <@window|dialog id>*
4
*/dock [-abgloNpNrt] [w h] <@window|dialog id>*
5
*/dock [-cbgloNpNrt] [w h] <container> <@window|dialog id>*
6
*/dock [-bgloNpNnrt] [w h] <container> <panel> <@window|dialog id>*
7 17 Per Amundsen
*/dock [-bgiloNpNrt] [w h] <container> <panel> <tab> <@window|dialog id>*
8 1 Per Amundsen
9 18 Per Amundsen
Docks/undocks a window or dialog as a [[Monitor_Panels|Monitor Panel]].
10 1 Per Amundsen
11 8 Per Amundsen
_See also [[$dockpanels]]._
12
13 1 Per Amundsen
*Switches*
14
15 19 Per Amundsen
table(ktable).
16
|*Switch*|*Description*|
17
| -a | Adds the window to any other dock panel on the specified dock side as a new tab or creates a new container and panel. |
18
| -b | Dock to the bottom. |
19
| -c | Create a new container and inserts the window at the specified side/container. |
20
| -g | Indicates "dialog id" specified instead of @window. |
21
| -i | Inserts the window into the specified side/container/panel/tab |
22
| -l | Dock to the left. |
23
| -n | Create a new panel and inserts the window at the specified side/container/panel. |
24
| -oN | Locks the panel. (0 = unlocked, 1 = locked, Ignored by F2 to toggle panels visibility) |
25
| -pN | Pins the panel. (0 = unpinned, 1 = pinned, Autohide) |
26
| -r | Dock to the right. |
27
| -t | Dock to the top. |
28
| -u | Undocks/restores the @window to a regular window. |
29 1 Per Amundsen
30
*Parameters*
31
32 19 Per Amundsen
table(ktable).
33
|*Parameter*|*Description*|
34
| [w h] | The preferred width and height of the panel. |
35
| <container> | Used with -c to insert the panel into a new container at the specified position. |
36
| <container> <panel> | Used with -n to insert the panel into a specific container at the specified panel position. |
37
| <container> <panel> <tab> | Used with -i to specify where to insert the new panel. |
38
| <@window<notextile>|</notextile>dialog id> | The window or dialog id to dock. |
39 1 Per Amundsen
40
*Example*
41
42
<pre>
43
alias testdock {
44
  ; Create a custom window.
45
  window @test
46
47 5 Per Amundsen
  ; Dock the custom window as a monitor panel to the left side, appending if there are any other panels.
48 1 Per Amundsen
  dock -al @test
49
50
  ; Restores the custom window as a normal window.
51
  dock -u @test
52
53
  ; Docks the custom window as a monitor panel to the top, ignoring any current panels.
54
  dock -t @test
55
}
56
</pre>
57
58
-