<!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.Hooks.FloatNext</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-Hooks-FloatNext.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Hooks-FloatNext.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>Quentin Moser <quentin.moser@unifr.ch></td></tr></table><p class="caption">XMonad.Hooks.FloatNext</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">The hook
</a></li><li><a href="#g:3">Actions
</a></li><li><a href="#g:4">Queries
</a></li><li><a href="#g:5"><code>DynamicLog</code> utilities
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Hook and keybindings for automatically sending the next
spawned window(s) to the floating layer.
</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:floatNextHook">floatNextHook</a> :: ManageHook</li><li class="src short"><a href="#v:floatNext">floatNext</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:toggleFloatNext">toggleFloatNext</a> :: X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:floatAllNew">floatAllNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:toggleFloatAllNew">toggleFloatAllNew</a> :: X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:willFloatNext">willFloatNext</a> :: X <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:willFloatAllNew">willFloatAllNew</a> :: X <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:willFloatNextPP">willFloatNextPP</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>) -> X (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</li><li class="src short"><a href="#v:willFloatAllNewPP">willFloatAllNewPP</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>) -> X (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</li><li class="src short"><a href="#v:runLogHook">runLogHook</a> :: X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>This module provides actions (that can be set as keybindings)
to automatically send the next spawned window(s) to the floating
layer.
</p><p>You can use it by including the following in your <code>~/.xmonad/xmonad.hs</code>:
</p><pre> import XMonad.Hooks.FloatNext
</pre><p>and adding <code><a href="XMonad-Hooks-FloatNext.html#v:floatNextHook">floatNextHook</a></code> to your <code>ManageHook</code>:
</p><pre> myManageHook = floatNextHook <+> manageHook defaultConfig
</pre><p>The <code><a href="XMonad-Hooks-FloatNext.html#v:floatNext">floatNext</a></code> and <code><a href="XMonad-Hooks-FloatNext.html#v:toggleFloatNext">toggleFloatNext</a></code> functions can be used in key
bindings to float the next spawned window:
</p><pre> , ((modm, xK_e), toggleFloatNext)
</pre><p><code><a href="XMonad-Hooks-FloatNext.html#v:floatAllNew">floatAllNew</a></code> and <code><a href="XMonad-Hooks-FloatNext.html#v:toggleFloatAllNew">toggleFloatAllNew</a></code> are similar but float all
spawned windows until disabled again.
</p><pre> , ((modm, xK_r), toggleFloatAllNew)
</pre></div><h1 id="g:2">The hook
</h1><div class="top"><p class="src"><a name="v:floatNextHook" class="def">floatNextHook</a> :: ManageHook<a href="src/XMonad-Hooks-FloatNext.html#floatNextHook" class="link">Source</a></p><div class="doc"><p>This <code>ManageHook</code> will selectively float windows as set
by <code><a href="XMonad-Hooks-FloatNext.html#v:floatNext">floatNext</a></code> and <code><a href="XMonad-Hooks-FloatNext.html#v:floatAllNew">floatAllNew</a></code>.
</p></div></div><h1 id="g:3">Actions
</h1><div class="top"><p class="src"><a name="v:floatNext" class="def">floatNext</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Hooks-FloatNext.html#floatNext" class="link">Source</a></p><div class="doc"><p><code>floatNext True</code> arranges for the next spawned window to be
sent to the floating layer, <code>floatNext False</code> cancels it.
</p></div></div><div class="top"><p class="src"><a name="v:toggleFloatNext" class="def">toggleFloatNext</a> :: X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Hooks-FloatNext.html#toggleFloatNext" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:floatAllNew" class="def">floatAllNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Hooks-FloatNext.html#floatAllNew" class="link">Source</a></p><div class="doc"><p><code>floatAllNew True</code> arranges for new windows to be
sent to the floating layer, <code>floatAllNew False</code> cancels it
</p></div></div><div class="top"><p class="src"><a name="v:toggleFloatAllNew" class="def">toggleFloatAllNew</a> :: X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Hooks-FloatNext.html#toggleFloatAllNew" class="link">Source</a></p></div><h1 id="g:4">Queries
</h1><div class="top"><p class="src"><a name="v:willFloatNext" class="def">willFloatNext</a> :: X <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/XMonad-Hooks-FloatNext.html#willFloatNext" class="link">Source</a></p><div class="doc"><p>Whether the next window will be set floating
</p></div></div><div class="top"><p class="src"><a name="v:willFloatAllNew" class="def">willFloatAllNew</a> :: X <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/XMonad-Hooks-FloatNext.html#willFloatAllNew" class="link">Source</a></p><div class="doc"><p>Whether new windows will be set floating
</p></div></div><h1 id="g:5"><code>DynamicLog</code> utilities
</h1><div class="doc"><p>The following functions are used to display the current
state of <code><a href="XMonad-Hooks-FloatNext.html#v:floatNext">floatNext</a></code> and <code><a href="XMonad-Hooks-FloatNext.html#v:floatAllNew">floatAllNew</a></code> in your
<code>XMonad.Hooks.DynamicLog.dynamicLogWithPP</code>.
<code><a href="XMonad-Hooks-FloatNext.html#v:willFloatNextPP">willFloatNextPP</a></code> and <code><a href="XMonad-Hooks-FloatNext.html#v:willFloatAllNewPP">willFloatAllNewPP</a></code> should be added
to the <code>XMonad.Hooks.DynamicLog.ppExtras</code> field of your
<code>XMonad.Hooks.DynamicLog.PP</code>.
</p><p>Use <code><a href="XMonad-Hooks-FloatNext.html#v:runLogHook">runLogHook</a></code> to refresh the output of your <code>logHook</code>, so
that the effects of a <code><a href="XMonad-Hooks-FloatNext.html#v:floatNext">floatNext</a></code>/... will be visible
immediately:
</p><pre> , ((modm, xK_e), toggleFloatNext >> runLogHook)
</pre><p>The <code>String -> String</code> parameters to <code><a href="XMonad-Hooks-FloatNext.html#v:willFloatNextPP">willFloatNextPP</a></code> and
<code><a href="XMonad-Hooks-FloatNext.html#v:willFloatAllNewPP">willFloatAllNewPP</a></code> will be applied to their output, you
can use them to set the text color, etc., or you can just
pass them <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#v:id">id</a></code>.
</p></div><div class="top"><p class="src"><a name="v:willFloatNextPP" class="def">willFloatNextPP</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>) -> X (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)<a href="src/XMonad-Hooks-FloatNext.html#willFloatNextPP" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:willFloatAllNewPP" class="def">willFloatAllNewPP</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>) -> X (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)<a href="src/XMonad-Hooks-FloatNext.html#willFloatAllNewPP" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:runLogHook" class="def">runLogHook</a> :: X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Hooks-FloatNext.html#runLogHook" class="link">Source</a></p></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>
