<!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.PhysicalScreens</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-PhysicalScreens.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Actions-PhysicalScreens.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>Nelson Elhage <nelhage@mit.edu></td></tr><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">XMonad.Actions.PhysicalScreens</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>Manipulate screens ordered by physical location instead of ID
</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">newtype</span> <a href="#t:PhysicalScreen">PhysicalScreen</a> = <a href="#v:P">P</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:getScreen">getScreen</a> :: <a href="XMonad-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ScreenId">ScreenId</a>)</li><li class="src short"><a href="#v:viewScreen">viewScreen</a> :: <a href="XMonad-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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:sendToScreen">sendToScreen</a> :: <a href="XMonad-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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:onNextNeighbour">onNextNeighbour</a> :: (<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WorkspaceId">WorkspaceId</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSet">WindowSet</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSet">WindowSet</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:onPrevNeighbour">onPrevNeighbour</a> :: (<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WorkspaceId">WorkspaceId</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSet">WindowSet</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSet">WindowSet</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></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>This module allows you name Xinerama screens from XMonad using their
physical location relative to each other (as reported by Xinerama),
rather than their <code>ScreenID</code> s, which are arbitrarily determined by
your X server and graphics hardware.
</p><p>Screens are ordered by the upper-left-most corner, from top-to-bottom
and then left-to-right.
</p><p>Example usage in your <code>~/.xmonad/xmonad.hs</code> file:
</p><pre> import XMonad.Actions.PhysicalScreens
</pre><pre> , ((modMask, xK_a), onPrevNeighbour W.view)
, ((modMask, xK_o), onNextNeighbour W.view)
, ((modMask .|. shiftMask, xK_a), onPrevNeighbour W.shift)
, ((modMask .|. shiftMask, xK_o), onNextNeighbour W.shift)
</pre><pre> --
-- mod-{w,e,r}, Switch to physical/Xinerama screens 1, 2, or 3
-- mod-shift-{w,e,r}, Move client to screen 1, 2, or 3
--
[((modm .|. mask, key), f sc)
| (key, sc) <- zip [xK_w, xK_e, xK_r] [0..]
, (f, mask) <- [(viewScreen, 0), (sendToScreen, shiftMask)]]
</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><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:PhysicalScreen" class="def">PhysicalScreen</a> <a href="src/XMonad-Actions-PhysicalScreens.html#PhysicalScreen" class="link">Source</a></p><div class="doc"><p>The type of the index of a screen by location
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:P" class="def">P</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:PhysicalScreen" class="caption collapser" onclick="toggleSection('i:PhysicalScreen')">Instances</p><div id="section.i:PhysicalScreen" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Enum">Enum</a> <a href="XMonad-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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/Prelude.html#t:Integral">Integral</a> <a href="XMonad-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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/Prelude.html#t:Num">Num</a> <a href="XMonad-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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-Ord.html#t:Ord">Ord</a> <a href="XMonad-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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/Prelude.html#t:Real">Real</a> <a href="XMonad-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:getScreen" class="def">getScreen</a> :: <a href="XMonad-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ScreenId">ScreenId</a>)<a href="src/XMonad-Actions-PhysicalScreens.html#getScreen" class="link">Source</a></p><div class="doc"><p>Translate a physical screen index to a <a href="ScreenId.html">ScreenId</a>
</p></div></div><div class="top"><p class="src"><a name="v:viewScreen" class="def">viewScreen</a> :: <a href="XMonad-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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-Actions-PhysicalScreens.html#viewScreen" class="link">Source</a></p><div class="doc"><p>Switch to a given physical screen
</p></div></div><div class="top"><p class="src"><a name="v:sendToScreen" class="def">sendToScreen</a> :: <a href="XMonad-Actions-PhysicalScreens.html#t:PhysicalScreen">PhysicalScreen</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-Actions-PhysicalScreens.html#sendToScreen" class="link">Source</a></p><div class="doc"><p>Send the active window to a given physical screen
</p></div></div><div class="top"><p class="src"><a name="v:onNextNeighbour" class="def">onNextNeighbour</a> :: (<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WorkspaceId">WorkspaceId</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSet">WindowSet</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSet">WindowSet</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-Actions-PhysicalScreens.html#onNextNeighbour" class="link">Source</a></p><div class="doc"><p>Apply operation on a WindowSet with the WorkspaceId of the next screen in the physical order as parameter.
</p></div></div><div class="top"><p class="src"><a name="v:onPrevNeighbour" class="def">onPrevNeighbour</a> :: (<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WorkspaceId">WorkspaceId</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSet">WindowSet</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSet">WindowSet</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-Actions-PhysicalScreens.html#onPrevNeighbour" class="link">Source</a></p><div class="doc"><p>Apply operation on a WindowSet with the WorkspaceId of the previous screen in the physical order as parameter.
</p></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>
