<!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</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.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout.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-0.11: A tiling window manager</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>not portable, Typeable deriving, mtl, posix</td></tr><tr><th>Stability</th><td>unstable</td></tr><tr><th>Maintainer</th><td>spencerjanssen@gmail.com</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The collection of core layouts.
</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">data</span> <a href="#t:Full">Full</a> a = <a href="#v:Full">Full</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:Tall">Tall</a> a = <a href="#v:Tall">Tall</a> {<ul class="subs"><li><a href="#v:tallNMaster">tallNMaster</a> :: !<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:tallRatioIncrement">tallRatioIncrement</a> :: !<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a></li><li><a href="#v:tallRatio">tallRatio</a> :: !<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a></li></ul>}</li><li class="src short"><span class="keyword">newtype</span> <a href="#t:Mirror">Mirror</a> l a = <a href="#v:Mirror">Mirror</a> (l a)</li><li class="src short"><span class="keyword">data</span> <a href="#t:Resize">Resize</a> <ul class="subs"><li>= <a href="#v:Shrink">Shrink</a> </li><li>| <a href="#v:Expand">Expand</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:IncMasterN">IncMasterN</a> = <a href="#v:IncMasterN">IncMasterN</a> !<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:Choose">Choose</a> l r a</li><li class="src short"><a href="#v:-124--124--124-">(|||)</a> :: (<a href="XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a, <a href="XMonad-Core.html#t:LayoutClass">LayoutClass</a> r a) => l a -> r a -> <a href="XMonad-Layout.html#t:Choose">Choose</a> l r a</li><li class="src short"><span class="keyword">data</span> <a href="#t:ChangeLayout">ChangeLayout</a> <ul class="subs"><li>= <a href="#v:FirstLayout">FirstLayout</a> </li><li>| <a href="#v:NextLayout">NextLayout</a> </li></ul></li><li class="src short"><a href="#v:mirrorRect">mirrorRect</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a> -> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a></li><li class="src short"><a href="#v:splitVertically">splitVertically</a>, <a href="#v:splitHorizontally">splitHorizontally</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a> -> [<a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a>]</li><li class="src short"><a href="#v:splitHorizontallyBy">splitHorizontallyBy</a>, <a href="#v:splitVerticallyBy">splitVerticallyBy</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:RealFrac">RealFrac</a> r => r -> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a> -> (<a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a>, <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a>)</li><li class="src short"><a href="#v:tile">tile</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a> -> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> -> [<a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a>]</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Full" class="def">Full</a> a <a href="src/XMonad-Layout.html#Full" class="link">Source</a></p><div class="doc"><p>Simple fullscreen mode. Renders the focused window fullscreen.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Full" class="def">Full</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Full" class="caption collapser" onclick="toggleSection('i:Full')">Instances</p><div id="section.i:Full" class="show"><table><tr><td class="src"><a href="XMonad-Core.html#t:LayoutClass">LayoutClass</a> <a href="XMonad-Layout.html#t:Full">Full</a> 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-Read.html#t:Read">Read</a> (<a href="XMonad-Layout.html#t:Full">Full</a> 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.html#t:Full">Full</a> 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:Tall" class="def">Tall</a> a <a href="src/XMonad-Layout.html#Tall" class="link">Source</a></p><div class="doc"><p>The builtin tiling mode of xmonad. Supports <code><a href="XMonad-Layout.html#v:Shrink">Shrink</a></code>, <code><a href="XMonad-Layout.html#v:Expand">Expand</a></code> and
<code><a href="XMonad-Layout.html#t:IncMasterN">IncMasterN</a></code>.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Tall" class="def">Tall</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:tallNMaster" class="def">tallNMaster</a> :: !<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></dt><dd class="doc"><p>The default number of windows in the master pane (default: 1)
</p></dd><dt class="src"><a name="v:tallRatioIncrement" class="def">tallRatioIncrement</a> :: !<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a></dt><dd class="doc"><p>Percent of screen to increment by when resizing panes (default: 3/100)
</p></dd><dt class="src"><a name="v:tallRatio" class="def">tallRatio</a> :: !<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a></dt><dd class="doc"><p>Default proportion of screen occupied by master pane (default: 1/2)
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:Tall" class="caption collapser" onclick="toggleSection('i:Tall')">Instances</p><div id="section.i:Tall" class="show"><table><tr><td class="src"><a href="XMonad-Core.html#t:LayoutClass">LayoutClass</a> <a href="XMonad-Layout.html#t:Tall">Tall</a> 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-Read.html#t:Read">Read</a> (<a href="XMonad-Layout.html#t:Tall">Tall</a> 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.html#t:Tall">Tall</a> a)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:Mirror" class="def">Mirror</a> l a <a href="src/XMonad-Layout.html#Mirror" class="link">Source</a></p><div class="doc"><p>Mirror a layout, compute its 90 degree rotated form.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Mirror" class="def">Mirror</a> (l a)</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Mirror" class="caption collapser" onclick="toggleSection('i:Mirror')">Instances</p><div id="section.i:Mirror" class="show"><table><tr><td class="src"><a href="XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => <a href="XMonad-Core.html#t:LayoutClass">LayoutClass</a> (<a href="XMonad-Layout.html#t:Mirror">Mirror</a> 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-Read.html#t:Read">Read</a> (l a) => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout.html#t:Mirror">Mirror</a> 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> (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.html#t:Mirror">Mirror</a> l 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:Resize" class="def">Resize</a> <a href="src/XMonad-Layout.html#Resize" class="link">Source</a></p><div class="doc"><p>Change the size of the master pane.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Shrink" class="def">Shrink</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Expand" class="def">Expand</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Resize" class="caption collapser" onclick="toggleSection('i:Resize')">Instances</p><div id="section.i:Resize" class="show"><table><tr><td class="src"><a href="XMonad-Core.html#t:Typeable">Typeable</a> <a href="XMonad-Layout.html#t:Resize">Resize</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="XMonad-Core.html#t:Message">Message</a> <a href="XMonad-Layout.html#t:Resize">Resize</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:IncMasterN" class="def">IncMasterN</a> <a href="src/XMonad-Layout.html#IncMasterN" class="link">Source</a></p><div class="doc"><p>Increase the number of clients in the master pane.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:IncMasterN" class="def">IncMasterN</a> !<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:IncMasterN" class="caption collapser" onclick="toggleSection('i:IncMasterN')">Instances</p><div id="section.i:IncMasterN" class="show"><table><tr><td class="src"><a href="XMonad-Core.html#t:Typeable">Typeable</a> <a href="XMonad-Layout.html#t:IncMasterN">IncMasterN</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="XMonad-Core.html#t:Message">Message</a> <a href="XMonad-Layout.html#t:IncMasterN">IncMasterN</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:Choose" class="def">Choose</a> l r a <a href="src/XMonad-Layout.html#Choose" class="link">Source</a></p><div class="doc"><p>A layout that allows users to switch between various layout options.
</p></div><div class="subs instances"><p id="control.i:Choose" class="caption collapser" onclick="toggleSection('i:Choose')">Instances</p><div id="section.i:Choose" class="show"><table><tr><td class="src">(<a href="XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a, <a href="XMonad-Core.html#t:LayoutClass">LayoutClass</a> r a) => <a href="XMonad-Core.html#t:LayoutClass">LayoutClass</a> (<a href="XMonad-Layout.html#t:Choose">Choose</a> l r) 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-Read.html#t:Read">Read</a> (l a), <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (r a)) => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout.html#t:Choose">Choose</a> l r 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> (l a), <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (r 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.html#t:Choose">Choose</a> l r a)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:-124--124--124-" class="def">(|||)</a> :: (<a href="XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a, <a href="XMonad-Core.html#t:LayoutClass">LayoutClass</a> r a) => l a -> r a -> <a href="XMonad-Layout.html#t:Choose">Choose</a> l r a<a href="src/XMonad-Layout.html#%7C%7C%7C" class="link">Source</a></p><div class="doc"><p>The layout choice combinator
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ChangeLayout" class="def">ChangeLayout</a> <a href="src/XMonad-Layout.html#ChangeLayout" class="link">Source</a></p><div class="doc"><p>Messages to change the current layout.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:FirstLayout" class="def">FirstLayout</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:NextLayout" class="def">NextLayout</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:ChangeLayout" class="caption collapser" onclick="toggleSection('i:ChangeLayout')">Instances</p><div id="section.i:ChangeLayout" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="XMonad-Layout.html#t:ChangeLayout">ChangeLayout</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.html#t:ChangeLayout">ChangeLayout</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="XMonad-Core.html#t:Typeable">Typeable</a> <a href="XMonad-Layout.html#t:ChangeLayout">ChangeLayout</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="XMonad-Core.html#t:Message">Message</a> <a href="XMonad-Layout.html#t:ChangeLayout">ChangeLayout</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:mirrorRect" class="def">mirrorRect</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a> -> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a><a href="src/XMonad-Layout.html#mirrorRect" class="link">Source</a></p><div class="doc"><p>Mirror a rectangle.
</p></div></div><div class="top"><p class="src"><a name="v:splitVertically" class="def">splitVertically</a>, <a name="v:splitHorizontally" class="def">splitHorizontally</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a> -> [<a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a>]<a href="src/XMonad-Layout.html#splitVertically" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:splitHorizontallyBy" class="def">splitHorizontallyBy</a>, <a name="v:splitVerticallyBy" class="def">splitVerticallyBy</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:RealFrac">RealFrac</a> r => r -> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a> -> (<a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a>, <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a>)<a href="src/XMonad-Layout.html#splitHorizontallyBy" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:tile" class="def">tile</a><a href="src/XMonad-Layout.html#tile" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a></td><td class="doc"><p><code>frac</code>, what proportion of the screen to devote to the master area
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a></td><td class="doc"><p><code>r</code>, the rectangle representing the screen
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p><code>nmaster</code>, the number of windows in the master pane
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p><code>n</code>, the total number of windows to tile
</p></td></tr><tr><td class="src">-> [<a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Rectangle">Rectangle</a>]</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Compute the positions for windows using the default two-pane tiling
algorithm.
</p><p>The screen is divided into two panes. All clients are
then partioned between these two panes. One pane, the master, by
convention has the least number of windows in it.
</p></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>
