Project

General

Profile

Actions

Added in 1.9.4

$dockpanels

Returns $true if any Monitor Panels is visible except pinned Monitor Panels, otherwise $false.

See also Monitor Panels, /dock.


$dockpanels(name|@window|dialog id)

Returns $true if named dockpanel is visible, otherwise $false.

Parameters

name|@window|dialog id - The panel name, @window or dialog id to check. (Server, Channel, Private, Url, Notify, Dcc, Highlight, Nicklist or Treebar)

Properties

.side - Returns the docked panel side. (left/right/top/bottom)
.container - Returns the container position for the panel.
.panel - Returns the panel position.
.tab - Returns the tab position for the panel.
.name - Returns the name of the window/docked panel.
.locked - Returns $true if the docked panel is locked, otherwise $false.
.pinned - Returns $true if the docked panel is pinned, otherwise $false.
.visible - Returns $true if the docked panel is visible, otherwise $false.
.w - Returns the docked panel width.
.h - Returns the docked panel height.
.wid - Returns the window id of the panel if any.

Example

; Display information about the highlight panels.
//echo -ag Higlight is $iif($dockpanels(Highlight), Visible, Hidden)

; Hide the highlights dockpanel if it's in a window.
//window -h @ $+ $dockpanels(Highlight).wid

Added in 4.3

$dockpanels(side, [container], [panel], [tab])

Returns the number of containers/panels/tabs docked in Monitor Panels or information about docked panels/windows.

See also Monitor Panels, /dock.

Parameters

side - The dock side to list. (left/right/top/bottom)
[container] - If N = 0, number of containers, otherwise the Nth container to list.
[panel] - If N = 0, number of panels, otherwise the Nth panel to list.
[tab] - If N = 0, number of tabs, otherwise the Nth tab to list.

Properties

.side - Returns the docked panel side. (left/right/top/bottom)
.container - Returns the container position for the panel.
.panel - Returns the panel position.
.tab - Returns the tab position for the panel.
.name - Returns the name of the window/docked panel.
.locked - Returns $true if the docked panel is locked, otherwise $false.
.pinned - Returns $true if the docked panel is pinned, otherwise $false.
.visible - Returns $true if the docked panel is visible, otherwise $false.
.w - Returns the docked panel width.
.h - Returns the docked panel height.

Example

alias listdocks {
  echo -ag Number of containers on the bottom = $dockpanels(bottom, 0)

  var %c 0
  while (%c < $dockpanels(right, 0)) {
    inc %c

    echo -ag Number of panels in container %c is $dockpanels(bottom, %c, 0)

    var %p 0
    while (%p < $dockpanels(bottom, %c, 0)) {
      inc %p

      echo -ag Number of tabs in panel %p = $dockpanels(bottom, %c, %p, 0)

      var %t 0
      while (%t < $dockpanels(bottom, %c, %p, 0)) {
        inc %t
        echo -ag Tab %t is $dockpanels(bottom, %c, %p, %t)
      }
    } 
  }
}

Updated by Per Amundsen 10 days ago · 16 revisions

Also available in: PDF HTML TXT