nIcon

<wiki:toc max_depth="3" />

Introduction

nIcon is a module for LiteStep. It lets you display the items in a folder as a grid of icons - just like the explorer desktop does.

Configuration

Loading

To load the module you need to add a `LoadModule` line pointing to this modules file to your step.rc or theme.rc: LoadModule "$ModulesDir$nIcon-0.5.dll" Or, if you are using NetLoadModule:

Make sure to load it _after_ nCore since it needs the library function nCore provides.

Creation

To start you need to create a new nIcon "group". You do this by naming it in your step.rc, theme.rc or any other .rc file that is loaded into your LiteStep configuration:

You can create as many nIcon "groups" as you like. Adding another line like this:

will add another one.

You can also create several groups with 1 line, this will create nIcon groups with names _Group1_, _Group2_, and _Group3_.

Configuration

All settings in your configuration files start with the "Name" you gave your nIcon group. For example this would set the Width of the nIcon group area on your desktop for the first example we created above: TheNAMEWidth 200 To set the Width for the second example group we would add this line: AnotherNameWidth 200

As you can see the options always consists of the name and the setting we want to configure. This documentation will use *(Name)* as a general placeholder after this.

General Settings

`Folder`

Default Value: Desktop

`DontHideDesktopSystemIcons`

`*(Name)Hide`

Background Configuration

nIcon's background is a window with the prefix (Name).

Tile Layout

nIcon supports all layout settings, with the prefix (Name).

Tile Configuration

All icon tiles are windows with 3 additional states, Hover, Selected, and Focused. They have the prefix (Name)Icon.

`Size`

The size of the icons

Default Value: 48

`GhostOpacity`

The opacity of icons that are "Cut" out.

Default Value: 0.6

Rectangle Configuration

nIcon uses a selection rectangle. It uses 2 brushes. One with prefix (Name)SelectionRectangle, and the other with prefix (Name)SelectionRectangleOutline. It also has the following 3 setting: CornerRadiusX, CornerRadiusY, and OutlineWidth.

Sample configuration

; Make DesktopIcons a child of nDesk -- the desktop background window.
Parent nDesk
	
; Place it in the top left corner of the primary monitor.
X $Monitor1Left - VirtualScreenX$
Y $Monitor1Top - VirtualScreenY$
	
; Cover the entire monitor, in the horizontal, and leave 34 pixels on the
; bottom (e.g. for a taskbar)
Width $Monitor1ResolutionX$
Height $Monitor1ResolutionY - 34$
	
; Display the contents of the (virtual) desktop folder
Folder Desktop
	
; Set the background color to completely transparent red
Color #0F00
	
; Inherit click events from nDesk.
Group nDesk
	
; 64px by 64px icons
IconSize 64

}

Note that the [MultiMonitor] module is used in order to get the MonitorX evars.