<!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.Util.WorkspaceCompare</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-Util-WorkspaceCompare.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Util-WorkspaceCompare.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>Spencer Janssen <spencerjanssen@gmail.com></td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Util.WorkspaceCompare</p></div><div id="description"><p class="caption">Description</p><div class="doc empty"> </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:WorkspaceCompare">WorkspaceCompare</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="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ordering">Ordering</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:WorkspaceSort">WorkspaceSort</a> = [<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSpace">WindowSpace</a>] -> [<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSpace">WindowSpace</a>]</li><li class="src short"><a href="#v:getWsIndex">getWsIndex</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-Maybe.html#t:Maybe">Maybe</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:getWsCompare">getWsCompare</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceCompare">WorkspaceCompare</a></li><li class="src short"><a href="#v:getWsCompareByTag">getWsCompareByTag</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceCompare">WorkspaceCompare</a></li><li class="src short"><a href="#v:getXineramaPhysicalWsCompare">getXineramaPhysicalWsCompare</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceCompare">WorkspaceCompare</a></li><li class="src short"><a href="#v:getXineramaWsCompare">getXineramaWsCompare</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceCompare">WorkspaceCompare</a></li><li class="src short"><a href="#v:mkWsSort">mkWsSort</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceCompare">WorkspaceCompare</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceSort">WorkspaceSort</a></li><li class="src short"><a href="#v:getSortByIndex">getSortByIndex</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceSort">WorkspaceSort</a></li><li class="src short"><a href="#v:getSortByTag">getSortByTag</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceSort">WorkspaceSort</a></li><li class="src short"><a href="#v:getSortByXineramaPhysicalRule">getSortByXineramaPhysicalRule</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceSort">WorkspaceSort</a></li><li class="src short"><a href="#v:getSortByXineramaRule">getSortByXineramaRule</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceSort">WorkspaceSort</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:WorkspaceCompare" class="def">WorkspaceCompare</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="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ordering">Ordering</a><a href="src/XMonad-Util-WorkspaceCompare.html#WorkspaceCompare" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:WorkspaceSort" class="def">WorkspaceSort</a> = [<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSpace">WindowSpace</a>] -> [<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSpace">WindowSpace</a>]<a href="src/XMonad-Util-WorkspaceCompare.html#WorkspaceSort" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:getWsIndex" class="def">getWsIndex</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-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a>)<a href="src/XMonad-Util-WorkspaceCompare.html#getWsIndex" class="link">Source</a></p><div class="doc"><p>Lookup the index of a workspace id in the user's config, return Nothing
if that workspace does not exist in the config.
</p></div></div><div class="top"><p class="src"><a name="v:getWsCompare" class="def">getWsCompare</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceCompare">WorkspaceCompare</a><a href="src/XMonad-Util-WorkspaceCompare.html#getWsCompare" class="link">Source</a></p><div class="doc"><p>A comparison function for WorkspaceId, based on the index of the
tags in the user's config.
</p></div></div><div class="top"><p class="src"><a name="v:getWsCompareByTag" class="def">getWsCompareByTag</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceCompare">WorkspaceCompare</a><a href="src/XMonad-Util-WorkspaceCompare.html#getWsCompareByTag" class="link">Source</a></p><div class="doc"><p>A simple comparison function that orders workspaces
lexicographically by tag.
</p></div></div><div class="top"><p class="src"><a name="v:getXineramaPhysicalWsCompare" class="def">getXineramaPhysicalWsCompare</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceCompare">WorkspaceCompare</a><a href="src/XMonad-Util-WorkspaceCompare.html#getXineramaPhysicalWsCompare" class="link">Source</a></p><div class="doc"><p>A comparison function like <code><a href="XMonad-Util-WorkspaceCompare.html#v:getXineramaWsCompare">getXineramaWsCompare</a></code>, but uses physical locations for screens.
</p></div></div><div class="top"><p class="src"><a name="v:getXineramaWsCompare" class="def">getXineramaWsCompare</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceCompare">WorkspaceCompare</a><a href="src/XMonad-Util-WorkspaceCompare.html#getXineramaWsCompare" class="link">Source</a></p><div class="doc"><p>A comparison function for Xinerama based on visibility, workspace
and screen id. It produces the same ordering as
<code><a href="XMonad-Hooks-DynamicLog.html#v:pprWindowSetXinerama">pprWindowSetXinerama</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:mkWsSort" class="def">mkWsSort</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceCompare">WorkspaceCompare</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceSort">WorkspaceSort</a><a href="src/XMonad-Util-WorkspaceCompare.html#mkWsSort" class="link">Source</a></p><div class="doc"><p>Create a workspace sorting function from a workspace comparison
function.
</p></div></div><div class="top"><p class="src"><a name="v:getSortByIndex" class="def">getSortByIndex</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceSort">WorkspaceSort</a><a href="src/XMonad-Util-WorkspaceCompare.html#getSortByIndex" class="link">Source</a></p><div class="doc"><p>Sort several workspaces according to their tags' indices in the
user's config.
</p></div></div><div class="top"><p class="src"><a name="v:getSortByTag" class="def">getSortByTag</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceSort">WorkspaceSort</a><a href="src/XMonad-Util-WorkspaceCompare.html#getSortByTag" class="link">Source</a></p><div class="doc"><p>Sort workspaces lexicographically by tag.
</p></div></div><div class="top"><p class="src"><a name="v:getSortByXineramaPhysicalRule" class="def">getSortByXineramaPhysicalRule</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceSort">WorkspaceSort</a><a href="src/XMonad-Util-WorkspaceCompare.html#getSortByXineramaPhysicalRule" class="link">Source</a></p><div class="doc"><p>Like <code><a href="XMonad-Util-WorkspaceCompare.html#v:getSortByXineramaRule">getSortByXineramaRule</a></code>, but uses physical locations for screens.
</p></div></div><div class="top"><p class="src"><a name="v:getSortByXineramaRule" class="def">getSortByXineramaRule</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="XMonad-Util-WorkspaceCompare.html#t:WorkspaceSort">WorkspaceSort</a><a href="src/XMonad-Util-WorkspaceCompare.html#getSortByXineramaRule" class="link">Source</a></p><div class="doc"><p>Sort serveral workspaces for xinerama displays, in the same order
produced by <code><a href="XMonad-Hooks-DynamicLog.html#v:pprWindowSetXinerama">pprWindowSetXinerama</a></code>: first
visible workspaces, sorted by screen, then hidden workspaces,
sorted by tag.
</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>
