<!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.LayoutBuilderP</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-LayoutBuilderP.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-LayoutBuilderP.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>Ilya Portnov <portnov84@rambler.ru></td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.LayoutBuilderP</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Overloading ways to select windows
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A layout combinator that sends windows matching given predicate to one rectangle
and the rest to another.
</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:LayoutP">LayoutP</a> p l1 l2 a = <a href="#v:LayoutP">LayoutP</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a) (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a) p <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a>) (l1 a) (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> (l2 a))</li><li class="src short"><a href="#v:layoutP">layoutP</a> :: (<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/Data-Eq.html#t:Eq">Eq</a> a, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l1 a, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l2 a, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l3 a, <a href="XMonad-Layout-LayoutBuilderP.html#t:Predicate">Predicate</a> p a) => p -> <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a> -> l1 a -> <a href="XMonad-Layout-LayoutBuilderP.html#t:LayoutP">LayoutP</a> p l2 l3 a -> <a href="XMonad-Layout-LayoutBuilderP.html#t:LayoutP">LayoutP</a> p l1 (<a href="XMonad-Layout-LayoutBuilderP.html#t:LayoutP">LayoutP</a> p l2 l3) a</li><li class="src short"><a href="#v:layoutAll">layoutAll</a> :: <span class="keyword">forall</span> l1 p a. (<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/Data-Eq.html#t:Eq">Eq</a> a, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l1 a, <a href="XMonad-Layout-LayoutBuilderP.html#t:Predicate">Predicate</a> p a) => <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a> -> l1 a -> <a href="XMonad-Layout-LayoutBuilderP.html#t:LayoutP">LayoutP</a> p l1 <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Full">Full</a> a</li><li class="src short"><a href="#v:relBox">relBox</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/base-4.5.0.0/Prelude.html#t:Rational">Rational</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/base-4.5.0.0/Prelude.html#t:Rational">Rational</a> -> <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a></li><li class="src short"><a href="#v:absBox">absBox</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/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="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a></li><li class="src short"><span class="keyword">class</span> <a href="#t:Predicate">Predicate</a> p w <span class="keyword">where</span><ul class="subs"><li><a href="#v:alwaysTrue">alwaysTrue</a> :: <a href="XMonad-Layout-LayoutBuilderP.html#t:Proxy">Proxy</a> w -> p</li><li><a href="#v:checkPredicate">checkPredicate</a> :: p -> w -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Proxy">Proxy</a> a = <a href="#v:Proxy">Proxy</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:LayoutP" class="def">LayoutP</a> p l1 l2 a <a href="src/XMonad-Layout-LayoutBuilderP.html#LayoutP" class="link">Source</a></p><div class="doc"><p>Data type for our layout.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:LayoutP" class="def">LayoutP</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a) (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a) p <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a>) (l1 a) (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> (l2 a))</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:LayoutP" class="caption collapser" onclick="toggleSection('i:LayoutP')">Instances</p><div id="section.i:LayoutP" class="show"><table><tr><td class="src">(<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l1 w, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l2 w, <a href="XMonad-Layout-LayoutBuilderP.html#t:Predicate">Predicate</a> p w, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> w, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> w, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> w, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> w, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> p) => <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> (<a href="XMonad-Layout-LayoutBuilderP.html#t:LayoutP">LayoutP</a> p l1 l2) w</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> p, <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> (l1 a), <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (l2 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-LayoutBuilderP.html#t:LayoutP">LayoutP</a> p l1 l2 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> p, <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> (l1 a), <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (l2 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-LayoutBuilderP.html#t:LayoutP">LayoutP</a> p l1 l2 a)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:layoutP" class="def">layoutP</a><a href="src/XMonad-Layout-LayoutBuilderP.html#layoutP" 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/Text-Read.html#t:Read">Read</a> a, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l1 a, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l2 a, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l3 a, <a href="XMonad-Layout-LayoutBuilderP.html#t:Predicate">Predicate</a> p a)</td><td class="doc empty"> </td></tr><tr><td class="src">=> p</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a></td><td class="doc"><p>The box to place the windows in
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a></td><td class="doc"><p>Possibly an alternative box that is used when this layout handles all windows that are left
</p></td></tr><tr><td class="src">-> l1 a</td><td class="doc"><p>The layout to use in the specified area
</p></td></tr><tr><td class="src">-> <a href="XMonad-Layout-LayoutBuilderP.html#t:LayoutP">LayoutP</a> p l2 l3 a</td><td class="doc"><p>Where to send the remaining windows
</p></td></tr><tr><td class="src">-> <a href="XMonad-Layout-LayoutBuilderP.html#t:LayoutP">LayoutP</a> p l1 (<a href="XMonad-Layout-LayoutBuilderP.html#t:LayoutP">LayoutP</a> p l2 l3) a</td><td class="doc"><p>The resulting layout
</p></td></tr></table></div><div class="doc"><p>Use the specified layout in the described area windows that match given predicate and send the rest of the windows to the next layout in the chain.
It is possible to supply an alternative area that will then be used instead, if there are no windows to send to the next layout.
</p></div></div><div class="top"><p class="src"><a name="v:layoutAll" class="def">layoutAll</a><a href="src/XMonad-Layout-LayoutBuilderP.html#layoutAll" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <span class="keyword">forall</span> l1 p a . (<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/Data-Eq.html#t:Eq">Eq</a> a, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l1 a, <a href="XMonad-Layout-LayoutBuilderP.html#t:Predicate">Predicate</a> p a)</td><td class="doc empty"> </td></tr><tr><td class="src">=> <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a></td><td class="doc"><p>The box to place the windows in
</p></td></tr><tr><td class="src">-> l1 a</td><td class="doc"><p>The layout to use in the specified area
</p></td></tr><tr><td class="src">-> <a href="XMonad-Layout-LayoutBuilderP.html#t:LayoutP">LayoutP</a> p l1 <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Full">Full</a> a</td><td class="doc"><p>The resulting layout
</p></td></tr></table></div><div class="doc"><p>Use the specified layout in the described area for all remaining windows.
</p></div></div><div class="top"><p class="src"><a name="v:relBox" class="def">relBox</a><a href="src/XMonad-Layout-LayoutBuilder.html#relBox" 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>Relative X-Position with respect to the surrounding area
</p></td></tr><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>Relative Y-Position with respect to the surrounding area
</p></td></tr><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>Relative width with respect to the remaining width
</p></td></tr><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>Relative height with respect to the remaining height
</p></td></tr><tr><td class="src">-> <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a></td><td class="doc"><p>The resulting <code><a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a></code> describing the area
</p></td></tr></table></div><div class="doc"><p>Create a box with only relative measurements.
</p></div></div><div class="top"><p class="src"><a name="v:absBox" class="def">absBox</a><a href="src/XMonad-Layout-LayoutBuilder.html#absBox" 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/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>Absolute X-Position
</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>Absolute Y-Position
</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>Absolute width
</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>Absolute height
</p></td></tr><tr><td class="src">-> <a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a></td><td class="doc"><p>The resulting <code><a href="XMonad-Layout-LayoutBuilder.html#t:SubBox">SubBox</a></code> describing the area
</p></td></tr></table></div><div class="doc"><p>Create a box with only absolute measurements. If the values are negative, the total remaining space will be added. For
sizes it will also be added for zeroes.
</p></div></div><h1 id="g:1">Overloading ways to select windows
</h1><div class="doc"><p><code><a href="XMonad-Layout-LayoutBuilderP.html#t:Predicate">Predicate</a></code> exists because layouts are required to be serializable, and
<a href="XMonad-Util-WindowProperties.html">XMonad.Util.WindowProperties</a> is not sufficient (for example it does not
allow using regular expressions).
</p><p>compare <a href="XMonad-Util-Invisible.html">XMonad.Util.Invisible</a>
</p></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:Predicate" class="def">Predicate</a> p w <span class="keyword">where</span><a href="src/XMonad-Layout-LayoutBuilderP.html#Predicate" class="link">Source</a></p><div class="doc"><p>Type class for predicates. This enables us to manage not only Windows,
but any objects, for which instance Predicate is defined.
</p><p>Another instance exists in XMonad.Util.WindowPropertiesRE in xmonad-extras
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:alwaysTrue" class="def">alwaysTrue</a><a href="src/XMonad-Layout-LayoutBuilderP.html#alwaysTrue" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="XMonad-Layout-LayoutBuilderP.html#t:Proxy">Proxy</a> w</td><td class="doc empty"> </td></tr><tr><td class="src">-> p</td><td class="doc"><p>A predicate that is always True.
</p></td></tr></table></div><p class="src"><a name="v:checkPredicate" class="def">checkPredicate</a><a href="src/XMonad-Layout-LayoutBuilderP.html#checkPredicate" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: p</td><td class="doc empty"> </td></tr><tr><td class="src">-> w</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:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>Check if given object (window or smth else) matches that predicate
</p></td></tr></table></div></div><div class="subs instances"><p id="control.i:Predicate" class="caption collapser" onclick="toggleSection('i:Predicate')">Instances</p><div id="section.i:Predicate" class="show"><table><tr><td class="src"><a href="XMonad-Layout-LayoutBuilderP.html#t:Predicate">Predicate</a> <a href="XMonad-Util-WindowProperties.html#t:Property">Property</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:Proxy" class="def">Proxy</a> a <a href="src/XMonad-Layout-LayoutBuilderP.html#Proxy" class="link">Source</a></p><div class="doc"><p>Contains no actual data, but is needed to help select the correct instance
of <code><a href="XMonad-Layout-LayoutBuilderP.html#t:Predicate">Predicate</a></code>
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Proxy" class="def">Proxy</a></td><td class="doc empty"> </td></tr></table></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>
