xTaskbar v0.9.2 ReadMe

• xTaskbar
• Main Settings
• Image Settings
• Icon Settings
• Font Settings
• Bangs and Events
• Examples
• Contact
• Changes.txt

Special Settings

*xTaskbar <taskbarname>
Define your own Taskbar Name, for having just more then one Taskbar.
Important: You don't need to set this, if you only need one Taskbar! (See Examples).

Settings Example with custom Taskbar(Name):
*xTaskbar Task
TaskX x-coordinate
TaskY ....

Setting example without custom Taskbar(Name):
xTaskbarX x-coordinate
xTaskbarY ....

Main Settings

• X INT
  X-Coordinate
• Y INT
  Y-Coordinate
• Width INT
  Width of the Taskbar
• Height INT
  Height of the Taskbar
• AlwaysOnTop BOOL
  Taskbar is always on top
• StartHidden BOOL
  Start Taskbar Hidden.
• TransparencyMode BOOL
  If set, the transparency will be TRUE.
• ShowIcon BOOL
  Show Icons in Taskbar.
• ShowText BOOL
  Show Text in Taskbar
• ShowTooltip BOOL
  Shows TaskTiles tooltips.
• Lines BOOL
  Number of TaskbarLines (horizontal Layout) or TaskbarRows (vertical Layout).
• Display "all", "normal", "active", "minimized", "normal+active", "normal+minimized" and "active+minimized"
  Defines, which Button States your Taskbar should show.
  "All" -> DEFAULT and except the case you use more than one Taskbar, you maybe shouldn't change this.
• LeftBorder INT
  Sets the number of pixels on the left edge to reserve as a border. If no value is provided then the default is 0.
• TopBorder INT
  Sets the number of pixels on the top edge to reserve as a border. If no value is provided then the default is 0.
• RightBorder INT
  Sets the number of pixels on the right edge to reserve as a border. If no value is provided then the default is 0.
• BottomBorder INT
  Sets the number of pixels on the bottom edge to reserve as a border. If no value is provided then the default is 0.
• MaxButtonWidth INT
  Maximum width of the Taskbutton. If no value is provided then the default is $resolutionx$.
• MaxButtonHeight INT
  Maximum height of the Taskbutton. If no value is provided then the default is 32.
• ButtonXSpacing INT
  X Space between buttons. If no value is provided then the default is 0.
• ButtonYSpacing INT
  Y Space between buttons. If no value is provided then the default is 0.
• UpdateInterval
  Sets the Update Interval of the Taskbar Tiles.
• LoadInBox BOOL
  To hook the taskbar (simply hides it till it's loaded into the Parent).
• FocusOnEnter BOOL
  If set the Taskbar "steals" the Focus from the active window, which provides instant MouseWheel functions! The One and Only purpose of this setting.
• NoCreateAtStartup BOOL
  Taskbar will not be created on startup.
• ButtonDirection ".left", ".right", ".top" or ".bottom"
  The direction when new tasks added. If no value is provided then the default is .right
• ImageMode "stretch", "tile", "tile-horizontal", "tile-vertical"
  If no value is provided then the default is stretch
• Image IMAGE
  Backround Image of the Taskbar
• ImageLeftEdge INT
  Sets the number of pixels on the left edge to reserve as a border. If no value is provided then the default is 0.
• ImageRightEdge INT
  Sets the number of pixels on the right edge to reserve as a border. If no value is provided then the default is 0.
• ImageTopEdge INT
  Sets the number of pixels on the top edge to reserve as a border. If no value is provided then the default is 0.
• ImageBottomEdge INT
  Sets the number of pixels on the bottom edge to reserve as a border. If no value is provided then the default is 0.
• SaturationIntensity INT
  If no value is provided then the default is 255.
• HueIntensity INT
  If no value is provided then the default is 0.
• HueColor COLOR
  If no value is provided then the default is ffffff.

Overview "Button Image Settings"

The * in front of each setting means, that every setting can be:
Normal, Active, Minimized, Flashing
If you don't set any of these 4 specific modifiers, the settings will be used for all modes.(see Examples)
If you set a setting with "Normal" then, THIS becomes Default for all other States!!

Example:
xTaskbarButtonSaturationIntensity 70
All Button States have a SaturationIntensity of 70!
xTaskbarMinimizedButtonSaturationIntensity 70
Minimized Buttons have a SaturationIntensity of 70!

Button Image Settings

• * ButtonImage IMAGE
  Sets the image of the button.
• * ButtonImageLeftEdge INT
  Sets the number of pixels on the left edge to reserve as a border. If no value is provided then the default is 0.
• * ButtonImageTopEdge INT
  Sets the number of pixels on the top edge to reserve as a border. If no value is provided then the default is 0.
• * ButtonImageRightEdge INT
  Sets the number of pixels on the right edge to reserve as a border. If no value is provided then the default is 0.
• * ButtonImageBottomEdge INT
  Sets the number of pixels on the bottom edge to reserve as a border. If no value is provided then the default is 0.
• * ButtonImageMode "stretch", "tile", "tile-horizontal" or "tile-vertical"
  If no value is provided then the default is "stretch".
• * ButtonSaturationIntensity INT
  If no value is provided then the default is 255.
• * ButtonHueIntensity INT
  If no value is provided then the default is 0.
• * ButtonHueColor COLOR
  If no value is provided then the default is ffffff.
• * ButtonAlphaBlend INT
  If no value is provided then the default is 255.

Overview "Icon Settings"

The * in front of each setting means that every setting can be:
Normal, Active, Minimized, Flashing
If you don't set any of these 4 specific modifiers, the settings will be used for all modes. (see Examples)

If you set a setting with "Normal" then, THIS becomes Default for all other States!!

Example:
xTaskbarIconX 5
All Button States have a IconX Position of 5!
xTaskbarMinimizedIconX 5
Minimized Buttons have a IconX Position of 5!

Icon Settings

• * IconX INT
  X Position IN TaskButton. If no value is provided then the default is 0.
• * IconY INT
  Y Position IN TaskButton. If no value is provided then the default is "centered".
• * IconSize INT
  If no value is provided then the default is 16.
• * IconSaturationIntensity INT
  If no value is provided then the default is 255.
• * IconHueIntensity INT
  If no value is provided then the default is 0.
• * IconHueColor COLOR
  If no value is provided then the default is ffffff.

Overview "Font Settings"

The * in front of each setting means that every setting can be:
Normal, Active, Minimized, Flashing
If you don't set any of these 4 specific modifiers, the settings will be used for all modes. (see Examples)

If you set a setting with "Normal" then, THIS becomes Default for all other States!!

Example:
xTaskbarFontHeight 20
All Button States have a FontHeight of 20!
xTaskbarMinimizedFontHeight 20
Minimized Buttons have a Text FontHeight of 20!

Font Settings

• * Font FONT
  If no value is provided then the default is "Arial".
• * FontHeight INT
  If no value is provided then the default is 15.
• * FontLeftBorder INT
  Sets the number of pixels on the left edge to reserve as a border. If no value is provided then the default is 0.
• * FontRightBorder INT
  Sets the number of pixels on the right edge to reserve as a border. If no value is provided then the default is 0.
• * FontTopBorder INT
  Sets the number of pixels on the top edge to reserve as a border. If no value is provided then the default is 0.
• * FontBottomBorder INT
  Sets the number of pixels on the bottom edge to reserve as a border. If no value is provided then the default is 0.
• * FontColor COLOR
  If no value is provided then the default is 000000.
• * FontBold BOOL
  Set Font Bold.
• * FontItalic BOOL
  Set Font Italic.
• * FontUnderline
  Set Font Underline.
• * FontAlign "left", "right" or "center"
  If no value is provided then the default is left.
• * FontVertAlign "top", "bottom" or "center"
  If no value is provided then the default is center.
• * FontShadow BOOL
  Set if you want Font Shadow.
• * FontShadowColor COLOR
  Color of the Font Shadow If no value is provided then the default is c0c0c0.
• * FontShadowX INT
  X Coordinate of the Font Shadow. If no value is provided then the default is 1.
• * FontShadowY INT
  Y Coordinate of the Font Shadow. If no value is provided then the default is 1.

Overview

All Values in '[...]' are optional, means if you didn't specify more than ONE Taskbar, you never need to specify [TASKBARNAME]!!

The exaxt purpose of every bang should be quite obvious.

Bangs

• !xTaskbarAlwaysOnTop [TASKBARNAME]
• !xTaskbarCreate [TASKBARNAME]
• !xTaskbarDestroy [TASKBARNAME]
• !xTaskbarDisplay [TASKBARNAME] (values see MainSettings "xTaskbarDisplay")
• !xTaskbarHide [TASKBARNAME]
• !xTaskbarLines [TASKBARNAME] (number of lines/rows)
• !xTaskbarLSBoxHook [TASKBARNAME]
• !xTaskbarMove [TASKBARNAME] X Y [STEPS] [TIME]
• !xTaskbarMoveBy [TASKBARNAME] X Y [STEPS] [TIME]
• !xTaskbarPinToDesktop [TASKBARNAME]
• !xTaskbarReposition [TASKBARNAME] X Y WIDTH HEIGHT [STEPS] [TIME]
• !xTaskbarRepositionBy [TASKBARNAME] X Y WIDTH HEIGHT [STEPS] [TIME]
• !xTaskbarResize [TASKBARNAME] WIDTH HEIGHT [STEPS] [TIME]
• !xTaskbarResizeBy [TASKBARNAME] WIDTH HEIGHT [STEPS] [TIME]
• !xTaskbarSetAlpha [TASKBARNAME] INT
• !xTaskbarShow [TASKBARNAME]
• !xTaskbarSwitch [TASKBARNAME] "next", "prev"
• !xTaskbarToggle [TASKBARNAME]
• !xTaskbarToggleAlwaysOnTop [TASKBARNAME]

Taskbar Button Events

• OnLeftClickButton ".select", ".menu", ".close", ".ontop" or ".none"
  Sets an action to perform, when the mouse left clicks a task button.
  Default is .select
• OnRightClickButton ".select", ".menu", ".close", ".ontop" or ".none"
  Sets an action to perform, when the mouse right clicks a task button.
  Default is .menu
• OnMiddleClickButton ".select", ".menu", ".close", ".ontop" or ".none"
  Sets an action to perform, when the mouse middle clicks a task button.
  Default is .none

Taskbar Events

• OnEnter (action)
  Sets an action to perform, when the mouse cursor enters the taskbar.
• OnLeave (action)
  Sets an action to perform, when the mouse cursor leaves the taskbar.
• OnLeftClickDown (action)
  Sets an action to perform, when the user presses the left mousebutton down on the taskbar.
• OnLeftClickUp (action)
  Sets an action to perform, when the user releases the left mousebutton on the taskbar.
• OnMiddleClickDown (action)
  Sets an action to perform, when the user presses the left mousebutton down on the taskbar.
• OnMiddleClickUp (action)
  Sets an action to perform, when the user releases the middle mousebutton on the taskbar.
• OnRightClickDown (action)
  Sets an action to perform, when the user presses the left mousebutton down on the taskbar.
• OnRightClickUp (action)
  Sets an action to perform, when the user releases the right mouse button on the taskbar.
• OnWheelDown (action)
  Sets an action to perform, when the mouse wheel scrolls down while the mouse cursor hovers over the taskbar.
• OnWheelUp (action)
  Sets an action to perform, when the mouse wheel is scrolled up while the mouse cursor hovers over the taskbar.
• OnResize (action)
  Sets an action to perform, when the taskbar has changed its size.
• OnMove (action)
  Sets an action to perform, when the taskbar has changed its position (executed after the move!).
• OnAdd (action)
  Sets an action to perform, when a task has been added.
• OnRemove (action)
  Sets an action to perform, when a task has been removed.

Taskbar Special Settings

You can remove the Buttons from Applications with the following:

*xTaskbarRemove "ClassName" ["WindowName"]

All Applications, which match the "ClassName" won't be shown in the Taskbar.

Taskbar without defined Custom Name and the same Font/Icon Settings for all buttons:
xTaskbarX 20 xTaskbarY 50 xTaskbarWidth $resolutionx-200$ xTaskbarHeight 27 xTaskbarImage Taskbar_Background.png xTaskbarNormalButtonImage TaskbarNormal_Background.png xTaskbarActiveAlphaBlend 90 xTaskbarActiveButtonImage xTaskbarActive_Background.png xTaskbarActiveButtonImageMode tile xTaskbarFont "Verdana" xTaskbarFontHeight 16 xTaskbarFontColor CDCDCD xTaskbarIconX 2 xTaskbarIconY 10 xTaskbarIconSize 22
Information: You see that there is missing the xTaskbarMinimized/FlashingButtonImage, if they're not set, xTaskbarNormalButtonImage will be taken. This is also on Icons and Fonts possible.

Taskbar with defined Custom Name and the same Font Settings for all buttons:
*xTaskbar MyOwnBar MyOwnBarX 20 MyOwnBarY 50 MyOwnBarWidth $resolutionx-200$ MyOwnBarHeight 27 MyOwnBarImage Taskbar_Background.png MyOwnBarNormalButtonImage TaskbarNormal_Background.png MyOwnBarActiveAlphaBlend 90 MyOwnBarActiveButtonImage xTaskbarActive_Background.png MyOwnBarActiveButtonImageMode tile MyOwnBarFont "Verdana" MyOwnBarFontHeight 16 MyOwnBarFontColor CDCDCD MyOwnBarActiveIconX 5 MyOwnBarActiveIconY 56 MyOwnBarActiveIconSize322 MyOwnBarMinimizedIconX 32 MyOwnBarMinimizedIconY 43 MyOwnBarMinimizedIconSize 22 MyOwnBarFlashingIconX 10 MyOwnBarFlashingIconY 2 MyOwnBarFlashingIconSize 53
Information: You can add as many Taskbars as you want, just give them another name. eg: you can have one bar with only icons and one with only text!

Please report bugs, if there should be any, to:
andymon@ls-universe.info

If you have wishes for xTaskbar tell them also, maybe I can realize them =)

Btw.: I'm native german, so everyone who's also german mustn't write me in English ;)

Homepage: Here you find news, updates, and some more.
www.LS-Universe.info