<!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.WorkspaceNames</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-WorkspaceNames.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Actions-WorkspaceNames.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>Tomas Janousek <tomi@nomi.cz></td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Actions.WorkspaceNames</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">Workspace naming
</a></li><li><a href="#g:3">Workspace swapping
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Provides bindings to rename workspaces, show these names in DynamicLog and
swap workspaces along with their names. These names survive restart.
Together with <a href="XMonad-Layout-WorkspaceDir.html">XMonad.Layout.WorkspaceDir</a> this provides for a fully
dynamic topic space workflow.
</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:renameWorkspace">renameWorkspace</a> :: <a href="XMonad-Prompt.html#t:XPConfig">XPConfig</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:workspaceNamesPP">workspaceNamesPP</a> :: <a href="XMonad-Hooks-DynamicLog.html#t:PP">PP</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Hooks-DynamicLog.html#t:PP">PP</a></li><li class="src short"><a href="#v:getWorkspaceNames">getWorkspaceNames</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/xmonad-0.11/XMonad-Core.html#t:WorkspaceId">WorkspaceId</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:setWorkspaceName">setWorkspaceName</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/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:setCurrentWorkspaceName">setCurrentWorkspaceName</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:swapTo">swapTo</a> :: <a href="XMonad-Util-Types.html#t:Direction1D">Direction1D</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:swapTo-39-">swapTo'</a> :: <a href="XMonad-Util-Types.html#t:Direction1D">Direction1D</a> -> <a href="XMonad-Actions-CycleWS.html#t:WSType">WSType</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:swapWithCurrent">swapWithCurrent</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></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.WorkspaceNames
</pre><p>Then add keybindings like the following:
</p><pre> , ((modm .|. shiftMask, xK_r ), renameWorkspace defaultXPConfig)
</pre><p>and apply workspaceNamesPP to your DynamicLog pretty-printer:
</p><pre> myLogHook =
workspaceNamesPP xmobarPP >>= dynamicLogString >>= xmonadPropLog
</pre><p>We also provide a modification of <a href="XMonad-Actions-SwapWorkspaces.html">XMonad.Actions.SwapWorkspaces</a>'s
functionality, which may be used this way:
</p><pre> , ((modMask .|. shiftMask, xK_Left ), swapTo Prev)
, ((modMask .|. shiftMask, xK_Right ), swapTo Next)
</pre><pre> [((modm .|. controlMask, k), swapWithCurrent i)
| (i, k) <- zip workspaces [xK_1 ..]]
</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">Workspace naming
</h1><div class="top"><p class="src"><a name="v:renameWorkspace" class="def">renameWorkspace</a> :: <a href="XMonad-Prompt.html#t:XPConfig">XPConfig</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-WorkspaceNames.html#renameWorkspace" class="link">Source</a></p><div class="doc"><p>Prompt for a new name for the current workspace and set it.
</p></div></div><div class="top"><p class="src"><a name="v:workspaceNamesPP" class="def">workspaceNamesPP</a> :: <a href="XMonad-Hooks-DynamicLog.html#t:PP">PP</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Hooks-DynamicLog.html#t:PP">PP</a><a href="src/XMonad-Actions-WorkspaceNames.html#workspaceNamesPP" class="link">Source</a></p><div class="doc"><p>Modify <a href="XMonad-Hooks-DynamicLog.html">XMonad.Hooks.DynamicLog</a>'s pretty-printing format to show
workspace names as well.
</p></div></div><div class="top"><p class="src"><a name="v:getWorkspaceNames" class="def">getWorkspaceNames</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/xmonad-0.11/XMonad-Core.html#t:WorkspaceId">WorkspaceId</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-WorkspaceNames.html#getWorkspaceNames" class="link">Source</a></p><div class="doc"><p>Returns a function that maps workspace tag <code>"t"</code> to <code>"t:name"</code> for
workspaces with a name, and to <code>"t"</code> otherwise.
</p></div></div><div class="top"><p class="src"><a name="v:setWorkspaceName" class="def">setWorkspaceName</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/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-WorkspaceNames.html#setWorkspaceName" class="link">Source</a></p><div class="doc"><p>Sets the name of a workspace. Empty string makes the workspace unnamed
again.
</p></div></div><div class="top"><p class="src"><a name="v:setCurrentWorkspaceName" class="def">setCurrentWorkspaceName</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-WorkspaceNames.html#setCurrentWorkspaceName" class="link">Source</a></p><div class="doc"><p>Sets the name of the current workspace. See <code><a href="XMonad-Actions-WorkspaceNames.html#v:setWorkspaceName">setWorkspaceName</a></code>.
</p></div></div><h1 id="g:3">Workspace swapping
</h1><div class="top"><p class="src"><a name="v:swapTo" class="def">swapTo</a> :: <a href="XMonad-Util-Types.html#t:Direction1D">Direction1D</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-WorkspaceNames.html#swapTo" class="link">Source</a></p><div class="doc"><p>See <code><a href="XMonad-Actions-SwapWorkspaces.html#v:swapTo">swapTo</a></code>. This is the same with names.
</p></div></div><div class="top"><p class="src"><a name="v:swapTo-39-" class="def">swapTo'</a> :: <a href="XMonad-Util-Types.html#t:Direction1D">Direction1D</a> -> <a href="XMonad-Actions-CycleWS.html#t:WSType">WSType</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-WorkspaceNames.html#swapTo%27" class="link">Source</a></p><div class="doc"><p>Swap with the previous or next workspace of the given type.
</p></div></div><div class="top"><p class="src"><a name="v:swapWithCurrent" class="def">swapWithCurrent</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-WorkspaceNames.html#swapWithCurrent" class="link">Source</a></p><div class="doc"><p>See <code><a href="XMonad-Actions-SwapWorkspaces.html#v:swapWithCurrent">swapWithCurrent</a></code>. This is almost the
same with names.
</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>
