xmonad-contrib-0.13: Third party extensions for xmonad

Copyright | (c) Lukas Mai
License | BSD-style (see LICENSE)
Maintainer | <l.mai@web.de>
Stability | unstable
Portability | unportable
Safe Haskell | None
Language | Haskell98

XMonad.Layout.MultiToggle

Contents

- Usage

Description

Dynamically apply and unapply transformers to your window layout. This can be used to rotate your window layout by 90 degrees, or to make the currently focused window occupy the whole screen ("zoom in") then undo the transformation ("zoom out").

Synopsis

- class (Eq t, Typeable t) => Transformer t a | t -> a where
- data Toggle a = Transformer t a => Toggle t
- (??) :: a -> b -> HCons a b
- data EOT = EOT
- single :: a -> HCons a EOT
- mkToggle :: LayoutClass l a => ts -> l a -> MultiToggle ts l a
- mkToggle1 :: LayoutClass l a => t -> l a -> MultiToggle (HCons t EOT) l a
- class HList c a
- data HCons a b
- data MultiToggle ts l a

# Usage

The basic idea is to have a base layout and a set of layout transformers, of which at most one is active at any time. Enabling another transformer first disables any currently active transformer; i.e. it works like a group of radio buttons.

To use this module, you need some data types which represent transformers; for some commonly used transformers (including MIRROR, NOBORDERS, and FULL used in the examples below) you can simply import XMonad.Layout.MultiToggle.Instances.

Somewhere else in your file you probably have a definition of `layout`; the default looks like this:

    layout = tiled ||| Mirror tiled ||| Full

After changing this to

    layout = mkToggle (single MIRROR) (tiled ||| Full)

you can now dynamically apply the `Mirror` transformation:

    ...
      , ((modm,               xK_x     ), sendMessage $ Toggle MIRROR)
    ...

(That should be part of your key bindings.) When you press `mod-x`, the active layout is mirrored. Another `mod-x` and it's back to normal.

It's also possible to stack `MultiToggle`s. For example:

    layout = id
        . smartBorders
        . mkToggle (NOBORDERS ?? FULL ?? EOT)
        . mkToggle (single MIRROR)
        $ tiled ||| Grid ||| Circle

By binding a key to `(sendMessage $ Toggle FULL)` you can temporarily maximize windows, in addition to being able to rotate layouts and remove window borders.

You can also define your own transformers by creating a data type which is an instance of the `Transformer` class. For example, here is the definition of `MIRROR`:

    data MIRROR = MIRROR deriving (Read, Show, Eq, Typeable)
    instance Transformer MIRROR Window where
        transform _ x k = k (Mirror x) (\(Mirror x') -> x')

Note, you need to put `{-# LANGUAGE DeriveDataTypeable #-}` at the beginning of your file.

class (Eq t, Typeable t) => Transformer t a | t -> a where Source #

A class to identify custom transformers (and look up transforming functions by type).

Minimal complete definition

transform

Methods

transform :: LayoutClass l a => t -> l a -> (forall l'. LayoutClass l' a => l' a -> (l' a -> l a) -> b) -> b Source #

Instances

Transformer StdTransformers Window Source # |
Methods transform :: LayoutClass l Window => StdTransformers -> l Window -> (forall l'. LayoutClass l' Window => l' Window -> (l' Window -> l Window) -> b) -> b Source #
Transformer REFLECTY Window Source # |
Methods transform :: LayoutClass l Window => REFLECTY -> l Window -> (forall l'. LayoutClass l' Window => l' Window -> (l' Window -> l Window) -> b) -> b Source #
Transformer REFLECTX Window Source # |
Methods transform :: LayoutClass l Window => REFLECTX -> l Window -> (forall l'. LayoutClass l' Window => l' Window -> (l' Window -> l Window) -> b) -> b Source #

data Toggle a Source #

Toggle the specified layout transformer.

Constructors

Transformer t a => Toggle t |

Instances

Typeable * a => Message (Toggle a) Source # |

(??) :: a -> b -> HCons a b infixr 0 Source #

Prepend an element to a heterogeneous list. Used to build transformer tables for `mkToggle`.

data EOT Source #

Marks the end of a transformer list.

Constructors

EOT |

Instances

Read EOT Source # |
Methods readsPrec :: Int -> ReadS EOT # readList :: ReadS [EOT] # readPrec :: ReadPrec EOT # readListPrec :: ReadPrec [EOT] #
Show EOT Source # |
Methods showsPrec :: Int -> EOT -> ShowS # show :: EOT -> String # showList :: [EOT] -> ShowS #
HList EOT w Source # |
Methods find :: Transformer t w => EOT -> t -> Maybe Int resolve :: EOT -> Int -> b -> (forall t. Transformer t w => t -> b) -> b

single :: a -> HCons a EOT Source #

Construct a singleton transformer table.

mkToggle :: LayoutClass l a => ts -> l a -> MultiToggle ts l a Source #

Construct a `MultiToggle` layout from a transformer table and a base layout.

mkToggle1 :: LayoutClass l a => t -> l a -> MultiToggle (HCons t EOT) l a Source #

Construct a `MultiToggle` layout from a single transformer and a base layout.

class HList c a Source #

Minimal complete definition

find, resolve

Instances

HList EOT w Source # |
Methods find :: Transformer t w => EOT -> t -> Maybe Int resolve :: EOT -> Int -> b -> (forall t. Transformer t w => t -> b) -> b
(Transformer a w, HList b w) => HList (HCons a b) w Source # |
Methods find :: Transformer t w => HCons a b -> t -> Maybe Int resolve :: HCons a b -> Int -> b -> (forall t. Transformer t w => t -> b) -> b

data HCons a b Source #

Instances

(Read b, Read a) => Read (HCons a b) Source # |
Methods readsPrec :: Int -> ReadS (HCons a b) # readList :: ReadS [HCons a b] # readPrec :: ReadPrec (HCons a b) # readListPrec :: ReadPrec [HCons a b] #
(Show b, Show a) => Show (HCons a b) Source # |
Methods showsPrec :: Int -> HCons a b -> ShowS # show :: HCons a b -> String # showList :: [HCons a b] -> ShowS #
(Transformer a w, HList b w) => HList (HCons a b) w Source # |
Methods find :: Transformer t w => HCons a b -> t -> Maybe Int resolve :: HCons a b -> Int -> b -> (forall t. Transformer t w => t -> b) -> b

data MultiToggle ts l a Source #

Instances

(Typeable * a, Show ts, HList ts a, LayoutClass l a) => LayoutClass (MultiToggle ts l) a Source # |

Methods

runLayout :: Workspace WorkspaceId (MultiToggle ts l a) a -> Rectangle -> X ([(a, Rectangle)], Maybe (MultiToggle ts l a)) #

doLayout :: MultiToggle ts l a -> Rectangle -> Stack a -> X ([(a, Rectangle)], Maybe (MultiToggle ts l a)) #

pureLayout :: MultiToggle ts l a -> Rectangle -> Stack a -> [(a, Rectangle)] #

emptyLayout :: MultiToggle ts l a -> Rectangle -> X ([(a, Rectangle)], Maybe (MultiToggle ts l a)) #

handleMessage :: MultiToggle ts l a -> SomeMessage -> X (Maybe (MultiToggle ts l a)) #

pureMessage :: MultiToggle ts l a -> SomeMessage -> Maybe (MultiToggle ts l a) #

description :: MultiToggle ts l a -> String #

(LayoutClass l a, Read (l a), HList ts a, Read ts) => Read (MultiToggle ts l a) Source # |
Methods readsPrec :: Int -> ReadS (MultiToggle ts l a) # readList :: ReadS [MultiToggle ts l a] # readPrec :: ReadPrec (MultiToggle ts l a) # readListPrec :: ReadPrec [MultiToggle ts l a] #
(Show ts, Show (l a), LayoutClass l a) => Show (MultiToggle ts l a) Source # |
Methods showsPrec :: Int -> MultiToggle ts l a -> ShowS # show :: MultiToggle ts l a -> String # showList :: [MultiToggle ts l a] -> ShowS #