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 wharf.dll do?
The Wharf is a vertical application launch bar similar to the Microsoft Office Shortcut bar and the AfterStep application Wharf. Wharf entries can include applications or LiteStep !Bang commands, which are executed with a mouse click. Some LiteStep modules are specifically written for use in the Wharf, their functions ranging from system meters, games, CD players, clocks, and even TV tuners! The core VWM, LSTime and Systray modules can also be loaded in the Wharf.
Example Configuration for Wharf.dll
*Wharf [Caption] [IMAGE.BMP] Folder
      *Wharf [Caption] [IMAGE.BMP] [Action]
      *Wharf [Caption] [IMAGE.BMP] [@Module]
*Wharf ~Folder
Folder/~Folder This command defines the beginning and end of each Wharf folder.
[Caption] The name or title given to the Wharf tile, which will show up as a tooltip when the mouse is held over the Wharf tile. The caption can be any sequence of alphanumeric characters enclosed in single or double quotes.

Note: To display nothing when the mouse if held over the Wharf tile, use a null value of "".

[IMAGE.BMP] The image file or .extracted icon to display on the Wharf tile.

Example:

   *Wharf WordPad .extract=c:\windows\write.exe,0 write.exe
   *Wharf NotePad note.bmp notepad.exe

[ACTION] Any LiteStep !Bang command or Windows executable.
[@Module] The location of the Wharf module to be loaded, written with a full path or Environment Variables. An at symbol, "@", must be placed in front of the path.

Example:

   @$ModuleDir$lstime.dll

Step.RC Syntax for Wharf.dll
WharfAutoUnpress [BOOL] Wharf tiles will immediately unpress after being pressed rather than remaining depressed during the mouse click.
WharfAlwaysOnTop [BOOL] Sets the Wharf to appear on top of all other LiteStep modules and even sometimes Application Windows.
WharfNoAutoClose [BOOL] Wharf folders remain outstretched until they are closed by clicking the folder tile a second time.
WharfNoTitlebar [BOOL] Removes the cap that is displayed at the top of the Wharf.
WharfTitlebarPix [IMAGE.BMP] Specifies the image for the Wharf titlebar.
WharfCapHeight [NUMBER] Specifies the height in pixels of the Wharf titlebar.

Default: 16

WharfTitleFore [COLOR] Specifies the font color for the Wharf Titles.

Default: FFFFFF

Note: WharfAllTitles must be set to true.

WharfTitleBack [COLOR] Specifies the background color for the Wharf Titles.

Default: 802020

Note: WharfAllTitles must be set to true.

WharfTitleFont [FONT] Specifies the font to use for Wharf Titles.

Default: Arial

Note: WharfAllTitles must be set to true.

WharfTitleFontSize [NUMBER] Specifies the size of the font used for Wharf Titles.

Default: 8

Note: WharfAllTitles must be set to true.

WharfTitleFontWeight [NUMBER] Specifies the weight of the font used for Wharf Titles. Higher values make the text bolder. Normal BOLD Text would be a weight of 600.

Default: 400

Note: WharfAllTitles must be set to true.

WharfAllTitles [BOOL] The caption specified in the *Wharf Step.RC line will be written onto the Wharf tile as text.
WharfTileSize [16, 32, 64] Specifies the size in pixels of all Wharf tiles.

Default: 64

Note: This setting applies to both the height and width of Wharf tiles, so all tiles must be squares. The only valid values are 16, 32 or 64.

WharfShadeButton [NUMBER] Adjusts the division of the WharfTitleBar between its dragging and hiding functions. Accepted values are from 1 (division is on the far left) through to 63 (division is on the far right).

Default: WharfTileSize divided by 2.

WharfDblClickXPosition [NUMBER] X Co-ordinate relative to the right side of the screen that the wharf will move to when the titlebar is double clicked.

Default: 120

WharfDblClickDockOnLeft [BOOL] Moves the Wharf to the left edge of the screen when you double click the titlebar.
WharfBevelWidth [NUMBER] Specifies the width in pixels of the bevel around the edge of each individual Wharf tile.

Default: 1

WharfNoAnim [BOOL] The opening and closing of Wharf folders will not be animated.
WharfAnimStep [NUMBER] Specifies the size in pixels of the steps that are taken while animating the opening and closing of Wharf folders.

Default: 64

WharfAnimDelay [NUMBER] Specifies the time delay in milliseconds between steps of Wharf folder animation.

Default: 10

AutoHideWharf [BOOL] Tells the Wharf to automatically hide to the right, or left, side of the screen after a period of inactivity, which is specified in AutoHideDelay.
AutoHideDelay [NUMBER] The period of inactivity in milliseconds after which the Wharf will automatically hide to the side of the screen.

Default: 300

Note: AutoHideWharf must be set to true.

AutoShowDelay [NUMBER] Specifies the time period in milliseconds before the Wharf will show up again when the mouse passes over the hidden Wharf bar.

Default: 300

WharfHiddenWidth [NUMBER] Specifies the width in pixels of the strip that is visible when the Wharf automatically hides to the right or left edge of the screen.

Default: 1

WharfPressOffset [NUMBER] Specifies how "depressed" Wharf tiles will become when they are clicked.

Default: 1

WharfNoHints [BOOL] Tooltips will no longer appear when the mouse is held over a Wharf tile.
WharfCloseOnSwitch [BOOL] The open Wharf folder will close when it loses focus.
WharfOpenSound [SOUND.WAV] Specifies the sound that will play when a Wharf folder is opened.
WharfCloseSound [SOUND.WAV] Specifies the sound that will play when a Wharf folder is closed.
WharfMinSound [SOUND.WAV] Specifies the sound that will play when the Wharf is shaded.
WharfMaxSound [SOUND.WAV] Specifies the sound that will play when the Wharf is unshaded.
SnapToWharf [BOOL] The Wharf will snap to the edge of the screen if it is within the distance specified in SnapToSensitivity.
SnapToSensitivity [NUMBER] If the Wharf is moved within this pixel distance from the screen edge, it will automatically snap to the screen edge.

Default: 16

Note: SnapToWharf must be set to true.

DefaultBackPix [IMAGE.BMP] Specifies the default background image that appears behind all Wharf items not inside a Wharf folder.
FolderBackPix [IMAGE.BMP] Specifies the default background image that appears behind icons inside a Wharf folder.
FolderPix [IMAGE.BMP] This defines an extra image that is placed on the Wharf tile to show that it is a Wharf Folder. For example, a small arrow like the one used to designate Popup folders.
!Bang Commands for Wharf.dll
!ToggleWharf This will toggle the Wharf between visible and hidden states. When hidden, the Wharf is simply "rolled up" into the titlebar image.
!WharfTasks This !Bang command is similar to the Popup command !PopupTasks. It is part of the Wharf configuration in the Step.RC and functions by placing a folder in the Wharf, with an icon for each currently running task.

Example: *Wharf "Current Tasks" tasks.bmp !WharfTasks