<?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/Layout/Minimize.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE MultiParamTypeClasses, DeriveDataTypeable, TypeSynonymInstances, FlexibleContexts #-}</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.Layout.Minimize</span>
<a name="line-5"></a><span class='hs-comment'>-- Copyright : (c) Jan Vornberger 2009</span>
<a name="line-6"></a><span class='hs-comment'>-- License : BSD3-style (see LICENSE)</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Maintainer : jan.vornberger@informatik.uni-oldenburg.de</span>
<a name="line-9"></a><span class='hs-comment'>-- Stability : unstable</span>
<a name="line-10"></a><span class='hs-comment'>-- Portability : not portable</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- Makes it possible to minimize windows, temporarily removing them</span>
<a name="line-13"></a><span class='hs-comment'>-- from the layout until they are restored.</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'>Layout</span><span class='hs-varop'>.</span><span class='hs-conid'>Minimize</span> <span class='hs-layout'>(</span>
<a name="line-18"></a> <span class='hs-comment'>-- * Usage</span>
<a name="line-19"></a> <span class='hs-comment'>-- $usage</span>
<a name="line-20"></a> <span class='hs-varid'>minimize</span><span class='hs-layout'>,</span>
<a name="line-21"></a> <span class='hs-conid'>MinimizeMsg</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-22"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-23"></a>
<a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>StackSet</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>W</span>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Layout</span><span class='hs-varop'>.</span><span class='hs-conid'>LayoutModifier</span>
<a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Layout</span><span class='hs-varop'>.</span><span class='hs-conid'>BoringWindows</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>BW</span>
<a name="line-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>List</span>
<a name="line-29"></a>
<a name="line-30"></a><span class='hs-comment'>-- $usage</span>
<a name="line-31"></a><span class='hs-comment'>-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:</span>
<a name="line-32"></a><span class='hs-comment'>--</span>
<a name="line-33"></a><span class='hs-comment'>-- > import XMonad.Layout.Minimize</span>
<a name="line-34"></a><span class='hs-comment'>--</span>
<a name="line-35"></a><span class='hs-comment'>-- Then edit your @layoutHook@ by adding the Minimize layout modifier:</span>
<a name="line-36"></a><span class='hs-comment'>--</span>
<a name="line-37"></a><span class='hs-comment'>-- > myLayout = minimize (Tall 1 (3/100) (1/2)) ||| Full ||| etc..</span>
<a name="line-38"></a><span class='hs-comment'>-- > main = xmonad defaultConfig { layoutHook = myLayout }</span>
<a name="line-39"></a><span class='hs-comment'>--</span>
<a name="line-40"></a><span class='hs-comment'>-- For more detailed instructions on editing the layoutHook see:</span>
<a name="line-41"></a><span class='hs-comment'>--</span>
<a name="line-42"></a><span class='hs-comment'>-- "XMonad.Doc.Extending#Editing_the_layout_hook"</span>
<a name="line-43"></a><span class='hs-comment'>--</span>
<a name="line-44"></a><span class='hs-comment'>-- In the key-bindings, do something like:</span>
<a name="line-45"></a><span class='hs-comment'>--</span>
<a name="line-46"></a><span class='hs-comment'>-- > , ((modm, xK_m ), withFocused (\f -> sendMessage (MinimizeWin f)))</span>
<a name="line-47"></a><span class='hs-comment'>-- > , ((modm .|. shiftMask, xK_m ), sendMessage RestoreNextMinimizedWin)</span>
<a name="line-48"></a><span class='hs-comment'>--</span>
<a name="line-49"></a><span class='hs-comment'>-- The first action will minimize the focused window, while the second one will restore</span>
<a name="line-50"></a><span class='hs-comment'>-- the next minimized window.</span>
<a name="line-51"></a><span class='hs-comment'>--</span>
<a name="line-52"></a><span class='hs-comment'>-- For detailed instruction on editing the key binding see:</span>
<a name="line-53"></a><span class='hs-comment'>--</span>
<a name="line-54"></a><span class='hs-comment'>-- "XMonad.Doc.Extending#Editing_key_bindings".</span>
<a name="line-55"></a><span class='hs-comment'>--</span>
<a name="line-56"></a><span class='hs-comment'>-- The module is designed to work together with "XMonad.Layout.BoringWindows" so</span>
<a name="line-57"></a><span class='hs-comment'>-- that minimized windows will be skipped when switching the focus window with</span>
<a name="line-58"></a><span class='hs-comment'>-- the keyboard. Use the 'BW.boringAuto' function.</span>
<a name="line-59"></a><span class='hs-comment'>--</span>
<a name="line-60"></a><span class='hs-comment'>-- Also see "XMonad.Hooks.RestoreMinimized" if you want to be able to restore</span>
<a name="line-61"></a><span class='hs-comment'>-- minimized windows from your taskbar.</span>
<a name="line-62"></a>
<a name="line-63"></a><a name="Minimize"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Minimize</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Minimize</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Window</span><span class='hs-keyglyph'>]</span> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span> <span class='hs-conid'>Read</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-layout'>)</span>
<a name="line-64"></a><a name="minimize"></a><span class='hs-definition'>minimize</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>LayoutClass</span> <span class='hs-varid'>l</span> <span class='hs-conid'>Window</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>l</span> <span class='hs-conid'>Window</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ModifiedLayout</span> <span class='hs-conid'>Minimize</span> <span class='hs-varid'>l</span> <span class='hs-conid'>Window</span>
<a name="line-65"></a><span class='hs-definition'>minimize</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ModifiedLayout</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Minimize</span> <span class='hs-conid'>[]</span>
<a name="line-66"></a>
<a name="line-67"></a><a name="MinimizeMsg"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>MinimizeMsg</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>MinimizeWin</span> <span class='hs-conid'>Window</span>
<a name="line-68"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>RestoreMinimizedWin</span> <span class='hs-conid'>Window</span>
<a name="line-69"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>RestoreNextMinimizedWin</span>
<a name="line-70"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Typeable</span><span class='hs-layout'>,</span> <span class='hs-conid'>Eq</span><span class='hs-layout'>)</span>
<a name="line-71"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Message</span> <span class='hs-conid'>MinimizeMsg</span>
<a name="line-72"></a>
<a name="line-73"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>LayoutModifier</span> <span class='hs-conid'>Minimize</span> <span class='hs-conid'>Window</span> <span class='hs-keyword'>where</span>
<a name="line-74"></a> <span class='hs-varid'>modifierDescription</span> <span class='hs-layout'>(</span><span class='hs-conid'>Minimize</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"Minimize"</span>
<a name="line-75"></a>
<a name="line-76"></a> <span class='hs-varid'>modifyLayout</span> <span class='hs-layout'>(</span><span class='hs-conid'>Minimize</span> <span class='hs-varid'>minimized</span><span class='hs-layout'>)</span> <span class='hs-varid'>wksp</span> <span class='hs-varid'>rect</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-77"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>stack</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>stack</span> <span class='hs-varid'>wksp</span>
<a name="line-78"></a> <span class='hs-varid'>filtStack</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>stack</span> <span class='hs-varop'>>>=</span><span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>filter</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>w</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>not</span> <span class='hs-layout'>(</span><span class='hs-varid'>w</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>minimized</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-79"></a> <span class='hs-varid'>runLayout</span> <span class='hs-layout'>(</span><span class='hs-varid'>wksp</span> <span class='hs-layout'>{</span><span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>stack</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filtStack</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span> <span class='hs-varid'>rect</span>
<a name="line-80"></a>
<a name="line-81"></a> <span class='hs-varid'>handleMess</span> <span class='hs-layout'>(</span><span class='hs-conid'>Minimize</span> <span class='hs-varid'>minimized</span><span class='hs-layout'>)</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>fromMessage</span> <span class='hs-varid'>m</span> <span class='hs-keyword'>of</span>
<a name="line-82"></a> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-conid'>MinimizeWin</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span>
<a name="line-83"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>not</span> <span class='hs-layout'>(</span><span class='hs-varid'>w</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>minimized</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-84"></a> <span class='hs-conid'>BW</span><span class='hs-varop'>.</span><span class='hs-varid'>focusDown</span>
<a name="line-85"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Minimize</span> <span class='hs-layout'>(</span><span class='hs-varid'>w</span><span class='hs-conop'>:</span><span class='hs-varid'>minimized</span><span class='hs-layout'>)</span>
<a name="line-86"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-87"></a> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-conid'>RestoreMinimizedWin</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span>
<a name="line-88"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Minimize</span> <span class='hs-layout'>(</span><span class='hs-varid'>minimized</span> <span class='hs-varop'>\\</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>w</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-89"></a> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-conid'>RestoreNextMinimizedWin</span><span class='hs-layout'>)</span>
<a name="line-90"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>not</span> <span class='hs-layout'>(</span><span class='hs-varid'>null</span> <span class='hs-varid'>minimized</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-91"></a> <span class='hs-varid'>focus</span> <span class='hs-layout'>(</span><span class='hs-varid'>head</span> <span class='hs-varid'>minimized</span><span class='hs-layout'>)</span>
<a name="line-92"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Minimize</span> <span class='hs-layout'>(</span><span class='hs-varid'>tail</span> <span class='hs-varid'>minimized</span><span class='hs-layout'>)</span>
<a name="line-93"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-94"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
</pre></body>
</html>
