<!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.Drawer</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-Drawer.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-Drawer.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>max.rabkin@gmail.com</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.Drawer</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Usage
</a></li><li><a href="#g:2">Drawers
</a></li><li><a href="#g:3">Placing drawers
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A layout modifier that puts some windows in a <a href="drawer.html">drawer</a> which retracts and
expands depending on whether any window in it has focus.
</p><p>Useful for music players, tool palettes, etc.
</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"><a href="#v:simpleDrawer">simpleDrawer</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-Util-WindowProperties.html#t:Property">Property</a> -> <a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Tall">Tall</a> a</li><li class="src short"><a href="#v:drawer">drawer</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-Util-WindowProperties.html#t:Property">Property</a> -> l a -> <a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l a</li><li class="src short"><a href="#v:onLeft">onLeft</a> :: <a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l a -> l' a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> (<a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l) l' a</li><li class="src short"><a href="#v:onTop">onTop</a> :: <a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l a -> l' a -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Mirror">Mirror</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> (<a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l) (<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Mirror">Mirror</a> l')) a</li><li class="src short"><a href="#v:onRight">onRight</a> :: <a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l a -> l' a -> <a href="XMonad-Layout-Drawer.html#t:Reflected">Reflected</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> (<a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l) (<a href="XMonad-Layout-Drawer.html#t:Reflected">Reflected</a> l')) a</li><li class="src short"><a href="#v:onBottom">onBottom</a> :: <a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l a -> l' a -> <a href="XMonad-Layout-Drawer.html#t:Reflected">Reflected</a> (<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Mirror">Mirror</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> (<a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l) (<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Mirror">Mirror</a> (<a href="XMonad-Layout-Drawer.html#t:Reflected">Reflected</a> l')))) a</li><li class="src short">module <a href="XMonad-Util-WindowProperties.html">XMonad.Util.WindowProperties</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:Drawer">Drawer</a> l a</li><li class="src short"><span class="keyword">type</span> <a href="#t:Reflected">Reflected</a> l = <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Reflect.html#t:Reflect">Reflect</a> l</li></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>To use this module, add the following import to <code>~/.xmonad/xmonad.hs</code>:
</p><pre> import XMonad.Layout.Drawer
</pre><pre> myLayout = drawer `onTop` (Tall 1 0.03 0.5) ||| Full ||| RandomOtherLayout...
where
drawer = simpleDrawer 0.01 0.3 (ClassName "Rhythmbox" `Or` ClassName "Xchat")
main = xmonad defaultConfig { layoutHook = myLayout }
</pre><p>This will place the Rhythmbox and Xchat windows in at the top of the screen
only when using the <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Tall">Tall</a></code> layout. See <a href="XMonad-Util-WindowProperties.html">XMonad.Util.WindowProperties</a> for
more information on selecting windows.
</p></div><h1 id="g:2">Drawers
</h1><div class="top"><p class="src"><a name="v:simpleDrawer" class="def">simpleDrawer</a><a href="src/XMonad-Layout-Drawer.html#simpleDrawer" 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>The portion of the screen taken up by the drawer when closed
</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>The portion of the screen taken up by the drawer when open
</p></td></tr><tr><td class="src">-> <a href="XMonad-Util-WindowProperties.html#t:Property">Property</a></td><td class="doc"><p>Which windows to put in the drawer
</p></td></tr><tr><td class="src">-> <a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Tall">Tall</a> a</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Construct a drawer with a simple layout of the windows inside
</p></div></div><div class="top"><p class="src"><a name="v:drawer" class="def">drawer</a><a href="src/XMonad-Layout-Drawer.html#drawer" 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>The portion of the screen taken up by the drawer when closed
</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>The portion of the screen taken up by the drawer when open
</p></td></tr><tr><td class="src">-> <a href="XMonad-Util-WindowProperties.html#t:Property">Property</a></td><td class="doc"><p>Which windows to put in the drawer
</p></td></tr><tr><td class="src">-> l a</td><td class="doc"><p>The layout of windows in the drawer
</p></td></tr><tr><td class="src">-> <a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l a</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Construct a drawer with an arbitrary layout for windows inside
</p></div></div><h1 id="g:3">Placing drawers
</h1><div class="top"><p class="src"><a name="v:onLeft" class="def">onLeft</a> :: <a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l a -> l' a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> (<a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l) l' a<a href="src/XMonad-Layout-Drawer.html#onLeft" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:onTop" class="def">onTop</a> :: <a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l a -> l' a -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Mirror">Mirror</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> (<a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l) (<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Mirror">Mirror</a> l')) a<a href="src/XMonad-Layout-Drawer.html#onTop" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:onRight" class="def">onRight</a> :: <a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l a -> l' a -> <a href="XMonad-Layout-Drawer.html#t:Reflected">Reflected</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> (<a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l) (<a href="XMonad-Layout-Drawer.html#t:Reflected">Reflected</a> l')) a<a href="src/XMonad-Layout-Drawer.html#onRight" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:onBottom" class="def">onBottom</a> :: <a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l a -> l' a -> <a href="XMonad-Layout-Drawer.html#t:Reflected">Reflected</a> (<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Mirror">Mirror</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> (<a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l) (<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Mirror">Mirror</a> (<a href="XMonad-Layout-Drawer.html#t:Reflected">Reflected</a> l')))) a<a href="src/XMonad-Layout-Drawer.html#onBottom" class="link">Source</a></p></div><div class="top"><p class="src">module <a href="XMonad-Util-WindowProperties.html">XMonad.Util.WindowProperties</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Drawer" class="def">Drawer</a> l a <a href="src/XMonad-Layout-Drawer.html#Drawer" class="link">Source</a></p><div class="subs instances"><p id="control.i:Drawer" class="caption collapser" onclick="toggleSection('i:Drawer')">Instances</p><div id="section.i:Drawer" 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> l <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a>, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (l <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a>)) => <a href="XMonad-Layout-LayoutModifier.html#t:LayoutModifier">LayoutModifier</a> (<a href="XMonad-Layout-Drawer.html#t:Drawer">Drawer</a> l) <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="/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-Drawer.html#t:Drawer">Drawer</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-Drawer.html#t:Drawer">Drawer</a> l a)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Reflected" class="def">Reflected</a> l = <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Reflect.html#t:Reflect">Reflect</a> l<a href="src/XMonad-Layout-Drawer.html#Reflected" class="link">Source</a></p></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>
