Project

General

Profile

$dockpanels » History » Version 13

Per Amundsen, 05/09/2022 12:34 AM

1 1 Per Amundsen
_Added in 1.9.4_
2
3
*$dockpanels*
4
5 5 Per Amundsen
Returns [[$true]] if any dockpanel is visible except Treebar, otherwise [[$false]].
6 1 Per Amundsen
7 13 Per Amundsen
_See also [[Monitor Panels]], [[/dock]]._
8 1 Per Amundsen
9 9 Per Amundsen
*$dockpanels(name|@window)*
10 1 Per Amundsen
11 5 Per Amundsen
Returns [[$true]] if named dockpanel is visible, otherwise [[$false]].
12 1 Per Amundsen
13
*Parameters*
14
15 9 Per Amundsen
name|@window - The panel name or @window to check. (Server, Channel, Private, Url, Notify, Dcc, Highlight, Nicklist or Treebar)
16 3 Per Amundsen
17
*Properties*
18
19 8 Per Amundsen
.side - Returns the docked panel side. (left/right/top/bottom)
20
.container - Returns the container position for the panel.
21
.panel - Returns the panel position.
22
.tab - Returns the tab position for the panel.
23
.name - Returns the name of the window/docked panel.
24
.locked - Returns [[$true]] if the docked panel is locked, otherwise [[$false]].
25
.pinned - Returns [[$true]] if the docked panel is pinned, otherwise [[$false]].
26
.visible - Returns [[$true]] if the docked panel is visible, otherwise [[$false]].
27
.w - Returns the docked panel width.
28
.h - Returns the docked panel height.
29 3 Per Amundsen
.wid - Returns the window id of the panel if any.
30 4 Per Amundsen
31
*Example*
32
33
<pre>
34
; Display information about the highlight panels.
35
//echo -ag Higlight is $iif($dockpanels(Highlight), Visible, Hidden)
36
37 1 Per Amundsen
; Hide the highlights dockpanel if it's in a window.
38
//window -h @ $+ $dockpanels(Highlight).wid
39 9 Per Amundsen
</pre>
40
41
_Added in 4.3_
42
43
*$dockpanels(side, [container], [panel], [tab])*
44
45
Returns the number of containers/panels/tabs docked in [[Monitor Panels]] or information about docked panels/windows.
46
47
_See also [[Monitor Panels]], [[/dock]]._
48
49
*Parameters*
50
51
side - The dock side to list. (left/right/top/bottom)
52 10 Per Amundsen
[container] - If N = 0, number of containers, otherwise the Nth container to list.
53
[panel] - If N = 0, number of panels, otherwise the Nth panel to list.
54
[tab] - If N = 0, number of tabs, otherwise the Nth tab to list.
55 9 Per Amundsen
56
*Properties*
57
58
.side - Returns the docked panel side. (left/right/top/bottom)
59
.container - Returns the container position for the panel.
60
.panel - Returns the panel position.
61
.tab - Returns the tab position for the panel.
62
.name - Returns the name of the window/docked panel.
63
.locked - Returns [[$true]] if the docked panel is locked, otherwise [[$false]].
64
.pinned - Returns [[$true]] if the docked panel is pinned, otherwise [[$false]].
65
.visible - Returns [[$true]] if the docked panel is visible, otherwise [[$false]].
66
.w - Returns the docked panel width.
67
.h - Returns the docked panel height.
68
69
*Example*
70
71
<pre>
72 11 Per Amundsen
alias listdocks {
73
  echo -ag Number of containers on the bottom = $dockpanels(bottom, 0)
74
75
  var %c 0
76
  while (%c < $dockpanels(right, 0)) {
77
    inc %c
78
    
79
    echo -ag Number of panels in container %c is $dockpanels(bottom, %c, 0)
80
    
81
    var %p 0
82
    while (%p < $dockpanels(bottom, %c, 0)) {
83
      inc %p
84
      
85
      echo -ag Number of tabs in panel %p = $dockpanels(bottom, %c, %p, 0)
86
      
87
      var %t 0
88
      while (%t < $dockpanels(bottom, %c, %p, 0)) {
89
        inc %t
90
        echo -ag Tab %t is $dockpanels(bottom, %c, %p, %t)
91
      }
92
    } 
93
  }
94
}
95 4 Per Amundsen
</pre>