XMonad.Layout.Gaps

Create manually-sized gaps along edges of the screen which will not be used for tiling, along with support for toggling gaps on and off.

Note 1: For gaps/space around windows see XMonad.Layout.Spacing.

Note 2: XMonad.Hooks.ManageDocks is the preferred solution for leaving space for your dock-type applications (status bars, toolbars, docks, etc.), since it automatically sets up appropriate gaps, allows them to be toggled, etc. However, this module may still be useful in some situations where the automated approach of ManageDocks does not work; for example, to work with a dock-type application that does not properly set the STRUTS property, or to leave part of the screen blank which is truncated by a projector, and so on.

Usage

You can use this module by importing it into your ~/.xmonad/xmonad.hs file:

import XMonad.Layout.Gaps

and applying the gaps modifier to your layouts as follows (for example):

layoutHook = gaps [(U,18), (R,23)] $ Tall 1 (3/100) (1/2) ||| Full  -- leave gaps at the top and right

You can additionally add some keybindings to toggle or modify the gaps, for example:

, ((modm .|. controlMask, xK_g), sendMessage $ ToggleGaps)               -- toggle all gaps
, ((modm .|. controlMask, xK_t), sendMessage $ ToggleGap U)              -- toggle the top gap
, ((modm .|. controlMask, xK_w), sendMessage $ IncGap 5 R)               -- increment the right-hand gap
, ((modm .|. controlMask, xK_q), sendMessage $ DecGap 5 R)               -- decrement the right-hand gap
, ((modm .|. controlMask, xK_r), sendMessage $ ModifyGaps rotateGaps)    -- rotate gaps 90 degrees clockwise
, ((modm .|. controlMask, xK_h), sendMessage $ weakModifyGaps halveHor)  -- halve the left and right-hand gaps
, ((modm .|. controlMask, xK_d), sendMessage $ modifyGap (*2) L)         -- double the left-hand gap
, ((modm .|. controlMask, xK_s), sendMessage $ setGaps [(U,18), (R,23)]) -- reset the GapSpec
, ((modm .|. controlMask, xK_b), sendMessage $ setGap 30 D)              -- set the bottom gap to 30
]
  where rotateGaps gs = zip (map (rotate . fst) gs) (map snd gs)
        rotate U = R
        rotate R = D
        rotate D = L
        rotate L = U
        halveHor d i | d `elem` [L, R] = i `div` 2
                     | otherwise       = i

If you want complete control over all gaps, you could include something like this in your keybindings, assuming in this case you are using mkKeymap or additionalKeysP from XMonad.Util.EZConfig for string keybinding specifications:

++
[ ("M-g " ++ f ++ " " ++ k, sendMessage $ m d)
    | (k, d) <- [("a",L), ("s",D), ("w",U), ("d",R)]
    , (f, m) <- [("v", ToggleGap), ("h", IncGap 10), ("f", DecGap 10)]
]

Given the above keybinding definition, for example, you could type M-g, v, a to toggle the top gap.

To configure gaps differently per-screen, use XMonad.Layout.PerScreen (coming soon).

Warning: If you also use the avoidStruts layout modifier, it must come before any of these modifiers. See the documentation of avoidStruts for details.

data Direction2D

Two-dimensional directions:

Constructors

U

Up

D

Down

R

Right

L

Left

Instances

Bounded Direction2D

Defined in XMonad.Util.Types

Methods

minBound :: Direction2D

maxBound :: Direction2D

Enum Direction2D

Defined in XMonad.Util.Types

Methods

succ :: Direction2D -> Direction2D

pred :: Direction2D -> Direction2D

toEnum :: Int -> Direction2D

fromEnum :: Direction2D -> Int

enumFrom :: Direction2D -> [Direction2D]

enumFromThen :: Direction2D -> Direction2D -> [Direction2D]

enumFromTo :: Direction2D -> Direction2D -> [Direction2D]

enumFromThenTo :: Direction2D -> Direction2D -> Direction2D -> [Direction2D]

Read Direction2D

Defined in XMonad.Util.Types

Methods

readsPrec :: Int -> ReadS Direction2D

readList :: ReadS [Direction2D]

readPrec :: ReadPrec Direction2D

readListPrec :: ReadPrec [Direction2D]

Show Direction2D

Defined in XMonad.Util.Types

Methods

showsPrec :: Int -> Direction2D -> ShowS

show :: Direction2D -> String

showList :: [Direction2D] -> ShowS

Eq Direction2D

Defined in XMonad.Util.Types

Methods

(==) :: Direction2D -> Direction2D -> Bool

(/=) :: Direction2D -> Direction2D -> Bool

Ord Direction2D

Defined in XMonad.Util.Types

Methods

compare :: Direction2D -> Direction2D -> Ordering

(<) :: Direction2D -> Direction2D -> Bool

(<=) :: Direction2D -> Direction2D -> Bool

(>) :: Direction2D -> Direction2D -> Bool

(>=) :: Direction2D -> Direction2D -> Bool

max :: Direction2D -> Direction2D -> Direction2D

min :: Direction2D -> Direction2D -> Direction2D

data Gaps a

The gap state. The first component is the configuration (which gaps are allowed, and their current size), the second is the gaps which are currently active.

Instances

LayoutModifier Gaps a

Defined in XMonad.Layout.Gaps

Methods

modifyLayout :: LayoutClass l a => Gaps a -> Workspace WorkspaceId (l a) a -> Rectangle -> X ([(a, Rectangle)], Maybe (l a))

modifyLayoutWithUpdate :: LayoutClass l a => Gaps a -> Workspace WorkspaceId (l a) a -> Rectangle -> X (([(a, Rectangle)], Maybe (l a)), Maybe (Gaps a))

handleMess :: Gaps a -> SomeMessage -> X (Maybe (Gaps a))

handleMessOrMaybeModifyIt :: Gaps a -> SomeMessage -> X (Maybe (Either (Gaps a) SomeMessage))

pureMess :: Gaps a -> SomeMessage -> Maybe (Gaps a)

redoLayout :: Gaps a -> Rectangle -> Maybe (Stack a) -> [(a, Rectangle)] -> X ([(a, Rectangle)], Maybe (Gaps a))

pureModifier :: Gaps a -> Rectangle -> Maybe (Stack a) -> [(a, Rectangle)] -> ([(a, Rectangle)], Maybe (Gaps a))

hook :: Gaps a -> X ()

unhook :: Gaps a -> X ()

modifierDescription :: Gaps a -> String

modifyDescription :: LayoutClass l a => Gaps a -> l a -> String

Read (Gaps a)

Defined in XMonad.Layout.Gaps

Methods

readsPrec :: Int -> ReadS (Gaps a)

readList :: ReadS [Gaps a]

readPrec :: ReadPrec (Gaps a)

readListPrec :: ReadPrec [Gaps a]

Show (Gaps a)

Defined in XMonad.Layout.Gaps

Methods

showsPrec :: Int -> Gaps a -> ShowS

show :: Gaps a -> String

showList :: [Gaps a] -> ShowS

type GapSpec = [(Direction2D, Int)]

A manual gap configuration. Each side of the screen on which a gap is enabled is paired with a size in pixels.

gaps

Arguments

:: GapSpec

The gaps to allow, paired with their initial sizes.

-> l a

The layout to modify.

-> ModifiedLayout Gaps l a

Add togglable manual gaps to a layout.

gaps'

Arguments

:: [((Direction2D, Int), Bool)]

The gaps to allow and their initial states.

-> l a

The layout to modify.

-> ModifiedLayout Gaps l a

Add togglable manual gaps to a layout, explicitly specifying the initial states.

data GapMessage

Messages which can be sent to a gap modifier.

Constructors

ToggleGaps

Toggle all gaps.

ToggleGap !Direction2D

Toggle a single gap.

IncGap !Int !Direction2D

Increase a gap by a certain number of pixels.

DecGap !Int !Direction2D

Decrease a gap.

ModifyGaps (GapSpec -> GapSpec)

Modify arbitrarily.

Instances

Message GapMessage

Defined in XMonad.Layout.Gaps

weakModifyGaps :: (Direction2D -> Int -> Int) -> GapMessage

Modifies gaps weakly, for convenience.

modifyGap :: (Int -> Int) -> Direction2D -> GapMessage

Arbitrarily modify a single gap with the given function.

setGaps :: GapSpec -> GapMessage

Set the GapSpec.

setGap :: Int -> Direction2D -> GapMessage

Set a gap to the given value.