<!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.SimpleDecoration</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-SimpleDecoration.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-SimpleDecoration.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.9.2: 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>andrea.rossato@unibz.it</td></tr></table><p class="caption">XMonad.Layout.SimpleDecoration</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>A layout modifier for adding simple decorations to the windows of a
given layout. The decorations are in the form of ion-like tabs
for window titles.
</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:simpleDeco">simpleDeco</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="XMonad-Layout-SimpleDecoration.html#t:Shrinker">Shrinker</a> s) => s -> <a href="XMonad-Layout-SimpleDecoration.html#t:Theme">Theme</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> (<a href="XMonad-Layout-Decoration.html#t:Decoration">Decoration</a> <a href="XMonad-Layout-SimpleDecoration.html#t:SimpleDecoration">SimpleDecoration</a> s) l a</li><li class="src short"><span class="keyword">data</span> <a href="#t:Theme">Theme</a> = <a href="#v:Theme">Theme</a> {<ul class="subs"><li><a href="#v:activeColor">activeColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:inactiveColor">inactiveColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:urgentColor">urgentColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:activeBorderColor">activeBorderColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:inactiveBorderColor">inactiveBorderColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:urgentBorderColor">urgentBorderColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:activeTextColor">activeTextColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:inactiveTextColor">inactiveTextColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:urgentTextColor">urgentTextColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:fontName">fontName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:decoWidth">decoWidth</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Xlib.html#t:Dimension">Dimension</a></li><li><a href="#v:decoHeight">decoHeight</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Xlib.html#t:Dimension">Dimension</a></li></ul>}</li><li class="src short"><a href="#v:defaultTheme">defaultTheme</a> :: <a href="XMonad-Layout-SimpleDecoration.html#t:Theme">Theme</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:SimpleDecoration">SimpleDecoration</a> a = <a href="#v:Simple">Simple</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:shrinkText">shrinkText</a> :: <a href="XMonad-Layout-Decoration.html#t:DefaultShrinker">DefaultShrinker</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:CustomShrink">CustomShrink</a> = <a href="#v:CustomShrink">CustomShrink</a></li><li class="src short"><span class="keyword">class</span> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> s, <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> s) => <a href="#t:Shrinker">Shrinker</a> s <span class="keyword">where</span><ul class="subs"><li><a href="#v:shrinkIt">shrinkIt</a> :: s -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</li></ul></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.SimpleDecoration
</pre><p>Then edit your <code>layoutHook</code> by adding the SimpleDecoration decoration to
your layout:
</p><pre> myL = simpleDeco shrinkText defaultTheme (layoutHook defaultConfig)
main = xmonad defaultConfig { layoutHook = myL }
</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><p>You can also edit the default configuration options.
</p><pre> mySDConfig = defaultTheme { inactiveBorderColor = "red"
, inactiveTextColor = "red"}
</pre><p>and
</p><pre> myL = dwmStyle shrinkText mySDConfig (layoutHook defaultTheme)
</pre></div><div class="top"><p class="src"><a name="v:simpleDeco" class="def">simpleDeco</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="XMonad-Layout-SimpleDecoration.html#t:Shrinker">Shrinker</a> s) => s -> <a href="XMonad-Layout-SimpleDecoration.html#t:Theme">Theme</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> (<a href="XMonad-Layout-Decoration.html#t:Decoration">Decoration</a> <a href="XMonad-Layout-SimpleDecoration.html#t:SimpleDecoration">SimpleDecoration</a> s) l a<a href="src/XMonad-Layout-SimpleDecoration.html#simpleDeco" class="link">Source</a></p><div class="doc"><p>Add simple decorations to windows of a layout.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Theme" class="def">Theme</a> <a href="src/XMonad-Layout-Decoration.html#Theme" class="link">Source</a></p><div class="doc"><p>A <code><a href="XMonad-Layout-SimpleDecoration.html#t:Theme">Theme</a></code> is a record of colors, font etc., to customize a
<code><a href="XMonad-Layout-Decoration.html#t:DecorationStyle">DecorationStyle</a></code>.
</p><p>For a collection of <code><a href="XMonad-Layout-SimpleDecoration.html#t:Theme">Theme</a></code>s see <a href="XMonad-Util-Themes.html">XMonad.Util.Themes</a>
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Theme" class="def">Theme</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:activeColor" class="def">activeColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>Color of the active window
</p></dd><dt class="src"><a name="v:inactiveColor" class="def">inactiveColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>Color of the inactive window
</p></dd><dt class="src"><a name="v:urgentColor" class="def">urgentColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>Color of the urgent window
</p></dd><dt class="src"><a name="v:activeBorderColor" class="def">activeBorderColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>Color of the border of the active window
</p></dd><dt class="src"><a name="v:inactiveBorderColor" class="def">inactiveBorderColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>Color of the border of the inactive window
</p></dd><dt class="src"><a name="v:urgentBorderColor" class="def">urgentBorderColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>Color of the border of the urgent window
</p></dd><dt class="src"><a name="v:activeTextColor" class="def">activeTextColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>Color of the text of the active window
</p></dd><dt class="src"><a name="v:inactiveTextColor" class="def">inactiveTextColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>Color of the text of the inactive window
</p></dd><dt class="src"><a name="v:urgentTextColor" class="def">urgentTextColor</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>Color of the text of the urgent window
</p></dd><dt class="src"><a name="v:fontName" class="def">fontName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>Font name
</p></dd><dt class="src"><a name="v:decoWidth" class="def">decoWidth</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Xlib.html#t:Dimension">Dimension</a></dt><dd class="doc"><p>Maximum width of the decorations (if supported by the <code><a href="XMonad-Layout-Decoration.html#t:DecorationStyle">DecorationStyle</a></code>)
</p></dd><dt class="src"><a name="v:decoHeight" class="def">decoHeight</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Xlib.html#t:Dimension">Dimension</a></dt><dd class="doc"><p>Height of the decorations
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:Theme" class="caption collapser" onclick="toggleSection('i:Theme')">Instances</p><div id="section.i:Theme" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> <a href="XMonad-Layout-SimpleDecoration.html#t:Theme">Theme</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="XMonad-Layout-SimpleDecoration.html#t:Theme">Theme</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:defaultTheme" class="def">defaultTheme</a> :: <a href="XMonad-Layout-SimpleDecoration.html#t:Theme">Theme</a><a href="src/XMonad-Layout-Decoration.html#defaultTheme" class="link">Source</a></p><div class="doc"><p>The default xmonad <code><a href="XMonad-Layout-SimpleDecoration.html#t:Theme">Theme</a></code>.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:SimpleDecoration" class="def">SimpleDecoration</a> a <a href="src/XMonad-Layout-SimpleDecoration.html#SimpleDecoration" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Simple" class="def">Simple</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:SimpleDecoration" class="caption collapser" onclick="toggleSection('i:SimpleDecoration')">Instances</p><div id="section.i:SimpleDecoration" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> a => <a href="XMonad-Layout-Decoration.html#t:DecorationStyle">DecorationStyle</a> <a href="XMonad-Layout-SimpleDecoration.html#t:SimpleDecoration">SimpleDecoration</a> a</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-SimpleDecoration.html#t:SimpleDecoration">SimpleDecoration</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-SimpleDecoration.html#t:SimpleDecoration">SimpleDecoration</a> a)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:shrinkText" class="def">shrinkText</a> :: <a href="XMonad-Layout-Decoration.html#t:DefaultShrinker">DefaultShrinker</a><a href="src/XMonad-Layout-Decoration.html#shrinkText" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CustomShrink" class="def">CustomShrink</a> <a href="src/XMonad-Layout-Decoration.html#CustomShrink" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:CustomShrink" class="def">CustomShrink</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:CustomShrink" class="caption collapser" onclick="toggleSection('i:CustomShrink')">Instances</p><div id="section.i:CustomShrink" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> <a href="XMonad-Layout-SimpleDecoration.html#t:CustomShrink">CustomShrink</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="XMonad-Layout-SimpleDecoration.html#t:CustomShrink">CustomShrink</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="XMonad-Layout-SimpleDecoration.html#t:Shrinker">Shrinker</a> <a href="XMonad-Layout-SimpleDecoration.html#t:CustomShrink">CustomShrink</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> s, <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> s) => <a name="t:Shrinker" class="def">Shrinker</a> s <span class="keyword">where</span><a href="src/XMonad-Layout-Decoration.html#Shrinker" class="link">Source</a></p><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:shrinkIt" class="def">shrinkIt</a> :: s -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]<a href="src/XMonad-Layout-Decoration.html#shrinkIt" class="link">Source</a></p></div><div class="subs instances"><p id="control.i:Shrinker" class="caption collapser" onclick="toggleSection('i:Shrinker')">Instances</p><div id="section.i:Shrinker" class="show"><table><tr><td class="src"><a href="XMonad-Layout-SimpleDecoration.html#t:Shrinker">Shrinker</a> <a href="XMonad-Layout-Decoration.html#t:DefaultShrinker">DefaultShrinker</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="XMonad-Layout-SimpleDecoration.html#t:Shrinker">Shrinker</a> <a href="XMonad-Layout-SimpleDecoration.html#t:CustomShrink">CustomShrink</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.9.2</p></div></body></html>
