<!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.Actions.Warp</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-Actions-Warp.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Actions-Warp.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.9.2: 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>daniel@wagner-home.com</td></tr></table><p class="caption">XMonad.Actions.Warp</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Usage
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Warp the pointer to a given window or screen.
</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"><a href="#v:banish">banish</a> :: <a href="XMonad-Actions-Warp.html#t:Corner">Corner</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:banishScreen">banishScreen</a> :: <a href="XMonad-Actions-Warp.html#t:Corner">Corner</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:Corner">Corner</a> <ul class="subs"><li>= <a href="#v:UpperLeft">UpperLeft</a> </li><li>| <a href="#v:UpperRight">UpperRight</a> </li><li>| <a href="#v:LowerLeft">LowerLeft</a> </li><li>| <a href="#v:LowerRight">LowerRight</a> </li></ul></li><li class="src short"><a href="#v:warpToScreen">warpToScreen</a> :: ScreenId -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:warpToWindow">warpToWindow</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>You can use this module with the following in your <code>~/.xmonad/xmonad.hs</code>:
</p><pre> import XMonad.Actions.Warp
</pre><p>then add appropriate keybindings to warp the pointer; for example:
</p><pre> , ((modm, xK_z ), warpToWindow (1%2) (1%2)) -- @@ Move pointer to currently focused window
-- mod-ctrl-{w,e,r} @@ Move mouse pointer to screen 1, 2, or 3
[((modm .|. controlMask, key), warpToScreen sc (1%2) (1%2))
| (key, sc) <- zip [xK_w, xK_e, xK_r] [0..]]
</pre><p>Note that warping to a particular screen may change the focus.
</p></div><div class="top"><p class="src"><a name="v:banish" class="def">banish</a> :: <a href="XMonad-Actions-Warp.html#t:Corner">Corner</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Actions-Warp.html#banish" class="link">Source</a></p><div class="doc"><p>Move the mouse cursor to a corner of the focused window. Useful for
uncluttering things.
</p><p>Internally, this uses numerical parameters. We parametrize on the <code><a href="XMonad-Actions-Warp.html#t:Corner">Corner</a></code>
type so the user need not see the violence inherent in
the system.
</p><p><code><a href="XMonad-Actions-Warp.html#v:warpToScreen">warpToScreen</a></code> and <code><a href="XMonad-Actions-Warp.html#v:warpToWindow">warpToWindow</a></code> can be used in a variety of
ways. Suppose you wanted to emulate Ratpoison's 'banish' command,
which moves the mouse pointer to a corner? warpToWindow can do that!
</p></div></div><div class="top"><p class="src"><a name="v:banishScreen" class="def">banishScreen</a> :: <a href="XMonad-Actions-Warp.html#t:Corner">Corner</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Actions-Warp.html#banishScreen" class="link">Source</a></p><div class="doc"><p>Same as <code><a href="XMonad-Actions-Warp.html#v:banish">banish</a></code> but moves the mouse to the corner of the
currently focused screen
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Corner" class="def">Corner</a> <a href="src/XMonad-Actions-Warp.html#Corner" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:UpperLeft" class="def">UpperLeft</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:UpperRight" class="def">UpperRight</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:LowerLeft" class="def">LowerLeft</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:LowerRight" class="def">LowerRight</a></td><td class="doc empty"> </td></tr></table></div></div><div class="top"><p class="src"><a name="v:warpToScreen" class="def">warpToScreen</a> :: ScreenId -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Actions-Warp.html#warpToScreen" class="link">Source</a></p><div class="doc"><p>Warp the pointer to the given position (top left = (0,0), bottom
right = (1,1)) on the given screen.
</p></div></div><div class="top"><p class="src"><a name="v:warpToWindow" class="def">warpToWindow</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Actions-Warp.html#warpToWindow" class="link">Source</a></p><div class="doc"><p>Warp the pointer to a given position relative to the currently
focused window. Top left = (0,0), bottom right = (1,1).
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
