<!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.Layout.PerWorkspace</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-Layout-PerWorkspace.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-PerWorkspace.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.9.2: 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><byorgey@gmail.com></td></tr></table><p class="caption">XMonad.Layout.PerWorkspace</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>Configure layouts on a per-workspace basis: use layouts and apply
layout modifiers selectively, depending on the workspace.
</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">data</span> <a href="#t:PerWorkspace">PerWorkspace</a> l1 l2 a</li><li class="src short"><a href="#v:onWorkspace">onWorkspace</a> :: (LayoutClass l1 a, LayoutClass l2 a) => WorkspaceId -> l1 a -> l2 a -> <a href="XMonad-Layout-PerWorkspace.html#t:PerWorkspace">PerWorkspace</a> l1 l2 a</li><li class="src short"><a href="#v:onWorkspaces">onWorkspaces</a> :: (LayoutClass l1 a, LayoutClass l2 a) => [WorkspaceId] -> l1 a -> l2 a -> <a href="XMonad-Layout-PerWorkspace.html#t:PerWorkspace">PerWorkspace</a> l1 l2 a</li><li class="src short"><a href="#v:modWorkspace">modWorkspace</a> :: LayoutClass l a => WorkspaceId -> (l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> lm l a) -> l a -> <a href="XMonad-Layout-PerWorkspace.html#t:PerWorkspace">PerWorkspace</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> lm l) l a</li><li class="src short"><a href="#v:modWorkspaces">modWorkspaces</a> :: LayoutClass l a => [WorkspaceId] -> (l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> lm l a) -> l a -> <a href="XMonad-Layout-PerWorkspace.html#t:PerWorkspace">PerWorkspace</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> lm l) l 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.Layout.PerWorkspace
</pre><p>and modifying your layoutHook as follows (for example):
</p><pre> layoutHook = modWorkspace "baz" m1 $ -- apply layout modifier m1 to all layouts on workspace "baz"
onWorkspace "foo" l1 $ -- layout l1 will be used on workspace "foo".
onWorkspaces ["bar","6"] l2 $ -- layout l2 will be used on workspaces "bar" and "6".
l3 -- layout l3 will be used on all other workspaces.
</pre><p>Note that <code>l1</code>, <code>l2</code>, and <code>l3</code> can be arbitrarily complicated
layouts, e.g. <code>(Full ||| smartBorders $ tabbed shrinkText
defaultTConf ||| ...)</code>, and <code>m1</code> can be any layout modifier, i.e. a
function of type <code>(l a -> ModifiedLayout lm l a)</code>.
</p><p>In another scenario, suppose you wanted to have layouts A, B, and C
available on all workspaces, except that on workspace foo you want
layout D instead of C. You could do that as follows:
</p><pre> layoutHook = A ||| B ||| onWorkspace "foo" D C
</pre></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:PerWorkspace" class="def">PerWorkspace</a> l1 l2 a <a href="src/XMonad-Layout-PerWorkspace.html#PerWorkspace" class="link">Source</a></p><div class="doc"><p>Structure for representing a workspace-specific layout along with
a layout for all other workspaces. We store the tags of workspaces
to be matched, and the two layouts. We save the layout choice in
the Bool, to be used to implement description.
</p></div><div class="subs instances"><p id="control.i:PerWorkspace" class="caption collapser" onclick="toggleSection('i:PerWorkspace')">Instances</p><div id="section.i:PerWorkspace" class="show"><table><tr><td class="src">(LayoutClass l1 a, LayoutClass l2 a, <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> a) => LayoutClass (<a href="XMonad-Layout-PerWorkspace.html#t:PerWorkspace">PerWorkspace</a> l1 l2) a</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> (l1 a), <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> (l2 a)) => <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-PerWorkspace.html#t:PerWorkspace">PerWorkspace</a> l1 l2 a)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> (l1 a), <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> (l2 a)) => <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-PerWorkspace.html#t:PerWorkspace">PerWorkspace</a> l1 l2 a)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:onWorkspace" class="def">onWorkspace</a><a href="src/XMonad-Layout-PerWorkspace.html#onWorkspace" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (LayoutClass l1 a, LayoutClass l2 a)</td><td class="doc empty"> </td></tr><tr><td class="src">=> WorkspaceId</td><td class="doc"><p>the tag of the workspace to match
</p></td></tr><tr><td class="src">-> l1 a</td><td class="doc"><p>layout to use on the matched workspace
</p></td></tr><tr><td class="src">-> l2 a</td><td class="doc"><p>layout to use everywhere else
</p></td></tr><tr><td class="src">-> <a href="XMonad-Layout-PerWorkspace.html#t:PerWorkspace">PerWorkspace</a> l1 l2 a</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Specify one layout to use on a particular workspace, and another
to use on all others. The second layout can be another call to
<code><a href="XMonad-Layout-PerWorkspace.html#v:onWorkspace">onWorkspace</a></code>, and so on.
</p></div></div><div class="top"><p class="src"><a name="v:onWorkspaces" class="def">onWorkspaces</a><a href="src/XMonad-Layout-PerWorkspace.html#onWorkspaces" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (LayoutClass l1 a, LayoutClass l2 a)</td><td class="doc empty"> </td></tr><tr><td class="src">=> [WorkspaceId]</td><td class="doc"><p>tags of workspaces to match
</p></td></tr><tr><td class="src">-> l1 a</td><td class="doc"><p>layout to use on matched workspaces
</p></td></tr><tr><td class="src">-> l2 a</td><td class="doc"><p>layout to use everywhere else
</p></td></tr><tr><td class="src">-> <a href="XMonad-Layout-PerWorkspace.html#t:PerWorkspace">PerWorkspace</a> l1 l2 a</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Specify one layout to use on a particular set of workspaces, and
another to use on all other workspaces.
</p></div></div><div class="top"><p class="src"><a name="v:modWorkspace" class="def">modWorkspace</a><a href="src/XMonad-Layout-PerWorkspace.html#modWorkspace" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: LayoutClass l a</td><td class="doc empty"> </td></tr><tr><td class="src">=> WorkspaceId</td><td class="doc"><p>tag of the workspace to match
</p></td></tr><tr><td class="src">-> (l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> lm l a)</td><td class="doc"><p>the modifier to apply on the matching workspace
</p></td></tr><tr><td class="src">-> l a</td><td class="doc"><p>the base layout
</p></td></tr><tr><td class="src">-> <a href="XMonad-Layout-PerWorkspace.html#t:PerWorkspace">PerWorkspace</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> lm l) l a</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Specify a layout modifier to apply to a particular workspace; layouts
on all other workspaces will remain unmodified.
</p></div></div><div class="top"><p class="src"><a name="v:modWorkspaces" class="def">modWorkspaces</a><a href="src/XMonad-Layout-PerWorkspace.html#modWorkspaces" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: LayoutClass l a</td><td class="doc empty"> </td></tr><tr><td class="src">=> [WorkspaceId]</td><td class="doc"><p>tags of the workspaces to match
</p></td></tr><tr><td class="src">-> (l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> lm l a)</td><td class="doc"><p>the modifier to apply on the matching workspaces
</p></td></tr><tr><td class="src">-> l a</td><td class="doc"><p>the base layout
</p></td></tr><tr><td class="src">-> <a href="XMonad-Layout-PerWorkspace.html#t:PerWorkspace">PerWorkspace</a> (<a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> lm l) l a</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Specify a layout modifier to apply to a particular set of
workspaces; layouts on all other workspaces will remain
unmodified.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
