<!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.DynamicWorkspaceGroups</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-DynamicWorkspaceGroups.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Actions-DynamicWorkspaceGroups.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>experimental</td></tr><tr><th>Maintainer</th><td><byorgey@gmail.com></td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Actions.DynamicWorkspaceGroups</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>Dynamically manage "workspace groups", sets of workspaces being
used together for some common task or purpose, to allow switching
between workspace groups in a single action. Note that this only
makes sense for multi-head setups.
</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">type</span> <a href="#t:WSGroupId">WSGroupId</a> = <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:addWSGroup">addWSGroup</a> :: <a href="XMonad-Actions-DynamicWorkspaceGroups.html#t:WSGroupId">WSGroupId</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: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:addCurrentWSGroup">addCurrentWSGroup</a> :: <a href="XMonad-Actions-DynamicWorkspaceGroups.html#t:WSGroupId">WSGroupId</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:forgetWSGroup">forgetWSGroup</a> :: <a href="XMonad-Actions-DynamicWorkspaceGroups.html#t:WSGroupId">WSGroupId</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:viewWSGroup">viewWSGroup</a> :: <a href="XMonad-Actions-DynamicWorkspaceGroups.html#t:WSGroupId">WSGroupId</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:promptWSGroupView">promptWSGroupView</a> :: <a href="XMonad-Prompt.html#t:XPConfig">XPConfig</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</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:promptWSGroupAdd">promptWSGroupAdd</a> :: <a href="XMonad-Prompt.html#t:XPConfig">XPConfig</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</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:promptWSGroupForget">promptWSGroupForget</a> :: <a href="XMonad-Prompt.html#t:XPConfig">XPConfig</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</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"><span class="keyword">data</span> <a href="#t:WSGPrompt">WSGPrompt</a> </li></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>You can use this module by importing it into your ~/.xmonad/xmonad.hs file:
</p><pre> import XMonad.Actions.DynamicWorkspaceGroups
</pre><p>Then add keybindings like the following (this example uses
<a href="XMonad-Util-EZConfig.html">XMonad.Util.EZConfig</a>-style keybindings, but this is not necessary):
</p><pre> , ("M-y n", promptWSGroupAdd myXPConfig "Name this group: ")
, ("M-y g", promptWSGroupView myXPConfig "Go to group: ")
, ("M-y d", promptWSGroupForget myXPConfig "Forget group: ")
</pre></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:WSGroupId" class="def">WSGroupId</a> = <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/XMonad-Actions-DynamicWorkspaceGroups.html#WSGroupId" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:addWSGroup" class="def">addWSGroup</a> :: <a href="XMonad-Actions-DynamicWorkspaceGroups.html#t:WSGroupId">WSGroupId</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: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-DynamicWorkspaceGroups.html#addWSGroup" class="link">Source</a></p><div class="doc"><p>Add a new workspace group with the given name.
</p></div></div><div class="top"><p class="src"><a name="v:addCurrentWSGroup" class="def">addCurrentWSGroup</a> :: <a href="XMonad-Actions-DynamicWorkspaceGroups.html#t:WSGroupId">WSGroupId</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-DynamicWorkspaceGroups.html#addCurrentWSGroup" class="link">Source</a></p><div class="doc"><p>Give a name to the current workspace group.
</p></div></div><div class="top"><p class="src"><a name="v:forgetWSGroup" class="def">forgetWSGroup</a> :: <a href="XMonad-Actions-DynamicWorkspaceGroups.html#t:WSGroupId">WSGroupId</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-DynamicWorkspaceGroups.html#forgetWSGroup" class="link">Source</a></p><div class="doc"><p>Delete the named workspace group from the list of workspace
groups. Note that this has no effect on the workspaces involved;
it simply forgets the given name.
</p></div></div><div class="top"><p class="src"><a name="v:viewWSGroup" class="def">viewWSGroup</a> :: <a href="XMonad-Actions-DynamicWorkspaceGroups.html#t:WSGroupId">WSGroupId</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-DynamicWorkspaceGroups.html#viewWSGroup" class="link">Source</a></p><div class="doc"><p>View the workspace group with the given name.
</p></div></div><div class="top"><p class="src"><a name="v:promptWSGroupView" class="def">promptWSGroupView</a> :: <a href="XMonad-Prompt.html#t:XPConfig">XPConfig</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</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-DynamicWorkspaceGroups.html#promptWSGroupView" class="link">Source</a></p><div class="doc"><p>Prompt for a workspace group to view.
</p></div></div><div class="top"><p class="src"><a name="v:promptWSGroupAdd" class="def">promptWSGroupAdd</a> :: <a href="XMonad-Prompt.html#t:XPConfig">XPConfig</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</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-DynamicWorkspaceGroups.html#promptWSGroupAdd" class="link">Source</a></p><div class="doc"><p>Prompt for a name for the current workspace group.
</p></div></div><div class="top"><p class="src"><a name="v:promptWSGroupForget" class="def">promptWSGroupForget</a> :: <a href="XMonad-Prompt.html#t:XPConfig">XPConfig</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</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-DynamicWorkspaceGroups.html#promptWSGroupForget" class="link">Source</a></p><div class="doc"><p>Prompt for a workspace group to forget.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:WSGPrompt" class="def">WSGPrompt</a> <a href="src/XMonad-Actions-DynamicWorkspaceGroups.html#WSGPrompt" class="link">Source</a></p><div class="subs instances"><p id="control.i:WSGPrompt" class="caption collapser" onclick="toggleSection('i:WSGPrompt')">Instances</p><div id="section.i:WSGPrompt" class="show"><table><tr><td class="src"><a href="XMonad-Prompt.html#t:XPrompt">XPrompt</a> <a href="XMonad-Actions-DynamicWorkspaceGroups.html#t:WSGPrompt">WSGPrompt</a></td><td class="doc empty"> </td></tr></table></div></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>
