Project

General

Profile

$dockpanels » History » Version 16

Per Amundsen, 05/12/2022 08:44 PM

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