xTray Docs Version 1.1.1
Basic Configuration:
Main Settings - OverlayTray Setup - Background Image Setup - Background SolidColor Setup - Exported Variables
OverlayButton Setup:
Icon Background Overlay
Icon Setup:
Icon Settings
Bangs and Events:
Bang Commands - Events
Special Features:
Special Settings - Examples - Tips'n'Tricks - Contact
First of all, this is NO vTray with a 'x' instead of a 'v'!!
So you cannot use your old vTray or Systray(2) Settings and quickly switch over to xTray! You have to start more or less from start.
Key: INT = Integer or whole number BOOL = Boolean Value (true or false) COLOR = Color in Hex (FFFFFF = White, 000000 = Black, ...) ACTION = Bang Commands, Applications, all Litestep can execute.
xTrayLoadInBox BOOL
MUST be set to hook the Tray in another Module!
xTrayX INT
Sets the horizontal position of the Tray in pixels. Positive value's are relative to the left side of the desktop, negative value's are relative to the right side. You can also make the position relative to the center of the desktop by appending the character 'c' after the number ("32c", "-128c") or "Real Negative Values" by adding a '~' before the number ("~10").
Example:
xTrayx ~5 is 5 Pixel LEFT from the LEFT SIDE ( Just as info, this isn't on the screen anymore ;) )
xTrayx -5 is 5 Pixel LEFT from the RIGHT SIDE
xTrayY INT
Sets the vertical position of the Tray in pixels. Positive value's are relative to the top of the desktop, negative value's are relative to the bottom. You can also make the position relative to the center of the desktop by appending the character 'c' after the number ("32c", "-128c") or "Real Negative Values" by adding a '~' before the number ("~10").
Example:
xTrayx ~5 is now 5 Pixel ABOVE the TOP SIDE ( Just as info, this isn't on the screen anymore ;) )
xTrayx -5 is now 5 Pixel ABOVE the BOTTOM SIDE
xTrayAutoSize [INT] [INT]
If this command is present then the Tray will automatically ReSize(RePosition) itself to hold up the inital position and needed size.
If the optional two INT values are specified, those will set the Animation STEPS and DELAY of the Resize(RePosition) Process.
xTrayAutoSize 20 20 would use 20 STEPS with a DELAY of 20ms for the Aniamtion!
Caution:
This deactivates "xTrayWidth" and "xTrayHeight"!
The Position is automatically adapted, based on the "xTrayDirection" and "xTrayWrapDirection"!
That means, if you specify xTrayDirection .left the Tray Starts at "xTrayX" and grows to the LEFT, you DON'T need to reposition it (it's the normal behaviour of all AutoSizing Trays).
If you specify xTrayWrapDirection .top the Tray Starts at "xTrayY" and grows to the TOP, you DON'T need to reposition it (it's the normal behaviour of all AutoSizing Trays).
xTrayWidth INT
Sets the horizontal size of the Tray. If the value is positive then its an absolute size in pixel, if negative then its the Screen(Parentlabel) Width minus the specified value. Additionally you can make the size relative to a precentage of the Screen(Parentlabel) Width by appending the character '%' after the number ("50%", "-20")..
xTrayHeight INT
Sets the vertical size of the Tray. If the value is positive then its an absolute size in pixel, if negative then its the Screen(Parentlabel) Height minus the specified value. Additionally you can make the size relative to a precentage of the Screen(Parentlabel) Height by appending the character '%' after the number ("50%", "-20").
xTrayButtonSize INT
With this setting you can make the clickable ButtonSize (and OverlayButtons) bigger then the IconSize!
This affects the Size of the (xTrayAutoSize) xTray.
Default is xTrayIconSize.
Make sure you use only even numbers, due to the positioning inside the button (division by 2).
Because the Icons are positioned at
$(xTrayButtonSize - xTrayIconSize) / 2$
inside of the button.
So (xTrayButtonSize - xTrayIconSize) should always be a even number!
xTrayAlwaysOnTop BOOL
If this command is present then it makes the Tray "always on top". The Tray stays above all application windows.
xTrayBehindWindow "Classname" "WindowName"
If a "Classname" (and a "Windowname") is set, the Tray is placed Behind this window and will never come to front.
By Default the Tray never changes it's zOrder after first creation (if not AlwaysOnTop).
xTrayStartHidden BOOL
If this command is present then the Tray will be initially invisible. It can later be shown using bang commands.
xTrayHideIfEmpty BOOL
If defined, the Tray hides itself when it is empty, and shows up again if a TrayIcon is added.
xTrayAlphaTransparency INT
The command makes the Tray really alphatransparent (eg. you will see the background or a window you drag below the Tray shine through).
Valid values are 0-255, where 0 is totally transparent and 255 is opaque.
If no value is provided then the default is 255.
Caution:
This won't work on WinME or Win9x!
xTrayAlphaMap BOOL
If this command is present then the xTray uses a given AlphaChannel in the PNG images for painting per-pixel Alphatransparency.
Caution:
AlphaMap can only be used if an Main BG Image IS set and NO SolidColors are used for the Main BG.
This won't work on WinME or Win9x!
Using AlphaMap doesn't support:
ALPHAMAP WON'T WORK WITH HOOKED XTRAYS!!
xTrayAlphaFade BOOL
If this command is present then the Tray will be fade in/out on Show/Hide.
Caution:
This won't work on WinME or Win9x!
xTrayCustomAlphaFade (STEPSIZE) (DELAY)
If this command is present then the Tray will be fade in/out on Show/Hide with the given settings.
Caution:
This won't work on WinME or Win9x!
xTrayTransparencyMode BOOL
If defined, the Transparency (Magic Pink) will be TRUE Transparency.
xTrayBorders LEFT RIGHT TOP BOTTOM or (LEFT/RIGHT) (TOP/BOTTOM) or (LEFT/RIGHT/TOP/BOTTOM)
Accepts 4, 2 or 1 INT Value(s), which define the borders (in AutoSize Mode).
A single CFG-Line variation of:
xTrayLeftBorder
xTrayRightBorder
xTrayTopBorder
xTrayBottomBorder
xTrayLeftBorder INT
Sets the number of pixels on the left edge to reserve as a border to TrayIcons.
If no value is provided then the default is 0.
xTrayTopBorder INT
Sets the number of pixels on the top edge to reserve as a border to TrayIcons.
If no value is provided then the default is 0.
xTrayRightBorder INT
Sets the number of pixels on the right edge to reserve as a border to TrayIcons.
If no value is provided then the default is 0.
xTrayBottomBorder INT
Sets the number of pixels on the bottom edge to reserve as a border to TrayIcons.
If no value is provided then the default is 0.
xTrayLines INT
Number of TrayLines (horizontal Layout) or TrayRows (vertical Layout).
xTrayMaxLines INT
Sets the Maximal available count of Tray Lines/Rows. Restricts xTrayLines.
xTrayXSpacing INT
X (horizontal) Space between buttons.
If no value is provided then the default is 0.
xTrayYSpacing INT
Y (vertical) Space between buttons.
If no value is provided then the default is 0.
xTrayLayout ".horizontal" or ".vertical"
Sets the basic layout, and affects how a Tray can be used. Play with it to achieve what you want your Tray to look like :)
If no value is provided then the default is ".horizontal".
xTrayDirection ".left", ".right", ".top" or ".bottom"
The direction in which new Trayicons are added.
If no value is provided then the default is ".right" (".bottom" for vertical Layout).
xTrayWrapDirection ".top", ".bottom", ".left" or ".right"
The direction in which new Trayicons are added in after a Wrap in MultiLine Trays.
If no value is provided then the default is ".bottom" (".right" for vertical Layout).
xTrayWrapCount INT
This settings combines the former AutoLines and MinButtonWidth/Height! The Tray wraps (a new line is added) if the Trayicons exceed the WrapCount.
If no WrapCount is set, there is no AutoAdding of lines.
If more than one Tray Line is set and NO WrapCount is set, then the Default WrapCount is 5.
xTrayLoopIcons BOOL
If set, the icons "loop" (after the last comes again the first).
This works only when "xTrayAutoSize" is NOT set and you see only a difference if you call the Bang "!xTrayScrollIcons"
xTrayShowTooltip BOOL
Show TrayIcon Tooltips (if set to FALSE, this deactivates also "xTrayShowInfoTip"!)
If no value is provided then the default is TRUE.
xTrayShowInfoTip BOOL
Shows XP TrayIcon Infotips additionally to "Normal" Tooltips.
Works only on Win2000 and WinXP
xTrayBalloonTooltip BOOL
If set, the normal Tooltips are BallonTooltips like the InfoTips, just without Title and Icon!
xTrayTooltipDurations INT INT
The first INT value specifies in ms, how long the mouse must remain stationary within a trayicon for the tooltip to show up.
The second INT value specifies in ms, how long the toolwindow is shown. ( Minimum: 1000(ms) )
xTrayTooltipColor COLOR
Set the Background Color of Tooltips and InfoTips
xTrayTooltipTextColor COLOR
Set the Text Color of Tooltips and InfoTips
xTrayCleanUpInterval INT
Sets the amount of time in milliseconds between checks for "Crashed" TrayIcons.
If no value is provided then the default is 10000 (10 seconds).
xTrayMoveable BOOL
If this it set the Tray is moveable with the left Mouse on the Border (if no LeftClick Action is set!)
xTrayDisableDragnDrop BOOL
Simply disables completely the manual repositioning of the TrayIcons.
xTrayFocusOnEnter BOOL
If defined, the Tray "steals" the Focus from the active window, which provides instant MouseWheel functions! The One and Only intended purpose of this setting.
xTrayAlwaysFireClickEvents BOOL
If defined the Button Click Events are fired, even if a TrayIcon was clicked!
First of all, a "OverlayTray" isn't a normal Tray, it's only a plain "Image Overlay"!
You can use OverlayTray for AlphaMap Overlays, Texture Overlays, Colorizing, ...
You can combine as many OverlayTray's as you want, they can overlap each other, ...
*xTrayOverlayTray x y width height "SettingsPrefix" #a (0-255)
x, y, width and height
All position and sizing options of the normal xTray is available to setup the position and size of the OverlayTray.
For a complete and automatically adapted Overlay use for instance:
*xTrayOverlayTray 0 0 100% 100% ghost #
or for a 20 Pixel Border on the right side without Overlay:
*xTrayOverlayTray 0 0 -20 100% ghost #
...
"SettingsPrefix"
For all OverlayTray settings you need the "SettingsPrefix", which works exactly like the "xTray" for normal xTray!
Syntax:
*xTrayOverlayTray 10 10 24 24 ghost #
The correct Syntax for the OverlayTray settings are now:
GhostImage "ghost.png" GhostSaturationIntensity 75 ...
Flags
The "a" after the # specifies that THE OVERLAY! uses an AlphaMap Image!
Last Value
The last Value specifies the overall Alpha Value for the Overlay!
All SolidColors or Image Settings are valid to setup your OverlayTray Overlay!
SettingsPrefixImage ... SettingsPrefixSolidColors ...
Simply look in the following Section of the ReadMe.
xTrayBorderMethod "Raised", "Sunken", "Etched", "Bump" and ".none" (Default)
This settings draws a rectangular Border only (quite simple, but impressive), so you better use it only on rectangular TrayImages or together with SolidColors!
xTrayImage IMAGE
Sets the name of the Tray image. This file must be in BMP or PNG format format.
If no value is provided then the Tray is displayed either with the desktop background or is True Transparent depending to your settings.
xTrayImageMode "stretch", "tile", "tile-horizontal", "tile-vertical"
Sets the method used to scale the Tray image.
If no value is provided then the default is "stretch".
xTrayImageLeftEdge INT
Sets the number of pixels on the left edge of the image that will not be stretched or tiled.
If no value is provided then the default is 0.
xTrayImageRightEdge INT
Sets the number of pixels on the right edge of the image that will not be stretched or tiled.
If no value is provided then the default is 0.
xTrayImageTopEdge INT
Sets the number of pixels on the top edge of the image that will not be stretched or tiled.
If no value is provided then the default is 0.
xTrayImageBottomEdge INT
Sets the number of pixels on the bottom edge of the image that will not be stretched or tiled.
If no value is provided then the default is 0.
xTrayHueColor COLOR
This command specifies the blended in color.
You cannot use Grayscale Colors, like FFFFFF, c0c0c0, 888888, 000000, ...., because they don't have a color!
If no value is provided then the default is "FFFFFF".
xTrayHueIntensity INT
This command specifies the color of the pixel or the blended in color if HueIntensity is smaller then 100. (ONLY THE MAIN Tray BG).
Minimum: 0 -> Nothing (Default)
Maximum: 100
xTrayMixColor COLOR
This command specifies the mixed in color.
Same as the former HueColor!
If no value is provided then the default is "FFFFFF".
xTrayMixIntensity INT
This command specifies the amount of the mixed in color. (ONLY THE MAIN Tray BG).
Same as the former HueIntensity (with maximum 100 instead of 255)!
Minimum: 0 -> Nothing (Default)
Maximum: 100
xTrayLuminanceIntensity INT
This command specifies the luminance of the tray image (ONLY THE MAIN Tray BG).
Minimum: -100 -> Black
Maximum: 100 -> White
Default: 0
xTraySaturationIntensity INT
This command specifies the color saturation of the tray image. (ONLY THE MAIN Tray BG).
Minimum: 0 -> Grayscale
Maximum: 100 -> Full Colored (Default)
Values between 101-200 override the original Saturation of the Pixel!
This way you can colorize Grayscale Images.
xTraySolidColors (bgCOLOR) [(lightbevelCOLOR)] [(darkbevelCOLOR)]
Sets the colors of the Tray, first the BGColor, then optional Light and Dark BevelColors.
xTraySolidBevelSize LEFT RIGHT TOP BOTTOM or (LEFT/RIGHT) (TOP/BOTTOM) or (LEFT/RIGHT/TOP/BOTTOM)
Accepts 4, 2 or 1 INT Value(s), which define the size of the different bevel sides.
Sets the size of the painted bevel in pixels.
xTraySolidBevelSize 1 sets all borders to 1px
xTraySolidBevelSize 1 0 sets left/right borders to 1px and top/bottom borders to 0px
xTraySolidBevelSize 1 0 2 1 sets left/right/top/bottom border to the defined values
If no value is provided then the default is 0.
xTraySolidGradientColors (COLOR) [(COLOR)] [(COLOR)] ...
If defined, a Gradient is Painted with the BackgroundColor and the specified Gradient Colors. (NO GRADIENT PAINTED ON BORDER!).
xTraySolidGradientVertical BOOL
If defined, the Gradient is painted vertical instead of horizontal.
xTraySolidGradientRepeated INT
The Gradient colors are repeated in an endless loop over the whole xTray size.
INT specifies how big (in pixels) each plain color of the gradient shall be.
xTraySolidGradientType TYPE
TYPE can be:
".none" (Default: Oldstyle with (possible) multiple Gradient Colors)
".horizontal"
".vertical"
".radial"
".diagonal"
".fdiagonal"
".bdiagonal"
RESTRICTION: ONLY A TWO COLOR GRADIENT IS POSSIBLE!
xTraySolidTransformationType TYPE
TYPE can be:
".none" (Default)
".caricature"
".fisheye"
".swirled"
".cylinder"
".shift"
RESTRICTION: ONLY VALID WITH SolidGradientType <> ".none"!
(Note that you will need to define dummy variables if you include these in scripts/rc files with standard $evar$ syntax, since when LiteStep reads these files xTray has not yet added them, causing LiteStep to think the variables are undefined.)
Only useful if used in HANDTYPED BANGS (LSXCommand) or if you use it in mzscripts or with "xLabels" special "!ParseEvars" Bang Command!
To use $evars$ in Bangs, which contain the "CURRENT" value, use the escape code %# and prefix the "!ParseEvars" Bang!
$xTrayCurrentWidth$ becomes %#xTrayCurrentWidth%# and so on ...
$xTrayCurrentHWND$
The current HWND of the xTrayWindow as a int value.
Code Example:
int handle = GetRCInt("xTrayCurrentHWND", 0);
if (handle != 0)
{
HWND xTrayhWnd = (HWND) handle;
ShowWindow(xTrayhWnd, SW_HIDE);
}
$xTrayCurrentX$
The current horizontal position of the Tray.
$xTrayCurrentY$
The current vertical position of the Tray.
$xTrayCurrentWidth$
The current width of the Tray.
$xTrayCurrentHeight$
The current height of the Tray.
$xTrayCurrentIconCount$
The current count of DISPLAYED buttons in the Tray.
$xTrayCurrentLines$
The current lines/rows of the Tray.
Take a look at this setting: xTrayButtonSize
First of all, a "OverlayButton" is only a plain "Image Overlay" under the Icons!
You can use OverlayButtons for AlphaMap Overlays, Texture Overlays, Colorizing, ...
You can combine as many OverlayButton's as you want, they can overlap each other, ...
*xTrayOverlayButton x y width height "SettingsPrefix" #a
x, y, width and height
All position and sizing options of the normal xTray is available to setup the position and size of the OverlayButton.
The Overlay is always relative to the current IconSize, so most of the time you will probably use "100%" for width and height!
For a complete and automatically adapted Overlay use for instance:
*xTrayOverlayButton 0 0 100% 100% OverlayButton #
or for a 20 Pixel Border on the right side without Overlay:
*xTrayOverlayButton 0 0 -20 100% OverlayButton #
This would display an OverlayButton which is 6 pixel bigger then the normal button ("Glow Effect")
*xTrayOverlayButton ~6 ~6 100%+12 100%+12 testoverlay #a
...
SettingsPrefix
For all OverlayButton settings you need the "SettingsPrefix", which works exactly like the "xTray", for single overlays you should use "xTray"!
Attention: If you don't set a specific State Overlay, the Overlay of this state is not the Default!, so you can for instance apply an Overlay only for the Hidden State.
Syntax:
*xTrayOverlayButton 10 10 24 24 OverlayButton #
The correct Syntax for the OverlayButton settings are now:
OverlayButtonButtonImage "ghost_n.png" OverlayButtonHoverButtonImage "ghost_h.png" ...
Flags
The "a" after the # specifies that THE OVERLAY! uses an AlphaMap Image!
Supported Settings for a OverlayButton
All SolidColors or Image Settings are valid to setup your OverlayButton Overlay!
SettingsPrefixButtonImage ... SettingsPrefixButtonSolidColors ...
Simply look in the following Section of the ReadMe (ONLY FOR A DEFINED OVERLAYBUTTON!!).
(Prefix) is the Prefix of the Overlaybutton, if you only use one then use "xTray"!
(Button Type) = PlaceHolder, can be one of the following:
1. "" (Nothing/Blank) = Default value for ALL Button States
2. "Hover" = Hover Button State
3. "Hidden" = Hidden Button State
(Prefix)(Button Type)ButtonBorderMethod "Raised", "Sunken", "Etched", "Bump" and ".none" (Default)
This settings draws a rectangular Border only (quite simple, but impressive), so you better use it only on rectangular ButtonImages or together with SolidColors!
(Prefix)(Button Type)ButtonAlphaTransparency INT
If defined, the Button has the specified AlphaTransparency.
Attention:
Do not use this without a Tray BG, otherwise MagicPink shines through. Either use a BG or a AlphaMap Tray with a fully transparent Tray BG.
(Prefix)(Button Type)ButtonTrueTransparent BOOL
If defined, the Magic Pink Areas in the Image "Cut Out" the TrayMainBG.
(Prefix)(Button Type)ButtonImage IMAGE
Sets the name of the TrayIcon Background Image. This file must be in BMP or PNG format format.
If no value is provided then the Tray is displayed with the Tray background.
(Prefix)(Button Type)ButtonImageLeftEdge INT
Sets the number of pixels on the left edge of the TrayIcon Background Image that will not be stretched or tiled.
If no value is provided then the default is 0.
(Prefix)(Button Type)ButtonImageTopEdge INT
Sets the number of pixels on the top edge of the TrayIcon Background Image that will not be stretched or tiled.
If no value is provided then the default is 0.
(Prefix)(Button Type)ButtonImageRightEdge INT
Sets the number of pixels on the right edge of the TrayIcon Background Image that will not be stretched or tiled.
If no value is provided then the default is 0.
(Prefix)(Button Type)ButtonImageBottomEdge INT
Sets the number of pixels on the bottom edge of the TrayIcon Background Image that will not be stretched or tiled.
If no value is provided then the default is 0.
(Prefix)(Button Type)ButtonImageMode "stretch", "tile", "tile-horizontal" or "tile-vertical"
Sets the method used to scale the TrayIcon Background Image.
If no value is provided then the default is "stretch".
(Prefix)(Button Type)ButtonHueColor COLOR
This command specifies the blended in color.
You cannot use Grayscale Colors, like FFFFFF, c0c0c0, 888888, 000000, ...., because they don't have a color!
If no value is provided then the default is "FFFFFF".
(Prefix)(Button Type)ButtonHueIntensity INT
This command specifies the color of the pixel or the blended in color if HueIntensity is smaller then 100.
Minimum: 0 -> Nothing (Default)
Maximum: 100
(Prefix)(Button Type)ButtonMixColor COLOR
This command specifies the mixed in color.
Same as the former HueColor!
If no value is provided then the default is "FFFFFF".
(Prefix)(Button Type)ButtonMixIntensity INT
This command specifies the amount of the mixed in color.
Same as the former HueIntensity (with maximum 100 instead of 255)!
Minimum: 0 -> Nothing (Default)
Maximum: 100
(Prefix)(Button Type)ButtonLuminanceIntensity INT
This command specifies the luminance of the TrayIcon Background.
Minimum: -100 -> Black
Maximum: 100 -> White
Default: 0
(Prefix)(Button Type)ButtonSaturationIntensity INT
This command specifies the color saturation of the TrayIcon Background.
Minimum: 0 -> Grayscale
Maximum: 100 -> Full Colored (Default)
Values between 101-200 override the original Saturation of the Pixel!
This way you can colorize Grayscale Images.
Attention: Only valid, if "(Prefix)Use(Button Type)ButtonSolidColors" is set!
(Prefix)Use(Button Type)ButtonSolidColors BOOL
If defined, the SolidColor Settings for this State are enabled.
Example:
"xTrayUseHiddenButtonSolidColors"
(Prefix)(Button Type)ButtonSolidColors (bgCOLOR) [(lightbevelCOLOR)] [(darkbevelCOLOR)]
Sets the colors of the TrayButton, first the BGColor, then optional Light and Dark BevelColors.
(Prefix)(Button Type)ButtonSolidBevelSize LEFT RIGHT TOP BOTTOM or (LEFT/RIGHT) (TOP/BOTTOM) or (LEFT/RIGHT/TOP/BOTTOM)
Accepts 4, 2 or 1 INT Value(s), which define the size of the different bevel sides.
Sets the size of the painted Bevels in pixels.
xTray(Button Type)ButtonSolidBevelSize 1 sets all borders to 1px
xTray(Button Type)ButtonSolidBevelSize 1 0 sets left/right borders to 1px and top/bottom borders to 0px
xTray(Button Type)ButtonSolidBevelSize 1 0 2 1 sets left/right/top/bottom border to the defined values
If no value is provided then the default is 0.
(Prefix)(Button Type)ButtonSolidGradientType TYPE
TYPE can be:
".none" (Default: Oldstyle with (possible) multiple Gradient Colors)
".horizontal";
".vertical"
".radial"
".diagonal"
".fdiagonal"
".bdiagonal2
RESTRICTION: ONLY A TWO COLOR GRADIENT IS POSSIBLE!
(Prefix)(Button Type)ButtonSolidTransformationType TYPE
TYPE can be:
".none" (Default)
".caricature"
".fisheye"
".swirled"
".cylinder"
".shift"
RESTRICTION: ONLY VALID WITH SolidGradientType <> ".none"!
(Prefix)(Button Type)ButtonSolidGradientColors (COLOR) [(COLOR)] [(COLOR)] ...
If defined, a Gradient is painted with the BackgroundColor and the specified Gradient Colors. (NO GRADIENT PAINTED ON BORDER!).
(Prefix)(Button Type)ButtonSolidGradientVertical BOOL
If defined, the Gradient is painted vertical instead of horizontal.
(Prefix)(Button Type)ButtonSolidGradientRepeated INT
The Gradient colors are repeated in an endless loop over the whole button size.
INT specifies how big (in pixels) each plain color of the gradient shall be.
Take a look at this setting: xTrayButtonSize
xTrayIconSize INT
This command specifies the Size (Width/Height) of the displayed Icon.
Minimum: 8
Maximum: 64
If no value is provided then the default is 16.
xTrayIconHueColor COLOR
This command specifies the blended in color of the Icons.
You cannot use Grayscale Colors, like FFFFFF, c0c0c0, 888888, 000000, ...., because they don't have a color!
If no value is provided then the default is "FFFFFF".
xTrayIconHueIntensity INT
This command specifies the color of the pixel or the blended in color if HueIntensity is smaller then 100.
Minimum: 0 -> Nothing (Default)
Maximum: 100
xTrayIconMixColor COLOR
This command specifies the mixed in color of the Icons.
Same as the former HueColor!
If no value is provided then the default is "FFFFFF".
xTrayIconMixIntensity INT
This command specifies the amount of the mixed in color of the Icons.
Same as the former HueIntensity (with maximum 100 instead of 255)!
Minimum: 0 -> Nothing (Default)
Maximum: 100
xTrayIconLuminanceIntensity INT
This command specifies the luminance of the icons.
Minimum: -100 -> Black
Maximum: 100 -> White
Default: 0
xTrayIconSaturationIntensity INT
This command specifies the color saturation of the icons.
Minimum: 0 -> Grayscale
Maximum: 100 -> Full Colored (Default)
Values between 101-200 override the original Saturation of the Pixel!
This way you can colorize Grayscale Images.
Hover Icon State:
xTrayHoverIconSize INT
This command specifies the Size (Width/Height) of the displayed Hover Icon.
Make sure you have enough place in the Tray for the HoverIcon, cause the HoverIconSize isn't tracked for AutoSize!
Minimum: 8
Maximum: 64
If no value is provided then the default is 16.
xTrayHoverIconHueColor COLOR
This command specifies the blended in color of the Hover Icons.
You cannot use Grayscale Colors, like FFFFFF, c0c0c0, 888888, 000000, ...., because they don't have a color!
If no value is provided then the default is "FFFFFF".
xTrayHoverIconHueIntensity INT
This command specifies the color of the pixels or the blended in color if HueIntensity is smaller then 100.
Minimum: 0 -> Nothing (Default)
Maximum: 100
xTrayHoverIconMixColor COLOR
This command specifies the mixed in color of the Hover Icons.
Same as the former HueColor!
If no value is provided then the default is "FFFFFF".
xTrayHoverIconMixIntensity INT
This command specifies the amount of the mixed in color of the Hover Icons.
Same as the former HueIntensity (with maximum 100 instead of 255)!
Minimum: 0 -> Nothing (Default)
Maximum: 100
xTrayHoverIconLuminanceIntensity INT
This command specifies the luminance of the Hover Icons.
Minimum: -100 -> Black
Maximum: 100 -> White
Default: 0
xTrayHoverIconSaturationIntensity INT
This command specifies the color saturation of the Hover Icons.
Minimum: 0 -> Grayscale
Maximum: 100 -> Full Colored (Default)
Values between 101-200 override the original Saturation of the Pixel!
This way you can colorize Grayscale Images.
Hidden Icon State:
xTrayHiddenIconSize INT
This command specifies the Size (Width/Height) of the displayed Hidden Icon.
Make sure you have enough place in the Tray for the HiddenIcon, cause the HiddenIconSize isn't tracked for AutoSize!
Minimum: 8
Maximum: 64
If no value is provided then the default is 16.
xTrayHiddenIconHueColor COLOR
This command specifies the blended in color of the Hidden Icons.
You cannot use Grayscale Colors, like FFFFFF, c0c0c0, 888888, 000000, ...., because they don't have a color!
If no value is provided then the default is "FFFFFF".
xTrayHiddenIconHueIntensity INT
This command specifies the color of the pixels or the blended in color if HueIntensity is smaller then 100.
Minimum: 0 -> Nothing (Default)
Maximum: 100
xTrayHiddenIconMixColor COLOR
This command specifies the mixed in color of the Hidden Icons.
Same as the former HueColor!
If no value is provided then the default is "FFFFFF".
xTrayHiddenIconMixIntensity INT
This command specifies the amount of the mixed in color of the Hidden Icons.
Same as the former HueIntensity (with maximum 100 instead of 255)!
Minimum: 0 -> Nothing (Default)
Maximum: 100
xTrayHiddenIconLuminanceIntensity INT
This command specifies the luminance of the Hidden Icons.
Minimum: -100 -> Black
Maximum: 100 -> White
Default: 0
xTrayHiddenIconSaturationIntensity INT
This command specifies the color saturation of the Hidden Icons.
Minimum: 0 -> Grayscale
Maximum: 100 -> Full Colored (Default)
Values between 101-200 override the original Saturation of the Pixel!
This way you can colorize Grayscale Images.
The exact purpose of every bang should be quite obvious.
!xTrayAlwaysOnTop ("true"|"on", "false"|"off" or "toggle"|"switch")
"true" or "on": Makes the Tray "always on top". That is, it stays above all application windows.
"toggle" or "switch": Switches the Tray back and forth between the always on top and pinned to desktop states.
"false" or "off": Pins the Tray to the desktop so that it stays below all application windows. This the default state and is the opposite of always on top.
!xTrayHide
Hides the Tray, making it invisible.
!xTrayLSBoxHook
Called by the Parent Window to hook xTray. Do not call manually!
xTrayLoadInBox MUST be set to hook the Tray in another Module!
!xTrayMove X Y [STEPS] [TIME]
Moves the Tray.
With animation, if (STEPS) AND (TIME) are also defined. STEPS are the animation steps and TIME the pause between two steps in milliseconds.
Maximum TIME: 50ms ( Keep it short ;) )
!xTrayMoveBy X Y [STEPS] [TIME]
Lets you move the Tray according to its current positioning. To keep current position set x or y to 0. Negative values move the Tray to left/top, positive to right/bottom.
With animation, if (STEPS) AND (TIME) are also defined. STEPS are the animation steps and TIME the pause between two steps in milliseconds.
Maximum TIME: 50ms ( Keep it short ;) )
!xTrayRefresh SETTING NEWVALUE
"Refreshes" the Tray with the updated xTraysetting.
You can change "EVERY" Traysetting On-The-Fly without the need of a hardcoded bang! This is like Normal Bangs only temporary until next Recycle! If you want to keep settings, you must change and save them.
Examples:
You want (On-The-Fly) another Background Image for the Tray, simply call this Bang:
!xTrayrefresh xTrayimage new_image.png
Attention:
You need always TWO settings!
!xTrayRefresh xTrayShowTooltips
won't work, you must define the new setting value (e.g. false)
!xTrayRefresh xTrayShowTooltips false
!xTrayReposition X Y WIDTH HEIGHT [STEPS] [TIME]
Repositions (moves and resizes) the Tray.
With animation, if (STEPS) AND (TIME) are also defined. STEPS are the animation steps and TIME the pause between two steps in milliseconds.
Maximum TIME: 50ms ( Keep it short ;) )
!xTrayRepositionBy X Y WIDTH HEIGHT [STEPS] [TIME]
Repositions (moves and resizes) the Tray according to its current positioning and size.
To keep current position set x or y to 0. Negative values move Tray to left/top, positive to right/bottom.
To keep current size set cx or cy to 0. If negative, it shrinks the Tray about cx in width and/or cy in height. If positive, it grows the Tray about cx in width and/or cy in height.
With animation, if (STEPS) AND (TIME) are also defined. STEPS are the animation steps and TIME the pause between two steps in milliseconds.
Maximum TIME: 50ms ( Keep it short ;) )
!xTrayResize WIDTH HEIGHT [STEPS] [TIME]
Resizes the Tray.
With animation, if (STEPS) AND (TIME) are also defined. STEPS are the animation steps and TIME the pause between two steps in milliseconds.
Maximum TIME: 50ms ( Keep it short ;) )
!xTrayResizeBy WIDTH HEIGHT [STEPS] [TIME]
Resizes the Tray relative to current size.
If negative, it shrinks the Tray about cx in width and/or cy in height.
If positive, it grows the Tray about cx in width and/or cy in height.
To keep current width and/or height set cx or cy to 0.
With animation, if (STEPS) AND (TIME) are also defined. STEPS are the animation steps and TIME the pause between two steps in milliseconds.
Maximum TIME: 50ms ( Keep it short ;) )
!xTrayScrollIcons "next" or "prev" [AMOUNT]
Scrolls the Icons back and forth. This works only, if NO xTrayAutoSize is set!
The optional AMOUNT, specifies how many Icons will be scrolled.
If the AMOUNT reaches/exceeds the first or last Icon, the current Scroll will stop there.
See also xTrayLoopIcons
!xTraySetAlpha INT [STEPS] [TIME]
Set AlphaTransparency on the fly.
With Fade Animation, if (STEPS) AND (TIME) are also defined. STEPS are the fade steps and TIME the pause between two steps in milliseconds.
!xTrayShow
Shows the Tray, making it visible.
!xTrayToggle
Switches the Tray back and forth between the visible and invisible states.
!xTrayToggleHiddenIcons
Switches the Tray back and forth between the visible and invisible state of Hidden TrayIcons.
Remember:
You can Hide TrayIcons with *xTrayHide or by Pressing CTRL and MiddleClick the Icon.
You can Show Hidden TrayIcons by Pressing CTRL and MiddleClick the Icon (use !xTrayToggleHiddenIcons to show them first).
xTrayAlwaysFireClickEvents BOOL
If defined the Button Click Events are fired, even if a TrayIcon was clicked!
xTrayOnEnter ACTION
Sets an action to perform when the mouse cursor enters the Tray.
xTrayOnLeave ACTION
Sets an action to perform when the mouse cursor leaves the Tray.
xTrayOnShow ACTION
Sets an action to perform after the Tray is shown.
xTrayOnHide ACTION
Sets an action to perform after the Tray is hidden.
xTrayOnLeftClickDown ACTION
Sets an action to perform when the user presses the left mousebutton down on the Tray.
xTrayOnLeftClickUp ACTION
Sets an action to perform when the user releases the left mousebutton on the Tray.
xTrayOnMiddleClickDown ACTION
Sets an action to perform when the user presses the middle mousebutton down on the Tray.
xTrayOnMiddleClickUp ACTION
Sets an action to perform when the user releases the middle mousebutton on the Tray.
xTrayOnRightClickDown ACTION
Sets an action to perform when the user presses the right mousebutton down on the Tray.
xTrayOnRightClickUp ACTION
Sets an action to perform when the user releases the right mouse button on the Tray.
xTrayOnWheelDown ACTION
Sets an action to perform when the mouse wheel scrolls down while the mouse cursor hovers over the Tray.
See also: xTrayFocusOnEnter
xTrayOnWheelUp ACTION
Sets an action to perform when the mouse wheel scrolls up while the mouse cursor hovers over the Tray.
See also: xTrayFocusOnEnter
xTrayOnResize ACTION
Sets an action to perform when the Tray has changed its size.
xTrayOnMove ACTION
Sets an action to perform when the Tray has changed its position.
xTrayOnAdd ACTION
Sets an action to perform when a Trayicon has been added.
xTrayOnRemove ACTION
Sets an action to perform when a Trayicon has been removed.
xTrayOnLineAdd ACTION
Sets an action to perform when a line has been added.
xTrayOnLineRemove ACTION
Sets an action to perform when a line has been removed.
xTrayOnIconHide ACTION
In ACTION, "%[classname]%" will be replaced with the Classname and "%[windowtext]%" will be replaced with the Windowtext.
xTrayOnIconUnHide ACTION
In ACTION, "%[classname]%" will be replaced with the Classname and "%[windowtext]%" will be replaced with the Windowtext.
The following "WildcardString" references use the "Standard Wildcard" Syntax!
In the Wildcard String:
'*' matches any sequence of characters (zero or more)
'?' matches any character
[SET] matches any character in the specified set,
[!SET] or [^SET] matches any character not in the specified set.
A set is composed of characters or ranges; a range looks like character hyphen character (as in 0-9 or A-Z). [0-9a-zA-Z_] is the minimal set of characters allowed in the [..] pattern construct. Other characters are allowed (ie. 8 bit characters) if your system will support them.
To suppress the special syntactic significance of any of '[]*?!^-', and match the character exactly, precede it with a '\'.
You can remove the Buttons of specific Applications with the following:
*xTrayHide "SubString from Classname" ["SubString from Windowname"]
The "Classname" is required, the "Windowname" is optional!
Without a specified "Windowname", all Icons which match "Classname" will be hidden.
All Applications, which match the specifications, will not be shown in xTray.
Example:
*xTrayHide "*free*"
All Applications, which have the string "free" somewhere in their Classname, will be ignored from xTray.
You can Show(Hide) them with !xTrayToggleHiddenIcons!
You can deactivate the Manual Positioning of Icons of specific Applications with the following:
*xTrayNoDragnDrop "SubString from Classname" ["SubString from Windowname"]
The "Classname" is required, the "Windowname" is optional!
Without a specified "Windowname", all Icons which match "Classname" won't react on Drag'n'Drop.
All Applications, which match the specifications, will not react on manual repositioning.
You can sort Icons of specific Applications with the following:
*xTrayPosition INT "SubString from Classname" ["SubString from Windowname"]
The INT and "Classname" is required, the "Windowname" is optional!
You can set a fixed (unchangeable!) order of TrayIcons with these lines!
Starting with the lowest INT, all TrayIcons with a matching *xTrayPosition line are sorted ascending.
You can sort Icons with *xTrayPosition also at the END of the xTray! Just use positions values GREATER than 100, the highest is the last.
All other TrayIcons are ordered, AFTER those with a *xTrayPosition line smaller then 100 and BEFORE those with a *xTrayPosition line greater then 100, the same way as before, in order of creation or a later drag'n'drop positioning.
Without a specified "Windowname", all Icons which match "Classname" won't react on Drag'n'Drop.
To obtain the correct values for Classname and Windowname, perform a MiddleClick on an Icon while pressing SHIFT key!
Normal AutoSizing Singleline xTray in the bottomright of the screen growing to the left. Sends a Command to resize an aligned Tray!
xTrayX -0 xTrayY -24 xTrayBorders 4 xTrayAutoSize xTraySolidColors c0c0c0 000000 xTraySolidBevelSize 1 xTrayDirection .left xTrayOnResize !parseevars !xTaskbarResize %#resolutionx-xtraycurrentwidth$# %#xtaskbarcurrentheight%#
The same as above without a BG and without Pink IconBorders under XP
xTrayX -0 xTrayY -24 xTrayBorders 4 xTrayAutoSize IF WINXP xTrayAlphaMap xTrayImage transparent.png (a fully Transparent AlphaMap Image!) ENDIF xTrayDirection .left xTrayOnResize !parseevars !xTaskbarResize %#resolutionx-xtraycurrentwidth%# %#xtaskbarcurrentheight%#
Two Lines, vertically filled (top->bottom) with automatically added and removed lines (growing to the left)!
xTrayX -0 xTrayY -40 xTrayAutoSize xTrayLayout .vertical xTrayDirection .bottom xTrayWrapDirection .left xTrayLines 2 xTrayWrapCount 2 xTraySolidColors c0c0c0 000000 xTraySolidBevelSize 1
No AutoSizing, Two Lines, horizontally filled (left->right) a WrapCount of 3 to the bottom, with automatically added space when more then 6 icons occur (growing to the left)!
xTrayX -56 xTrayY -40 xTrayWidth 56 xTrayHeight 40 xTrayBorders 4 xTrayDirection .left xTrayLines 2 xTrayWrapCount 3 xTraySolidColors c0c0c0 000000 xTraySolidBevelSize 1 xTrayOnLineAdd !parseevars !execute [!xtrayrepositionby -16 0 16 0][!xTrayRefresh xTrayWrapCount %#xTraywrapcount+1%#]
An so on, i hope you got a little impression. It's basically the same as in xTaskbar, if you can setup xTaskbar, you can easily setup xTray :)
You miss the popping up Tray InfoTips from Win2000/XP!
Simply set xTrayShowInfoTip and be happy. Not all features, such as clickable Links in SP2, work, but at least you get the Info!
You want an Icon-Only Tray, and all the other Tray Modules gave you Pink Outlines under WinXP!
Case 1:
The xTray is directly on the Desktop (not hooked or AlwaysOnTop)!
It works from alone, cause you have FakeTransparency by Default activated :)
Icons Look Perfect!
Case 2:
The xTray is hooked!
First, you should set xTrayTransparencyMode just to be sure ;)
Without any problem it works now, BUT, the AlphaChannel is simply removed, so some icons will look less good!
AlphaChannel Icons Look Poorer!
Case 3:
The xTray isn't hooked, but AlwaysOnTop!
You must set xTrayAlphaMap AND use a fully transparent Image (100% Transparency) as xTrayImage!!
Icons Look Perfect!
In this case works also the poorer looking solution mentioned in Case 2!
You can reposition the TrayIcons per Drag'n'Drop!
Simply Press the Left Button Down on an Icon and while pressing the Button further Move over another Icon and release the Button.
You can "Hide TrayIcons" automatically or manually!
Either use *xTrayHide "SubString from Classname" ["SubString from Windowname"] or perform a MiddleClick on an Icon while pressing CTRL Key!
In both cases the matching Icon will be hidden from the Tray!
You can Toggle them on again with the Bang !xTrayToggleHiddenIcons (then use the CTRL+MiddleClick to reshow them permanently).
Those icons with the "Hidden" Flag have an Info in the Tooltip, so that you can identify them.
You can move the Tray with the Border and LeftButton!
Simply enable it via xTrayMoveable, make sure you have a Border and you don't have set a LeftClick Tray Action!
You can Scroll through the Icons, in an endless Loop, with the MouseWheel or MiddleClick (not in AutoSize Mode!)
You have also the Bang !xTrayScrollIcons "next" or "prev" [AMOUNT] for that. The optional AMOUNT, specifies how many Icons will be scrolled. If the AMOUNT reaches/exceeds the first or last Icon, the current Scroll will stop there.
You can obtain the neccessary Hiding Informations for "*xTrayHide", "*xTrayNoDragnDrop" or *xTrayPosition automatically!
To obtain the correct values for hiding, perform a MiddleClick on an Icon while pressing SHIFT key!
Please report bugs, if there should be any, to:
andymon at ls-universe dot info
Homepage:
http://www.ls-universe.info/
Here you find News, Updates, and some more.