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 shortcut2.dll do?
Shortcut2.dll provides desktop shortcuts similar to those found on the Explorer desktop but with a far higher degree of configurability. LiteStep shortcuts can be used to execute any !Bang command or Windows executable and are often used in advanced themes to hide, show and further manipulate other LiteStep modules. Shortcut2.dll also supports sounds, along with bitmaps that use Magic Pink, so your shortcut images are just as configurable as the actions they can perform.
Syntax for adding shortcuts with shortcut2.dll
*Shortcut [CAPTION] [X] [Y] [NORMAL.BMP] [HOVER.BMP] [CLICK.BMP] #[GROUP][FLAGS] [HOVER.WAV] [CLICK.WAV] [ACTION]

Note: This syntax goes on one line of your Step.RC and should not wrap.

[CAPTION] This is the tooltip caption that is displayed when the mouse is held over the shortcut.
[X Co-ordinate] [Y Co-ordinate] Sets the X and Y Co-ordinates for the desktop position of the upper-left hand corner of the shortcut image. If you place a "c" after your co-ordinate it will use the relative center of the screen to work from or an "r" if you want to make it relative to your last shortcut.

Example:
    -42  0 : Places the shortcut 42 spaces left from the top right edge of the screen.

    -42c 0 : Places the shortcut 42 spaces left from the horizontal center of the screen on the top edge.

     0c 0c : Places the shortcut in the center of the screen.

[NORMAL.BMP] Defines the image that will be displayed for the shortcut.

Note: Icons can also be .extracted instead of using an image file.

[HOVER.BMP] Defines the image that is displayed when the mouse is held over the shortcut.

Note: Icons can also be .extracted instead of using an image file.

[CLICK.BMP] Defines the image that is displayed when the shortcut is clicked.

Note: Icons can also be .extracted instead of using an image file.

[GROUP] A number to indicate what group the shortcut belongs to. Shortcuts that belong to the same group will react simultaneously to the !Bang commands described below. This can be any valid number in octal, decimal or hexadecimal format, although simple decimal numbers such as 1, 2, 3, etc. are the simplest to follow.

Note: A hash/pound character, "#", must be placed in front of the group number.

[FLAGS] These flags are extra options that allow configuration of shortcuts on an individual level. The letters should be placed directly after the group number, with no spaces in between.

T: indicates that the shortcut is on top of all normal windows.
O: indicates that the shortcut is opaque. If no Magic Pink is used in the shortcut's image, this flag will increase loading time significantly.
H: indicates that the shortcut is hidden at startup. Hidden shortcuts use no memory until they are displayed.
C: indicates the behaviour of the shortcut caption by doing the opposite of the ShortcutShowCaptions setting.

[HOVER.WAV] Sets the sound file you wish to have played when the mouse is placed over the shortcut. This setting overrides the ShortcutSoundHover Step.RC command.

Note: This setting can be omitted if unwanted.

[CLICK.WAV] Sets the sound file you wish to have played when you click on the shortcut. This will override the ShortcutSoundClick Step.RC command.

Note: This setting can be omitted if unwanted.

[ACTION] The action that will be performed when the shortcut is clicked. This can be a LiteStep !Bang command or a Windows executable.
Step.RC Syntax for shortcut2.dll
ShortcutSoundHover [SOUND.WAV] Sets the default sound that is used when a mouse is over any shortcut. If this command is omitted or set to .none, there will be no default hover sound.
ShortcutSoundClick [SOUND.WAV] Sets the default sound that is used when the left mouse button is clicked on any shortcut. If this is omitted or set to .none, there will be no default click sound.
ShortcutShowCaptions [BOOL] When set to true, the tooltip captions specified in the Step.RC *Shortcut command will be shown for all shortcuts. This setting can be toggled for individual shortcuts by using the "C" flag.
!Bang Commands for shortcut2.dll
In the following !Bang Commands, do not use the leading "#" character before the group number. To apply the !Bang command to more than one group, separate the group numbers by spaces or use an asterisk, "*", to apply to all groups. Also note that the changes made by these !Bang commands, as with all other modules, do not stay true through a !Recycle or restart of LiteStep. To permanently change the on top state or visibility of shortcuts you must edit their flags in the Step.RC, as described above.
!ShortcutGroupHide [GROUP] Hides the specified shortcut group, indicated by the group number.
!ShortcutGroupShow [GROUP] Displays the specified shortcut group, indicated by the group number.
!ShortcutGroupToggle [GROUP] Running this !Bang will hide the specified shortcut group, indicated by the group number, if it is shown or show the group if it is hidden.
!ShortcutGroupOnTop [GROUP] This will set the indicated shortcut group to be on top of all other LiteStep Modules and even sometimes Application Windows.
!ShortcutGroupOnBottom [GROUP] This will move the indicated shortcut group behind all other windows.
!ShortcutGroupOnTopToggle [GROUP] Toggles the specified Shortcut Group between the OnTop and OnBottom States.