<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--Rendered using the Haskell Html Library v0.2--> <HTML ><HEAD ><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8" ><TITLE >XMonad.Actions.Plane</TITLE ><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css" ><SCRIPT SRC="haddock-util.js" TYPE="text/javascript" ></SCRIPT ><SCRIPT TYPE="text/javascript" >window.onload = function () {setSynopsis("mini_XMonad-Actions-Plane.html")};</SCRIPT ></HEAD ><BODY ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="topbar" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD ><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" " ></TD ><TD CLASS="title" >xmonad-contrib-0.9.1: Third party extensions for xmonad</TD ><TD CLASS="topbut" ><A HREF="src/XMonad-Actions-Plane.html" >Source code</A ></TD ><TD CLASS="topbut" ><A HREF="index.html" >Contents</A ></TD ><TD CLASS="topbut" ><A HREF="doc-index.html" >Index</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="modulebar" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD ><FONT SIZE="6" >XMonad.Actions.Plane</FONT ></TD ><TD ALIGN="right" ><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="infohead" >Portability</TD ><TD CLASS="infoval" >unportable</TD ></TR ><TR ><TD CLASS="infohead" >Stability</TD ><TD CLASS="infoval" >unstable</TD ></TR ><TR ><TD CLASS="infohead" >Maintainer</TD ><TD CLASS="infoval" >Marco Tlio Gontijo e Silva <marcot@riseup.net></TD ></TR ></TABLE ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="section4" ><B >Contents</B ></TD ></TR ><TR ><TD ><DL ><DT ><A HREF="#1" >Usage </A ></DT ><DT ><A HREF="#2" >Data types </A ></DT ><DT ><A HREF="#3" >Key bindings </A ></DT ><DT ><A HREF="#4" >Navigating through workspaces </A ></DT ></DL ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" >Description</TD ></TR ><TR ><TD 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 ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" >Synopsis</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="decl" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="decl" ><SPAN CLASS="keyword" >data</SPAN > <A HREF="#t%3ADirection" >Direction</A > </TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="decl" >= <A HREF="#v%3AToLeft" >ToLeft</A ></TD ></TR ><TR ><TD CLASS="decl" >| <A HREF="#v%3AToUp" >ToUp</A ></TD ></TR ><TR ><TD CLASS="decl" >| <A HREF="#v%3AToRight" >ToRight</A ></TD ></TR ><TR ><TD CLASS="decl" >| <A HREF="#v%3AToDown" >ToDown</A ></TD ></TR ></TABLE ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="decl" ><SPAN CLASS="keyword" >data</SPAN > <A HREF="#t%3ALimits" >Limits</A > </TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="decl" >= <A HREF="#v%3AFinite" >Finite</A ></TD ></TR ><TR ><TD CLASS="decl" >| <A HREF="#v%3ACircular" >Circular</A ></TD ></TR ><TR ><TD CLASS="decl" >| <A HREF="#v%3ALinear" >Linear</A ></TD ></TR ></TABLE ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="decl" ><SPAN CLASS="keyword" >data</SPAN > <A HREF="#t%3ALines" >Lines</A > </TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="decl" >= <A HREF="#v%3AGConf" >GConf</A ></TD ></TR ><TR ><TD CLASS="decl" >| <A HREF="#v%3ALines" >Lines</A > <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A ></TD ></TR ></TABLE ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AplaneKeys" >planeKeys</A > :: <A HREF="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t%3AKeyMask" >KeyMask</A > -> <A HREF="XMonad-Actions-Plane.html#t%3ALines" >Lines</A > -> <A HREF="XMonad-Actions-Plane.html#t%3ALimits" >Limits</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/containers-0.3.0.0/Data-Map.html#t%3AMap" >Map</A > (<A HREF="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t%3AKeyMask" >KeyMask</A >, <A HREF="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t%3AKeySym" >KeySym</A >) (<A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AX" >X</A > <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29" >()</A >)</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AplaneShift" >planeShift</A > :: <A HREF="XMonad-Actions-Plane.html#t%3ALines" >Lines</A > -> <A HREF="XMonad-Actions-Plane.html#t%3ALimits" >Limits</A > -> <A HREF="XMonad-Actions-Plane.html#t%3ADirection" >Direction</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AX" >X</A > <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29" >()</A ></TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AplaneMove" >planeMove</A > :: <A HREF="XMonad-Actions-Plane.html#t%3ALines" >Lines</A > -> <A HREF="XMonad-Actions-Plane.html#t%3ALimits" >Limits</A > -> <A HREF="XMonad-Actions-Plane.html#t%3ADirection" >Direction</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AX" >X</A > <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29" >()</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" ><A NAME="1" ><A NAME="1" >Usage </A ></A ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="doc" ><P >You can use this module with the following in your <TT >~/.xmonad/xmonad.hs</TT > 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 ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" ><A NAME="2" ><A NAME="2" >Data types </A ></A ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><SPAN CLASS="keyword" >data</SPAN > <A NAME="t:Direction" ><A NAME="t%3ADirection" ></A ></A ><B >Direction</B > </TD ><TD CLASS="declbut" ><A HREF="src/XMonad-Actions-Plane.html#Direction" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="ndoc" >Direction to go in the plane. </TD ></TR ><TR ><TD CLASS="section4" >Constructors</TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0" ><TR ><TD CLASS="arg" ><A NAME="v:ToLeft" ><A NAME="v%3AToLeft" ></A ></A ><B >ToLeft</B ></TD ><TD CLASS="rdoc" ></TD ></TR ><TR ><TD CLASS="arg" ><A NAME="v:ToUp" ><A NAME="v%3AToUp" ></A ></A ><B >ToUp</B ></TD ><TD CLASS="rdoc" ></TD ></TR ><TR ><TD CLASS="arg" ><A NAME="v:ToRight" ><A NAME="v%3AToRight" ></A ></A ><B >ToRight</B ></TD ><TD CLASS="rdoc" ></TD ></TR ><TR ><TD CLASS="arg" ><A NAME="v:ToDown" ><A NAME="v%3AToDown" ></A ></A ><B >ToDown</B ></TD ><TD CLASS="rdoc" ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="section4" ><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Direction')" ALT="show/hide" > Instances</TD ></TR ><TR ><TD CLASS="body" ><DIV ID="i:Direction" STYLE="display:block;" ><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0" ><TR ><TD CLASS="decl" ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AEnum" >Enum</A > <A HREF="XMonad-Actions-Plane.html#t%3ADirection" >Direction</A ></TD ></TR ></TABLE ></DIV ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><SPAN CLASS="keyword" >data</SPAN > <A NAME="t:Limits" ><A NAME="t%3ALimits" ></A ></A ><B >Limits</B > </TD ><TD CLASS="declbut" ><A HREF="src/XMonad-Actions-Plane.html#Limits" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="ndoc" >Defines the behaviour when you're trying to move out of the limits. </TD ></TR ><TR ><TD CLASS="section4" >Constructors</TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0" ><TR ><TD CLASS="arg" ><A NAME="v:Finite" ><A NAME="v%3AFinite" ></A ></A ><B >Finite</B ></TD ><TD CLASS="rdoc" >Ignore the function call, and keep in the same workspace. </TD ></TR ><TR ><TD CLASS="arg" ><A NAME="v:Circular" ><A NAME="v%3ACircular" ></A ></A ><B >Circular</B ></TD ><TD CLASS="rdoc" >Get on the other side, like in the Snake game. </TD ></TR ><TR ><TD CLASS="arg" ><A NAME="v:Linear" ><A NAME="v%3ALinear" ></A ></A ><B >Linear</B ></TD ><TD CLASS="rdoc" >The plan comes as a row, so it goes to the next or prev if the workspaces were numbered. </TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="section4" ><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Limits')" ALT="show/hide" > Instances</TD ></TR ><TR ><TD CLASS="body" ><DIV ID="i:Limits" STYLE="display:block;" ><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0" ><TR ><TD CLASS="decl" ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Eq.html#t%3AEq" >Eq</A > <A HREF="XMonad-Actions-Plane.html#t%3ALimits" >Limits</A ></TD ></TR ></TABLE ></DIV ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><SPAN CLASS="keyword" >data</SPAN > <A NAME="t:Lines" ><A NAME="t%3ALines" ></A ></A ><B >Lines</B > </TD ><TD CLASS="declbut" ><A HREF="src/XMonad-Actions-Plane.html#Lines" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="ndoc" >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. </TD ></TR ><TR ><TD CLASS="section4" >Constructors</TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0" ><TR ><TD CLASS="arg" ><A NAME="v:GConf" ><A NAME="v%3AGConf" ></A ></A ><B >GConf</B ></TD ><TD CLASS="rdoc" >Use <TT >gconftool-2</TT > to find out the number of lines. </TD ></TR ><TR ><TD CLASS="arg" ><A NAME="v:Lines" ><A NAME="v%3ALines" ></A ></A ><B >Lines</B > <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A ></TD ><TD CLASS="rdoc" >Specify the number of lines explicitly. </TD ></TR ></TABLE ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" ><A NAME="3" ><A NAME="3" >Key bindings </A ></A ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:planeKeys" ><A NAME="v%3AplaneKeys" ></A ></A ><B >planeKeys</B > :: <A HREF="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t%3AKeyMask" >KeyMask</A > -> <A HREF="XMonad-Actions-Plane.html#t%3ALines" >Lines</A > -> <A HREF="XMonad-Actions-Plane.html#t%3ALimits" >Limits</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/containers-0.3.0.0/Data-Map.html#t%3AMap" >Map</A > (<A HREF="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t%3AKeyMask" >KeyMask</A >, <A HREF="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t%3AKeySym" >KeySym</A >) (<A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AX" >X</A > <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29" >()</A >)</TD ><TD CLASS="declbut" ><A HREF="src/XMonad-Actions-Plane.html#planeKeys" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="doc" >This is the way most people would like to use this module. It attaches the <TT ><A HREF="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t%3AKeyMask" >KeyMask</A ></TT > passed as a parameter with <TT ><A HREF="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#v%3AxK_Left" >xK_Left</A ></TT >, <TT ><A HREF="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#v%3AxK_Up" >xK_Up</A ></TT >, <TT ><A HREF="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#v%3AxK_Right" >xK_Right</A ></TT > and <TT ><A HREF="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#v%3AxK_Down" >xK_Down</A ></TT >, associating it with <TT ><A HREF="XMonad-Actions-Plane.html#v%3AplaneMove" >planeMove</A ></TT > to the corresponding <TT ><A HREF="XMonad-Actions-Plane.html#t%3ADirection" >Direction</A ></TT >. It also associates these bindings with <TT ><A HREF="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#v%3AshiftMask" >shiftMask</A ></TT > to <TT ><A HREF="XMonad-Actions-Plane.html#v%3AplaneShift" >planeShift</A ></TT >. </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" ><A NAME="4" ><A NAME="4" >Navigating through workspaces </A ></A ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:planeShift" ><A NAME="v%3AplaneShift" ></A ></A ><B >planeShift</B > :: <A HREF="XMonad-Actions-Plane.html#t%3ALines" >Lines</A > -> <A HREF="XMonad-Actions-Plane.html#t%3ALimits" >Limits</A > -> <A HREF="XMonad-Actions-Plane.html#t%3ADirection" >Direction</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AX" >X</A > <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29" >()</A ></TD ><TD CLASS="declbut" ><A HREF="src/XMonad-Actions-Plane.html#planeShift" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="doc" >Shift a window to the next workspace in <TT ><A HREF="XMonad-Actions-Plane.html#t%3ADirection" >Direction</A ></TT >. Note that this will also move to the next workspace. It's a good idea to use the same <TT ><A HREF="XMonad-Actions-Plane.html#t%3ALines" >Lines</A ></TT > and <TT ><A HREF="XMonad-Actions-Plane.html#t%3ALimits" >Limits</A ></TT > for all the bindings. </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:planeMove" ><A NAME="v%3AplaneMove" ></A ></A ><B >planeMove</B > :: <A HREF="XMonad-Actions-Plane.html#t%3ALines" >Lines</A > -> <A HREF="XMonad-Actions-Plane.html#t%3ALimits" >Limits</A > -> <A HREF="XMonad-Actions-Plane.html#t%3ADirection" >Direction</A > -> <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AX" >X</A > <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29" >()</A ></TD ><TD CLASS="declbut" ><A HREF="src/XMonad-Actions-Plane.html#planeMove" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="doc" >Move to the next workspace in <TT ><A HREF="XMonad-Actions-Plane.html#t%3ADirection" >Direction</A ></TT >. </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="botbar" >Produced by <A HREF="http://www.haskell.org/haddock/" >Haddock</A > version 2.6.1</TD ></TR ></TABLE ></BODY ></HTML >