<!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.Workscreen</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-Workscreen.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Actions-Workscreen.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>Dal <kedasl0@gmail.com></td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Actions.Workscreen</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>A workscreen permits to display a set of workspaces on several
screens. In xinerama mode, when a workscreen is viewed, workspaces
associated to all screens are visible.
</p><p>The first workspace of a workscreen is displayed on first screen,
second on second screen, etc. Workspace position can be easily
changed. If the current workscreen is called again, workspaces are
shifted.
</p><p>This also permits to see all workspaces of a workscreen even if just
one screen is present, and to move windows from workspace to workscreen.
</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:configWorkscreen">configWorkscreen</a> :: [<a href="XMonad-Actions-Workscreen.html#t:Workscreen">Workscreen</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:viewWorkscreen">viewWorkscreen</a> :: WorkscreenId -> <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"><span class="keyword">data</span> <a href="#t:Workscreen">Workscreen</a> = <a href="#v:Workscreen">Workscreen</a> {<ul class="subs"><li><a href="#v:workscreenId">workscreenId</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:workspaces">workspaces</a> :: [<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WorkspaceId">WorkspaceId</a>]</li></ul>}</li><li class="src short"><a href="#v:shiftToWorkscreen">shiftToWorkscreen</a> :: WorkscreenId -> <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:fromWorkspace">fromWorkspace</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/xmonad-0.11/XMonad-Core.html#t:WorkspaceId">WorkspaceId</a>] -> [<a href="XMonad-Actions-Workscreen.html#t:Workscreen">Workscreen</a>]</li><li class="src short"><a href="#v:expandWorkspace">expandWorkspace</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/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:WorkspaceId">WorkspaceId</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.Actions.Workscreen
myWorkspaces = let myOldWorkspaces = ["adm","work","mail"]
in Workscreen.expandWorkspace 2 myOldWorkspaces
myStartupHook = do Workscreen.configWorkscreen (Workscreen.fromWorkspace 2 myWorkspaces)
return ()
</pre><p>Then, replace normal workspace view and shift keybinding:
</p><pre> [((m .|. modm, k), f i)
| (i, k) <- zip [0..] [1..12]
, (f, m) <- [(Workscreen.viewWorkscreen, 0), (Workscreen.shiftToWorkscreen, 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"><a name="v:configWorkscreen" class="def">configWorkscreen</a> :: [<a href="XMonad-Actions-Workscreen.html#t:Workscreen">Workscreen</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-Workscreen.html#configWorkscreen" class="link">Source</a></p><div class="doc"><p>Initial configuration of workscreens
</p></div></div><div class="top"><p class="src"><a name="v:viewWorkscreen" class="def">viewWorkscreen</a> :: WorkscreenId -> <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-Workscreen.html#viewWorkscreen" class="link">Source</a></p><div class="doc"><p>View workscreen of index <code>WorkscreenId</code>. If current workscreen is asked
workscreen, workscreen's workspaces are shifted.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Workscreen" class="def">Workscreen</a> <a href="src/XMonad-Actions-Workscreen.html#Workscreen" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Workscreen" class="def">Workscreen</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:workscreenId" class="def">workscreenId</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:workspaces" class="def">workspaces</a> :: [<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WorkspaceId">WorkspaceId</a>]</dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:Workscreen" class="caption collapser" onclick="toggleSection('i:Workscreen')">Instances</p><div id="section.i:Workscreen" class="show"><table><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-Workscreen.html#t:Workscreen">Workscreen</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-Typeable-Internal.html#t:Typeable">Typeable</a> <a href="XMonad-Actions-Workscreen.html#t:Workscreen">Workscreen</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:shiftToWorkscreen" class="def">shiftToWorkscreen</a> :: WorkscreenId -> <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-Workscreen.html#shiftToWorkscreen" class="link">Source</a></p><div class="doc"><p>Shift a window on the first workspace of workscreen
<code>WorkscreenId</code>.
</p></div></div><div class="top"><p class="src"><a name="v:fromWorkspace" class="def">fromWorkspace</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/xmonad-0.11/XMonad-Core.html#t:WorkspaceId">WorkspaceId</a>] -> [<a href="XMonad-Actions-Workscreen.html#t:Workscreen">Workscreen</a>]<a href="src/XMonad-Actions-Workscreen.html#fromWorkspace" class="link">Source</a></p><div class="doc"><p>Create workscreen list from workspace list. Group workspaces to
packets of screens number size.
</p></div></div><div class="top"><p class="src"><a name="v:expandWorkspace" class="def">expandWorkspace</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/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:WorkspaceId">WorkspaceId</a>]<a href="src/XMonad-Actions-Workscreen.html#expandWorkspace" class="link">Source</a></p><div class="doc"><p>Helper to group workspaces. Multiply workspace by screens number.
</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>
