xmonad-contrib-0.7: Third party extensions for xmonadSource codeContentsIndex
XMonad.Hooks.ManageDocks
Portabilityunportable
Stabilityunstable
MaintainerJoachim Breitner <mail@joachim-breitner.de>
Contents
Usage
Description
This module provides tools to automatically manage dock type programs, such as gnome-panel, kicker, dzen, and xmobar.
Synopsis
manageDocks :: ManageHook
data AvoidStruts a
avoidStruts :: LayoutClass l a => l a -> ModifiedLayout AvoidStruts l a
data ToggleStruts = ToggleStruts
Usage

To use this module, add the following import to ~/.xmonad/xmonad.hs:

 import XMonad.Hooks.ManageDocks

The first component is a ManageHook which recognizes these windows. To enable it:

 manageHook = ... <+> manageDocks

The second component is a layout modifier that prevents windows from overlapping these dock windows. It is intended to replace xmonad's so-called gap support. First, you must add it to your list of layouts:

 layoutHook = avoidStruts (tall ||| mirror tall ||| ...)
                   where  tall = Tall 1 (3/100) (1/2)

AvoidStruts also supports toggling the dock gap, add a keybinding similar to:

 ,((modMask x, xK_b     ), sendMessage ToggleStruts)

Important note: if you are switching from manual gaps (defaultGaps in your config) to avoidStruts (recommended, since manual gaps will probably be phased out soon), be sure to switch off all your gaps (with mod-b) before reloading your config with avoidStruts! Toggling struts with a ToggleStruts message will not work unless your gaps are set to zero.

For detailed instructions on editing your key bindings, see XMonad.Doc.Extending#Editing_key_bindings.

manageDocks :: ManageHookSource
Detects if the given window is of type DOCK and if so, reveals it, but does not manage it. If the window has the STRUT property set, adjust the gap accordingly.
data AvoidStruts a Source
show/hide Instances
avoidStruts :: LayoutClass l a => l a -> ModifiedLayout AvoidStruts l aSource
Adjust layout automagically.
data ToggleStruts Source
Constructors
ToggleStruts
show/hide Instances
Produced by Haddock version 2.3.0