<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>XMonad.Layout.MultiToggle</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_XMonad-Layout-MultiToggle.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-MultiToggle.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">xmonad-contrib-0.11: Third party extensions for xmonad</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>unportable</td></tr><tr><th>Stability</th><td>unstable</td></tr><tr><th>Maintainer</th><td><l.mai@web.de></td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.MultiToggle</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Usage
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>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").
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">class</span> (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> t, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> t) => <a href="#t:Transformer">Transformer</a> t a | t -> a <span class="keyword">where</span><ul class="subs"><li><a href="#v:transform">transform</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => t -> l a -> (<span class="keyword">forall</span> l'. <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l' a => l' a -> (l' a -> l a) -> b) -> b</li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Toggle">Toggle</a> a = <span class="keyword">forall</span> t . <a href="XMonad-Layout-MultiToggle.html#t:Transformer">Transformer</a> t a => <a href="#v:Toggle">Toggle</a> t</li><li class="src short"><a href="#v:-63--63-">(??)</a> :: <a href="XMonad-Layout-MultiToggle.html#t:HList">HList</a> b w => a -> b -> <a href="XMonad-Layout-MultiToggle.html#t:HCons">HCons</a> a b</li><li class="src short"><span class="keyword">data</span> <a href="#t:EOT">EOT</a> = <a href="#v:EOT">EOT</a></li><li class="src short"><a href="#v:single">single</a> :: a -> <a href="XMonad-Layout-MultiToggle.html#t:HCons">HCons</a> a <a href="XMonad-Layout-MultiToggle.html#t:EOT">EOT</a></li><li class="src short"><a href="#v:mkToggle">mkToggle</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => ts -> l a -> <a href="XMonad-Layout-MultiToggle.html#t:MultiToggle">MultiToggle</a> ts l a</li><li class="src short"><a href="#v:mkToggle1">mkToggle1</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => t -> l a -> <a href="XMonad-Layout-MultiToggle.html#t:MultiToggle">MultiToggle</a> (<a href="XMonad-Layout-MultiToggle.html#t:HCons">HCons</a> t <a href="XMonad-Layout-MultiToggle.html#t:EOT">EOT</a>) l a</li><li class="src short"><span class="keyword">class</span> <a href="#t:HList">HList</a> c a </li><li class="src short"><span class="keyword">data</span> <a href="#t:HCons">HCons</a> a b</li><li class="src short"><span class="keyword">data</span> <a href="#t:MultiToggle">MultiToggle</a> ts l a</li></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>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.
</p><p>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 <a href="XMonad-Layout-MultiToggle-Instances.html">XMonad.Layout.MultiToggle.Instances</a>.
</p><p>Somewhere else in your file you probably have a definition of <code>layout</code>;
the default looks like this:
</p><pre> layout = tiled ||| Mirror tiled ||| Full
</pre><p>After changing this to
</p><pre> layout = mkToggle (single MIRROR) (tiled ||| Full)
</pre><p>you can now dynamically apply the <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Mirror">Mirror</a></code> transformation:
</p><pre> ...
, ((modm, xK_x ), sendMessage $ Toggle MIRROR)
...
</pre><p>(That should be part of your key bindings.) When you press <code>mod-x</code>, the
active layout is mirrored. Another <code>mod-x</code> and it's back to normal.
</p><p>It's also possible to stack <code>MultiToggle</code>s. For example:
</p><pre>
layout = id
. <code><a href="XMonad-Layout-NoBorders.html#v:smartBorders">smartBorders</a></code>
. mkToggle (NOBORDERS ?? FULL ?? EOT)
. mkToggle (single MIRROR)
$ tiled ||| <code><a href="XMonad-Layout-Grid.html#t:Grid">Grid</a></code> ||| <code><a href="XMonad-Layout-Circle.html#t:Circle">Circle</a></code>
</pre><p>By binding a key to <code>(sendMessage $ Toggle FULL)</code> you can temporarily
maximize windows, in addition to being able to rotate layouts and remove
window borders.
</p><p>You can also define your own transformers by creating a data type
which is an instance of the <code><a href="XMonad-Layout-MultiToggle.html#t:Transformer">Transformer</a></code> class. For example, here
is the definition of <code>MIRROR</code>:
</p><pre> data MIRROR = MIRROR deriving (Read, Show, Eq, Typeable)
instance Transformer MIRROR Window where
transform _ x k = k (Mirror x) (\(Mirror x') -> x')
</pre><p>Note, you need to put <code>{-# LANGUAGE DeriveDataTypeable #-}</code> at the
beginning of your file.
</p></div><div class="top"><p class="src"><span class="keyword">class</span> (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> t, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> t) => <a name="t:Transformer" class="def">Transformer</a> t a | t -> a <span class="keyword">where</span><a href="src/XMonad-Layout-MultiToggle.html#Transformer" class="link">Source</a></p><div class="doc"><p>A class to identify custom transformers (and look up transforming
functions by type).
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:transform" class="def">transform</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => t -> l a -> (<span class="keyword">forall</span> l'. <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l' a => l' a -> (l' a -> l a) -> b) -> b<a href="src/XMonad-Layout-MultiToggle.html#transform" class="link">Source</a></p></div><div class="subs instances"><p id="control.i:Transformer" class="caption collapser" onclick="toggleSection('i:Transformer')">Instances</p><div id="section.i:Transformer" class="show"><table><tr><td class="src"><a href="XMonad-Layout-MultiToggle.html#t:Transformer">Transformer</a> <a href="XMonad-Layout-MultiToggle-Instances.html#t:StdTransformers">StdTransformers</a> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="XMonad-Layout-MultiToggle.html#t:Transformer">Transformer</a> <a href="XMonad-Layout-Reflect.html#t:REFLECTY">REFLECTY</a> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="XMonad-Layout-MultiToggle.html#t:Transformer">Transformer</a> <a href="XMonad-Layout-Reflect.html#t:REFLECTX">REFLECTX</a> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Toggle" class="def">Toggle</a> a <a href="src/XMonad-Layout-MultiToggle.html#Toggle" class="link">Source</a></p><div class="doc"><p>Toggle the specified layout transformer.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><span class="keyword">forall</span> t . <a href="XMonad-Layout-MultiToggle.html#t:Transformer">Transformer</a> t a => <a name="v:Toggle" class="def">Toggle</a> t</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Toggle" class="caption collapser" onclick="toggleSection('i:Toggle')">Instances</p><div id="section.i:Toggle" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Typeable-Internal.html#t:Typeable1">Typeable1</a> <a href="XMonad-Layout-MultiToggle.html#t:Toggle">Toggle</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> a => <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Message">Message</a> (<a href="XMonad-Layout-MultiToggle.html#t:Toggle">Toggle</a> a)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:-63--63-" class="def">(??)</a> :: <a href="XMonad-Layout-MultiToggle.html#t:HList">HList</a> b w => a -> b -> <a href="XMonad-Layout-MultiToggle.html#t:HCons">HCons</a> a b<a href="src/XMonad-Layout-MultiToggle.html#%3F%3F" class="link">Source</a></p><div class="doc"><p>Prepend an element to a heterogeneous list. Used to build transformer
tables for <code><a href="XMonad-Layout-MultiToggle.html#v:mkToggle">mkToggle</a></code>.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:EOT" class="def">EOT</a> <a href="src/XMonad-Layout-MultiToggle.html#EOT" class="link">Source</a></p><div class="doc"><p>Marks the end of a transformer list.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:EOT" class="def">EOT</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:EOT" class="caption collapser" onclick="toggleSection('i:EOT')">Instances</p><div id="section.i:EOT" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> <a href="XMonad-Layout-MultiToggle.html#t:EOT">EOT</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="XMonad-Layout-MultiToggle.html#t:EOT">EOT</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="XMonad-Layout-MultiToggle.html#t:HList">HList</a> <a href="XMonad-Layout-MultiToggle.html#t:EOT">EOT</a> w</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:single" class="def">single</a> :: a -> <a href="XMonad-Layout-MultiToggle.html#t:HCons">HCons</a> a <a href="XMonad-Layout-MultiToggle.html#t:EOT">EOT</a><a href="src/XMonad-Layout-MultiToggle.html#single" class="link">Source</a></p><div class="doc"><p>Construct a singleton transformer table.
</p></div></div><div class="top"><p class="src"><a name="v:mkToggle" class="def">mkToggle</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => ts -> l a -> <a href="XMonad-Layout-MultiToggle.html#t:MultiToggle">MultiToggle</a> ts l a<a href="src/XMonad-Layout-MultiToggle.html#mkToggle" class="link">Source</a></p><div class="doc"><p>Construct a <code>MultiToggle</code> layout from a transformer table and a base
layout.
</p></div></div><div class="top"><p class="src"><a name="v:mkToggle1" class="def">mkToggle1</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => t -> l a -> <a href="XMonad-Layout-MultiToggle.html#t:MultiToggle">MultiToggle</a> (<a href="XMonad-Layout-MultiToggle.html#t:HCons">HCons</a> t <a href="XMonad-Layout-MultiToggle.html#t:EOT">EOT</a>) l a<a href="src/XMonad-Layout-MultiToggle.html#mkToggle1" class="link">Source</a></p><div class="doc"><p>Construct a <code>MultiToggle</code> layout from a single transformer and a base
layout.
</p></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:HList" class="def">HList</a> c a <a href="src/XMonad-Layout-MultiToggle.html#HList" class="link">Source</a></p><div class="subs instances"><p id="control.i:HList" class="caption collapser" onclick="toggleSection('i:HList')">Instances</p><div id="section.i:HList" class="show"><table><tr><td class="src"><a href="XMonad-Layout-MultiToggle.html#t:HList">HList</a> <a href="XMonad-Layout-MultiToggle.html#t:EOT">EOT</a> w</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="XMonad-Layout-MultiToggle.html#t:Transformer">Transformer</a> a w, <a href="XMonad-Layout-MultiToggle.html#t:HList">HList</a> b w) => <a href="XMonad-Layout-MultiToggle.html#t:HList">HList</a> (<a href="XMonad-Layout-MultiToggle.html#t:HCons">HCons</a> a b) w</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:HCons" class="def">HCons</a> a b <a href="src/XMonad-Layout-MultiToggle.html#HCons" class="link">Source</a></p><div class="subs instances"><p id="control.i:HCons" class="caption collapser" onclick="toggleSection('i:HCons')">Instances</p><div id="section.i:HCons" class="show"><table><tr><td class="src">(<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> a, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> b) => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-MultiToggle.html#t:HCons">HCons</a> a b)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> a, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> b) => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-MultiToggle.html#t:HCons">HCons</a> a b)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="XMonad-Layout-MultiToggle.html#t:Transformer">Transformer</a> a w, <a href="XMonad-Layout-MultiToggle.html#t:HList">HList</a> b w) => <a href="XMonad-Layout-MultiToggle.html#t:HList">HList</a> (<a href="XMonad-Layout-MultiToggle.html#t:HCons">HCons</a> a b) w</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:MultiToggle" class="def">MultiToggle</a> ts l a <a href="src/XMonad-Layout-MultiToggle.html#MultiToggle" class="link">Source</a></p><div class="subs instances"><p id="control.i:MultiToggle" class="caption collapser" onclick="toggleSection('i:MultiToggle')">Instances</p><div id="section.i:MultiToggle" class="show"><table><tr><td class="src">(<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> a, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> ts, <a href="XMonad-Layout-MultiToggle.html#t:HList">HList</a> ts a, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a) => <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> (<a href="XMonad-Layout-MultiToggle.html#t:MultiToggle">MultiToggle</a> ts l) a</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (l a), <a href="XMonad-Layout-MultiToggle.html#t:HList">HList</a> ts a, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> ts) => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-MultiToggle.html#t:MultiToggle">MultiToggle</a> ts l a)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> ts, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (l a), <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a) => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-MultiToggle.html#t:MultiToggle">MultiToggle</a> ts l a)</td><td class="doc empty"> </td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
