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 desktop2.dll do?
Desktop2.dll uses an invisible window of configurable size for you to click on. By configuring a desktop size, you are setting the size to which your maximized applications will fill. This will not affect the use of any LiteStep module. Desktop2.dll also allows you to assign actions to mouse clicks on the desktop. For example, when you right-click on the desktop, by default, desktop2.dll displays the popup. Consider this module, or one of the Third-Party replacements, to be REQUIRED for LiteStep use.

Note: In order for most LiteStep modules to work correctly they need to be loaded after your desktop module. Therefore, it is normally good practice to put your desktop2.dll LoadModule line before all other LoadModule lines.

Step.RC Syntax for desktop2.dll
SetDesktopArea[NUMBER]

SDALeft
SDARight
SDATop
SDABottom

This command enables custom desktop sizes, which can be very useful if there is some part of your theme that you don't want to be covered by maximized windows. The [NUMBER] is optional; however, in multimonitor systems it will allow you to configure different resolutions on different monitors.

SetDesktopArea[NUMBER] uses the following commands to set the desktop size with respect to each side of the screen:

Default: 1

   SDALeft [NUMBER]
      Default: 0

   SDARight [NUMBER]
      Default: 0

   SDATop [NUMBER]
      Default: 0

   SDABottom [NUMBER]
      Default: 0

Example: Maximized windows will fill the whole screen except for a 10 pixel border around the screen edge.

SetDesktopArea
   SDALeft    10
   SDARight   0
   SDATop     10
   SDABottom  -10

SetDesktopArea2
   SDALeft    0
   SDARight   -10
   SDATop     10
   SDABottom  -10

SetDesktopAreaMainMonitorOnly [BOOL] Any SDALeft, SDARight, SDATop, SDABottom settings will only be applied to the main monitor. If you are in a multimonitor system the workarea of the remaining monitors will be set to their resepective maximum screen size.
DesktopOnDisplayChange [ACTION] This command will run the specified set of commands whenever the Display Properties are changed.
!Bang Commands for desktop2.dll
!DesktopSetClick [STRING] [ACTION] This setting allows you to change what mouse click on the desktop and their Modifier keys do on the fly.

Note: The valid [STRING]s are rbutton, lbutton, mbutton, x1button, x2button, ctrl, alt, apps, rwin, lwin, and shift in any combination.

Example:
!DesktopSetClick rbutton !popup
!DesktopSetClick lbutton !about
!DesktopSetClick lbutton+ctrl !recycle

!DesktopSetArea [NUMBER] [NUMBER] [NUMBER] [NUMBER] Allows you to change the size of the Desktop Area on the fly. This can be helpfull when starting an application that needs to be run fullscreen.

Note: Settings are read as Left, Top, Right, Bottom from left to right and all of them must be specified.

Syntax for adding Mouse Clicks to Desktop2
*Desktop [MAIN BUTTON]+[MODIFIER KEY]+[MODIFIER KEY]+.. [ACTION]
[Main Button] Valid Buttons are:

lbutton - left mouse button up
rbutton - right mouse button up
mbutton - middle mouse button up
x1button - Microsoft IntelliMouse Explorer x1 mouse button up
x2button - Microsoft IntelliMouse Explorer x2 mouse button up

[Modifier Key] Valid Modifier Keys are:

lbutton - left mouse button up
rbutton - right mouse button up
mbutton - middle mouse button up
x1button - Microsoft IntelliMouse Explorer x1 mouse button up
x2button - Microsoft IntelliMouse Explorer x2 mouse button up
ctrl
shift
alt
apps
rwin
lwin

[Action] Any Windows executable (such as files with extensions .exe, .bat, .com) or any LiteStep !Bang command.
Examples of Mouse Click Configuration for desktop2.dll
*Desktop rbutton !Popup After you release the Right Mouse Button the Popup menu will be displayed.
*Desktop lbutton !About Once the Left Mouse Button is released the !About box will be displayed.
*Desktop lbutton+ctrl !Recycle When the Left Mouse Button is released, while holding down control recycles LiteStep.
*Desktop rbutton+lbutton !CommandToggle When the lbutton is held down while the rbutton is clicked, it will execute the !commandtoggle.

Note: In this example if you have a the lbutton defined as above the !About Window WILL appear.