xPopup v1.1 Final ReadMe

OverView

Well, let's enumerate some main features:

Multiple Syntax for unlimited different Popups (each popup can have it's unique look).
QuicklaunchMode with only Icons and ToolTips.
Shaded Popups
Drop Features for easy adding Items to PopupFolders or Quicklaunch.
MultiColumn Popups and/or MultiPart Popups.
Continuous BG Picture (Popup can have ANY shape you wish)
AlphaMap PopupMenus
AlphaFading and AlphaTransparent Popups
All Icons and Images can have different Saturation and Hueing
All Text, Icon, Image, Gradient features you know from xLabel or xTaskbar
Dynamic Info Entrys, which can provide ANY Info xLabel(Light) can serve (if loaded of course ;))
General Module Hooking Support: You can hook LsxCommand in the Popup or the complete xTaskbar
Compatible to *Popup settings in Compatibility Mode, so you don't have to change your settings in the Personal Folder. If you want to, you can load Popup2 and xPopup at the same time without problems.

If you combine all these things, you'll get even more possibilities.

But (There's always a "But"), some things are no longer supported! They will naturally be parsed out, they won't bother someone to remove them manually :)

Some Special abilities of Popup2 are obsolete due to "Dynamic Info Entrys" and "Module Hook Support", as there are:
!datetime, !remoteamp, !popupimage and !popuprun.

Also a special Popup Folder isn't implemented:
!PopupDesktops

Start Your Engines =)

↑

Main Settings

xPopupCompatibilityMode BOOL
If this is set xPopup reads the *Popup lines instead of it's own *xPopup lines.
This should allow you to use your old *Popup Menu Definitions, if you should switch completely to xPopup!

xPopupCacheAllPopupsAtStartup BOOL
If set, ALL PopupMenus AND ALL SubPopupMenus are loaded at Startup!
Positive: You will never have to wait for the first creation.
Negative: All max needed Resources are always used.

One major addition to the Default *(x)Popup PopupMenu definitions is the ability to setup different PopupStyles (Settings) for each defined PopupMenu!
Currently you define a new PopupMenu with the following:
*(x)Popup "Caption/Title" !New !PopupBang

This makes PopupMenu based on xPopup... Settings (xPopupEntryImage entry.png and so on).
Now you can add another Option to make PopupMenu's which are based on QuickPopup... Settings for instance (QuickPopupEntryImage entry.png and so on).

Example:
*(x)Popup "Caption/Title" !New !PopupBang quickpopup

Not so hard to understand, or? As always the LS-Universe Forum is open for questions :)

Short Default Settings:

xpopupcompatibilitymode xpopupusesolidcolors xpopupuseentrysolidcolors xpopupentryfontleftborder 20 xpopuptopborder 20

With these 5 Settings you have a simple, but useable xPopup to start with.

↑

Settings

Quicklaunch Mode Setup

QuicklaunchMode ".horizontal", ".vertical" or ".none"
If set to ".horizontal", the Popup gets a horizontal ICON only Layout with Tooltips.
If set to ".vertical", the Popup gets a vertical ICON only Layout with Tooltips.
Icon Direction is always left->right / top->bottom and cannot be changed.
WrapDirection is always right / bottom and cannot be changed.
Default is naturally ".none"!

QuicklaunchOpenTo ".right", ".left" in Horizontal or ".top", ".bottom" in Vertical Mode
Defines the Direction to which the Quicklaunch show open SubFolders, Default is ".top", ".right"!

QuicklaunchItemSize INT
Defines the Square Size of one QuicklaunchItem, Default is 32 -> 32x32

QuicklaunchWrapCount INT
Defines the Count of Items till a Wrap is performed, Default is unlimited (100).

HideDelay INT
Popuphide Delay (Checking Interval), if PopupMenu must be hidden.
Default is 250(ms), if this is too long for someone, set this maybe to 100.

FolderOpenDelay INT
FolderOpen Delay, specifies how long must the mouse be over the Folderentry till the SubFolder is opened.
Default is 1(ms)

TasksUpdateInterval INT
UpdateInterval for Pinned TasksPopup Menus.
Default is 5000(ms)

AutoMenuBreak BOOL
If set, the PopupMenu automatically makes a new Column instead of the MultiPart implementation.

MaxEntryWidth INT
Sets the maximum horizontal size of a single PopupMenu Entry. This must be an absolute value.

MinEntryWidth INT
Sets the minimum horizontal size of a single PopupMenu Entry. This must be an absolute value.

MinWidth INT
Sets the minimum horizontal size of the Popup. This must be an absolute value.

MinHeight INT
Sets the minimum vertical size of the Popup. This must be an absolute value. Default is bigger one of "TopBorder+BottomBorder" or "ImageTopEdge+ImageBottomEdge".

MaxWidth INT
Sets the maximum horizontal size of the Popup. This must be an absolute value.

MaxHeight INT
Sets the maximum vertical size of the Popup. This must be an absolute value.

WorkArea LEFT RIGHT TOP BOTTOM
Can be used to set a Custom WorkArea for the SnapFeature, all Coordinate Helpers work ('-', '~', 'c')
Default is the Normal Desktop as before.

RestrictToWorkArea BOOL
If set, the Popup is shown only inside the WorkArea (see above) and cannot be moved, sized or repositioned outside!

OpenToLeft BOOL
If set, all Folders open by Default to the Left instead of to the Right.

PinnedPopupNotOnTop BOOL
If this command is present, then the Pinned Popup's won't be AlwaysOnTop.

ManualUnPin BOOL
Default TRUE, if set to FALSE, you cannot close PopupMenus with LeftDoubleClick,....
Means, you cannot remove Pinned Popups, without calling it again or use !(PopupName)Unpin.

Moveable BOOL
Default TRUE, if set to FALSE, you cannot move PopupMenus with TopBorder or BottomBorder.

PinOnMove BOOL
Default TRUE, if set to FALSE, SubFolders, which are Dragged away from their Parent aren't automatically Pinned.

Shadeable BOOL
Default TRUE, if set to FALSE, you cannot shade PopupMenus with RightClick on TopBorder.

DropShadow BOOL
If this command is present then the Popup will have the "DropShadow" invented with WinXP.
Caution: This works only under WinXP!

AlphaMap BOOL
If this command is present then the Popup uses a given AlphaChannel in the PNG images for painting per-pixel alphatransparency.
Caution:
This won't work on WinME or Win9x!
Using AlphaMap doesn't support:
!Hook (does not hook other modules!)

AlphaTransparency INT
The command makes the Popup really alphatransparent (eg. you will see the background or a window shine through).
Caution: This won't work on WinME or Win9x!
Valid values are 0-255, where 0 is totally transparent and 255 is opaque.
Default is 255.

AlphaFade ".mainpopups", ".allpopups" or BOOL
If this command is present then the Popup will be fade in/out on Show/Hide.
TRUE or ".allpopups" would fade all Popups.
".mainpopups" would only fade the TopLevel Popup
Caution:
This won't work on WinME or Win9x!

CustomAlphaFade (stepsize) (delay)
If this command is present then the Popup will be fade in/out on Show/Hide with the given settings.
Caution:
This won't work on WinME or Win9x!

AutoSeparator BOOL
Show a automatically added !Separator between Folders and Files in !PopupDynamicFolder and !PopupFolder Entry's.

OverlapX INT
Determines how much a sub-menu will overlap its parent menu in horizontal direction. If no value is provided then the default is 0.

OverlapY INT
Determines how much a sub-menu will overlap its parent menu in vertical direction. If no value is provided then the default is "-TOPBORDER".

EntryHeight INT
This will set the Height of each Popup Entry (Entry and ActiveEntry). If no value is provided then the default is the Height of the used Image. If SolidColors are used the default is 20.

FolderHeight INT
This will set the Height of each Popup Entry (Folder and ActiveFolder). If no value is provided then the default is the Height of the used Image. If SolidColors are used the default is "EntryHeight".

InfoHeight INT
This will set the Height of each !Info Entry. If no value is provided then the default is "EntryHeight".

SeparatorHeight INT
This will set the Height of each Separator Entry. If no value is provided then the default is the Height of the used Image. If SolidColors are used the default is 2.

EntryShowText BOOL ActiveEntryShowText BOOL FolderShowText BOOL ActiveFolderShowText BOOL
Show Text in Popup Entrys, optional per State setup. Default is TRUE.

EntryShowIcon BOOL ActiveEntryShowIcon BOOL FolderShowIcon BOOL ActiveFolderShowIcon BOOL
Show Icons in Popup Entrys, optional per State setup. Default is TRUE.

EntryUseBigIcon BOOL ActiveEntryUseBigIcon BOOL FolderUseBigIcon BOOL ActiveFolderUseBigIcon BOOL
Use 32x32 Icons in Popup Entrys instead of the 16x16 Icons, optional per State setup. Default is FALSE.

DefaultIcon ICON
Use this Icon in Popup Entrys, if no Icon is found.

FolderIcon ICON
Use this Icon in Popup Folder Entrys.

ShowExtensions BOOL or "ExclusionList"
Shows Extension of Popup Entrys. If the ExclusionList is set, the specified Extensions will never be shown, all others will be displayed!
ExclusionList Syntax:
".lnk|.bat|.pif"

ShowCaption ".none", ".top" and ".bottom"
Shows Title/Caption either at TOP or BOTTOM or none at all.

FolderOpenOnClick BOOL
If set, SubFolders open only on definite "Click" no longer on "Hover".

TopBorder INT
Sets the number of pixels on the top edge to reserve as a border to Popup Entrys. If no value is provided then the default is 0.
Attention:
This is also used for the "Title" (if "ShowCaption" is set to ".top") and for Moving! If you want to move the Popup or want a "Top"Title, you should set your "TitleHeight" here.

BottomBorder INT
Sets the number of pixels on the bottom edge to reserve as a border to Popup Entrys. If no value is provided then the default is 0.
Attention:
This is also used for the "Title" (if "ShowCaption" is set to ".bottom") and for Moving! If you want to move the Popup or want a "Bottom"Title, you should set your "TitleHeight" here.

LeftBorder INT
Sets the number of pixels on the left edge to reserve as a border to Popup Entrys. 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 to Popup Entrys. If no value is provided then the default is 0.

XSpacing INT
X Space between Popup Entrys, after a "Menubreak" If no value is provided then the default is 0.

YSpacing INT
Y Space between Popup Entrys. If no value is provided then the default is 0.

Normal Images Setup

Image IMAGE
Sets the name of the continuous Popup BG Image. This file must be in BMP or PNG format format. If no value is provided then the Popup is displayed True Transparent.

ImageMode "stretch", "tile", "tile-horizontal", "tile-vertical"
Sets the method used to scale the continuous Popup BG Image. If no value is provided then the default is "stretch".

ImageLeftEdge INT
Sets the number of pixels on the left edge of the continuous Popup BG Image that will not be stretched or tiled. If no value is provided then the default is 0.

ImageRightEdge INT
Sets the number of pixels on the right edge of the continuous Popup BG Image that will not be stretched or tiled. If no value is provided then the default is 0.

ImageTopEdge INT
Sets the number of pixels on the top edge of the continuous Popup BG Image that will not be stretched or tiled. If no value is provided then the default is "xPopupTopBorder".

ImageBottomEdge INT
Sets the number of pixels on the bottom edge of the continuous Popup BG Image that will not be stretched or tiled. If no value is provided then the default is "xPopupBottomBorder".

SaturationIntensity INT
This command specifies the color saturation of the continuous Popup BG Image (ONLY THE MAIN POPUP BG).
Minimum: 0 -> Grayscale
Maximum: 255 -> Full Colored (Default)

HueIntensity INT
This command specifies the amount of the, in the continuous Popup BG Image, blended in color (ONLY THE MAIN POPUP BG).
Minimum: 0 -> Nothing (Default)
Maximum: 255

HueColor COLOR
This command specifies the blended in color.
Default: FFFFFF

Solid Image Setup

Attention: Only valid, if "UseSolidColors" is set!

UseSolidColors BOOL
If set, the SolidColor Settings are enabled.

SolidColors (bgcolor) [(lightbevelcolor)] [(darkbevelcolor)]
Sets the colors of the Popup BG, first the BGColor, then optional Light and Dark BevelColors

SolidBevelSize INT
Sets the size of the painted bevel in pixels.
Default: 0

SolidGradientColors (color) [(color)] [(color)] ...
If defined, a Gradient is Painted with the BackgroundColor and the specified Gradient Colors.
(NO GRADIENT PAINTED ON BORDER!).

SolidGradientVertical BOOL
If set, the Gradient is painted vertical instead of horizontal.

BorderMethod ".none", "raised", "etched", "sunken", "bump"
Draws a rectangular border with the specified style around the Popup. Best for SolidColors, and only for rectangular BG Images.

↑

Popup Entry State Settings

Overview "Popup Entry Image Settings"

ActiveFolderUseFolderDefault
If set, the Default for "ActiveFolder" Settings are "Folder" Settings instead od "ActiveEntry" Settings.
This setting affects "ActiveFolder" Default for ALL specific settings (Texture, Font and Icon!)

The "(Entry Type)" in front of each setting means, that every setting can be:
Entry, ActiveEntry, Folder, ActiveFolder or Info
If you set a setting with "Entry", then, THIS becomes Default for all other States except "Info"! If you set a setting with "ActiveEntry" then, THIS becomes Default for "ActiveFolder", if you specify "xPopupActiveFolderUseFolderDefault", "Folder" is used as default for "ActiveFolder"!

Example:
xPopupEntrySaturationIntensity 70
All Popup Entry States have a SaturationIntensity of 70!
xPopupActiveEntrySaturationIntensity 70
Only Active Popup Entrys have a SaturationIntensity of 70!

"Separator" and "Arrow", "ActiveArrow" are special!
The "Separator" Prefix allows you to setup a Separator Image, which is painted at !separator lines.
The "Arrow" and "ActiveArrow" Prefixes are limited to (Entry Type)Image IMAGE and are for Custom Folder Indicators and are only painted on Folder Entry's ("Arrow" is Default for "ActiveArrow"!)
You can use Magic Pink in all Images!

Arrow Image Setup

ArrowImage IMAGE
Sets the name of the Folder Arrow Image. This file must be in BMP or PNG format format. If no value is provided, then no Arrow is painted.

ArrowOffset INT
Specifies the distance between the Entry Border and the ArrowImage. If no value is provided, then the default is 4.

ArrowOnLeft BOOL
If set, the Arrow is painted on the left Side of the Entry instead of the right Side.

ActiveArrowImage IMAGE
Sets the name of the Active Folder Arrow Image. This file must be in BMP or PNG format format. If no value is provided, then no ActiveArrow is painted.

ActiveArrowOffset INT
Specifies the distance between the Entry Border and the ActiveArrowImage. If no value is provided, then the default is "ArrowOffset".

ActiveArrowOnLeft BOOL
If set, the ActiveArrow is painted on the left Side of the Entry instead of the right Side. If no value is provided, then the default is "ArrowOnLeft".

Popup Entry Image Settings

Normal Images Setup

(Entry Type)TrueTransparent BOOL
If set "Magic Pink" in IMAGES will be condidered as TRUE TRANSPARENT
-> You see the the "Desktop", instead of the MainPopupBG (if used!)
So you can make better mixtures between Real Transparency and MainPopupBG. Till now, only "Magic Pink" in MainPopupBG was Real Transparent all others usages only showed the MainPopupBG (if used!).
xPopup(EntryType)TrueTransparent has with ALPHAMAP ENABLED, a different function as with normal images!
If set, the EntryImageAlphaMap REPLACES the MainPopup BG and it's AlphaMap completely.
If not set (Default), the EntryImageAlphaMap IS PAINTED WITH THEIR AlphaMap ONTO the MainPopup BG.
This is a quite important difference, as some people already have discovered, so check out which method is better to achieve your goals.

(Entry Type)Image IMAGE
Sets the name of the Popup Entry Image. This file must be in BMP or PNG format format. If no value is provided then the Popup is displayed with the Popup background.

(Entry Type)ImageLeftEdge INT
Sets the number of pixels on the left edge of the Popup Entry Image that will not be stretched or tiled. If no value is provided then the default is 0.

(Entry Type)ImageTopEdge INT
Sets the number of pixels on the top edge of the Popup Entry Image that will not be stretched or tiled. If no value is provided then the default is 0.

(Entry Type)ImageRightEdge INT
Sets the number of pixels on the right edge of the Popup Entry Image that will not be stretched or tiled. If no value is provided then the default is 0.

(Entry Type)ImageBottomEdge INT
Sets the number of pixels on the bottom edge of the Popup Entry Image that will not be stretched or tiled. If no value is provided then the default is 0.

(Entry Type)ImageMode "stretch", "tile", "tile-horizontal" or "tile-vertical"
Sets the method used to scale the Popup Entry Image. If no value is provided then the default is "stretch".

(Entry Type)SaturationIntensity INT
This command specifies the color saturation of the Popup Entry.
Minimum: 0 -> Grayscale
Maximum: 255 -> Full Colored (Default)

(Entry Type)HueIntensity INT
This command specifies the amount of the, in the Popup Entry, blended in color.
Minimum: 0 -> Nothing (Default)
Maximum: 255

(Entry Type)HueColor COLOR
This command specifies the blended in color.
Default: FFFFFF

Solid Image Setup

Attention: Only valid, if "xPopupUse(Entry Type)SolidColors" is set!

Use(Entry Type)SolidColors BOOL
If set, the SolidColor Settings for this State are enabled.
Example: "xPopupUseActiveEntrySolidColors"

(Entry Type)SolidColors (bgcolor) [(lightbevelcolor)] [(darkbevelcolor)]
Sets the colors of the Popup Entry, first the BGColor, then optional Light and Dark BevelColors

(Entry Type)SolidBevelSize INT
Sets the size of the painted bevel in pixels.
Default: 0

(Entry Type)SolidGradientColors (color) [(color)] [(color)] ...
If defined, a Gradient is Painted with the BackgroundColor and the specified Gradient Colors.
(NO GRADIENT PAINTED ON BORDER!).

(Entry Type)SolidGradientVertical BOOL
If set, the Gradient is painted vertical instead of horizontal.

(EntryType)BorderMethod ".none", "raised", "etched", "sunken", "bump"
Draws a rectangular border with the specified style around the specified EntryType. Best for SolidColors, and only for rectangular Entry Images.

Overview "Icon Settings"

The "(Entry Type)" in front of each setting means that every setting can be:
Entry, ActiveEntry, Folder or ActiveFolder
If you set a setting with "Entry", then, THIS becomes Default for all other States! If you set a setting with "ActiveEntry" then, THIS becomes Default for "ActiveFolder", if you specify "xPopupActiveFolderUseFolderDefault", "Folder" is used as default for "ActiveFolder"!

Example:
xPopupEntryIconX 5
All Popup Entry States have a IconX Position of 5!
xPopupActiveEntryIconX 5
Active Popup Entrys have a IconX Position of 5!

Icon Settings

(Entry Type)IconX INT
Sets the horizontal position of the icon in the Popup Entry. If the value is positive then it is relative to the left side of the Popup Entry, if negative then to the right side. Additionally you can make the position relative to the center of the Popup Entry by appending the character 'c' after the number ("32c", "-128c").

(Entry Type)IconY INT
Sets the vertical position of the icon in the Popup Entry. If the value is positive then it is relative to the top side of the Popup Entry, if negative then to the bottom side. Additionally you can make the position relative to the center of the Popup Entry by appending the character 'c' after the number ("32c", "-128c").

(Entry Type)IconSize INT
This command specifies the Size (Width/Height) of the displayed Icon.
Minimum: 8
Maximum: 32
If no value is provided then the default is 16.

(Entry Type)IconSaturationIntensity INT
This command specifies the color saturation of the icon.
Minimum: 0 -> Grayscale
Maximum: 255 -> Full Colored (Default)

(Entry Type)IconHueIntensity INT
This command specifies the amount of the, in the icon, blended in color.
Minimum: 0 -> Nothing (Default)
Maximum: 255

(Entry Type)IconHueColor COLOR
This command specifies the blended in color.
Default: FFFFFF

Overview "Font Settings"

The "(Entry Type)" in front of each setting means that every setting can be:
Title, Info, Entry, ActiveEntry, Folder or ActiveFolder
If you set a setting with "Entry", then, THIS becomes Default for all other States except "Title" and "Info"! If you set a setting with "ActiveEntry" then, THIS becomes Default for "ActiveFolder", if you specify "xPopupActiveFolderUseFolderDefault", "Folder" is used as default for "ActiveFolder"!

Example:
xPopupEntryFontHeight 20
All Popup Entry States have a FontHeight of 20!
xPopupActiveEntryFontHeight 20
Active Popup Entrys have a Text FontHeight of 20!

"Arrow" and "ActiveArrow" are special!
The "Arrow" and "ActiveArrow" Prefixes are for Custom Folder Text Indicators and are only painted on Folder Entry's ("Arrow" is Default for "ActiveArrow"!)
You can setup the Arrow and ActiveArrow Font with all normal Font settings. Simply set at (Entrytype) the Prefixes "Arrow" and "ActiveArrow"!

Text Arrow Setup

UseTextArrow BOOL
If set, the TextArrows are enabled.

ArrowText STRING
The String which is painted as the Normal Folder TextArrow.

ActiveArrowText STRING
The String which is painted as the Active Folder TextArrow.

Font Settings

(Entry Type)Font FONT
Sets the name of the font used to display text. If no value is provided then the default is "Arial".

(EntryType)FontSmoothing BOOL
If set to "FALSE", you can use Text without ANY Background (MainPopupBG and EntryBG) and don't have PinkOutlines (from Smoothing).
Default is "TRUE".

(Entry Type)FontHeight INT
Sets the height of the font used to display the text in pixels. If no value is provided then the default is 15.

(Entry Type)FontLeftBorder INT
Sets the number of pixels on the left edge of the Popup Entry to reserve as a border. If no value is provided then the default is 0.

(Entry Type)FontRightBorder INT
Sets the number of pixels on the right edge of the Popup Entry to reserve as a border. If no value is provided then the default is 0.

(Entry Type)FontTopBorder INT
Sets the number of pixels on the top edge of the Popup Entry to reserve as a border. If no value is provided then the default is 0.

(Entry Type)FontBottomBorder INT
Sets the number of pixels on the bottom edge of the Popup Entry to reserve as a border. If no value is provided then the default is 0.

(Entry Type)FontColor COLOR
If no value is provided then the default is 000000.

(Entry Type)FontBold BOOL
If this command is present then the font will be bold.

(Entry Type)FontItalic BOOL
If this command is present then the font will be italic.

(Entry Type)FontUnderline BOOL
If this command is present then the font will be underlined.

(Entry Type)FontAlign "left", "right" or "center"
Sets the horizontal text alignment. If no value is provided then the default is "left".

(Entry Type)FontVertAlign "top", "bottom" or "center"
Sets the vertical text alignment. If no value is provided then the default is "center".

(Entry Type)FontShadow BOOL
If this command is present then the font will be shadowed.
You can either use Shadow or OutLine, not both at the same time! Outline overrides Shadow.

(Entry Type)FontShadowColor COLOR
Sets the color used to display the text shadow. If no value is provided then the default is dark gray (808080).

(Entry Type)FontShadowX INT
Sets the number of pixels in the horizontal direction that the shadow is offset from the rest of the text; this can be negative. If no value is provided then the default is 1.

(Entry Type)FontShadowY INT
Sets the number of pixels in the vertical direction that the shadow is offset from the rest of the text; this can be negative. If no value is provided then the default is 1.

(Entry Type)FontOutline BOOL
If this command is present then the text will be Outlined.
You can either use Shadow or OutLine, not both at the same time! Outline overrides Shadow.

(Entry Type)FontOutlineColor COLOR
Sets the color used to display the text Outline. If no value is provided then the default is dark gray (808080).

↑

Bang Commands And Events

Bangs

!xPopup [x] [y] ["anchor"] or !Popup [x] [y] ["anchor"] in CompatibilityMode
Calls the first defined Popup menu on the Screen (at Current Mouse Pos or manually at the defined Position [x] and [y].
"anchor" is the Cursor, relative to the displayed Popup, it can be:
topleft DEFAULT
topright
bottomleft
bottomright

!xPopupRescan or !PopupRescan
This Bang completely Resets xPopup and Reloads ALL settings from Step.
Purpose: You don't need to UnLoad <-> Reload xPopup, if you want to make changes to the *(x)popup lines or major settings in general.
Attention: The Bang automatically calls a !reload, so "Manually Set Evars" get lost!! But this happens always. if you try to reload saved settings :)
!xPopupDynamicFolder "Full Path" [x] [y] ["anchor"] or !PopupDynamicFolder "Full Path" [x] [y] ["anchor"] in CompatibilityMode
Calls a Popup menu with the specified RootFolder on the Screen without the need to define *(x)popup CFG (at Current Mouse Pos or manually at the defined Position [x] and [y].
"anchor" is the Cursor, relative to the displayed Popup, it can be:
topleft DEFAULT
topright
bottomleft
bottomright

!xPopupTasks [x] [y] ["anchor"] or !PopupTasks [x] [y] ["anchor"] in CompatibilityMode
Calls a PopupMenu with the current running Tasks on the Screen without the need to define *(x)popup CFG (at Current Mouse Pos or manually at the defined Position [x] and [y].
"anchor" is the Cursor, relative to the displayed Popup, it can be:
topleft DEFAULT
topright
bottomleft
bottomright

!xPopupControlPanel [x] [y] ["anchor"] or !PopupControlPanel [x] [y] ["anchor"] in CompatibilityMode
!xPopupMyComputer [x] [y] ["anchor"] or !PopupMyComputer [x] [y] ["anchor"] in CompatibilityMode
!xPopupNetwork [x] [y] ["anchor"] or !PopupNetwork [x] [y] ["anchor"] in CompatibilityMode
!xPopupPrinters [x] [y] ["anchor"] or !PopupPrinters [x] [y] ["anchor"] in CompatibilityMode
!xPopupRecentDocuments [x] [y] ["anchor"] or !PopupRecentDocuments [x] [y] ["anchor"] in CompatibilityMode
!xPopupRecycleBin [x] [y] ["anchor"] or !PopupRecycleBin [x] [y] ["anchor"] in CompatibilityMode
Calls a Shell Folder PopupMenu on the Screen without the need to define *(x)popup CFG (at Current Mouse Pos or manually at the defined Position [x] and [y].
"anchor" is the Cursor, relative to the displayed Popup, it can be:
topleft DEFAULT
topright
bottomleft
bottomright

There are only the Bangs available you have defined Popup Menu's for.
The following Bangs are only defined for TopLevel Popups, such you have defined with "!new" - "~new"!

!(PopupMenuName) [x] [y] ["anchor"]
Calls the Popup menu on the Screen (at Current Mouse Pos or manually at the defined Position [x] and [y].
"anchor" is the Cursor, relative to the displayed Popup, it can be:
topleft DEFAULT
topright
bottomleft
bottomright

!(PopupMenuName)Reposition (x-coordinate) (y-coordinate) [width] [height] [anchor]
Repositions (Moves and/or Resizes) the PopupMenu.
Accepts now an additional anchor "topleft", "topright", "bottomleft", "bottomright", which sets where the new position is relative to the Popup.
You need either 2 (x,y), 3 (x,y,anchor), 4(x,y,w,h) or 5(x,y,w,h,anchor) values!
!(PopupMenuName)Reposition accepts for x and y values "CurrentX" and "CurrentY", which will be replaced with the actual Position, so you don't need to use xLabel(light)'s !ParseEvars to get/keep the current position!

!(PopupMenuName)Pin
Pins & Shows the Popup at the current position. Call a !(popupname)Reposition before!

!(PopupMenuName)UnPin
UnPins & Hides the Popup.

!(PopupMenuName)Toggle
Toggles the Popup between visible and not visible.

!(PopupMenuName)TogglePin
Toggles (Pins/UnPins - Shows/Hides) the Popup.

!(PopupMenuName)ToggleShade
Shades/UnShades the Popup.

Events

Caption Mouse Actions:
Caption is only the "TopBorder" (or "BottomBorder" with xPopupShowCaption .bottom)!

"Action" in the following can be:
".none" -> Does nothing
".pin" -> Pins the Popup
".unpin" -> UnPins (and Closing) the Popup
".togglepin" -> Pin and UnPins (and Closing) the Popup
".toggleshade" -> Toggles the ShadeMode
".toggleontop" -> IF PINNED, changes the OnTop State of the Pinned Popup On-The-Fly.
".move" -> Defines the MoveButton
".close" -> Closes the PopupMenu (and UnPins it)

OnCaptionLeftClick "Action"
Default is ".move"

OnCaptionMiddleClick "Action"
Default is ".none" (Scroll is still possible)

OnCaptionRightClick "Action"
Default is ".toggleshade"

OnDrop "MOVE", "COPY", or "SHORTCUT"
Move: Moves the dropped File to the Folder on which it was dropped.
Copy: Copies the dropped File to the Folder on which it was dropped.
Shortcut: Makes a shortcut to the dropped File in the Folder on which it was dropped. This one is normally the best solution for a PopupMenu/Quicklaunch

OnOpen ACTION
The ACTION is executed, if a TOPLEVEL Popup is shown.
Inside of the ACTION "%[popupname]% or "%{popupname}%" ( due to possible interactions with xLabels !ParseEvars ) is replaced with the "PopupName" (The Bang without "!").

OnClose ACTION
The ACTION is executed, if a TOPLEVEL Popup is closed.
Inside of the ACTION "%[popupname]% or "%{popupname}%" ( due to possible interactions with xLabels !ParseEvars ) is replaced with the "PopupName" (The Bang without "!").

OnShade ACTION
The ACTION is executed, if a TOPLEVEL Popup is shaded.
Inside of the ACTION "%[popupname]% or "%{popupname}%" ( due to possible interactions with xLabels !ParseEvars ) is replaced with the "PopupName" (The Bang without "!").

OnUnShade ACTION
The ACTION is executed, if a TOPLEVEL Popup is unshaded.
Inside of the ACTION "%[popupname]% or "%{popupname}%" ( due to possible interactions with xLabels !ParseEvars ) is replaced with the "PopupName" (The Bang without "!").

The following SoundEvents ("OpenSound" / "CloseSound") are only defined for TopLevel Popups, such you have defined with "!new" - "~new"!
xLabel or xLabel(Light) >= v3.0 must have been loaded!

OpenSound "SoundFile"
Played, if a Main Popup menu has been opened.

CloseSound "SoundFile"
Played, if a Main Popup menu has been closed.

SwitchSound "SoundFile"
Played, if a different Entry has been selected.

ActionSound "SoundFile"
Played after a Action (LeftClick) on an Entry has been performed and the Popup closes.

↑

Tips 'n' Tricks

Compatible Popup2 Settings

How a Popup Definition can look:

*(x)Popup ".: LITESTEP :." !new !popup *(x)Popup !info "[time('ii:nn:ss')]" *(x)Popup !separator *(x)Popup !hook:5:5:150:20 !commandboxhook %%!commandmove%% *(x)Popup !separator *(x)Popup "Games" "!xPopupDynamicFolder:$ShortcutsDir$Games" *(x)Popup "Graphics" "!xPopupDynamicFolder:$ShortcutsDir$Graphics" *(x)Popup "Music" "!xPopupDynamicFolder:$ShortcutsDir$Music" *(x)Popup "Internet" "!xPopupDynamicFolder:$ShortcutsDir$Internet" *(x)Popup "Burn" "!xPopupDynamicFolder:$ShortcutsDir$Burn" *(x)Popup "AntiVirus" "!xPopupDynamicFolder:$ShortcutsDir$Antivirus" *(x)Popup !separator *(x)Popup "Trashcan" explorer $bitbucket$ *(x)Popup Menubreak *(x)Popup "Litestep" Folder *(x)Popup .icon="*.rc" "LSTM2" "$LiteStepDir$bin\lstm\lstm2.exe" *(x)Popup "popupcontrolpanel" !xpopupcontrolpanel *(x)Popup "popupmycomputer" !xpopupmycomputer *(x)Popup "popupnetwork" !xpopupnetwork *(x)Popup "popupprinters" !xpopupprinters *(x)Popup "popuprecentdocuments" !xpopuprecentdocuments *(x)Popup "popuprecyclebin" !xpopuprecyclebin *(x)Popup "changethemes" Folder *(x)Popup "installtheme" !execute ["$LiteStepDir$utilities\LSThemeInstaller.exe"] *(x)Popup "refreshlist" !execute ["$LiteStepDir$utilities\LSThemeInstaller.exe" "/refresh"] *(x)Popup ~Folder *(x)Popup .icon="$litestepdir$setup/icons/litestep.ico" "utilities" !xPopupFolder:"$LitestepDir$utilities\" *(x)Popup "edit config" Folder *(x)Popup "step.rc" !execute ["$TxtEditor$" "$LiteStepDir$step.rc"] *(x)Popup "theme.rc" !execute ["$TxtEditor$" "$ThemeDir$theme.rc"] *(x)Popup !Separator *(x)Popup "personal files" !xPopupFolder:"$PersonalDir$" *(x)Popup ~Folder *(x)Popup ~folder *(x)Popup .icon="$litestepdir$litestep.exe" "Recycle?" !recycle *(x)Popup "Suchen?" "$LiteStepDir$bin\find\pdfind.exe" *(x)Popup !separator *(x)Popup icon=".none" "Shutdown Menu?" !shutdown *(x)Popup ~new

You can use the following Popup2 Special Settings in *(x)Popup lines!

!Separator
!(x)PopupFolder:"FOLDER"
!(x)PopupDynamicFolder:"FOLDER"
!DynamicFolder:"FOLDER"
Folder
~Folder

Exported Variables

(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 xPopup has not yet added them, causing LS 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!
$mypopupcurrentwidth$ becomes %#mypopupcurrentwidth%# and so on ...

Only TopLevel Popups export now their Current Position and Size. If the Popup is called with !MyPopup then it's current Position and Size is exported with the Prefix "MyPopup".

$(popupname)CurrentX$
The current horizontal position of the Popup.

$(popupname)CurrentY$
The current vertical position of the Popup.

$(popupname)CurrentWidth$
The current width of the Popup.

$(popupname)CurrentHeight$
The current height of the Popup.

Multiple Popup Columns

To create a new Column in a PopupMenu use
*(x)Popup Menubreak
After that entry the PopupMenu starts a new Column at the Top!

Or use the automatic method
xPopupAutoMenubreak
Which automatically makes new Columns, if required, instead of the MultiPart implementation.

Custom Sorting in PopupFolders

Custom Item Sorting via User Modified Filenames
You can add [xx] before the Filename to enable sorting based on the 2-digit number (xx), the "[xx]" before the Filename won't be displayed.
These Files will be displayed first sorted with growing numbers.

[00]IrfanView.lnk -> IrfanView.lnk
[02]ZOrdertest.lnk -> ZOrdertest.lnk
[20]AdAware.lnk -> AdAware.lnk
Another.lnk
BasicFiles.lnk
...

Popup Menu consisting of only one Folder

*(x)Popup "Caption/Title" !new !popupBANG "Syntax prefix to use" *(x)Popup "Caption/Title" !(x)popupfolder:$Litestepdir$ *(x)Popup ~new

You can also use !(x)PopupTasks or the ShellFolders this way!

Or with the following Bang:
!(x)PopupDynamicFolder "Full Path" [x] [y] ["anchor"]
Explanation see Bangs!

Or you use this special Feature of xPopup:
!insertfolder as Extra Setup Feature
The Folder(s) Content is inserted directly at(after) this Line, NOT in a SubFolder! Piping and Wildcards are allowed.

Example:
*(x)popup !insertfolder:"$startmenu$"
This would add the complete $startmenu$ at(after) this line.

xLabel(Light) Info Entry

You can use and display all Info, which "xLabel(Light)" can display inside of a Popup Entry (Painted on Popup BG or on InfoBG, if specified). Just load xLabel(Light) and use the following "special" Syntax.

*(x)popup !info "xLabel(Light) Text Escape Sequence"

Example: To create a clock like with !datetime, make this entry
*(x)popup !info "[time('hh:nn:ss')]"

You can setup a EntryTexture with the "Info" Prefix like the other Entry Image Settings.
xPopupInfoImage info.png
xPopupInfoTrueTransparent ...

You can setup the Font with the "Info" Prefix like the other Fontsettings.
xPopupInfoFontHeight 20
xPopupInfoFontColor ff0000 ...

Module Hooking Support

You can hook every Module into your PopupMenu, but due to the circumstances the CFG is not as easy as above :P

*(x)popup !hook:LeftBorder:RightBorder:Width of the Module:Height of the Module !Modulebang Userdata_1 (... Userdata_N) %%BANG TO MOVE MODULE%%

Ok, that was hard, now the explanation:
LeftBorder: The number of Pixels from the LeftSide of the Popup, at which the Hooked Module should start.
RightBorder: The number of Pixels from the RightSide of the Popup, till the Hooked Module should end.
Width of the Module: The Width of the Hooked Module.
Height of the Module: The Height of the Hooked Module.

!Modulebang Userdata_1 (... Userdata_N): Same as with every Hooking Process (e.g. !labellsboxhook testlabel)

Now, the tricky point:
For the correct positioning (y-Coordinate) xpopup must know with which Bang it can move the Module! So, if there's such a Bang available just specify it here. Otherwise YOU must calculate the correct y-Coordinate in the module Settings!

%%!commandmove%%,for instance. It's important that you make the DOUBLE %% before and after %% the MoveBang!

If you set "!hook:0:0:0:0 !Modulebang Userdata_1 (... Userdata_N)" --> WITH 4 TIMES 0, the module will only be hooked and you can Size and Position it MANUALLY where you want it in the PopupMenu! It won't be condidered as an Entry that needs Place.

Shell Folder Support

ShellFolders work as in Popup2, as there are:


           !(x)PopupControlPanel
           
!(x)PopupMyComputer
           
!(x)PopupNetwork
           
!(x)PopupPrinters
           
!(x)PopupRecentDocuments
           
!(x)PopupRecycleBin

Tasks Folder Support

TaskFolders work as in Popup2, with additional Application ContextMenu on RightClick.

!(x)PopupTasks

Special Features

Custom Icons for Entry's

You can set (or remove) Custom Icons for every Defined PopupEntry.

*(x)Popup .icon="..." "MyEntry" "Action"

Defines the custom icon. Supports plain .ico files and extraction:
c:\win2k\explorer.exe
c:\win2k\explorer.exe,2
Supports ".none".
Supports generic icon file associations. Syntax: *.extension

Shading Popups

To Toggle Shaded Popups, simply RightClick on the Title/Caption(/TopBorder). The ShadedMode only consists of the Title(TopBorder) of the Popup and the BottomBorder, simply all Entrys are removed.
This would be the best for Pinned Popups, but it works for normal Popups or SubPopups the same.
Shaded Popups stay shaded, till you "unshade" them!

Pin To Desktop from Startup

To make a PopupMenu stay on the Desktop from start, just do this.

*xPopupStartPinned !(PopupBang) x y ["anchor"]

x and y are the Position value and support standard positioning syntax as '-', '~' or 'c'.
Accepts now optional "AnchorPoint", where "anchor" can be:
topleft DEFAULT
topright
bottomleft
bottomright

Pin To Desktop

To Separate a PopupMenu and make it stay on the Desktop, just Press CTRL+SHIFT and Press Down-Arrow or, if it's a SubFolder, simply Drag it away from the Parent.
To Kill it: Hover over the Popup and press CTRL+SHIFT and Up-Arrow or make a LeftDoubleClick on the Popup BG (on the TopBorder or BottomBorder!).

Keyboard Navigation

You can navigate through the PopupMenus with the Keyboard. Simply use UP, DOWN, LEFT and RIGHT ArrowKeys to switch between Entry's and use RETURN to execute or ESCAPE to Close.
As alternative xPopup supports & "Ampersand" in Captions to define a "JumpKey" -> jumps to this entry if this key is pressed. If none is defined or you're navigating through SubMenus the first entry which Caption starts with that Key is selected.

If you have a Mouse with Additional MouseButtons, the 4th should work as the LEFT Key pressed and the 5th as the RIGHT Key pressed (or maybe vice versa) :)

"Chording" (only the first 2 chars!)
If you quickly press another Key after the first, the first both Keys matching Entry will be selected. So, of you have many Entrys with "A" and you want "Animation", simply press "A" and then quick "N".

Pressing F5 updates the Popup, if the automatic Update on subfolders doesn't work or if you want to update the RootPopup (for people who use !insertfolder).

Scroll through Entry's

You can scroll Up and Down through the Entry's either with your MouseWheel or by Pressing the MiddleButton or Keyboard (see above).
To "Scroll/Switch" between Complete Part use "PageUp" and PageDown" Keys or Press CTRL during MouseWheel Scroll.

To open a SubFolder after Scrolling through the Entrys simply perform a LeftClick on the current Folder!

Multi Part PopupMenu's

If you have set MaxHeight or the PopupMenu doesn't fit on the whole screen it will be divided in visible Parts. You can access "hidden" parts by scrolling with Keyboard (PageUp, PageDown, Up, Down), MouseWheel or MiddleClick Up or Down till the last visible Entry, after that the next part will be displayed in the PopupMenu.

↑

Contact

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

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