<?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/Config/Desktop.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# OPTIONS_GHC -fno-warn-missing-signatures #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-4"></a><span class='hs-comment'>-- |</span>
<a name="line-5"></a><span class='hs-comment'>-- Module : XMonad.Config.Desktop</span>
<a name="line-6"></a><span class='hs-comment'>-- Copyright : (c) Spencer Janssen <spencerjanssen@gmail.com></span>
<a name="line-7"></a><span class='hs-comment'>-- License : BSD</span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- Maintainer : Spencer Janssen <spencerjanssen@gmail.com></span>
<a name="line-10"></a><span class='hs-comment'>-- Stability : unstable</span>
<a name="line-11"></a><span class='hs-comment'>-- Portability : unportable</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a><span class='hs-comment'>-- This module provides a config suitable for use with a desktop</span>
<a name="line-14"></a><span class='hs-comment'>-- environment such as KDE or GNOME.</span>
<a name="line-15"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-16"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Config</span><span class='hs-varop'>.</span><span class='hs-conid'>Desktop</span> <span class='hs-layout'>(</span>
<a name="line-17"></a>
<a name="line-18"></a> <span class='hs-comment'>-- | Several basic integration settings are common to all of xmonad's</span>
<a name="line-19"></a> <span class='hs-comment'>-- desktop integration configurations. The specific desktop environment</span>
<a name="line-20"></a> <span class='hs-comment'>-- (DE) modules like "XMonad.Config.Gnome" use this module's</span>
<a name="line-21"></a> <span class='hs-comment'>-- @desktopConfig@ to set up basic communication between xmonad and</span>
<a name="line-22"></a> <span class='hs-comment'>-- the DE via a subset of the Extended Window Manager Hints (EWMH)</span>
<a name="line-23"></a> <span class='hs-comment'>-- specification. Extra xmonad settings unique to specific DE's are</span>
<a name="line-24"></a> <span class='hs-comment'>-- added by overriding or modifying @desktopConfig@ fields in the</span>
<a name="line-25"></a> <span class='hs-comment'>-- same way that @defaultConfig@ is customized in @~\/.xmonad/xmonad.hs@.</span>
<a name="line-26"></a> <span class='hs-comment'>--</span>
<a name="line-27"></a> <span class='hs-comment'>-- For more information about EWMH see:</span>
<a name="line-28"></a> <span class='hs-comment'>--</span>
<a name="line-29"></a> <span class='hs-comment'>-- <<a href="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html">http://standards.freedesktop.org/wm-spec/wm-spec-latest.html</a>></span>
<a name="line-30"></a> <span class='hs-comment'>--</span>
<a name="line-31"></a> <span class='hs-comment'>-- See also: "XMonad.Hooks.EwmhDesktops", "XMonad.Hooks.ManageDocks",</span>
<a name="line-32"></a> <span class='hs-comment'>-- "XMonad.Util.EZConfig".</span>
<a name="line-33"></a>
<a name="line-34"></a> <span class='hs-comment'>-- * Usage</span>
<a name="line-35"></a> <span class='hs-comment'>-- $usage</span>
<a name="line-36"></a>
<a name="line-37"></a> <span class='hs-varid'>desktopConfig</span><span class='hs-layout'>,</span>
<a name="line-38"></a>
<a name="line-39"></a> <span class='hs-comment'>-- * Customizing a desktop config</span>
<a name="line-40"></a> <span class='hs-comment'>-- $customizing</span>
<a name="line-41"></a>
<a name="line-42"></a> <span class='hs-comment'>-- ** Modifying layouts, manageHook, or key bindings</span>
<a name="line-43"></a> <span class='hs-comment'>-- $layouts</span>
<a name="line-44"></a> <span class='hs-varid'>desktopLayoutModifiers</span>
<a name="line-45"></a>
<a name="line-46"></a> <span class='hs-comment'>-- ** Modifying the logHook</span>
<a name="line-47"></a> <span class='hs-comment'>-- $logHook</span>
<a name="line-48"></a>
<a name="line-49"></a> <span class='hs-comment'>-- ** Modifying the handleEventHook</span>
<a name="line-50"></a> <span class='hs-comment'>-- $eventHook</span>
<a name="line-51"></a>
<a name="line-52"></a> <span class='hs-comment'>-- ** Modifying the startupHook</span>
<a name="line-53"></a> <span class='hs-comment'>-- $startupHook</span>
<a name="line-54"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-55"></a>
<a name="line-56"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span>
<a name="line-57"></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'>ManageDocks</span>
<a name="line-58"></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'>EwmhDesktops</span>
<a name="line-59"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Util</span><span class='hs-varop'>.</span><span class='hs-conid'>Cursor</span>
<a name="line-60"></a>
<a name="line-61"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>M</span>
<a name="line-62"></a>
<a name="line-63"></a><span class='hs-comment'>-- $usage</span>
<a name="line-64"></a><span class='hs-comment'>-- While this document describes how to configure xmonad, you also need</span>
<a name="line-65"></a><span class='hs-comment'>-- to set up your Desktop Environment (DE) and display manager to use</span>
<a name="line-66"></a><span class='hs-comment'>-- xmonad as its window manager. For DE and distro specific tips on</span>
<a name="line-67"></a><span class='hs-comment'>-- how to do so, see the xmonad wiki:</span>
<a name="line-68"></a><span class='hs-comment'>--</span>
<a name="line-69"></a><span class='hs-comment'>-- <<a href="http://haskell.org/haskellwiki/Xmonad">http://haskell.org/haskellwiki/Xmonad</a>></span>
<a name="line-70"></a><span class='hs-comment'>--</span>
<a name="line-71"></a><span class='hs-comment'>-- To configure xmonad for use with a DE or with DE tools like panels</span>
<a name="line-72"></a><span class='hs-comment'>-- and pagers, in place of @defaultConfig@ in your @~\/.xmonad/xmonad.hs@,</span>
<a name="line-73"></a><span class='hs-comment'>-- use @desktopConfig@ or one of the other desktop configs from the</span>
<a name="line-74"></a><span class='hs-comment'>-- @XMonad.Config@ namespace. The following setup and customization examples</span>
<a name="line-75"></a><span class='hs-comment'>-- work the same way for the other desktop configs as for @desktopConfig@.</span>
<a name="line-76"></a><span class='hs-comment'>-- If you are using a specific DE config, import its module instead, and</span>
<a name="line-77"></a><span class='hs-comment'>-- use its config in place of @desktopConfig@ in the following examples.</span>
<a name="line-78"></a><span class='hs-comment'>--</span>
<a name="line-79"></a><span class='hs-comment'>-- > import XMonad</span>
<a name="line-80"></a><span class='hs-comment'>-- > import XMonad.Config.Desktop</span>
<a name="line-81"></a><span class='hs-comment'>-- ></span>
<a name="line-82"></a><span class='hs-comment'>-- > main = xmonad desktopConfig</span>
<a name="line-83"></a><span class='hs-comment'>--</span>
<a name="line-84"></a><span class='hs-comment'>-- @desktopConfig@ is an 'XConfig' that configures xmonad to</span>
<a name="line-85"></a><span class='hs-comment'>-- ignore and leave room for dock type windows like panels and trays, adds</span>
<a name="line-86"></a><span class='hs-comment'>-- the default key binding to toggle panel visibility, and activates basic</span>
<a name="line-87"></a><span class='hs-comment'>-- EWMH support. It also sets a prettier root window mouse pointer.</span>
<a name="line-88"></a>
<a name="line-89"></a><span class='hs-comment'>-- $customizing</span>
<a name="line-90"></a><span class='hs-comment'>-- To customize a desktop config, modify its fields as is illustrated with</span>
<a name="line-91"></a><span class='hs-comment'>-- @defaultConfig@ in "XMonad.Doc.Extending#Extending xmonad".</span>
<a name="line-92"></a>
<a name="line-93"></a><span class='hs-comment'>-- $layouts</span>
<a name="line-94"></a><span class='hs-comment'>-- See also "XMonad.Util.EZConfig" for more options for modifying key bindings.</span>
<a name="line-95"></a><span class='hs-comment'>-- To add to layouts, manageHook or key bindings use something like the following</span>
<a name="line-96"></a><span class='hs-comment'>-- to combine your modifications with the desktop config settings:</span>
<a name="line-97"></a><span class='hs-comment'>--</span>
<a name="line-98"></a><span class='hs-comment'>-- > import XMonad</span>
<a name="line-99"></a><span class='hs-comment'>-- > import XMonad.Config.Desktop</span>
<a name="line-100"></a><span class='hs-comment'>-- > import XMonad.Layout.Tabbed</span>
<a name="line-101"></a><span class='hs-comment'>-- > import XMonad.Util.EZConfig (additionalKeys)</span>
<a name="line-102"></a><span class='hs-comment'>-- ></span>
<a name="line-103"></a><span class='hs-comment'>-- > main =</span>
<a name="line-104"></a><span class='hs-comment'>-- > xmonad $ desktopConfig {</span>
<a name="line-105"></a><span class='hs-comment'>-- > -- add manage hooks while still ignoring panels and using default manageHooks</span>
<a name="line-106"></a><span class='hs-comment'>-- > manageHook = myManageHook <+> manageHook desktopConfig</span>
<a name="line-107"></a><span class='hs-comment'>-- ></span>
<a name="line-108"></a><span class='hs-comment'>-- > -- add a fullscreen tabbed layout that does not avoid covering</span>
<a name="line-109"></a><span class='hs-comment'>-- > -- up desktop panels before the desktop layouts</span>
<a name="line-110"></a><span class='hs-comment'>-- > , layoutHook = simpleTabbed ||| layoutHook desktopConfig</span>
<a name="line-111"></a><span class='hs-comment'>-- > }</span>
<a name="line-112"></a><span class='hs-comment'>-- > -- add a screenshot key to the default desktop bindings</span>
<a name="line-113"></a><span class='hs-comment'>-- > `additionalKeys` [ ((mod4Mask, xK_F8), spawn "scrot") ]</span>
<a name="line-114"></a><span class='hs-comment'>--</span>
<a name="line-115"></a><span class='hs-comment'>-- To replace the desktop layouts with your own choices, but still</span>
<a name="line-116"></a><span class='hs-comment'>-- allow toggling panel visibility, use 'desktopLayoutModifiers' to</span>
<a name="line-117"></a><span class='hs-comment'>-- modify your layouts:</span>
<a name="line-118"></a><span class='hs-comment'>--</span>
<a name="line-119"></a><span class='hs-comment'>-- > , layoutHook = desktopLayoutModifiers $ simpleTabbed ||| Tall 1 0.03 0.5</span>
<a name="line-120"></a><span class='hs-comment'>--</span>
<a name="line-121"></a><span class='hs-comment'>-- @desktopLayoutModifiers@ modifies a layout to avoid covering docks, panels,</span>
<a name="line-122"></a><span class='hs-comment'>-- etc. that set the @_NET_WM_STRUT_PARTIAL@ property.</span>
<a name="line-123"></a><span class='hs-comment'>-- See also "XMonad.Hooks.ManageDocks".</span>
<a name="line-124"></a>
<a name="line-125"></a><span class='hs-comment'>-- $logHook</span>
<a name="line-126"></a><span class='hs-comment'>-- To add to the logHook while still sending workspace and window information</span>
<a name="line-127"></a><span class='hs-comment'>-- to DE apps use something like:</span>
<a name="line-128"></a><span class='hs-comment'>--</span>
<a name="line-129"></a><span class='hs-comment'>-- > , logHook = myLogHook <+> logHook desktopConfig</span>
<a name="line-130"></a><span class='hs-comment'>--</span>
<a name="line-131"></a><span class='hs-comment'>-- Or for more elaborate logHooks you can use @do@:</span>
<a name="line-132"></a><span class='hs-comment'>--</span>
<a name="line-133"></a><span class='hs-comment'>-- > , logHook = do</span>
<a name="line-134"></a><span class='hs-comment'>-- > dynamicLogWithPP xmobarPP</span>
<a name="line-135"></a><span class='hs-comment'>-- > updatePointer (Relative 0.9 0.9)</span>
<a name="line-136"></a><span class='hs-comment'>-- > logHook desktopConfig</span>
<a name="line-137"></a><span class='hs-comment'>--</span>
<a name="line-138"></a>
<a name="line-139"></a><span class='hs-comment'>-- $eventHook</span>
<a name="line-140"></a><span class='hs-comment'>-- To customize xmonad's event handling while still having it respond</span>
<a name="line-141"></a><span class='hs-comment'>-- to EWMH events from pagers, task bars:</span>
<a name="line-142"></a><span class='hs-comment'>--</span>
<a name="line-143"></a><span class='hs-comment'>-- > , handleEventHook = myEventHooks <+> handleEventHook desktopConfig</span>
<a name="line-144"></a><span class='hs-comment'>--</span>
<a name="line-145"></a><span class='hs-comment'>-- or 'mconcat' if you write a list event of event hooks</span>
<a name="line-146"></a><span class='hs-comment'>--</span>
<a name="line-147"></a><span class='hs-comment'>-- > , handleEventHook = mconcat</span>
<a name="line-148"></a><span class='hs-comment'>-- > [ myMouseHandler</span>
<a name="line-149"></a><span class='hs-comment'>-- > , myMessageHandler</span>
<a name="line-150"></a><span class='hs-comment'>-- > , handleEventHook desktopConfig ]</span>
<a name="line-151"></a><span class='hs-comment'>--</span>
<a name="line-152"></a><span class='hs-comment'>-- Note that the event hooks are run left to right (in contrast to</span>
<a name="line-153"></a><span class='hs-comment'>-- 'ManageHook'S which are right to left)</span>
<a name="line-154"></a>
<a name="line-155"></a><span class='hs-comment'>-- $startupHook</span>
<a name="line-156"></a><span class='hs-comment'>-- To run the desktop startupHook, plus add further actions to be run each</span>
<a name="line-157"></a><span class='hs-comment'>-- time xmonad starts or restarts, use '<+>' to combine actions as in the</span>
<a name="line-158"></a><span class='hs-comment'>-- logHook example, or something like:</span>
<a name="line-159"></a><span class='hs-comment'>--</span>
<a name="line-160"></a><span class='hs-comment'>-- > , startupHook = do</span>
<a name="line-161"></a><span class='hs-comment'>-- > startupHook desktopConfig</span>
<a name="line-162"></a><span class='hs-comment'>-- > spawn "xmonad-restart.sh"</span>
<a name="line-163"></a><span class='hs-comment'>-- > adjustEventInput</span>
<a name="line-164"></a><span class='hs-comment'>--</span>
<a name="line-165"></a>
<a name="line-166"></a><a name="desktopConfig"></a><span class='hs-definition'>desktopConfig</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ewmh</span> <span class='hs-varid'>defaultConfig</span>
<a name="line-167"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>startupHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>setDefaultCursor</span> <span class='hs-varid'>xC_left_ptr</span>
<a name="line-168"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>layoutHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>desktopLayoutModifiers</span> <span class='hs-varop'>$</span> <span class='hs-varid'>layoutHook</span> <span class='hs-varid'>defaultConfig</span>
<a name="line-169"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>manageHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>manageHook</span> <span class='hs-varid'>defaultConfig</span> <span class='hs-varop'><+></span> <span class='hs-varid'>manageDocks</span>
<a name="line-170"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>keys</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>desktopKeys</span> <span class='hs-varop'><+></span> <span class='hs-varid'>keys</span> <span class='hs-varid'>defaultConfig</span> <span class='hs-layout'>}</span>
<a name="line-171"></a>
<a name="line-172"></a><a name="desktopKeys"></a><span class='hs-definition'>desktopKeys</span> <span class='hs-layout'>(</span><span class='hs-conid'>XConfig</span> <span class='hs-layout'>{</span><span class='hs-varid'>modMask</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>modm</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>M</span><span class='hs-varop'>.</span><span class='hs-varid'>fromList</span> <span class='hs-varop'>$</span>
<a name="line-173"></a> <span class='hs-keyglyph'>[</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>modm</span><span class='hs-layout'>,</span> <span class='hs-varid'>xK_b</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>sendMessage</span> <span class='hs-conid'>ToggleStruts</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>]</span>
<a name="line-174"></a>
<a name="line-175"></a><a name="desktopLayoutModifiers"></a><span class='hs-definition'>desktopLayoutModifiers</span> <span class='hs-varid'>layout</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>avoidStruts</span> <span class='hs-varid'>layout</span>
<a name="line-176"></a>
</pre></body>
</html>
