XMonad.Layout.Gaps

xmonad-contrib-0.13: Third party extensions for xmonad

Copyright | (c) 2008 Brent Yorgey
License | BSD3
Maintainer | <byorgey@gmail.com>
Stability | unstable
Portability | unportable
Safe Haskell | None
Language | Haskell98

XMonad.Layout.Gaps

Contents

- Usage

Description

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 that 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.

Synopsis

- data Direction2D
  - = U
  - | D
  - | R
  - | L
- data Gaps a
- type GapSpec = [(Direction2D, Int)]
- gaps :: GapSpec -> l a -> ModifiedLayout Gaps l a
- gaps' :: [((Direction2D, Int), Bool)] -> l a -> ModifiedLayout Gaps l a
- data GapMessage
  - = ToggleGaps
  - | ToggleGap !Direction2D
  - | IncGap !Int !Direction2D
  - | DecGap !Int !Direction2D

# 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

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).

data Direction2D #

Two-dimensional directions:

Constructors

U | Up
D | Down
R | Right
L | Left

Instances

Bounded Direction2D # |
Methods minBound :: Direction2D # maxBound :: Direction2D #
Enum Direction2D # |
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] #
Eq Direction2D # |
Methods (==) :: Direction2D -> Direction2D -> Bool # (/=) :: Direction2D -> Direction2D -> Bool #
Ord Direction2D # |
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 #
Read Direction2D # |
Methods readsPrec :: Int -> ReadS Direction2D # readList :: ReadS [Direction2D] # readPrec :: ReadPrec Direction2D # readListPrec :: ReadPrec [Direction2D] #
Show Direction2D # |
Methods showsPrec :: Int -> Direction2D -> ShowS # show :: Direction2D -> String # showList :: [Direction2D] -> ShowS #

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 # |
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) # |
Methods readsPrec :: Int -> ReadS (Gaps a) # readList :: ReadS [Gaps a] # readPrec :: ReadPrec (Gaps a) # readListPrec :: ReadPrec [Gaps a] #
Show (Gaps a) # |
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.

Instances

Message GapMessage # |