taskbar3.dll documentation
XML/XSL-generated documentation, on the official litestep docs model.
docs layout written by the LiteStep Documentation Effort, August 2000
XML schema by MrMidi, XSL by jesus_mjjg
What does taskbar3.dll do?
Taskbar3 is a module that lets you have a taskbar, just like windows does, so you can click on taskbar buttons to switch to a window, minimize it, maximize it, ... but this time with much more customizations, effects, ... Taskbar3 is originally a rip from the default litestep taskbar. Hopefully, it has followed its own path since some times. Some pieces of code were taken from various other modules (in that case, look at the sources), but you can be sure that this module has some tasks.dll code (and ideas) inside.

Step.rc syntax for taskbar3.dll
TaskbarX
Lets you specify the x (horizontal) coordinate of the taskbar.

Integer
Default: 0
TaskbarY
Lets you specify the y (vertical) coordinate of the taskbar.

Integer
Default: 0
TaskbarWidth
Lets you specify the width of the taskbar.

Integer
Default: $ResolutionX$
TaskbarHeight
Lets you specify the height of the taskbar.

Integer
Default: depends on the font used, so try it...
TaskbarAlwaysOnTop
Positions the taskbar above any other window.

Bool
Default: false
TaskbarDisableFlashing
Set this to true if you don't want the taskbar buttons to flash on windows notifications (exemple: instant messenger windows).

Bool
Default: false
TaskbarUseRealFlashing
Set this to true if you really want the taskbar buttons to flash instead of just changing skins/colors.

Bool
Default: false
TaskbarRefresh
The time in milliseconds before the taskbar is repainted.

Integer
Default: 500
TaskbarButtonDirection
Which direction will buttons go.

.left (Left) .right (Right)
TaskbarMaxButtonCount
The maximum number of showable buttons (navigate through them using !taskbarshowpart next/prev) .

Integer
Default: $TaskbarWidth$
TaskbarUseToolTips
Whether to use tooltips for task buttons or not.

Bool
Default: true
TaskbarMaxTaskWidth
The maximum width of a task button.

Integer
Default: $TaskbarWidth$
TaskbarNoSkinShift
the taskbar skin will not move as a task button is pressed.

Bool
Default: false
TaskbarNoFontShift
the text on the task buttons will not move as a taskbar button is pressed.

Bool
Default: false
TaskbarBorder
Defines the border size between the taskbar itself and the buttons.

Default: 4
Parameters: Integer or Integer Integer Integer Integer or
TaskbarButtonBorder
Defines the border size between any taskbar button and the icon/the text border.

Default: 4
Parameters: Integer or Integer Integer Integer Integer or
TaskbarButtonFontBorder
Defines the border size between any taskbarbuttonborder and the text.

Default: 20 0 0 0
Parameters: Integer or Integer Integer Integer Integer or
TaskbarSpacing
Defines the spacing between buttons inside the taskbar.

Integer
Default: 3
TaskbarIconShow
Are the icons shown or not.

Bool
Default: true
TaskbarIconX
Where to place icons inside taskbarbuttonborder. negative numbers centers it.

Integer
Default: 0
TaskbarIconY
Where to place icons inside taskbarbuttonborder. negative numbers centers it.

Integer
Default: 0
TaskbarIconSize
The icon size (maximum icon size, in fact).

Integer
Default: 16
TaskbarUseHueing
Use hue effect on icons.

Bool
Default: false
TaskbarHueColor
Hueing color for all kind of buttons.

Color
Default: 7d7d7d
TaskbarHueIntensity
Hueing intensity for all kind of buttons.

Integer
Default: 0
TaskbarUseSaturation
Use saturation effect on icons.

Bool
Default: false
TaskbarSaturationIntensity
Saturation intensity for all kind of buttons.

Integer
Default: 0
- Back (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
background color of the taskbar. You can use the suffix -back with any kind of button state or use the default TaskbarAll to set all of them at once. example: TaskbarFlashingBack

Color
Default: c0bfc0
- Fore (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
sets the color of the light bevel around the edge of the taskbar and task buttons, creating a 3d effect. you can use the suffix -fore with any kind of button state (normal, active, minimized, flashing, or nothing for the taskbar) example: taskbarflashingfore

Color
Default: ffffff
- Fore2 (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
sets the color of the dark bevel around the edge of the taskbar and task buttons, creating a 3d effect. you can use the suffix -fore2 with any kind of button state (normal, active, minimized, flashing, or nothing for the taskbar) example: taskbarflashingfore2

Color
Default: ffffff
- SkinCenter (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
sets the background image for the taskbar. if left and right parts are missing, center image gets stretched. you can use the suffix -skincenter with any kind of button state (normal, active, minimized, flashing, or nothing for the taskbar) example: taskbarflashingskincenter

Image
Default:
- SkinLeft (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
sets the image for the left edge of the taskbar. you can use the suffix -skinleft with any kind of button state (normal, active, minimized, flashing, or nothing for the taskbar) example: taskbarflashingskinleft

Image
Default:
- SkinRight (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
sets the image for the right edge of the taskbar. you can use the suffix -skinrightwith any kind of button state (normal, active, minimized, flashing, or nothing for the taskbar) example: taskbarflashingskinright

Image
Default:
TaskbarFontShow
Is the text shown or not. (todo: add per-state too ?)

Bool
Default: false
- FontFace (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
sets the font face to be used in the taskbar buttons. you can use the suffix -fontface with any kind of button state (normal, active, minimized, flashing) example: taskbarflashingfontface

Font
Default: sytem font, otherwise, other states default to taskbarnormalfontface
- FontSize (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
sets the font size to be used in the taskbar buttons. you can use the suffix -fontface with any kind of button state (normal, active, minimized, flashing) example: taskbarflashingfontface

Integer
Default: sytem font size, otherwise, other states default to taskbarnormalfontsize
- FontBold (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
configures the taskbar to display the button name in bold text. you can use the suffix -fontbold with any kind of button state (normal, active, minimized, flashing) example: taskbarflashingfontbold

Bool
Default: false
- FontItalic (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
configures the taskbar to display the button name in italic text. you can use the suffix -fontitalic with any kind of button state (normal, active, minimized, flashing) example: taskbarflashingfontitalic

Bool
Default: false
- FontUnderline (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
configures the taskbar to display the button name in underlined text. you can use the suffix -fontunderline with any kind of button state (normal, active, minimized, flashing) example: taskbarflashingfontunderline

Bool
Default: false
- FontColor (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
sets the color of text on the <state> taskbar buttons. you can use the suffix -fontcolor with any kind of button state (normal, active, minimized, flashing) example: taskbarflashingfontcolor

Color
Default: 000000
TaskbarUseFontShadow
set this to true if you want font shadows to appear on taskbar buttons.

Bool
Default: false
- FontShadowColor (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
set the color for font shadows. you can use the suffix -fontshadowcolor with any kind of button state (normal, active, minimized, flashing, and none to set for all states) example: taskbarfontshadowcolor

Color
Default: 00000
- FontShadowOffsetX (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
set horizontal offest for font shadows. you can use the suffix -fontshadowoffsetx with any kind of button state (normal, active, minimized, flashing, and none to set for all states) example: taskbarfontshadowoffsetx

Integer
Default: 1
- FontShadowOffsetY (apply the following prefixes):
TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
set vertical offest for font shadows. you can use the suffix -fontshadowoffsety with any kind of button state (normal, active, minimized, flashing, and none to set for all states) example: taskbarfontshadowoffsety

Integer
Default: 1
- HorizontalFontAlign (apply the following prefixes):
default: Taskbar

TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
General horizontal font alignment. With anything else than the TaskbarHorizontalFontAlign, Horizontal gets shortened to H. example: TaskbarNormalHFontAlign

.left (Left) .right (Right) .center (Center)
- VerticalFontAlign (apply the following prefixes):
default: Taskbar

TaskbarNormal
TaskbarActive
TaskbarMinimized
TaskbarFlashing
General vertical font alignment. With anything else than the TaskbarVerticalFontAlign, Horizontal gets shortened to V. example: TaskbarNormalVFontAlign

.center (Center) .top (Top) .bottom (Bottom)
- ButtonDown (apply the following prefixes):
TaskbarL
TaskbarR
TaskbarM
For clicks on the taskbar itself. these are commands (programs, ...). example: taskbarlbuttondown $command$

Default: !none
String
- ButtonUp (apply the following prefixes):
TaskbarL
TaskbarR
TaskbarM
For clicks on the taskbar itself. these are commands (programs, ...). example: taskbarlbuttondown $command$

Default: !none
String
!Bang Commands for taskbar3.dll
!TaskbarHideAllows you to hide a visible taskbar.
!TaskbarShowAllows you to show an hidden taskbar.
!TaskbarToggleLets you switch between a hidden and shown state.
!TaskbarSizeLets you resize the taskbar (negative number -> keeps setting).

Parameters: Integer Integer
!TaskbarMoveLets you move the taskbar (negative numbers work too, even in a box).

Parameters: Integer Integer
!TaskbarMoveByLets you move the taskbar according to its actual positioning (negative numbers work too, even in a box).

Parameters: Integer Integer
!TaskbarBoxHookLets you put the taskbar in a box, usiong lsbox (see lsbox docs).
!TaskbarLinesLets you specify the number of lines you want the taskbar to have. you have to compute the height by yourself at the moment, but this setting is going to change.

Parameters: Integer
!TaskbarShrinkLets you shrink the taskbar according to its actual size (negative number -> keeps setting). this is handy when used with systray2kad to have an autosizing taskbar/systray (see example below).

Parameters: Integer Integer
!TaskbarGrowLets you grow the taskbar according to its actual size (negative number -> keeps setting). this is handy when used with systray2kad to have an autosizing taskbar/systray (see example below).

Parameters: Integer Integer
!TaskbarHideTasksHides the tasks that are on the *taskbarhide list.
!TaskbarShowTasksShows the tasks that are on the *taskbarhide list.
!TaskbarToggleTasksToggles the two previous settings.
!TaskbarSwitchWill switch to the window after/before the last active button.
Parameters: Next Previous
!TaskbarShowPartWhen using taskbarmaxbuttoncount setting, those bangs let you scroll through the shown buttons (one at a time).
Parameters: Next Previous
About taskbar3.dll v0.305 rc 20030124-12h55:
Author contact informations:
Name: jesus_mjjg
Email: jesus_mjjg@skynet.be
Icq: 25829480
Msn: jesus_mjjg@hotmail.com
Yim:
Aim: jesusmjjg
Homepage:

Project homepage: http://users.skynet.be/fa052720/