Project

General

Profile

Dock » History » Version 16

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