<!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.Groups.Wmii</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-Groups-Wmii.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-Groups-Wmii.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>stable</td></tr><tr><th>Maintainer</th><td>orphaned</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.Groups.Wmii</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">Useful re-exports
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A wmii-like layout algorithm.
</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:wmii">wmii</a> :: <a href="XMonad-Layout-Decoration.html#t:Shrinker">Shrinker</a> s => s -> <a href="XMonad-Layout-Decoration.html#t:Theme">Theme</a> -> <a href="XMonad-Layout-Groups.html#t:Groups">Groups</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Renamed.html#t:Rename">Rename</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-Tabbed.html#t:TabbedDecoration">TabbedDecoration</a> s) (<a href="XMonad-Layout-MessageControl.html#t:Ignore">Ignore</a> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:ChangeLayout">ChangeLayout</a> (<a href="XMonad-Layout-MessageControl.html#t:Ignore">Ignore</a> <a href="XMonad-Layout-LayoutCombinators.html#t:JumpToLayout">JumpToLayout</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-MessageControl.html#t:UnEscape">UnEscape</a> (<a href="XMonad-Layout-LayoutCombinators.html#t:NewSelect">NewSelect</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Renamed.html#t:Rename">Rename</a> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Tall">Tall</a>) (<a href="XMonad-Layout-LayoutCombinators.html#t:NewSelect">NewSelect</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Renamed.html#t:Rename">Rename</a> <a href="XMonad-Layout-Simplest.html#t:Simplest">Simplest</a>) <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Full">Full</a>))))))) (<a href="XMonad-Layout-ZoomRow.html#t:ZoomRow">ZoomRow</a> <a href="XMonad-Layout-Groups-Examples.html#t:GroupEQ">GroupEQ</a>) <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a></li><li class="src short"><a href="#v:zoomGroupIn">zoomGroupIn</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"><a href="#v:zoomGroupOut">zoomGroupOut</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"><a href="#v:zoomGroupReset">zoomGroupReset</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"><a href="#v:toggleGroupFull">toggleGroupFull</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"><a href="#v:groupToNextLayout">groupToNextLayout</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"><a href="#v:groupToFullLayout">groupToFullLayout</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"><a href="#v:groupToTabbedLayout">groupToTabbedLayout</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"><a href="#v:groupToVerticalLayout">groupToVerticalLayout</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"><a href="#v:shrinkText">shrinkText</a> :: <a href="XMonad-Layout-Decoration.html#t:DefaultShrinker">DefaultShrinker</a></li><li class="src short"><a href="#v:defaultTheme">defaultTheme</a> :: <a href="XMonad-Layout-Decoration.html#t:Theme">Theme</a></li><li class="src short">module <a href="XMonad-Layout-Groups-Helpers.html">XMonad.Layout.Groups.Helpers</a></li></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>This module provides a layout inspired by the one used by the wmii
(<a href="http://wmii.suckless.org">http://wmii.suckless.org</a>) window manager.
Windows are arranged into groups in a horizontal row, and each group can lay out
its windows
</p><ul><li> by maximizing the focused one
</li><li> by tabbing them (wmii uses a stacked layout, but I'm too lazy to write it)
</li><li> by arranging them in a column.
</li></ul><p>As the groups are arranged in a <code>ZoomRow</code>, the relative width of each group can be
increased or decreased at will. Groups can also be set to use the whole screen
whenever they have focus.
</p><p>You can use the contents of this module by adding
</p><pre> import XMonad.Layout.Groups.Wmii
</pre><p>to the top of your <code>./.xmonad/xmonad.hs</code>, and adding <code><a href="XMonad-Layout-Groups-Wmii.html#v:wmii">wmii</a></code>
(with a <code><a href="XMonad-Layout-Decoration.html#t:Shrinker">Shrinker</a></code> and decoration <code><a href="XMonad-Layout-Decoration.html#t:Theme">Theme</a></code> as
parameters) to your layout hook, for example:
</p><pre> myLayout = wmii shrinkText defaultTheme
</pre><p>To be able to zoom in and out of groups, change their inner layout, etc.,
create key bindings for the relevant actions:
</p><pre> ((modMask, xK_f), toggleGroupFull)
</pre><p>and so on.
</p><p>For more information on how to extend your layout hook and key bindings, see
<a href="XMonad-Doc-Extending.html">XMonad.Doc.Extending</a>.
</p><p>Finally, you will probably want to be able to move focus and windows
between groups in a consistent fashion. For this, you should take a look
at the <a href="XMonad-Layout-Groups-Helpers.html">XMonad.Layout.Groups.Helpers</a> module, whose contents are re-exported
by this module.
</p></div><div class="top"><p class="src"><a name="v:wmii" class="def">wmii</a> :: <a href="XMonad-Layout-Decoration.html#t:Shrinker">Shrinker</a> s => s -> <a href="XMonad-Layout-Decoration.html#t:Theme">Theme</a> -> <a href="XMonad-Layout-Groups.html#t:Groups">Groups</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Renamed.html#t:Rename">Rename</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-Tabbed.html#t:TabbedDecoration">TabbedDecoration</a> s) (<a href="XMonad-Layout-MessageControl.html#t:Ignore">Ignore</a> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:ChangeLayout">ChangeLayout</a> (<a href="XMonad-Layout-MessageControl.html#t:Ignore">Ignore</a> <a href="XMonad-Layout-LayoutCombinators.html#t:JumpToLayout">JumpToLayout</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-MessageControl.html#t:UnEscape">UnEscape</a> (<a href="XMonad-Layout-LayoutCombinators.html#t:NewSelect">NewSelect</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Renamed.html#t:Rename">Rename</a> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Tall">Tall</a>) (<a href="XMonad-Layout-LayoutCombinators.html#t:NewSelect">NewSelect</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Renamed.html#t:Rename">Rename</a> <a href="XMonad-Layout-Simplest.html#t:Simplest">Simplest</a>) <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html#t:Full">Full</a>))))))) (<a href="XMonad-Layout-ZoomRow.html#t:ZoomRow">ZoomRow</a> <a href="XMonad-Layout-Groups-Examples.html#t:GroupEQ">GroupEQ</a>) <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a><a href="src/XMonad-Layout-Groups-Wmii.html#wmii" class="link">Source</a></p><div class="doc"><p>A layout inspired by wmii
</p></div></div><div class="top"><p class="src"><a name="v:zoomGroupIn" class="def">zoomGroupIn</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-Groups-Wmii.html#zoomGroupIn" class="link">Source</a></p><div class="doc"><p>Increase the width of the focused group
</p></div></div><div class="top"><p class="src"><a name="v:zoomGroupOut" class="def">zoomGroupOut</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-Groups-Wmii.html#zoomGroupOut" class="link">Source</a></p><div class="doc"><p>Decrease the size of the focused group
</p></div></div><div class="top"><p class="src"><a name="v:zoomGroupReset" class="def">zoomGroupReset</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-Groups-Wmii.html#zoomGroupReset" class="link">Source</a></p><div class="doc"><p>Reset the size of the focused group to the default
</p></div></div><div class="top"><p class="src"><a name="v:toggleGroupFull" class="def">toggleGroupFull</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-Groups-Wmii.html#toggleGroupFull" class="link">Source</a></p><div class="doc"><p>Toggle whether the currently focused group should be maximized
whenever it has focus.
</p></div></div><div class="top"><p class="src"><a name="v:groupToNextLayout" class="def">groupToNextLayout</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-Groups-Wmii.html#groupToNextLayout" class="link">Source</a></p><div class="doc"><p>Rotate the layouts in the focused group.
</p></div></div><div class="top"><p class="src"><a name="v:groupToFullLayout" class="def">groupToFullLayout</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-Groups-Wmii.html#groupToFullLayout" class="link">Source</a></p><div class="doc"><p>Switch the focused group to the "maximized" layout.
</p></div></div><div class="top"><p class="src"><a name="v:groupToTabbedLayout" class="def">groupToTabbedLayout</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-Groups-Wmii.html#groupToTabbedLayout" class="link">Source</a></p><div class="doc"><p>Switch the focused group to the "tabbed" layout.
</p></div></div><div class="top"><p class="src"><a name="v:groupToVerticalLayout" class="def">groupToVerticalLayout</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-Groups-Wmii.html#groupToVerticalLayout" class="link">Source</a></p><div class="doc"><p>Switch the focused group to the "column" layout.
</p></div></div><h1 id="g:2">Useful re-exports
</h1><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"><a name="v:defaultTheme" class="def">defaultTheme</a> :: <a href="XMonad-Layout-Decoration.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-Decoration.html#t:Theme">Theme</a></code>.
</p></div></div><div class="top"><p class="src">module <a href="XMonad-Layout-Groups-Helpers.html">XMonad.Layout.Groups.Helpers</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>
