LiteStep v. 0.24.6 documentation

written by the LiteStep Documentation Effort, August 2000
Changes.TXT

  .: introduction   .: configuration   .: installation   .: theme installation   .: theme creation   .: development   .: glossary   .: links  
  .: command   .: desktop   .: hotkey   .: litestep   .: lstime   .: popup   .: shortcut   .: systray   .: taskbar   .: vwm   .: wharf  

What does popup2.dll do?
Popup2.dll provides the user with a menu system comparable to the Explorer Start Menu, with the added advantage of being completely customizable with respect to appearance and content. The Popup menu can be used to execute LiteStep !Bang commands, as well as Windows components such as the Control Panel and external applications. Extended Popup features include the ability to show the date and time, display the contents of any folder on your system, keyboard navigation, and act as a remote control for controlling WinAmp.

To Configure the Popup for KeyBoard Navigation, simply place an ampersand, "&" into the Popup Name. Once the Popup menu is displayed, simply press the key that is underlined.

By default, the Popup is accessed by right-clicking on the desktop, however it can also be displayed through the use of hotkeys, shortcuts, or any other method of executing a !Bang command.

Example Configuration for popup2.dll
For a single popup reffered to by !Popup you could use a configuration like this:

*Popup "Programs" !DynamicFolder:$Programs$
*Popup "Editors" Folder
       *Popup &NotePad c:\windows\notepad.exe
       *Popup &MetaPad .icon=C:\metapad.exe,1 c:\metapad.exe
*Popup ~Folder
*Popup "Active Apps" !PopupTasks

If you wanted to configure multiple popups you would use a configuration simliar to this:

*Popup "Programs" !New !PopupPrograms
IF Win9x
*Popup "Programs" !DynamicFolder:$Programs$
ENDIF
IF WinNT
*Popup "Programs" !DynamicFolder:$Programs$|$CommonPrograms$
*Popup "AdminTools" !DynamicFolder:$AdminToolsDir$
ENDIF
*Popup ~New

*Popup "Stuff" !New !PopupStuff
*Popup "Tasks" !PopupTasks
*Popup "Desktops" !PopupDesktops
*Popup ~New

Note: No matter what you configure, the first *Popup will always be assigned !Popup.

Step.RC Syntax for popup2.dll
Popup2 is the first and only module that uses the Color Settings configured in the Appearance tab of the Windows Display Properties section in the Control Panel. The default values for all of the [Color] Settings in Popup2 are taken from the current Windows color scheme. The Popup colors can be changed by specifying your own colors in the Step.RC or by using images that will override the colors. There is no need to edit the Windows color scheme to change the color of your Popup - simply use the [COLOR] or [IMAGE.BMP] commands described below.
HotlistName [STRING] Puts [Name] at the top of the Popup menu.
PopupTitleAlignment [Left/Center/Right] Allows you to specify where you want your HotlistName to appear in the title bar of the popup.

Default: Left

PopupTitleHeight [NUMBER] Sets the Height of the Popup Title so that it may differ from the Height of the rest of the Popup Entries.

Default: Submenu Height

PopupTitleColor [COLOR] Sets the font color of the Popup titlebar.

Default: Window Text

PopupTitleBgColor [COLOR] Sets the background color of the Popup titlebar.

Default: Active Caption

Note: If PopupTitlePix is specified, PopupTitleBgColor is ignored.

PopupGradientTitle [COLOR] Sets the gradient background color of the Popup titlebar.

Default: Active Caption

Note: If PopupTitlePix is specified, PopupGradientTitle is ignored.

PopupFolderColor [COLOR] Sets the font color of the Popup Folders.

Default: Window Text

PopupSelFolderColor [COLOR] Sets the font color of the Popup Folder that is currently selected.

Default: Window Text

PopupFolderBgColor [COLOR] Sets the background color of the Popup Folder.

Default: Active Caption

PopupSelFolderBgColor [COLOR]
PopupFolderPix [IMAGE.BMP]
PopupSelFolderPix [IMAGE.BMP]
PopupGradientFolder [COLOR]
PopupArrowImage [IMAGE.BMP] Allows you to specify the icon you want to be used when a Popup Folder is found.
PopupSelArrowImage [IMAGE.BMP] Allows you to specify a different icon for when a folder is selected than when it is just normally displayed
PopupEntryAlignment [Left/Center/Right] Allows you to specify what kind of text alignment you would like for your popup menu.

Default: Left

PopupEntryColor [COLOR] Sets the font color of the text on a Popup entry.

Default: Menu Text

PopupEntryBgColor [COLOR] Sets the background color of a Popup entry.

Default: Button Face

Note: If PopupEntryPix is specified, PopupEntryBgColor is ignored.

PopupSelEntryColor [COLOR] Sets the font color of the text a Popup entry when the mouse is over it.

Default: Highlight Text

PopupSelEntryBgColor [COLOR] Sets the background color of a Popup entry when the mouse is over it.

Default: Highlight

Note: If PopupSelEntryPix is specified, PopupSelEntryBgColor is ignored.

PopupGradientEntry [COLOR] Sets the gradient background color of a typical Popup entry. This sets the gradient color for both typical and selected entries.

Default: Button Face

PopupBevelLightColor [COLOR] Sets the light (top-left) bevel of the Popup menu.

Default: 3D Highlight

PopupBevelDarkColor [COLOR] Sets the dark (bottom-right) bevel of the Popup menu.

Default: 3D Shadow

PopupNoMenuBevel [BOOL] Removes the bevel around the outer edge of the Popup menu and disables PopupBevelLightColor and PopupBevelDarkColor settings.
PopupNoBevel [BOOL] Removes the bevel between individual Popup entries.
PopupEntryFontFace [FONT] This will set the font for the text in the Popup menu.

Default:

PopupFontFace [FONT] This will set the font for the text in the Popup titlebar.

Default:

PopupFontHeight [NUMBER] This will set the font size in pixels, not points.

Default: 16

PopupFolderFontFace [FONT] This will set the font for the text in the Popup where there are folders.
PopupFolderFontHeight [NUMBER] This will set the font size in pixels, not points, for the font used on PopupFolders.

Default: 16

PopupSelEntryFontFace [FONT] The Popup Font style can be defined to selected entry's independent of the Title.
PopupSelEntryFontHeight [NUMBER] The Popup Font size can be defined to selected entry's independent of the Title.

Default: 16

PopupSubMenuHeight [NUMBER] This will set the size of each Popup entry (title, typical, and selected).

Default: 20

PopupTitlePix [IMAGE.BMP] Sets the image that will show in your Popup titlebar.

Note: This will ignore PopupTitleBgColor.

PopupEntryPix [IMAGE.BMP] Sets the image that will show in a typical Popup entry.

Note: This will ignore PopupEntryBgColor.

PopupSelEntryPix [IMAGE.BMP] Sets the image that will show in a Popup entry when the mouse is over it.

Note: This will ignore PopupSelEntryBgColor.

PopupBottomPix [IMAGE.BMP] Sets the image that will show at the bottom of each Popup menu and sub-menu.
PopupBLT {0, 1, 2} Sets the way image files are displayed.

   0 is normal
   1 is stretched
   2 is tiled

Default: 0

PopupSeparatorPix [IMAGE.BMP] Allows you to assign a bitmap image to be used for all !Separator lines.
PopupNotTransparent [BOOL] Makes sure that text is drawn, even if there is no image behind it.
PopupAdaptiveWidth [BOOL] The Popup will automatically adjust the width of each Popup sub-menu to accommodate the longest entry in the menu.
PopupMaxWidth [NUMBER] Sets the maximum width the Popup can be.

Default: 500

PopupMinWidth [NUMBER] Sets the minimum width the Popup can be.

Default: 128

PopupOverlapX [NUMBER] Determines how much a sub-menu will overlap its parent menu.

Default: 5

PopupOverlapY [NUMBER] Determines how much a sub-menu will be above or below the parent window.

Default: 20

PopupTextOffset [NUMBER] Sets the number of pixels the text will start from the left side of the Popup menu.

Default: 5

PopupMenuDelay [NUMBER] This changes the amount of time it takes between putting your mouse over a folder and when the sub-menu appears.

Default: 100

PopupNoTitles [BOOL] The Popup menu will not draw any titlebars for sub-menus. If PopupTitlePix has been defined, it will not be shown on sub-menus.
PopupIcons [BOOL] The Popup will draw icons to the left of the text for each Popup entry.

Note: You can explicity set the icon to be used by utilizing .icon=

PopupIconsOnRight [BOOL] The Popup will draw icons to the right of the text for each Popup entry.

Note: You can explicity set the icon to be used by utilizing .icon=

PopupDefaultIcon [Icon] Sets the default icon to show when there is no registered icon for a Popup entry.
PopupIconSpacing [NUMBER] Sets the distance between an Icon and the text in your popup entries.

Note: PopupIcons must be set to true.

PopupIconSize [NUMBER] With this setting you can adjust the size of all of your icons in your popup menu.

Note: PopupIcons must be set to true.

PopupNoFolderArrow [BOOL] The Popup will not draw the arrow icon to indicate that a Popup entry is a folder.
PopupDateTimeAlign {0,1,2,4} This will change the way the date/time is aligned in the Popup.

   0 is left aligned
   1 is centered horizontally
   2 is right aligned
   4 is centered vertically

Default: 2

PopupAutoSeparator [BOOL] A separating line will be automatically inserted between folders and the files in the Popup menu.
PopupTasksWindowCaption [BOOL] !Popuptasks will use the real window captions in the Tasks sub-menu.
PopupScrollSpeed [NUMBER] This will adjust the Popup scrolling speed if the Popup appears off of the screen. Higher values increase the scrolling speed.

Default: 1

PopupTitleBold [BOOL] Displays the HotListName will be shown in BOLD.
PopupEntryFontHeight [NUMBER] The Popup Font size can be defined to entry's independent of the Title.

Default: 16

PopupNoCloseButton [BOOL] Popup will not draw a close button on a pinned menu item.
PinnedPopupNotOnTop [BOOL] Makes a pinned Popup item will act like a normal window by not being always on top of other windows.
PopupNoTitleText [BOOL] Prevents the display of the Title Text on sub-menus while still displaying the title graphic.
PopupTasksStartPinned [BOOL] This will keep the display of !PopupTasks on the screen until you close it by clicking on the "X" in the upper right corner.
!Bang Commands for popup2.dll
The !Bang Commands for Popup2.dll are not like !Bang commands for other modules. The ONLY commands that you can execute outside of a Popup Menu is !Popup and !PopupTasks. All other Popup !Bang commands should be preceded with the *Popup command. Since the syntax for each of these !Bang commands may be slightly different, examples are provided below.
!Popup This causes the Popup menu to appear and is the only !Bang command not used within the *Popup Section of the Step.RC.

By default, the Popup menu appears wherever the mouse cursor currently sits. Optionally, co-ordinates can be included in the !Popup command to specify exactly where the Popup menu should appear.

Example: !Popup x=-20 y=50

!PopupFolder:[FOLDER] This creates a static subfolder that displays the contents of the specified drive or directory. The contents of the directory are loaded at startup, and can only be updated by !Recycling LiteStep.

Note: You can limit the content for a PopupFolder by using pattern matching. If the PopupFolder contains another folder, that folder must match your pattern in order to be displayed.

Example: *Popup "My Documents" !PopupFolder:"C:\My Docuemnts\*.doc"

Multiple directories can be placed in the same PopupFolder by using the pipe character, "|", to separate them.

Example: *Popup "LiteStep" !PopupFolder:"C:\LiteStep\"|$ModuleDir$

Note: By right-clicking on the folder, or any sub-menu, you can open the context menu for the directory. This is similar to the functionality in the Start Menu of Windows Explorer.

!PopupDynamicfolder:[FOLDER]
!Dynamicfolder:[FOLDER] 		This creates a dynamic subfolder with the contents of the specified drive or directory. Dynamic folders differ from static folders in that the Popup folder will automatically update when the directory is updated, meaning that a !Recycle is not necessary to see changes.

Note: You can limit the content for a DynamicPopupFolder by using pattern matching. If the DynamicPopupFolder contains another folder, that folder must match your pattern in order to be displayed.

Example: *Popup "My Documents" !PopupFolder:"C:\My Docuemnts\"*.doc

Multiple directories can be placed in the same PopupDynamicFolder by using the pipe character, "|", to separate them.

Example: *Popup "C Drive" !PopupDynamicFolder:$Programs$|"C:\"

Note: By right-clicking on the folder, or any sub-menu, you can open the context menu for the directory. This is similar to the functionality in the Start Menu of Windows Explorer.

!PopupImage [IMAGE.BMP] Inserts a "dummy" image as a popup entry. This image has no functionality other than acting as a separator in the popup menu.

Example: *Popup !PopupImage separator.bmp

!Separator Inserts a horizontal line as a popup item using the PopupBevel Colors you have specified in the Step.RC.

Example: *Popup !Separator

!PopupTasks Creates a sub-menu containing all the currently running tasks.

Example: *Popup "Task List" !PopupTasks

!PopupRun Creates a run box inside the Popup menu that can run !Bang commands as well as executables.

Example: *Popup "Execute:" !PopupRun

!RemoteAmp [IMAGE.BMP] Creates a WinAmp control as a popup entry, based on the image you specify. The image should have previous, play, pause, stop, and next buttons, from left to right.

Example: *Popup !RemoteAmp remoteamp.bmp

!DateTime The syntax for this command is a little strange, so here's an example:

Example: *Popup "%H:%M.%S" !DateTime

This will display the current hour, minute, and second as a popup entry. Click here to see all the codes for date and time entries.

!PopupMyComputer Creates a sub-menu containing the contents of the Windows "My Computer" folder. If you right-click on this sub-menu you will get the explorer context menu for My Computer.

Example: *Popup "My Computer" !PopupMyComputer

!PopupNetwork Creates a sub-menu containing entries for all networked computers found in the Windows "Network Neighbourhood" folder. If you right-click on this sub-menu you will get the context menu for Network Neighborhood.

Example: *Popup "Network" !PopupNetwork

!PopupControlPanel Creates a sub-menu containing all the items in the Windows "Control Panel" folder. If you right-click on the sub-menu you will open the Control Panel context menu.

Example: *Popup "Control Panel" !PopupControlPanel

!PopupPrinters Creates a sub-menu listing all available printers in the Windows "Printers" folder. If you right-click on the sub-menu you will open the Printers context menu.

Example: *Popup "Printers" !PopupPrinters

!PopupRecycleBin Creates a sub-menu that lists all of the items in your Recycle Bin.

Example: *Popup "Garbage" !PopupRecycleBin

!PopupRecentDocuments Creates a sub-menu that lists all of the documents you have recently viewed.

Example: *Popup "Recent Docs" !PopupRecentDocuments

!PopupDesktops Creates a sub-menu that shows you the VWM name specified by the VWMDeskNameN.

Example: *Popup "Desktops" !PopupDesktops