<!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.Actions.Plane</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-Actions-Plane.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Actions-Plane.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>Marco Tlio Gontijo e Silva <marcot@riseup.net></td></tr></table><p class="caption">XMonad.Actions.Plane</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">Data types
</a></li><li><a href="#g:3">Key bindings
</a></li><li><a href="#g:4">Navigating through workspaces
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module has functions to navigate through workspaces in a bidimensional
manner. It allows the organization of workspaces in lines, and provides
functions to move and shift windows in all four directions (left, up, right
and down) possible in a surface.
</p><p>This functionality was inspired by GNOME (finite) and KDE (infinite)
keybindings for workspace navigation, and by <a href="XMonad-Actions-CycleWS.html">XMonad.Actions.CycleWS</a> for
the idea of applying this approach to XMonad.
</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"><span class="keyword">data</span> <a href="#t:Direction">Direction</a> <ul class="subs"><li>= <a href="#v:ToLeft">ToLeft</a> </li><li>| <a href="#v:ToUp">ToUp</a> </li><li>| <a href="#v:ToRight">ToRight</a> </li><li>| <a href="#v:ToDown">ToDown</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Limits">Limits</a> <ul class="subs"><li>= <a href="#v:Finite">Finite</a> </li><li>| <a href="#v:Circular">Circular</a> </li><li>| <a href="#v:Linear">Linear</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Lines">Lines</a> <ul class="subs"><li>= <a href="#v:GConf">GConf</a> </li><li>| <a href="#v:Lines">Lines</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> </li></ul></li><li class="src short"><a href="#v:planeKeys">planeKeys</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t:KeyMask">KeyMask</a> -> <a href="XMonad-Actions-Plane.html#t:Lines">Lines</a> -> <a href="XMonad-Actions-Plane.html#t:Limits">Limits</a> -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> (<a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t:KeyMask">KeyMask</a>, <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t:KeySym">KeySym</a>) (X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:planeShift">planeShift</a> :: <a href="XMonad-Actions-Plane.html#t:Lines">Lines</a> -> <a href="XMonad-Actions-Plane.html#t:Limits">Limits</a> -> <a href="XMonad-Actions-Plane.html#t:Direction">Direction</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:planeMove">planeMove</a> :: <a href="XMonad-Actions-Plane.html#t:Lines">Lines</a> -> <a href="XMonad-Actions-Plane.html#t:Limits">Limits</a> -> <a href="XMonad-Actions-Plane.html#t:Direction">Direction</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</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> file:
</p><pre> import XMonad.Actions.Plane
main = xmonad defaultConfig {keys = myKeys}
myKeys conf = union (keys defaultConfig conf) $ myNewKeys conf
myNewkeys (XConfig {modMask = modm}) = planeKeys modm (Lines 3) Finite
</pre><p>For detailed instructions on editing your key bindings, see
<a href="XMonad-Doc-Extending.html#Editing_key_bindings">XMonad.Doc.Extending</a>.
</p></div><h1 id="g:2">Data types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Direction" class="def">Direction</a> <a href="src/XMonad-Actions-Plane.html#Direction" class="link">Source</a></p><div class="doc"><p>Direction to go in the plane.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ToLeft" class="def">ToLeft</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ToUp" class="def">ToUp</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ToRight" class="def">ToRight</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ToDown" class="def">ToDown</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-Actions-Plane.html#t:Direction">Direction</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:Limits" class="def">Limits</a> <a href="src/XMonad-Actions-Plane.html#Limits" class="link">Source</a></p><div class="doc"><p>Defines the behaviour when you're trying to move out of the limits.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Finite" class="def">Finite</a></td><td class="doc"><p>Ignore the function call, and keep in the same workspace.
</p></td></tr><tr><td class="src"><a name="v:Circular" class="def">Circular</a></td><td class="doc"><p>Get on the other side, like in the Snake game.
</p></td></tr><tr><td class="src"><a name="v:Linear" class="def">Linear</a></td><td class="doc"><p>The plan comes as a row, so it goes to the next or prev if
the workspaces were numbered.
</p></td></tr></table></div><div class="subs instances"><p id="control.i:Limits" class="caption collapser" onclick="toggleSection('i:Limits')">Instances</p><div id="section.i:Limits" 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 href="XMonad-Actions-Plane.html#t:Limits">Limits</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:Lines" class="def">Lines</a> <a href="src/XMonad-Actions-Plane.html#Lines" class="link">Source</a></p><div class="doc"><p>The number of lines in which the workspaces will be arranged. It's
possible to use a number of lines that is not a divisor of the number of
workspaces, but the results are better when using a divisor. If it's not a
divisor, the last line will have the remaining workspaces.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:GConf" class="def">GConf</a></td><td class="doc"><p>Use <code>gconftool-2</code> to find out the number of lines.
</p></td></tr><tr><td class="src"><a name="v:Lines" class="def">Lines</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>Specify the number of lines explicitly.
</p></td></tr></table></div></div><h1 id="g:3">Key bindings
</h1><div class="top"><p class="src"><a name="v:planeKeys" class="def">planeKeys</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t:KeyMask">KeyMask</a> -> <a href="XMonad-Actions-Plane.html#t:Lines">Lines</a> -> <a href="XMonad-Actions-Plane.html#t:Limits">Limits</a> -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> (<a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t:KeyMask">KeyMask</a>, <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t:KeySym">KeySym</a>) (X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/XMonad-Actions-Plane.html#planeKeys" class="link">Source</a></p><div class="doc"><p>This is the way most people would like to use this module. It attaches the
<code><a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t:KeyMask">KeyMask</a></code> passed as a parameter with <code><a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#v:xK_Left">xK_Left</a></code>, <code><a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#v:xK_Up">xK_Up</a></code>, <code><a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#v:xK_Right">xK_Right</a></code> and
<code><a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#v:xK_Down">xK_Down</a></code>, associating it with <code><a href="XMonad-Actions-Plane.html#v:planeMove">planeMove</a></code> to the corresponding <code><a href="XMonad-Actions-Plane.html#t:Direction">Direction</a></code>.
It also associates these bindings with <code><a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#v:shiftMask">shiftMask</a></code> to <code><a href="XMonad-Actions-Plane.html#v:planeShift">planeShift</a></code>.
</p></div></div><h1 id="g:4">Navigating through workspaces
</h1><div class="top"><p class="src"><a name="v:planeShift" class="def">planeShift</a> :: <a href="XMonad-Actions-Plane.html#t:Lines">Lines</a> -> <a href="XMonad-Actions-Plane.html#t:Limits">Limits</a> -> <a href="XMonad-Actions-Plane.html#t:Direction">Direction</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Actions-Plane.html#planeShift" class="link">Source</a></p><div class="doc"><p>Shift a window to the next workspace in <code><a href="XMonad-Actions-Plane.html#t:Direction">Direction</a></code>. Note that this will
also move to the next workspace. It's a good idea to use the same <code><a href="XMonad-Actions-Plane.html#t:Lines">Lines</a></code>
and <code><a href="XMonad-Actions-Plane.html#t:Limits">Limits</a></code> for all the bindings.
</p></div></div><div class="top"><p class="src"><a name="v:planeMove" class="def">planeMove</a> :: <a href="XMonad-Actions-Plane.html#t:Lines">Lines</a> -> <a href="XMonad-Actions-Plane.html#t:Limits">Limits</a> -> <a href="XMonad-Actions-Plane.html#t:Direction">Direction</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Actions-Plane.html#planeMove" class="link">Source</a></p><div class="doc"><p>Move to the next workspace in <code><a href="XMonad-Actions-Plane.html#t:Direction">Direction</a></code>.
</p></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>
