<?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/Util/Scratchpad.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span> <a name="line-2"></a><span class='hs-comment'>-- |</span> <a name="line-3"></a><span class='hs-comment'>-- Module : XMonad.Util.Scratchpad</span> <a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Braden Shepherdson 2008</span> <a name="line-5"></a><span class='hs-comment'>-- License : BSD-style (as xmonad)</span> <a name="line-6"></a><span class='hs-comment'>--</span> <a name="line-7"></a><span class='hs-comment'>-- Maintainer : Braden.Shepherdson@gmail.com</span> <a name="line-8"></a><span class='hs-comment'>-- Stability : unstable</span> <a name="line-9"></a><span class='hs-comment'>-- Portability : unportable</span> <a name="line-10"></a><span class='hs-comment'>--</span> <a name="line-11"></a><span class='hs-comment'>-- Very handy hotkey-launched floating terminal window.</span> <a name="line-12"></a><span class='hs-comment'>--</span> <a name="line-13"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span> <a name="line-14"></a> <a name="line-15"></a><span class='hs-keyword'>module</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'>Scratchpad</span> <span class='hs-layout'>(</span> <a name="line-16"></a> <span class='hs-comment'>-- * Usage</span> <a name="line-17"></a> <span class='hs-comment'>-- $usage</span> <a name="line-18"></a> <span class='hs-varid'>scratchpadSpawnAction</span> <a name="line-19"></a> <span class='hs-layout'>,</span><span class='hs-varid'>scratchpadSpawnActionTerminal</span> <a name="line-20"></a> <span class='hs-layout'>,</span><span class='hs-varid'>scratchpadSpawnActionCustom</span> <a name="line-21"></a> <span class='hs-layout'>,</span><span class='hs-varid'>scratchpadManageHookDefault</span> <a name="line-22"></a> <span class='hs-layout'>,</span><span class='hs-varid'>scratchpadManageHook</span> <a name="line-23"></a> <span class='hs-layout'>,</span><span class='hs-varid'>scratchpadFilterOutWorkspace</span> <a name="line-24"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-25"></a> <a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span> <a name="line-27"></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-28"></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'>NamedScratchpad</span> <a name="line-29"></a> <a name="line-30"></a> <a name="line-31"></a><span class='hs-comment'>-- $usage</span> <a name="line-32"></a><span class='hs-comment'>-- Bind a key to 'scratchpadSpawnAction'</span> <a name="line-33"></a><span class='hs-comment'>-- Pressing it will spawn the terminal, or bring it to the current</span> <a name="line-34"></a><span class='hs-comment'>-- workspace if it already exists.</span> <a name="line-35"></a><span class='hs-comment'>-- Pressing the key with the terminal on the current workspace will</span> <a name="line-36"></a><span class='hs-comment'>-- send it to a hidden workspace called @NSP@.</span> <a name="line-37"></a><span class='hs-comment'>--</span> <a name="line-38"></a><span class='hs-comment'>-- If you already have a workspace called @NSP@, it will use that.</span> <a name="line-39"></a><span class='hs-comment'>-- @NSP@ will also appear in xmobar and dzen status bars. You can tweak your</span> <a name="line-40"></a><span class='hs-comment'>-- @dynamicLog@ settings to filter it out if you like.</span> <a name="line-41"></a><span class='hs-comment'>--</span> <a name="line-42"></a><span class='hs-comment'>-- A tool like detach (<<a href="http://detach.sourceforge.net">http://detach.sourceforge.net</a>>) turns it</span> <a name="line-43"></a><span class='hs-comment'>-- into a launchpad for X apps.</span> <a name="line-44"></a><span class='hs-comment'>--</span> <a name="line-45"></a><span class='hs-comment'>-- By default, your xmonad terminal is used.</span> <a name="line-46"></a><span class='hs-comment'>-- The default ManageHook uses a centered, half-screen-wide,</span> <a name="line-47"></a><span class='hs-comment'>-- quarter-screen-tall window.</span> <a name="line-48"></a><span class='hs-comment'>-- The key, position and size are configurable.</span> <a name="line-49"></a><span class='hs-comment'>--</span> <a name="line-50"></a><span class='hs-comment'>-- The terminal application must support the @-name@ argument.</span> <a name="line-51"></a><span class='hs-comment'>-- Known supported terminals: rxvt, rxvt-unicode, xterm.</span> <a name="line-52"></a><span class='hs-comment'>-- Most others are likely to follow the lead set by xterm.</span> <a name="line-53"></a><span class='hs-comment'>--</span> <a name="line-54"></a><span class='hs-comment'>-- Bind the following to a key in your xmonad.hs keybindings:</span> <a name="line-55"></a><span class='hs-comment'>--</span> <a name="line-56"></a><span class='hs-comment'>-- > scratchpadSpawnAction conf</span> <a name="line-57"></a><span class='hs-comment'>--</span> <a name="line-58"></a><span class='hs-comment'>-- Where @conf@ is the configuration.</span> <a name="line-59"></a><span class='hs-comment'>--</span> <a name="line-60"></a><span class='hs-comment'>-- And add one of the @scratchpadManageHook*@s to your ManageHook list.</span> <a name="line-61"></a><span class='hs-comment'>-- The default rectangle is half the screen wide and a quarter of the</span> <a name="line-62"></a><span class='hs-comment'>-- screen tall, centered.</span> <a name="line-63"></a><span class='hs-comment'>--</span> <a name="line-64"></a> <a name="line-65"></a> <a name="line-66"></a> <a name="line-67"></a><a name="scratchpadSpawnAction"></a><span class='hs-comment'>-- | Action to pop up the terminal, for the user to bind to a custom key.</span> <a name="line-68"></a><span class='hs-definition'>scratchpadSpawnAction</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>XConfig</span> <span class='hs-varid'>l</span> <span class='hs-comment'>-- ^ The configuration, to retrieve the terminal</span> <a name="line-69"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span> <a name="line-70"></a><span class='hs-definition'>scratchpadSpawnAction</span> <span class='hs-varid'>conf</span> <span class='hs-keyglyph'>=</span> <a name="line-71"></a> <span class='hs-varid'>scratchpadSpawnActionCustom</span> <span class='hs-varop'>$</span> <span class='hs-varid'>terminal</span> <span class='hs-varid'>conf</span> <span class='hs-varop'>++</span> <span class='hs-str'>" -name scratchpad"</span> <a name="line-72"></a> <a name="line-73"></a> <a name="line-74"></a><a name="scratchpadSpawnActionTerminal"></a><span class='hs-comment'>-- | Action to pop up the terminal, with a directly specified terminal.</span> <a name="line-75"></a><span class='hs-definition'>scratchpadSpawnActionTerminal</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ Name of the terminal program</span> <a name="line-76"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span> <a name="line-77"></a><span class='hs-definition'>scratchpadSpawnActionTerminal</span> <span class='hs-varid'>term</span> <span class='hs-keyglyph'>=</span> <a name="line-78"></a> <span class='hs-varid'>scratchpadSpawnActionCustom</span> <span class='hs-varop'>$</span> <span class='hs-varid'>term</span> <span class='hs-varop'>++</span> <span class='hs-str'>" -name scratchpad"</span> <a name="line-79"></a> <a name="line-80"></a> <a name="line-81"></a><a name="scratchpadSpawnActionCustom"></a><span class='hs-comment'>-- | Action to pop up any program with the user specifying how to set</span> <a name="line-82"></a><span class='hs-comment'>-- its resource to \"scratchpad\". For example, with gnome-terminal:</span> <a name="line-83"></a><span class='hs-comment'>--</span> <a name="line-84"></a><span class='hs-comment'>-- > scratchpadSpawnActionCustom "gnome-terminal --disable-factory --name scratchpad"</span> <a name="line-85"></a><span class='hs-definition'>scratchpadSpawnActionCustom</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ Command to spawn a program with resource \"scratchpad\"</span> <a name="line-86"></a> <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'>scratchpadSpawnActionCustom</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>namedScratchpadAction</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>NS</span> <span class='hs-str'>"scratchpad"</span> <span class='hs-varid'>c</span> <span class='hs-varid'>scratchpadQuery</span> <span class='hs-varid'>nonFloating</span><span class='hs-keyglyph'>]</span> <span class='hs-str'>"scratchpad"</span> <a name="line-88"></a> <a name="line-89"></a><a name="scratchpadQuery"></a><span class='hs-comment'>-- factored out since this is common to both the ManageHook and the action</span> <a name="line-90"></a><span class='hs-definition'>scratchpadQuery</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Query</span> <span class='hs-conid'>Bool</span> <a name="line-91"></a><span class='hs-definition'>scratchpadQuery</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>resource</span> <span class='hs-varop'>=?</span> <span class='hs-str'>"scratchpad"</span> <a name="line-92"></a> <a name="line-93"></a> <a name="line-94"></a><a name="scratchpadManageHookDefault"></a><span class='hs-comment'>-- | The ManageHook, with the default rectangle:</span> <a name="line-95"></a><span class='hs-comment'>-- Half the screen wide, a quarter of the screen tall, centered.</span> <a name="line-96"></a><span class='hs-definition'>scratchpadManageHookDefault</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ManageHook</span> <a name="line-97"></a><span class='hs-definition'>scratchpadManageHookDefault</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>namedScratchpadManageHook</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>NS</span> <span class='hs-str'>""</span> <span class='hs-str'>""</span> <span class='hs-varid'>scratchpadQuery</span> <span class='hs-layout'>(</span><span class='hs-varid'>customFloating</span> <span class='hs-varid'>scratchpadDefaultRect</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <a name="line-98"></a> <a name="line-99"></a> <a name="line-100"></a><a name="scratchpadManageHook"></a><span class='hs-comment'>-- | The ManageHook, with a user-specified StackSet.RationalRect,</span> <a name="line-101"></a><span class='hs-comment'>-- e.g., for a terminal 4/10 of the screen width from the left, half</span> <a name="line-102"></a><span class='hs-comment'>-- the screen height from the top, and 6/10 of the screen width by</span> <a name="line-103"></a><span class='hs-comment'>-- 3/10 the screen height, use:</span> <a name="line-104"></a><span class='hs-comment'>--</span> <a name="line-105"></a><span class='hs-comment'>-- > scratchpadManageHook (W.RationalRect 0.4 0.5 0.6 0.3)</span> <a name="line-106"></a><span class='hs-definition'>scratchpadManageHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-conid'>RationalRect</span> <span class='hs-comment'>-- ^ User-specified screen rectangle.</span> <a name="line-107"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ManageHook</span> <a name="line-108"></a><span class='hs-definition'>scratchpadManageHook</span> <span class='hs-varid'>rect</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>namedScratchpadManageHook</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>NS</span> <span class='hs-str'>""</span> <span class='hs-str'>""</span> <span class='hs-varid'>scratchpadQuery</span> <span class='hs-layout'>(</span><span class='hs-varid'>customFloating</span> <span class='hs-varid'>rect</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <a name="line-109"></a> <a name="line-110"></a> <a name="line-111"></a><a name="scratchpadFilterOutWorkspace"></a><span class='hs-comment'>-- | Transforms a workspace list containing the SP workspace into one that</span> <a name="line-112"></a><span class='hs-comment'>-- doesn't contain it. Intended for use with logHooks.</span> <a name="line-113"></a><span class='hs-definition'>scratchpadFilterOutWorkspace</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>WindowSpace</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>WindowSpace</span><span class='hs-keyglyph'>]</span> <a name="line-114"></a><span class='hs-definition'>scratchpadFilterOutWorkspace</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>namedScratchpadFilterOutWorkspace</span> <a name="line-115"></a> <a name="line-116"></a> <a name="line-117"></a><a name="scratchpadDefaultRect"></a><span class='hs-definition'>scratchpadDefaultRect</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-conid'>RationalRect</span> <a name="line-118"></a><span class='hs-definition'>scratchpadDefaultRect</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-conid'>RationalRect</span> <span class='hs-num'>0.25</span> <span class='hs-num'>0.375</span> <span class='hs-num'>0.5</span> <span class='hs-num'>0.25</span> <a name="line-119"></a> <a name="line-120"></a> </pre></body> </html>
