<!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.Spiral</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-Spiral.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-Spiral.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>portable</td></tr><tr><th>Stability</th><td>stable</td></tr><tr><th>Maintainer</th><td>Joe Thornber <joe.thornber@gmail.com></td></tr></table><p class="caption">XMonad.Layout.Spiral</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 spiral tiling 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:spiral">spiral</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a> -> SpiralWithDir a</li><li class="src short"><a href="#v:spiralWithDir">spiralWithDir</a> :: <a href="XMonad-Layout-Spiral.html#t:Direction">Direction</a> -> <a href="XMonad-Layout-Spiral.html#t:Rotation">Rotation</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a> -> SpiralWithDir a</li><li class="src short"><span class="keyword">data</span> <a href="#t:Rotation">Rotation</a> <ul class="subs"><li>= <a href="#v:CW">CW</a> </li><li>| <a href="#v:CCW">CCW</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Direction">Direction</a> <ul class="subs"><li>= <a href="#v:East">East</a> </li><li>| <a href="#v:South">South</a> </li><li>| <a href="#v:West">West</a> </li><li>| <a href="#v:North">North</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.Spiral
</pre><p>Then edit your <code>layoutHook</code> by adding the Spiral layout:
</p><pre> myLayout = spiral (6/7) ||| 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:spiral" class="def">spiral</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a> -> SpiralWithDir a<a href="src/XMonad-Layout-Spiral.html#spiral" class="link">Source</a></p><div class="doc"><p>A spiral layout. The parameter controls the size ratio between
successive windows in the spiral. Sensible values range from 0
up to the aspect ratio of your monitor (often 4/3).
</p><p>By default, the spiral is counterclockwise, starting to the east.
See also <code><a href="XMonad-Layout-Spiral.html#v:spiralWithDir">spiralWithDir</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:spiralWithDir" class="def">spiralWithDir</a> :: <a href="XMonad-Layout-Spiral.html#t:Direction">Direction</a> -> <a href="XMonad-Layout-Spiral.html#t:Rotation">Rotation</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a> -> SpiralWithDir a<a href="src/XMonad-Layout-Spiral.html#spiralWithDir" class="link">Source</a></p><div class="doc"><p>Create a spiral layout, specifying the starting cardinal direction,
the spiral direction (clockwise or counterclockwise), and the
size ratio.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Rotation" class="def">Rotation</a> <a href="src/XMonad-Layout-Spiral.html#Rotation" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:CW" class="def">CW</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:CCW" class="def">CCW</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Rotation" class="caption collapser" onclick="toggleSection('i:Rotation')">Instances</p><div id="section.i:Rotation" 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-Spiral.html#t:Rotation">Rotation</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-Spiral.html#t:Rotation">Rotation</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:Direction" class="def">Direction</a> <a href="src/XMonad-Layout-Spiral.html#Direction" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:East" class="def">East</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:South" class="def">South</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:West" class="def">West</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:North" class="def">North</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Direction" class="caption collapser" onclick="toggleSection('i:Direction')">Instances</p><div id="section.i:Direction" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Enum">Enum</a> <a href="XMonad-Layout-Spiral.html#t:Direction">Direction</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/Data-Eq.html#t:Eq">Eq</a> <a href="XMonad-Layout-Spiral.html#t:Direction">Direction</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-Spiral.html#t:Direction">Direction</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-Spiral.html#t:Direction">Direction</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>
