<!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.ScreenCorners</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-ScreenCorners.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Hooks-ScreenCorners.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.11: 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>Nils Schweinsberg <mail@n-sch.de></td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Hooks.ScreenCorners</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">Adding screen corners
</a></li><li><a href="#g:3">Event hook
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Run <code>X ()</code> actions by touching the edge of your screen with your mouse.
</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"><span class="keyword">data</span> <a href="#t:ScreenCorner">ScreenCorner</a> <ul class="subs"><li>= <a href="#v:SCUpperLeft">SCUpperLeft</a> </li><li>| <a href="#v:SCUpperRight">SCUpperRight</a> </li><li>| <a href="#v:SCLowerLeft">SCLowerLeft</a> </li><li>| <a href="#v:SCLowerRight">SCLowerRight</a> </li></ul></li><li class="src short"><a href="#v:addScreenCorner">addScreenCorner</a> :: <a href="XMonad-Hooks-ScreenCorners.html#t:ScreenCorner">ScreenCorner</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:addScreenCorners">addScreenCorners</a> :: [(<a href="XMonad-Hooks-ScreenCorners.html#t:ScreenCorner">ScreenCorner</a>, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a>)] -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:screenCornerEventHook">screenCornerEventHook</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Extras.html#t:Event">Event</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:All">All</a></li></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>This extension adds KDE-like screen corners to XMonad. By moving your cursor
into one of your screen corners you can trigger an <code>X ()</code> action, for
example <code><a href="XMonad-Actions-GridSelect.html">XMonad.Actions.GridSelect</a>.goToSelected</code> or
<code><a href="XMonad-Actions-CycleWS.html">XMonad.Actions.CycleWS</a>.nextWS</code> etc.
</p><p>To use it, import it on top of your <code>xmonad.hs</code>:
</p><pre> import XMonad.Hooks.ScreenCorners
</pre><p>Then add your screen corners in our startup hook:
</p><pre> myStartupHook = do
...
addScreenCorner SCUpperRight (goToSelected defaultGSConfig { gs_cellwidth = 200})
addScreenCorners [ (SCLowerRight, nextWS)
, (SCLowerLeft, prevWS)
]
</pre><p>And finally wait for screen corner events in your event hook:
</p><pre> myEventHook e = do
...
screenCornerEventHook e
</pre></div><h1 id="g:2">Adding screen corners
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ScreenCorner" class="def">ScreenCorner</a> <a href="src/XMonad-Hooks-ScreenCorners.html#ScreenCorner" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:SCUpperLeft" class="def">SCUpperLeft</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:SCUpperRight" class="def">SCUpperRight</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:SCLowerLeft" class="def">SCLowerLeft</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:SCLowerRight" class="def">SCLowerRight</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:ScreenCorner" class="caption collapser" onclick="toggleSection('i:ScreenCorner')">Instances</p><div id="section.i:ScreenCorner" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="XMonad-Hooks-ScreenCorners.html#t:ScreenCorner">ScreenCorner</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ord">Ord</a> <a href="XMonad-Hooks-ScreenCorners.html#t:ScreenCorner">ScreenCorner</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="XMonad-Hooks-ScreenCorners.html#t:ScreenCorner">ScreenCorner</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:addScreenCorner" class="def">addScreenCorner</a> :: <a href="XMonad-Hooks-ScreenCorners.html#t:ScreenCorner">ScreenCorner</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/XMonad-Hooks-ScreenCorners.html#addScreenCorner" class="link">Source</a></p><div class="doc"><p>Add one single <code>X ()</code> action to a screen corner
</p></div></div><div class="top"><p class="src"><a name="v:addScreenCorners" class="def">addScreenCorners</a> :: [(<a href="XMonad-Hooks-ScreenCorners.html#t:ScreenCorner">ScreenCorner</a>, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a>)] -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/XMonad-Hooks-ScreenCorners.html#addScreenCorners" class="link">Source</a></p><div class="doc"><p>Add a list of <code>(ScreenCorner, X ())</code> tuples
</p></div></div><h1 id="g:3">Event hook
</h1><div class="top"><p class="src"><a name="v:screenCornerEventHook" class="def">screenCornerEventHook</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Extras.html#t:Event">Event</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:All">All</a><a href="src/XMonad-Hooks-ScreenCorners.html#screenCornerEventHook" class="link">Source</a></p><div class="doc"><p>Handle screen corner events
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
