<!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.SimpleFloat</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-SimpleFloat.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-SimpleFloat.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>andrea.rossato@unibz.it</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.SimpleFloat</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 basic floating layout.
</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:simpleFloat">simpleFloat</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> 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-SimpleFloat.html#t:SimpleDecoration">SimpleDecoration</a> <a href="XMonad-Layout-Decoration.html#t:DefaultShrinker">DefaultShrinker</a>) (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Actions-MouseResize.html#t:MouseResize">MouseResize</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-WindowArranger.html#t:WindowArranger">WindowArranger</a> <a href="XMonad-Layout-SimpleFloat.html#t:SimpleFloat">SimpleFloat</a>)) a</li><li class="src short"><a href="#v:simpleFloat-39-">simpleFloat'</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="XMonad-Layout-SimpleFloat.html#t:Shrinker">Shrinker</a> s) => s -> <a href="XMonad-Layout-Decoration.html#t:Theme">Theme</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-SimpleFloat.html#t:SimpleDecoration">SimpleDecoration</a> s) (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Actions-MouseResize.html#t:MouseResize">MouseResize</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-WindowArranger.html#t:WindowArranger">WindowArranger</a> <a href="XMonad-Layout-SimpleFloat.html#t:SimpleFloat">SimpleFloat</a>)) 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.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:SimpleFloat">SimpleFloat</a> a = <a href="#v:SF">SF</a> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Dimension">Dimension</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.5.0.0/Text-Read.html#t:Read">Read</a> s, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.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.5.0.0/Data-String.html#t:String">String</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.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.SimpleFloat
</pre><p>Then edit your <code>layoutHook</code> by adding the SimpleFloat layout:
</p><pre> myLayout = simpleFloat ||| Full ||| etc..
main = xmonad defaultConfig { layoutHook = myLayout }
</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:simpleFloat" class="def">simpleFloat</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> 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-SimpleFloat.html#t:SimpleDecoration">SimpleDecoration</a> <a href="XMonad-Layout-Decoration.html#t:DefaultShrinker">DefaultShrinker</a>) (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Actions-MouseResize.html#t:MouseResize">MouseResize</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-WindowArranger.html#t:WindowArranger">WindowArranger</a> <a href="XMonad-Layout-SimpleFloat.html#t:SimpleFloat">SimpleFloat</a>)) a<a href="src/XMonad-Layout-SimpleFloat.html#simpleFloat" class="link">Source</a></p><div class="doc"><p>A simple floating layout where every window is placed according
to the window's initial attributes.
</p><p>This version is decorated with the <code><a href="XMonad-Layout-SimpleFloat.html#t:SimpleDecoration">SimpleDecoration</a></code> style.
</p></div></div><div class="top"><p class="src"><a name="v:simpleFloat-39-" class="def">simpleFloat'</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="XMonad-Layout-SimpleFloat.html#t:Shrinker">Shrinker</a> s) => s -> <a href="XMonad-Layout-Decoration.html#t:Theme">Theme</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-SimpleFloat.html#t:SimpleDecoration">SimpleDecoration</a> s) (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Actions-MouseResize.html#t:MouseResize">MouseResize</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-WindowArranger.html#t:WindowArranger">WindowArranger</a> <a href="XMonad-Layout-SimpleFloat.html#t:SimpleFloat">SimpleFloat</a>)) a<a href="src/XMonad-Layout-SimpleFloat.html#simpleFloat%27" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="XMonad-Layout-SimpleFloat.html#v:simpleFloat">simpleFloat</a></code>, but with the possibility of setting a
custom shrinker and a custom theme.
</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.5.0.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.5.0.0/Data-Eq.html#t:Eq">Eq</a> a => <a href="XMonad-Layout-Decoration.html#t:DecorationStyle">DecorationStyle</a> <a href="XMonad-Layout-SimpleFloat.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.5.0.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-SimpleFloat.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.5.0.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-SimpleFloat.html#t:SimpleDecoration">SimpleDecoration</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:SimpleFloat" class="def">SimpleFloat</a> a <a href="src/XMonad-Layout-SimpleFloat.html#SimpleFloat" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:SF" class="def">SF</a> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Dimension">Dimension</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:SimpleFloat" class="caption collapser" onclick="toggleSection('i:SimpleFloat')">Instances</p><div id="section.i:SimpleFloat" 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> <a href="XMonad-Layout-SimpleFloat.html#t:SimpleFloat">SimpleFloat</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 href="XMonad-Layout-SimpleFloat.html#t:SimpleFloat">SimpleFloat</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-SimpleFloat.html#t:SimpleFloat">SimpleFloat</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.5.0.0/Text-Read.html#t:Read">Read</a> <a href="XMonad-Layout-SimpleFloat.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.5.0.0/Text-Show.html#t:Show">Show</a> <a href="XMonad-Layout-SimpleFloat.html#t:CustomShrink">CustomShrink</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="XMonad-Layout-SimpleFloat.html#t:Shrinker">Shrinker</a> <a href="XMonad-Layout-SimpleFloat.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.5.0.0/Text-Read.html#t:Read">Read</a> s, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.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.5.0.0/Data-String.html#t:String">String</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.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-SimpleFloat.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-SimpleFloat.html#t:Shrinker">Shrinker</a> <a href="XMonad-Layout-SimpleFloat.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.10.0</p></div></body></html>
