Wharf 2.1.0

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

Use single '.extract' if [Action] parameter is a file name and you want to obtain it's icon

[Action]
Any LiteStep !Bang command or Windows executable.

[@Module]
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:

@"$ModulesDir$lstime.dll"

Note: if you're going to share OTS2 theme with Wharf, don't forget to put NetInstallModule line for each .dll-applet entry and distribute applets with .app extension with your theme. Example:

*NetInstallModule ckVWM-1.41 ; Wharf applet is ckVWM.dll
*Wharf "VWM" .none @"$ModulesDir$ckVWM-1.41.dll"

; but wharfanoid.app doesn't recognized by NetLoadModule.dll
; so it should to be copied to the \theme\misc\ folder
*Wharf "Game" .none @"$MiscDir$wharfanoid.app"

Flags and parameters:

WharfAutoUnpress [false/true]
Wharf tiles will immediately unpress after being pressed rather than remaining depressed during the mouse click.
Default: false

WharfAlwaysOnTop [false/true]
Sets the Wharf to appear on top of all other LiteStep modules and even sometimes Application Windows.
Default: false

WharfSlidersOnTop [false/true]
Sets the Wharf subfolders to appear on top of all other windows.
Default: false

WharfNoAutoClose [false/true]
Wharf folders remain outstretched until they are closed by clicking the folder tile a second time.
Default: false

WharfNoTitlebar [false/true]
Removes the cap that is displayed at the top of the Wharf.
Default: false

WharfStartRolledUp [false/true]
Set wharf rolled up on startup.
Default: false

WharfTitlebarPix [image]
Specifies the image for the Wharf titlebar.
Default: none

WharfCapHeight [size]
Specifies the height in pixels of the Wharf titlebar.
Default: 16

WharfTitleFore [color]
Specifies the font color for the Wharf Titles.
Ignored if WharfAllTitles is false.
Default: FFFFFF

WharfTitleFont [font]
Font name to use for Wharf Titles.
Ignored if WharfAllTitles is false.
Default: Arial

WharfTitleFontSize [number]
Specifies the size of the font used for Wharf Titles.
Ignored if WharfAllTitles is false.
Default: 8

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.
Ignored if WharfAllTitles is false.
Default: 400

WharfAllTitles [false/true]
The caption specified in the *Wharf line will be written onto the Wharf tile as text.
Default: false

WharfTileSize [16, 32, 64]
Specifies the size in pixels of all Wharf tiles. 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.
Default: 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.

WharfTitleBarLeftClick [action]
Set the action for a left mouse click on the titlebar.
Default: !WharfRollup

WharfTitleBarRightClick [action]
Set the action for a right mouse click on the titlebar.
Default: !none

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: 0

WharfDblClickDockOnLeft [false/true]
Moves the Wharf to the left edge of the screen when you double click the titlebar.
Default: false

WharfBevelWidth [number]
Specifies the width in pixels of the bevel around the edge of each individual Wharf tile.
Default: 1

WharfNoAnim [false/true]
The opening and closing of Wharf folders will not be animated.
Default: false

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

WharfAutoHide [false/true]
Tells the Wharf to automatically hide to the right, or left, side of the screen after a period of inactivity, which is specified in WharfAutoHideDelay.
Default: false

WharfAutoHideDelay [number]
The period of inactivity in milliseconds after which the Wharf will automatically hide to the side of the screen.
Ignored if WharfAutoHide is false
Default: 300

WharfAutoShowDelay [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 [false/true]
Tooltips will no longer appear when the mouse is held over a Wharf tile.
Default: false

WharfCloseOnSwitch [false/true]
The open Wharf folder will close when it loses focus.
Default: false

WharfOpenSound [sound.wav]
Specifies the sound that will play when a Wharf folder is opened.
Default: none

WharfCloseSound [sound.wav]
Specifies the sound that will play when a Wharf folder is closed.
Default: none

WharfMinSound [sound.wav]
Specifies the sound that will play when the Wharf is shaded.
Default: none

WharfMaxSound [sound.wav]
Specifies the sound that will play when the Wharf is unshaded.
Default: none

WharfSnapToEdges [false/true]
The Wharf will snap to the edge of the screen if it is within the distance specified in WharfSnapSensitivity.
Default: false

WharfSnapSensitivity [number]
If the Wharf is moved within this pixel distance from the screen edge, it will automatically snap to the screen edge.
This option ignored if WharfSnapToEdges set to false.
Default: 16

WharfDefaultBackPix [image]
Specifies the default background image that appears behind all Wharf items not inside a Wharf folder.
Default: none

WharfFolderBackPix [image]
Specifies the default background image that appears behind icons inside a Wharf folder.
Default: none

FolderPix [image]
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.
Default: none

WharfStartHidden [false/true]
Start hidden
Default: false

ModulesINI [path]
File where Wharf should store it's position
Default: $LiteStepDir$modules.ini

Full list of available !bangs:

!WharfRollup
This will toggle the Wharf between visible and hidden states. When hidden, the Wharf is simply "rolled up" into the titlebar image.

!WharfHide
Hide the entire wharf, including titlebar.

!WharfShow
Show the entire wharf, including titlebar.

!WharfTasks
This pseudo !Bang command is similar to the Popup command !PopupTasks. It is part of the Wharf configuration in the 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

Version 2.1.0, 23.05.2004 (Seg@)

ModulesINI option now can be overridden by WharfModulesINI

Obsolete and idle fields of wharfDataType structure now filled with zeroes:
trayIconSize <- TrayIconSize
taskBarFore <- LSTaskBarFore
taskBarBack <- LSTaskBarBack
taskBarText <- LSTaskBarText
taskBarFore2 <- LSTaskBarFore2
taskBar <- NoTaskBar
showBeta <- NoShowBeta
usClock <- UsClock
vwmVelocity <- VWMVelocity
VWMDistance <- VWMSecurityDistance
VWMNoAuto <- VWMNoAuto
pixmapDir <- szImagePath
vwmBackColor <- VWMBackColor
vwmSelBackColor <- VWMSelBackColor
vwmForeColor <- VWMForeColor
vwmBorderColor <- VWMBorderColor
This change should not break compatibility with any present-day module. The idea of Wharf as a module container is noticably changed since 1998.

Major code rewriting. "Real" classes, "real" STL and a lot of surplus code removed. Compiled using the latest STLport. Also all string buffers enlarged to 4096 bytes instead of 256 (I like long !bangs)

Added support for 32-bit icons with alpha-channel

Tasks without icon in the !WharfTasks folder will use default application icon

Now Drag&Drop supported (hmmm... only Drop =) )
Wharf folders will be opened automatically when you dragging files/text under it

Default value for WharfSlidersOnTop changed to TRUE

VersionInfo added