Windows

Overview

Screenbar has three types of windows: panels, drag windows, and tooltips. Panels are created on startup based on the sbPanels option. Drag windows are created by dragging layout elements which have the (prefix)Draggable option set. Tooltips are created by hovering the mouse over a layout element which has the (prefix)ToolTip option set. Some options are shared, while others are specific to one of these types.

Window options common to all window types:

(prefix)BackgroundColor [color]
Default: 000000 (black)
If not transparent, the panel's background fill color.
(prefix)RootElement [identifier]
Mandatory setting
The name of the root layout element which this panel is drawn with.
(prefix)Transparent [bool]
Default: false
If set, areas on this window which aren't covered by elements are transparent.
(prefix)TransparencyMethod [colorkey|overlay]
Default: colorkey
If (prefix)Transparent is true, the method used for making the window transparent. If set to colorkey, uses color-key transparency, making the color (255,0,255) represent transparency, and making that color the background color. If set to overlay, uses an alpha map for partial transparency. Due to a bug in Windows video overlay handling, transparent windows may not cover the top-left pixel of the screen (0,0). Doing so will break common video players.
(prefix)Opacity [int]
Default: 255
If (prefix)Transparent is true, the overall opacity of the window, from 0 (fully transparent) to 255 (fully opaque).
(prefix)Vertical [bool]
Default: false
Whether this window flows vertically. Affects how flow layout elements are arranged. Not used if this window is an appbar panel; in that case, it is vertical if it is on the left or right edge, and horizontal if it is on the top or bottom edge. Also does not apply to drag windows, which inherit this setting from the (prefix)Draggable element that created them.
(prefix)CreateAnimation [animation]
Default: none
The animation which is played when the window is first created.
(prefix)AnimationDirection [up|left|right|down|auto]
Default: auto
The orientation for this panel's create, show and hide animations, and for animations run by elements in its layout. If the direction is "auto", it is determined by which edge of the screen the window is on, and points towards the center of the monitor.

Panels

See also: sbPanels option.
(prefix)Monitors [monitors]
Default: all
The monitor (or monitors) on which this panel appears. Positioning options are relative to this monitor. If more than one monitor is specified (as with the default), then one panel is created for each monitor specified.
(prefix)AlwaysOnTop [bool]
Default: false
Whether this panel starts out always on top.
(prefix)X [coord]
(prefix)Y [coord]
(prefix)Width [coord]
(prefix)Height [coord]
Mandatory setting (if applicable)
If this panel is not an appbar, sets the location and size of this panel. Not used if this panel is an appbar. Negative coordinates are interpreted as relative to the width and height of the monitor the panel is on.
(prefix)Appbar [bool]
Default: false
If set, makes this panel into an appbar. Rather than using the rect specified by (prefix)X,Y,Width,Height, it spans the edge of the screen given by (prefix)Edge, with a thickness of (prefix)Thickness.
(prefix)Edge [left|top|right|bottom]
Default: bottom
If this panel is an appbar, the edge of the screen which it is docked to.
(prefix)Thickness [int]
The thickness of this panel, if it is an appbar. Ignored if it isn't.
(prefix)AutoHide [bool]
Default: false
Makes this panel automatically hide itself when the cursor is not near it. Only available if (prefix)Appbar is true.
(prefix)HideDelay [int]
Default: 1000
If auto-hide is enabled, the amount of time the panel remains visible after the cursor has moved off it, in milliseconds.
(prefix)HiddenThickness [int]
Default: 1
The amount of the panel which is visible while it is hidden due to auto-hide, in pixels.
(prefix)HideAnimation [animation]
Default: none
The animation played when this window auto-hides.
(prefix)ShowAnimation [animation]
Default: none
The animation played when this window reappears after being auto-hidden.

Tooltips

(prefix)MinLength [int]
(prefix)MaxLength [int]
Defaults: 0, 1000
The minimum and maximum lengths of this window. The actual length is determined by the root element, within these constraints.
(prefix)PlacementMethod [panel|cursor]
Default: panel
The way in which the position of this window should be determined. If set to 'panel', the window is aligned to the edge of the panel which contained the element that's hovered over. If set to 'cursor', it is positioned a fixed distance above or below the cursor, and may overlap or not touch the panel.
(prefix)Thickness [int]
Default: 16
The thickness of this window (height if a horizontal layout, width if vertical).

Drag windows

Drag windows inherit their size, root element, and vertical setting from the element which is being dragged.