WinList(1.5)

NAME
WinList - the AfterStep window list module

SYNOPSIS
WinList is spawned by afterstep, so no command line invocation will work.

From within an afterstep menu file by 'WinList':

% cat "~/GNUstep/Library/AfterStep/start/Modules/WinList"
	Module "WinList" WinList
	MiniPixmap "mini-as.xpm"
To stop the WinList module, a menu item can be used:

% cat "~/GNUstep/Library/AfterStep/start/Modules/WinList_Stop"
	KillModuleByName "Stop WinList" WinList
	MiniPixmap "mini-as.xpm"

DESCRIPTION
The WinList module provides a window list made up of buttons, each corresponding to a window that AfterStep is managing. Clicking on the buttons with any of the three mouse buttons will either do a default action or can be user configured by editing the winlist file.

INITIALIZATION
During initialization, WinList will search a configuration file which describes the colors, font, actions to take on mouse clicks, and geometry settings to use. The configuration file is /usr/local/share/afterstep/winlist; but can be overriden by ~/GNUstep/Library/AfterStep/winlist . If the WinList executable is linked to another name, ie 'ln -s WinList OtherWinList', then another module called OtherWinList can be started, with a completely different set of configurations than WinList, simply by adding *OtherWinList options following the same *WinList configuration options below to the winlist file. This way multiple Identify programs can be used.

INVOCATION
WinList can be invoked from the autoexec file or from a menu item as shown in the Synopsis section above. WinList can also be invoked from binding "Module WinList argument" to a keystroke or mouse button using Transient as an argument which will cause WinList to resemble the built-in window list. AfterStep will search through the directories specified in the ModulePath configuration in the base.#bpp (where # is your colordepth) to attempt to locate WinList.

CONFIGURATION OPTIONS
WinList reads the winlist file when it starts up, and looks for its configuration options

*WinListGeometry geometry
    Specifies the location and gravity of the WinList window. At the current time, size is not supported and WinList will resize itself as buttons are added. If the NoAnchor option is not specified then the window's gravity corner will be anchored, and the window will grow in the opposite direction. (i.e. If the geometry is specified -5-5, that is SoutEastGravity. This will cause the window to draw up and to the left as windows are added)

*WinListFont font
    Specifies the font to be used for labeling the buttons.

*WinListFore color
    Specifies the color to use for the button names.

*WinListBack color
    Specifies the color for the buttons.

*WinListUseSkipList
    Tells WinList to not show the windows that are have WindowListSkip as a Style option in the atabase file.

*WinListNoAnchor
    By default, WinList will anchor the gravity corner so the window will grow in the opposite direction. This undoes that option.

*WinListUseIconNames
    Tells WinList to use the icon name of the window instead of the full window name. This is useful to keep the width of the window small.

*WinListAction action response[,reponse...]
    Tells WinList to do response when action is done. The currently supported actions are: Click1, Click2, Click3. The currently supported responses are any AfterStep built-in commands, including modules and functions.

*WinListOrientation down|across
    Will make a vertical or horizontal winlist.

*WinListMaxWidth width in pixel
    Sets either maxwidth for a vertical winlist or the actual width for a horizontal "taskbar".

*WinListLeftJustify
    If used, will justify the text to the left. If unspecified, the default is to center text.

*WinListPixmap pixmap
    This option sets WinList background pixmap.

*WinListTextStyle style
    Specifies TextStyle to be used, 0 is normal text, 1 and 2 are 3D looking text.

*WinListGradType gradient type
    Tells WinList which gradient type to use, possible gradient types are 1 blah, 2 - vertical gradient, 3 - horizontal gradient, anything else, no gradient.

*WinListGradFrom colour
    Starting colour for gradients.

*WinListGradTo colour
    Ending colour for gradients.

WinListAutoHide number
    Makes WinList auto-hide, when the mouse cursor travels off WinList it reduces its size and becomes a line, when the mouse cursor travels onto hidden WinList it readjusts its size to normal dimensions. 0 turns this feature off, positive numbers turn it on.

*WinListBalloons
    Turns on the balloon feature. A "balloon" is displayed showing the name of the button the pointer is resting on in the WinList.

*WinListBalloonFore color
    Specifies the color for text in the balloon window. If omitted it defaults to the foreground color for the window being described.

*WinListBalloonBack color
    Specifies the background color for the balloon window. If omitted it defaults to the background color for the window being described.

*WinListBalloonFont font-name
    Specifies a font to use for the balloon text. Defaults to fixed.

*WinListBalloonBorderWidth number
    Sets the width of the balloon window's border. Defaults to 1.

*WinListBalloonBorderColor color
    Sets the color of the balloon window's border. Defaults to black.

*WinListBalloonDelay number
    Specifies the period in milliseconds to delay the appearance of the balloon.

*WinListBalloonYOffset number
    The balloon window is positioned to be horizontally centered against the WinList window it is describing. The vertical position may be set as an offset. Negative offsets of -N are placed N pixels above the WinList window, positive offsets of +N are placed N pixels below. Defaults to +2.

FILES

/usr/local/share/afterstep/winlist
    The global configuration file for system wide defaults of all users.

$HOME/GNUstep/Library/AfterStep/winlist
    This file should be copied from the /usr/local/share/afterstep/winlist and edited to suit the user's specific requirements. This file, if exists, will override the system wide default file.

EXAMPLES
The winlist file shipped contains a working example, refer to the FILES section above for its configuration options.

To pop up the window list in tranient mode (appear only when button 3 is pressed & held):

    ...the feel file would contain -
	Mouse 3  R  A  Module "WinList" WinList Transient

AUTHORS
Rene Fichter <ceezaer@cyberspace.org>
Mike Finger <mfinger@mermaid.micro.umn.edu>
David Mihm <davemann@ionet.net> [Man page]
Rafal Wierzbicki <rafal@mcss.mcmaster.ca>

SEE ALSO
afterstep(1),