<!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.MultiColumns</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-MultiColumns.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-MultiColumns.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>Anders Engstrom <ankaan@gmail.com></td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.MultiColumns</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>This layout tiles windows in a growing number of columns. The number of
windows in each column can be controlled by messages.
</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:multiCol">multiCol</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</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-Layout-MultiColumns.html#t:MultiCol">MultiCol</a> a</li><li class="src short"><span class="keyword">data</span> <a href="#t:MultiCol">MultiCol</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.MultiColumns
</pre><p>Then edit your <code>layoutHook</code> by adding the multiCol layout:
</p><pre> myLayouts = multiCol [1] 4 0.01 0.5 ||| etc..
main = xmonad defaultConfig { layoutHook = myLayouts }
</pre><p>Or alternatively:
</p><pre> myLayouts = Mirror (multiCol [1] 2 0.01 (-0.25)) ||| etc..
main = xmonad defaultConfig { layoutHook = myLayouts }
</pre><p>The maximum number of windows in a column can be controlled using the
IncMasterN messages and the column containing the focused window will be
modified. If the value is 0, all remaining windows will be placed in that
column when all columns before that has been filled.
</p><p>The size can be set to between 1 and -0.5. If the value is positive, the
master column will be of that size. The rest of the screen is split among
the other columns. But if the size is negative, it instead indicates the
size of all non-master columns and the master column will cover the rest of
the screen. If the master column would become smaller than the other
columns, the screen is instead split equally among all columns. Therefore,
if equal size among all columns are desired, set the size to -0.5.
</p><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:multiCol" class="def">multiCol</a><a href="src/XMonad-Layout-MultiColumns.html#multiCol" 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/Data-Int.html#t:Int">Int</a>]</td><td class="doc"><p>Windows in each column, starting with master. Set to 0 to catch the rest.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>Default value for all following columns.
</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>How much to change size each time.
</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>Initial size of master area, or column area if the size is negative.
</p></td></tr><tr><td class="src">-> <a href="XMonad-Layout-MultiColumns.html#t:MultiCol">MultiCol</a> a</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Layout constructor.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:MultiCol" class="def">MultiCol</a> a <a href="src/XMonad-Layout-MultiColumns.html#MultiCol" class="link">Source</a></p><div class="subs instances"><p id="control.i:MultiCol" class="caption collapser" onclick="toggleSection('i:MultiCol')">Instances</p><div id="section.i:MultiCol" 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-MultiColumns.html#t:MultiCol">MultiCol</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/Data-Eq.html#t:Eq">Eq</a> (<a href="XMonad-Layout-MultiColumns.html#t:MultiCol">MultiCol</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-MultiColumns.html#t:MultiCol">MultiCol</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-MultiColumns.html#t:MultiCol">MultiCol</a> 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>
