Latest version of xDesk is 1.2
This is xDesk-1.2, a LiteStep module used to provide a "desktop container".
You need to load xPaintClass-1.0 before xDesk, otherwise xDesk won't load!
You can also simply put xPaintClass-1.0 in your LiteStep folder.
You can download the latest xPaintClass-1.0.dll at: www.ls-universe.info
Add some new LoadModule lines somewhere in your theme configuration, similar to the following (this assumes that xDesk-1.2.dll resides in "C:\LiteStep\Modules"):
LoadModule "C:\LiteStep\Modules\xPaintClass-1.0.dll"
LoadModule "C:\LiteStep\Modules\xDesk-1.2.dll"
or the newer *NetLoadModule lines:
*NetLoadModule xPaintClass-1.0
*NetLoadModule xDesk-1.2
To make the newest version available for your theme, you should probably add the following lines somewhere in your theme configuration:
*NetLoadModuleSite "http://www.modules.shellfront.org/"
*NetLoadModuleSite "http://www.modules.ls-universe.info/modules/"
*NetLoadModuleSite "http://www.modules.nbi-studio.com/"
*NetloadModuleSite "http://www.ls-themes.org/modules/download/"
The following commands are typically placed somewhere in your theme configuration. See the LiteStep documentation for help modifying these files.
- [ ]
- Values between [ and ] are optional
- ACTION
- Bang commands, applications, anything LiteStep can execute
- BOOL
- Boolean value (
true
or false
)
- COLOR
- Color in Hex (FFFFFF = White, 000000 = Black, …)
- COORDINATE
- X or Y coordinate on the screen
- If the value is positive, then it is relative to the top/left of the desktop.
- If the value is negative, then it is relative to the bottom/right of the desktop.
- You can make the position relative to the center of the desktop by appending the character 'c' after the number ("32c", "-128c")
- You can use "real negative values" by adding a '~' before the number ("~10").
- Additionally you can use percent values of the desktop ("50%", "75%") and you can combine those percent values with further positioning ("20%-20", "80%+5", "100%+20").
- You can position xDesk on multi monitor systems with:
- 1@
- Relative to primary monitor
- 2@
- Relative to secondary monitor
- 3@
- Relative to third monitor (untested)
- v@
- Relative to virtual screen (all monitors combined)
- DIMENSION
- A number of pixels
- If the value is positive, then it is an absolute size in pixels
- If the value is negative, then it is the desktop width/height minus the specified value.
- Additionally you can make the size relative to a percentage of the desktop width/height by appending the character '%' after the number ("50%", "-20", "50%-20", "75%+40").
- You can size xDesk relative to monitors on multi monitor systems using the same syntax as for COORDINATE (1@, 2@, etc)
- INT
- A number
- STRING
- A word, usually beginning with a period (.) or a quoted text
- XDESKMODIFIER
-
.none
, .mouse1
, .mouse2
, .mouse3
, .ctrl
, .shift
, .alt
and all combinations of the last three values (.ctrl+shift
, .shift+alt
, .alt+shift+ctrl
, etc)
- xDeskHueColor COLOR
- This command specifies the color of the hue, if
xDeskHueIntensity
is greater than 0.
- Gray scale colors, like FFFFFF, c0c0c0, 888888, 000000, etc, will not make a difference to the hue since they don't have a color.
- If no value is provided, then the default is FFFFFF (i.e. no hue color).
- xDeskHueIntensity INT
- This command sets the intensity of the hue effect.
- Minimum: 0 (nothing), maximum: 100
- If no value is provided the default is 0.
- xDeskMixColor COLOR
- This command specifies the color, which is mixed with the existing colors.
- If no value is provided, then the default is FFFFFF.
- xDeskMixIntensity INT
- This command sets the intensity of the color mixing effect.
- Minimum: 0 (nothing), maximum: 100
- If no value is provided the default is 0.
- xDeskLuminanceIntensity INT
- This command sets the the intensity of the luminance effect applied to the wallpaper image.
- Minimum: -100 (black), maximum: 100 (white)
- If no value is provided the default is 0.
- xDeskSaturationIntensity INT
- This command sets the color saturation of the wallpaper image.
- Minimum: 0 (grayscale), maximum: 200.
- If no value is provided the default is 100 (fully colored).
- Values between 101-200 override the original saturation of the pixel. This way you can colorize gray scale desktops.
- xDeskEnableDoubleClicks BOOL
- Configures whether double click actions are possible or not.
- By default double click actions are disabled.
Modify how your wallpaper looks.
Create matching colors to your theme or add static elements like logos.
- *xDeskOverlay COORDINATE COORDINATE DIMENSION DIMENSION STRING #STRING
- The parameters are:
x
y
width
height
settingsprefix
flag
All position and sizing options are available to set the position and size of the static overlay.
settingsprefix
is needed and is the prefix needed for xPaintTexture.
flag
can be a
or empty. a
means that the overlay uses an alpha mapped image.
For instance a 20 pixel border on the right side:
*xDeskOverlay -20 0 -20 100% ghost #
ghostPaintingMode .image
ghostImage image.png
ATTENTION: These are static overlays. They are always visible and you cannot toggle them.
- !xDeskSetWorkArea COORDINATE COORDINATE DIMENSION DIMENSION
- !xDeskSetWorkArea 1 COORDINATE COORDINATE DIMENSION DIMENSION
- !xDeskSetWorkArea primary COORDINATE COORDINATE DIMENSION DIMENSION
- !xDeskSetWorkArea 2 COORDINATE COORDINATE DIMENSION DIMENSION
- !xDeskSetWorkArea secondary COORDINATE COORDINATE DIMENSION DIMENSION
- Set the workarea based on the xPaintClass-1.0 coordinate and dimension features.
- !xDeskSetWallpaper [STRING]
- The parameter is:
path
- Sets the new wallpaper.
-
path
should be the path to a wallpaper image. bmp, png, jpg, and gif images are supported.
When used without any argument the current modified wallpaper is saved in the ThemeDir and it is set as the current wallpaper. Afterwards you should remove the overlay and colorization settings. This saves RAM and CPU because they aren't needed anymore (until the user changes his wallpaper again).
When used with an imagepath as argument then this wallpaper is set.
- !xDesk CLICKACTION SYNTAX_FROM_*LINES
- This Bang command can reassign click events or click regions on the fly.
Example:
!xDesk OnLeftClickDown .none !newpopup
The drop action is executed, if the matching XDESKMODIFIER key combination is pressed during the drop.
Or in case of .mouse1
and .mouse2
of the drag was performed with the left (1) or right (2) mouse button.
- *xDeskOnDrop XDESKMODIFIER STRING STRING
- Sets an action to perform, when file(s) or folder(s) is dropped on the destop.
- User confirmation on overwrite is required ;)
- The first STRING can be:
move
, copy
, delete
or shortcut
.
- The second STRING is the path to move, copy or create shortcut (MUST be enclosed in '" "')
Examples:
; Move the dropped file(s) to a given destination
*xDeskOnDrop .none move "Path To Move To"
; Copy the dropped file(s) to a given destination
*xDeskOnDrop .none copy "Path To Copy To"
; Delete the dropped file(s)
*xDeskOnDrop .none delete
; Create shortcuts to the dropped file(s) at a given destination
*xDeskOnDrop .none shortcut "Path Where The Shortcut(s) Will Be Created"
Alternative:
- *xDeskOnDrop XDESKMODIFIER ACTION
- In the ACTION "%droppath%" (lowercase!) will be replaced with the full path of the dropped file.
- If no "%droppath%" is found, it is the same behavior as before, the drop path will be simply appended after the ACTION.
Example:
*xDeskOnDrop .none !execute [!alert "%[droppath]%" "Saved"][!xtextsaveevar @$configdir$save.rc@ @dropped@ @%[droppath]%@]
The action is executed, if the matching XDESKMODIFIER key combination is pressed during the click.
For the double click events you have to set xDeskEnableDoubleClicks
- *xDeskOnWheelDown XDESKMODIFIER ACTION
- Sets an action to perform, when the user rolls the mousewheel down on the desktop.
- *xDeskOnWheelUp XDESKMODIFIER ACTION
- Sets an action to perform, when the user rolls the mousewheel up on the desktop.
- *xDeskOnLeftClickDown XDESKMODIFIER ACTION
- Sets an action to perform, when the user presses the left mousebutton down on the desktop.
- *xDeskOnLeftClickUp XDESKMODIFIER ACTION
- Sets an action to perform, when the user left clicks on the desktop (releases the left mousebutton).
- *xDeskOnLeftDoubleClick XDESKMODIFIER ACTION
- Sets an action to perform, when the user double-clicks the desktop with the left mousebutton.
- *xDeskOnMiddleClickDown XDESKMODIFIER ACTION
- Sets an action to perform, when the user presses the middle mousebutton down on the desktop.
- *xDeskOnMiddleClickUp XDESKMODIFIER ACTION
- Sets an action to perform, when the user middle clicks on the desktop (releases the middle mousebutton).
- *xDeskOnMiddleDoubleClick XDESKMODIFIER ACTION
- Sets an action to perform, when the user double-clicks the desktop with the middle mousebutton.
- *xDeskOnRightClickDown XDESKMODIFIER ACTION
- Sets an action to perform, when the user presses the right mousebutton down on the desktop.
- *xDeskOnRightClickUp XDESKMODIFIER ACTION
- Sets an action to perform, when the user right clicks on the desktop (releases the right mousebutton).
- *xDeskOnRightDoubleClick XDESKMODIFIER ACTION
- Sets an action to perform, when the user double-clicks the desktop with the right mousebutton.
- *xDeskOnX1ClickDown XDESKMODIFIER ACTION
- Sets an action to perform, when the user presses the X1 mousebutton down on the desktop.
- *xDeskOnX1ClickUp XDESKMODIFIER ACTION
- Sets an action to perform, when the user clicks with the X1 button on the desktop (releases the X1 mousebutton).
- *xDeskOnX1DoubleClick XDESKMODIFIER ACTION
- Sets an action to perform, when the user double-clicks the desktop with the X1 mousebutton.
- *xDeskOnX2ClickDown XDESKMODIFIER ACTION
- Sets an action to perform, when the user presses the X2 mousebutton down on the desktop.
- *xDeskOnX2ClickUp XDESKMODIFIER ACTION
- Sets an action to perform, when the user clicks with the X2 button on the desktop (releases the X2 mousebutton).
- *xDeskOnX2DoubleClick XDESKMODIFIER ACTION
- Sets an action to perform, when the user double-clicks the desktop with the X2 mousebutton.
Clicking outside of these specified regions will execute the normal commands. (As specified by normal xDesk Click Events
.)
If regions overlap each other, the first matching region defined in the configuration files will be executed.
For the double click events you have to set xDeskEnableDoubleClicks
- *xDeskOnLeftClickRegion COORDINATE COORDINATE DIMENSION DIMENSION ACTION
- Specifies a region inside the desktop which executes the given action when clicked with the left mousebutton. You can have as many of these lines as you want.
- *xDeskOnLeftDoubleClickRegion COORDINATE COORDINATE DIMENSION DIMENSION ACTION
- Specifies a region inside the desktop which executes the given action when doubleclicked with the left mousebutton. You can have as many of these lines as you want.
- *xDeskOnMiddleClickRegion COORDINATE COORDINATE DIMENSION DIMENSION ACTION
- Specifies a region inside the desktop which executes the given action when clicked with the middle mousebutton. You can have as many of these lines as you want.
- *xDeskOnMiddleDoubleClickRegion COORDINATE COORDINATE DIMENSION DIMENSION ACTION
- Specifies a region inside the desktop which executes the given action when doubleclicked with the middle mousebutton. You can have as many of these lines as you want.
- *xDeskOnRightClickRegion COORDINATE COORDINATE DIMENSION DIMENSION ACTION
- Specifies a region inside the desktop which executes the given action when clicked with the right mousebutton. You can have as many of these lines as you want.
- *xDeskOnRightDoubleClickRegion COORDINATE COORDINATE DIMENSION DIMENSION ACTION
- Specifies a region inside the desktop which executes the given action when doubleclicked with the right mousebutton. You can have as many of these lines as you want.
- *xDeskOnX1ClickRegion COORDINATE COORDINATE DIMENSION DIMENSION ACTION
- Specifies a region inside the desktop which executes the given action when clicked with the X1 mousebutton. You can have as many of these lines as you want.
- *xDeskOnX1DoubleClickRegion COORDINATE COORDINATE DIMENSION DIMENSION ACTION
- Specifies a region inside the desktop which executes the given action when doubleclicked with the X1 mousebutton. You can have as many of these lines as you want.
- *xDeskOnX2ClickRegion COORDINATE COORDINATE DIMENSION DIMENSION ACTION
- Specifies a region inside the desktop which executes the given action when clicked with the X2 mousebutton. You can have as many of these lines as you want.
- *xDeskOnX2DoubleClickRegion COORDINATE COORDINATE DIMENSION DIMENSION ACTION
- Specifies a region inside the desktop which executes the given action when doubleclicked with the X2 mousebutton. You can have as many of these lines as you want.
- *xDeskWorkArea COORDINATE COORDINATE DIMENSION DIMENSION
- Sets the workarea based on the xPaintClass-1.0 coordinate and dimension features!
Important:
The following lines set exactly the same workarea:
jDeskWorkArea "5,5,-5,-30"
*xDeskWorkArea 5 5 -10 -35
- jDesk uses the "left,top,right,bottom" syntax, xDesk uses COORDINATE COORDINATE DIMENSION DIMENSION
- You need to subtract the left/top part too (from the right/bottom part) to get the correct width/height.
- *xDeskWorkArea 1 COORDINATE COORDINATE DIMENSION DIMENSION
- *xDeskWorkArea primary COORDINATE COORDINATE DIMENSION DIMENSION
- Sets the workarea of the primary monitor based on the xPaintClass-1.0 coordinate and dimension features.
- *xDeskWorkArea 2 COORDINATE COORDINATE DIMENSION DIMENSION
- *xDeskWorkArea secondary COORDINATE COORDINATE DIMENSION DIMENSION
- Sets the workarea of the secondary monitor based on the xPaintClass-1.0 coordinate and dimension features.