<!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.Groups.Helpers</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-Groups-Helpers.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-Groups-Helpers.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>stable</td></tr><tr><th>Maintainer</th><td>orphaned</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.Groups.Helpers</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Usage
</a><ul><li><a href="#g:2">Layout-generic actions
</a></li><li><a href="#g:3"><code><a href="XMonad-Layout-Groups.html#t:Groups">Groups</a></code>-secific actions
</a></li></ul></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Utility functions for <a href="XMonad-Layout-Groups.html">XMonad.Layout.Groups</a>.
</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:swapUp">swapUp</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:swapDown">swapDown</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:swapMaster">swapMaster</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:focusUp">focusUp</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:focusDown">focusDown</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:focusMaster">focusMaster</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:toggleFocusFloat">toggleFocusFloat</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:swapGroupUp">swapGroupUp</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:swapGroupDown">swapGroupDown</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:swapGroupMaster">swapGroupMaster</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:focusGroupUp">focusGroupUp</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:focusGroupDown">focusGroupDown</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:focusGroupMaster">focusGroupMaster</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:moveToGroupUp">moveToGroupUp</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</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:moveToGroupDown">moveToGroupDown</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</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:moveToNewGroupUp">moveToNewGroupUp</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:moveToNewGroupDown">moveToNewGroupDown</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:splitGroup">splitGroup</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>This module provides helpers functions for use with <a href="XMonad-Layout-Groups.html">XMonad.Layout.Groups</a>-based
layouts. You can use its contents by adding
</p><pre> import XMonad.Layout.Groups.Helpers
</pre><p>to the top of your <code>./.xmonad/xmonad.hs</code>.
</p><p><a href="XMonad-Layout-Groups.html">XMonad.Layout.Groups</a>-based layouts do not have the same notion
of window ordering as the rest of XMonad. For this reason, the usual
ways of reordering windows and moving focus do not work with them.
<a href="XMonad-Layout-Groups.html">XMonad.Layout.Groups</a> provides <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Message">Message</a></code>s that can be used to obtain
the right effect.
</p><p>But what if you want to use both <code><a href="XMonad-Layout-Groups.html#t:Groups">Groups</a></code> and other layouts?
This module provides actions that try to send <code><a href="XMonad-Layout-Groups.html#t:GroupsMessage">GroupsMessage</a></code>s, and
fall back to the classic way if the current layout doesn't hande them.
They are in the section called "Layout-generic actions".
</p><p>The sections "Groups-specific actions" contains actions that don't make
sense for non-<code><a href="XMonad-Layout-Groups.html#t:Groups">Groups</a></code>-based layouts. These are simply wrappers around
the equivalent <code><a href="XMonad-Layout-Groups.html#t:GroupsMessage">GroupsMessage</a></code>s, but are included so you don't have to
write <code>sendMessage $ Modify $ ...</code> everytime.
</p><p>This module exports many operations with the same names as
<code><a href="XMonad-Layout-Groups.html#t:ModifySpec">ModifySpec</a></code>s from <a href="XMonad-Layout-Groups.html">XMonad.Layout.Groups</a>, so if you want
to import both, we suggest to import <a href="XMonad-Layout-Groups.html">XMonad.Layout.Groups</a>
qualified:
</p><pre> import qualified XMonad.Layout.Groups as G
</pre><p>For more information on how to extend your layour hook and key bindings, see
<a href="XMonad-Doc-Extending.html">XMonad.Doc.Extending</a>.
</p></div><h2 id="g:2">Layout-generic actions
</h2><div class="top"><p class="src"><a name="v:swapUp" class="def">swapUp</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-Layout-Groups-Helpers.html#swapUp" class="link">Source</a></p><div class="doc"><p>Swap the focused window with the previous one
</p></div></div><div class="top"><p class="src"><a name="v:swapDown" class="def">swapDown</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-Layout-Groups-Helpers.html#swapDown" class="link">Source</a></p><div class="doc"><p>Swap the focused window with the next one
</p></div></div><div class="top"><p class="src"><a name="v:swapMaster" class="def">swapMaster</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-Layout-Groups-Helpers.html#swapMaster" class="link">Source</a></p><div class="doc"><p>Swap the focused window with the master window
</p></div></div><div class="top"><p class="src"><a name="v:focusUp" class="def">focusUp</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-Layout-Groups-Helpers.html#focusUp" class="link">Source</a></p><div class="doc"><p>If the focused window is floating, focus the next floating
window. otherwise, focus the next non-floating one.
</p></div></div><div class="top"><p class="src"><a name="v:focusDown" class="def">focusDown</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-Layout-Groups-Helpers.html#focusDown" class="link">Source</a></p><div class="doc"><p>If the focused window is floating, focus the next floating
window. otherwise, focus the next non-floating one.
</p></div></div><div class="top"><p class="src"><a name="v:focusMaster" class="def">focusMaster</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-Layout-Groups-Helpers.html#focusMaster" class="link">Source</a></p><div class="doc"><p>Move focus to the master window
</p></div></div><div class="top"><p class="src"><a name="v:toggleFocusFloat" class="def">toggleFocusFloat</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-Layout-Groups-Helpers.html#toggleFocusFloat" class="link">Source</a></p><div class="doc"><p>Move focus between the floating and non-floating layers
</p></div></div><h2 id="g:3"><code><a href="XMonad-Layout-Groups.html#t:Groups">Groups</a></code>-secific actions
</h2><div class="top"><p class="src"><a name="v:swapGroupUp" class="def">swapGroupUp</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-Layout-Groups-Helpers.html#swapGroupUp" class="link">Source</a></p><div class="doc"><p>Swap the focused group with the previous one
</p></div></div><div class="top"><p class="src"><a name="v:swapGroupDown" class="def">swapGroupDown</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-Layout-Groups-Helpers.html#swapGroupDown" class="link">Source</a></p><div class="doc"><p>Swap the focused group with the next one
</p></div></div><div class="top"><p class="src"><a name="v:swapGroupMaster" class="def">swapGroupMaster</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-Layout-Groups-Helpers.html#swapGroupMaster" class="link">Source</a></p><div class="doc"><p>Swap the focused group with the master group
</p></div></div><div class="top"><p class="src"><a name="v:focusGroupUp" class="def">focusGroupUp</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-Layout-Groups-Helpers.html#focusGroupUp" class="link">Source</a></p><div class="doc"><p>Move the focus to the previous group
</p></div></div><div class="top"><p class="src"><a name="v:focusGroupDown" class="def">focusGroupDown</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-Layout-Groups-Helpers.html#focusGroupDown" class="link">Source</a></p><div class="doc"><p>Move the focus to the next group
</p></div></div><div class="top"><p class="src"><a name="v:focusGroupMaster" class="def">focusGroupMaster</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-Layout-Groups-Helpers.html#focusGroupMaster" class="link">Source</a></p><div class="doc"><p>Move the focus to the master group
</p></div></div><div class="top"><p class="src"><a name="v:moveToGroupUp" class="def">moveToGroupUp</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</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-Layout-Groups-Helpers.html#moveToGroupUp" class="link">Source</a></p><div class="doc"><p>Move the focused window to the previous group. The <code><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></code> argument
determines what will be done if the focused window is in the very first
group: Wrap back to the end (<code><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#v:True">True</a></code>), or create a new group before
it (<code><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#v:False">False</a></code>).
</p></div></div><div class="top"><p class="src"><a name="v:moveToGroupDown" class="def">moveToGroupDown</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</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-Layout-Groups-Helpers.html#moveToGroupDown" class="link">Source</a></p><div class="doc"><p>Move the focused window to the next group. The <code><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></code> argument
determines what will be done if the focused window is in the very last
group: Wrap back to the beginning (<code><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#v:True">True</a></code>), or create a new group after
it (<code><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#v:False">False</a></code>).
</p></div></div><div class="top"><p class="src"><a name="v:moveToNewGroupUp" class="def">moveToNewGroupUp</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-Layout-Groups-Helpers.html#moveToNewGroupUp" class="link">Source</a></p><div class="doc"><p>Move the focused window to a new group before the current one
</p></div></div><div class="top"><p class="src"><a name="v:moveToNewGroupDown" class="def">moveToNewGroupDown</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-Layout-Groups-Helpers.html#moveToNewGroupDown" class="link">Source</a></p><div class="doc"><p>Move the focused window to a new group after the current one
</p></div></div><div class="top"><p class="src"><a name="v:splitGroup" class="def">splitGroup</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-Layout-Groups-Helpers.html#splitGroup" class="link">Source</a></p><div class="doc"><p>Split the focused group in two at the position of the focused
window.
</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>
