<!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.BoringWindows</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-BoringWindows.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-BoringWindows.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>Adam Vogt <vogt.adam@gmail.com></td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.BoringWindows</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">Tips
</a><ul><li><a href="#g:3">variant of <code>Full</code>
</a></li></ul></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>BoringWindows is an extension to allow windows to be marked boring
</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:boringWindows">boringWindows</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/Data-Eq.html#t:Eq">Eq</a> a) => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-BoringWindows.html#t:BoringWindows">BoringWindows</a> l a</li><li class="src short"><a href="#v:boringAuto">boringAuto</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/Data-Eq.html#t:Eq">Eq</a> a) => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-BoringWindows.html#t:BoringWindows">BoringWindows</a> l a</li><li class="src short"><a href="#v:markBoring">markBoring</a>, <a href="#v:focusMaster">focusMaster</a>, <a href="#v:focusDown">focusDown</a>, <a href="#v:focusUp">focusUp</a>, <a href="#v:clearBoring">clearBoring</a> :: <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/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:UpdateBoring">UpdateBoring</a> = <a href="#v:UpdateBoring">UpdateBoring</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:BoringMessage">BoringMessage</a> <ul class="subs"><li>= <a href="#v:Replace">Replace</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> [<a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a>] </li><li>| <a href="#v:Merge">Merge</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> [<a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a>] </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:BoringWindows">BoringWindows</a> a</li></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>You can use this module with the following in your
<code>~/.xmonad/xmonad.hs</code>:
</p><pre> import XMonad.Layout.BoringWindows
</pre><p>Then edit your <code>layoutHook</code> by adding the layout modifier:
</p><pre> myLayout = boringWindows (Full ||| etc..)
main = xmonad defaultConfig { layoutHook = myLayout }
</pre><p>Then to your keybindings, add:
</p><pre> , ((modm, xK_j), focusUp)
, ((modm, xK_k), focusDown)
, ((modm, xK_m), focusMaster)
</pre><p>For more detailed instructions on editing the layoutHook see:
</p><p><a href="XMonad-Doc-Extending.html#Editing_the_layout_hook">XMonad.Doc.Extending</a>
</p></div><div class="top"><p class="src"><a name="v:boringWindows" class="def">boringWindows</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/Data-Eq.html#t:Eq">Eq</a> a) => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-BoringWindows.html#t:BoringWindows">BoringWindows</a> l a<a href="src/XMonad-Layout-BoringWindows.html#boringWindows" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:boringAuto" class="def">boringAuto</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/Data-Eq.html#t:Eq">Eq</a> a) => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-BoringWindows.html#t:BoringWindows">BoringWindows</a> l a<a href="src/XMonad-Layout-BoringWindows.html#boringAuto" class="link">Source</a></p><div class="doc"><p>Mark windows that are not given rectangles as boring
</p></div></div><div class="top"><p class="src"><a name="v:markBoring" class="def">markBoring</a>, <a name="v:focusMaster" class="def">focusMaster</a>, <a name="v:focusDown" class="def">focusDown</a>, <a name="v:focusUp" class="def">focusUp</a>, <a name="v:clearBoring" class="def">clearBoring</a> :: <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/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/XMonad-Layout-BoringWindows.html#markBoring" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:UpdateBoring" class="def">UpdateBoring</a> <a href="src/XMonad-Layout-BoringWindows.html#UpdateBoring" class="link">Source</a></p><div class="doc"><p>UpdateBoring is sent before attempting to view another boring window, so
that layouts have a chance to mark boring windows.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:UpdateBoring" class="def">UpdateBoring</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:UpdateBoring" class="caption collapser" onclick="toggleSection('i:UpdateBoring')">Instances</p><div id="section.i:UpdateBoring" 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 href="XMonad-Layout-BoringWindows.html#t:UpdateBoring">UpdateBoring</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:Message">Message</a> <a href="XMonad-Layout-BoringWindows.html#t:UpdateBoring">UpdateBoring</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:BoringMessage" class="def">BoringMessage</a> <a href="src/XMonad-Layout-BoringWindows.html#BoringMessage" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Replace" class="def">Replace</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</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 name="v:Merge" class="def">Merge</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</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 class="subs instances"><p id="control.i:BoringMessage" class="caption collapser" onclick="toggleSection('i:BoringMessage')">Instances</p><div id="section.i:BoringMessage" 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-BoringWindows.html#t:BoringMessage">BoringMessage</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-BoringWindows.html#t:BoringMessage">BoringMessage</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 href="XMonad-Layout-BoringWindows.html#t:BoringMessage">BoringMessage</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:Message">Message</a> <a href="XMonad-Layout-BoringWindows.html#t:BoringMessage">BoringMessage</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:BoringWindows" class="def">BoringWindows</a> a <a href="src/XMonad-Layout-BoringWindows.html#BoringWindows" class="link">Source</a></p><div class="subs instances"><p id="control.i:BoringWindows" class="caption collapser" onclick="toggleSection('i:BoringWindows')">Instances</p><div id="section.i:BoringWindows" 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-BoringWindows.html#t:BoringWindows">BoringWindows</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="XMonad-Layout-LayoutModifier.html#t:LayoutModifier">LayoutModifier</a> <a href="XMonad-Layout-BoringWindows.html#t:BoringWindows">BoringWindows</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="/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> (<a href="XMonad-Layout-BoringWindows.html#t:BoringWindows">BoringWindows</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 => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-BoringWindows.html#t:BoringWindows">BoringWindows</a> a)</td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:2">Tips
</h1><h2 id="g:3">variant of <code>Full</code>
</h2><div class="doc"><p>An alternative to <code>Full</code> is <a href="XMonad-Layout-Simplest.html">XMonad.Layout.Simplest</a>. Less windows are
ignored by <code><a href="XMonad-Layout-BoringWindows.html#v:focusUp">focusUp</a></code> and <code><a href="XMonad-Layout-BoringWindows.html#v:focusDown">focusDown</a></code>. This may be helpful when you want windows
to be uninteresting by some other layout modifier (ex.
<a href="XMonad-Layout-Minimize.html">XMonad.Layout.Minimize</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>
