<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>XMonad/Hooks/FloatNext.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE DeriveDataTypeable #-}</span>
<a name="line-2"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-3"></a><span class='hs-comment'>-- |</span>
<a name="line-4"></a><span class='hs-comment'>-- Module : XMonad.Hooks.FloatNext</span>
<a name="line-5"></a><span class='hs-comment'>-- Copyright : Quentin Moser <moserq@gmail.com></span>
<a name="line-6"></a><span class='hs-comment'>-- License : BSD-style (see LICENSE)</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Maintainer : orphaned</span>
<a name="line-9"></a><span class='hs-comment'>-- Stability : unstable</span>
<a name="line-10"></a><span class='hs-comment'>-- Portability : unportable</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- Hook and keybindings for automatically sending the next</span>
<a name="line-13"></a><span class='hs-comment'>-- spawned window(s) to the floating layer.</span>
<a name="line-14"></a><span class='hs-comment'>--</span>
<a name="line-15"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-16"></a>
<a name="line-17"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Hooks</span><span class='hs-varop'>.</span><span class='hs-conid'>FloatNext</span> <span class='hs-layout'>(</span> <span class='hs-comment'>-- * Usage</span>
<a name="line-18"></a> <span class='hs-comment'>-- $usage</span>
<a name="line-19"></a>
<a name="line-20"></a> <span class='hs-comment'>-- * The hook</span>
<a name="line-21"></a> <span class='hs-varid'>floatNextHook</span>
<a name="line-22"></a>
<a name="line-23"></a> <span class='hs-comment'>-- * Actions</span>
<a name="line-24"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>floatNext</span>
<a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toggleFloatNext</span>
<a name="line-26"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>floatAllNew</span>
<a name="line-27"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toggleFloatAllNew</span>
<a name="line-28"></a>
<a name="line-29"></a> <span class='hs-comment'>-- * Queries</span>
<a name="line-30"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>willFloatNext</span>
<a name="line-31"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>willFloatAllNew</span>
<a name="line-32"></a>
<a name="line-33"></a> <span class='hs-comment'>-- * 'DynamicLog' utilities</span>
<a name="line-34"></a> <span class='hs-comment'>-- $pp</span>
<a name="line-35"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>willFloatNextPP</span>
<a name="line-36"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>willFloatAllNewPP</span>
<a name="line-37"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>runLogHook</span> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-38"></a>
<a name="line-39"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span>
<a name="line-40"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Hooks</span><span class='hs-varop'>.</span><span class='hs-conid'>ToggleHook</span>
<a name="line-41"></a>
<a name="line-42"></a><a name="hookName"></a><span class='hs-definition'>hookName</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span>
<a name="line-43"></a><span class='hs-definition'>hookName</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"__float"</span>
<a name="line-44"></a>
<a name="line-45"></a><span class='hs-comment'>-- $usage</span>
<a name="line-46"></a><span class='hs-comment'>-- This module provides actions (that can be set as keybindings)</span>
<a name="line-47"></a><span class='hs-comment'>-- to automatically send the next spawned window(s) to the floating</span>
<a name="line-48"></a><span class='hs-comment'>-- layer.</span>
<a name="line-49"></a><span class='hs-comment'>--</span>
<a name="line-50"></a><span class='hs-comment'>-- You can use it by including the following in your @~\/.xmonad\/xmonad.hs@:</span>
<a name="line-51"></a><span class='hs-comment'>--</span>
<a name="line-52"></a><span class='hs-comment'>-- > import XMonad.Hooks.FloatNext</span>
<a name="line-53"></a><span class='hs-comment'>--</span>
<a name="line-54"></a><span class='hs-comment'>-- and adding 'floatNextHook' to your 'ManageHook':</span>
<a name="line-55"></a><span class='hs-comment'>--</span>
<a name="line-56"></a><span class='hs-comment'>-- > myManageHook = floatNextHook <+> manageHook defaultConfig</span>
<a name="line-57"></a><span class='hs-comment'>--</span>
<a name="line-58"></a><span class='hs-comment'>-- The 'floatNext' and 'toggleFloatNext' functions can be used in key</span>
<a name="line-59"></a><span class='hs-comment'>-- bindings to float the next spawned window:</span>
<a name="line-60"></a><span class='hs-comment'>--</span>
<a name="line-61"></a><span class='hs-comment'>-- > , ((modm, xK_e), toggleFloatNext)</span>
<a name="line-62"></a><span class='hs-comment'>--</span>
<a name="line-63"></a><span class='hs-comment'>-- 'floatAllNew' and 'toggleFloatAllNew' are similar but float all</span>
<a name="line-64"></a><span class='hs-comment'>-- spawned windows until disabled again.</span>
<a name="line-65"></a><span class='hs-comment'>--</span>
<a name="line-66"></a><span class='hs-comment'>-- > , ((modm, xK_r), toggleFloatAllNew)</span>
<a name="line-67"></a>
<a name="line-68"></a><a name="floatNextHook"></a><span class='hs-comment'>-- | This 'ManageHook' will selectively float windows as set</span>
<a name="line-69"></a><span class='hs-comment'>-- by 'floatNext' and 'floatAllNew'.</span>
<a name="line-70"></a><span class='hs-definition'>floatNextHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ManageHook</span>
<a name="line-71"></a><span class='hs-definition'>floatNextHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>toggleHook</span> <span class='hs-varid'>hookName</span> <span class='hs-varid'>doFloat</span>
<a name="line-72"></a>
<a name="line-73"></a><a name="floatNext"></a><span class='hs-comment'>-- | @floatNext True@ arranges for the next spawned window to be</span>
<a name="line-74"></a><span class='hs-comment'>-- sent to the floating layer, @floatNext False@ cancels it.</span>
<a name="line-75"></a><span class='hs-definition'>floatNext</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-76"></a><span class='hs-definition'>floatNext</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hookNext</span> <span class='hs-varid'>hookName</span>
<a name="line-77"></a>
<a name="line-78"></a><a name="toggleFloatNext"></a><span class='hs-definition'>toggleFloatNext</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-79"></a><span class='hs-definition'>toggleFloatNext</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>toggleHookNext</span> <span class='hs-varid'>hookName</span>
<a name="line-80"></a>
<a name="line-81"></a><a name="floatAllNew"></a><span class='hs-comment'>-- | @floatAllNew True@ arranges for new windows to be</span>
<a name="line-82"></a><span class='hs-comment'>-- sent to the floating layer, @floatAllNew False@ cancels it</span>
<a name="line-83"></a><span class='hs-definition'>floatAllNew</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-84"></a><span class='hs-definition'>floatAllNew</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hookAllNew</span> <span class='hs-varid'>hookName</span>
<a name="line-85"></a>
<a name="line-86"></a><a name="toggleFloatAllNew"></a><span class='hs-definition'>toggleFloatAllNew</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-87"></a><span class='hs-definition'>toggleFloatAllNew</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>toggleHookAllNew</span> <span class='hs-varid'>hookName</span>
<a name="line-88"></a>
<a name="line-89"></a><a name="willFloatNext"></a><span class='hs-comment'>-- | Whether the next window will be set floating</span>
<a name="line-90"></a><span class='hs-definition'>willFloatNext</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>X</span> <span class='hs-conid'>Bool</span>
<a name="line-91"></a><span class='hs-definition'>willFloatNext</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>willHookNext</span> <span class='hs-varid'>hookName</span>
<a name="line-92"></a>
<a name="line-93"></a><a name="willFloatAllNew"></a><span class='hs-comment'>-- | Whether new windows will be set floating</span>
<a name="line-94"></a><span class='hs-definition'>willFloatAllNew</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>X</span> <span class='hs-conid'>Bool</span>
<a name="line-95"></a><span class='hs-definition'>willFloatAllNew</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>willHookAllNew</span> <span class='hs-varid'>hookName</span>
<a name="line-96"></a>
<a name="line-97"></a><span class='hs-comment'>-- $pp</span>
<a name="line-98"></a><span class='hs-comment'>-- The following functions are used to display the current</span>
<a name="line-99"></a><span class='hs-comment'>-- state of 'floatNext' and 'floatAllNew' in your</span>
<a name="line-100"></a><span class='hs-comment'>-- 'XMonad.Hooks.DynamicLog.dynamicLogWithPP'.</span>
<a name="line-101"></a><span class='hs-comment'>-- 'willFloatNextPP' and 'willFloatAllNewPP' should be added</span>
<a name="line-102"></a><span class='hs-comment'>-- to the 'XMonad.Hooks.DynamicLog.ppExtras' field of your</span>
<a name="line-103"></a><span class='hs-comment'>-- 'XMonad.Hooks.DynamicLog.PP'.</span>
<a name="line-104"></a><span class='hs-comment'>--</span>
<a name="line-105"></a><span class='hs-comment'>-- Use 'runLogHook' to refresh the output of your 'logHook', so</span>
<a name="line-106"></a><span class='hs-comment'>-- that the effects of a 'floatNext'/... will be visible</span>
<a name="line-107"></a><span class='hs-comment'>-- immediately:</span>
<a name="line-108"></a><span class='hs-comment'>--</span>
<a name="line-109"></a><span class='hs-comment'>-- > , ((modm, xK_e), toggleFloatNext >> runLogHook)</span>
<a name="line-110"></a><span class='hs-comment'>--</span>
<a name="line-111"></a><span class='hs-comment'>-- The @String -> String@ parameters to 'willFloatNextPP' and</span>
<a name="line-112"></a><span class='hs-comment'>-- 'willFloatAllNewPP' will be applied to their output, you</span>
<a name="line-113"></a><span class='hs-comment'>-- can use them to set the text color, etc., or you can just</span>
<a name="line-114"></a><span class='hs-comment'>-- pass them 'id'.</span>
<a name="line-115"></a>
<a name="line-116"></a><a name="willFloatNextPP"></a><span class='hs-definition'>willFloatNextPP</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span>
<a name="line-117"></a><span class='hs-definition'>willFloatNextPP</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>willHookNextPP</span> <span class='hs-varid'>hookName</span>
<a name="line-118"></a>
<a name="line-119"></a><a name="willFloatAllNewPP"></a><span class='hs-definition'>willFloatAllNewPP</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span>
<a name="line-120"></a><span class='hs-definition'>willFloatAllNewPP</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>willHookAllNewPP</span> <span class='hs-varid'>hookName</span>
</pre></body>
</html>
