Topic index Glossary

# Module:WinList

AfterStep module displaying list of opened windows

- ### SYNOPSIS

WinList [ standard options]

- ### CONFIGURATION OPTIONS :

  Geometry +x+y

    Specifies the location of the WinList window. Note that only position can be specified - size is defined by other parameters and number of buttons.

  MinSize WxH

    Minimum size of the WinList. WinList will not shrink smaller then this size, when number of buttons is small, but instead it will enlarge buttons to fill extra space. You can set only Width, only Height or both.

  MaxSize WxH

    Maximum size of the WinList. WinList will not grow larger then this size, when number of buttons increase, but instead it will shrink buttons to fit in allowed space. You can set only Width, only Height or both. extra rows/columns could be added when max size is reached in one direction.

  MaxRows count

    Maximum number of rows in WinList.

  MaxColumns count

    Maximum number of columns in WinList.

  MaxColWidth width

    Maximum width of the column. Older *WinListMaxWidth is still supported for compatibility, but depreciated.

  MinColWidth width

    Minimum width of the column

  MaxWidth

    This is depreciated and just there for compatibility. Please use MaxSize/MinSize instead.

  Action 1|2|3|4|5 action

    Defines what function should be executed on the window when specific mouse button is clicked over window's button.

  FillRowsFirst

    Flag, indicating that WinList should should add new row when new button is added, and only if MaxRows or max height is reached - add new column. By Default WinLIst adds columns first.

  UseSkipList

    Obey SkipWinList flags set by applications or database config.

  UseName 0|1|2|3

    Tells WinList what type of name to use for displaying in WinList label.

    # 0 - Name, 1 - icon, 2 - res_name, 3 - res_class

  Align Left,Right,Top,Bottom

    Sets align of the text label in WinList buttons.

    See Also: Alignment flags for further details.

  Bevel None,Left,Right,Top, Bottom, NoOutline

    Defines 3D bevel of WinList buttons.

    See Also: Bevel flags for further details.

  FBevel None,Left,Right,Top, Bottom, NoOutline

    Defines 3D bevel of WinList buttons for windows that are in focused state.

    See Also: Bevel flags for further details.

  UBevel None,Left,Right,Top, Bottom, NoOutline

    Defines 3D bevel of WinList buttons for windows that are in unfocused state.

    See Also: Bevel flags for further details.

  SBevel None,Left,Right,Top, Bottom, NoOutline

    Defines 3D bevel of WinList buttons for windows that are in sticky state.

    See Also: Bevel flags for further details.

  FocusedBevel

    FIXME: add proper description here.

    See Also: Bevel flags for further details.

  StickyBevel

    FIXME: add proper description here.

    See Also: Bevel flags for further details.

  UnfocusedBevel

    FIXME: add proper description here.

    See Also: Bevel flags for further details.

  CompositionMethod

    Sets composition method to be used to draw WinList buttons. Default is alpha-blending. Valid values are in range 130-145.

  FCompositionMethod

    CompositionMethod for WinList buttons representing focused windows.

  UCompositionMethod

    CompositionMethod for WinList buttons representing unfocused windows.

  SCompositionMethod

    CompositionMethod for WinList buttons representing sticky windows.

  Spacing

    FIXME: add proper description here.

  HSpacing

    FIXME: add proper description here.

  VSpacing

    FIXME: add proper description here.

  UnfocusedStyle "style"

    MyStyle to be used for rendering of window buttons for windows thar are in focused state.

  FocusedStyle "style"

    MyStyle to be used for rendering of window buttons for windows thar are in focused state.

  StickyStyle

    MyStyle to be used for rendering of window buttons for windows thar are in sticky state.

  ShapeToContents

    When Shaped extensions are available - it will cause WinList to have non-rectangular shape to wrap around columns/rows of buttons.

  Orientation

    down|across - Will make a vertical or horizontal winlist.

    This is depreciated. Use FillRowsFirst instead.

  MyStyle

    FIXME: add proper description here.

    See Also: MyStyle definition for further details.

  Balloons

    Turns on the balloon feature. A "balloon" is displayed showing the name of the button the pointer is resting on in the WinList. The balloon background and text are configured with the MyStyle "*WinListBalloon"

  BalloonXOffset

    FIXME: add proper description here.

  BalloonYOffset

    FIXME: add proper description here.

  BalloonDelay

    FIXME: add proper description here.

  BalloonCloseDelay

    Determines the delay in ms between when balloon is shown and before it disapears.

  BalloonBorderHilite

    Defines the bevel to be drawn around balloons - replaces the BorderWidth setting.

    See Also: Bevel flags for further details.

  BalloonStyle

    FIXME: add proper description here.

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.

Topic index Glossary Back to Top

AfterStep version 2.00.03