<!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.ManageHelpers</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-ManageHelpers.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Hooks-ManageHelpers.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>Lukas Mai <l.mai@web.de></td></tr></table><p class="caption">XMonad.Hooks.ManageHelpers</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module provides helper functions to be used in <code>manageHook</code>. Here's
how you might use this:
</p><pre> import XMonad.Hooks.ManageHelpers
main =
xmonad defaultConfig{
...
manageHook = composeOne [
isKDETrayWindow -?> doIgnore,
transience,
isFullscreen -?> doFullFloat,
resource =? "stalonetray" -?> doIgnore
],
...
}
</pre></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:Side">Side</a> <ul class="subs"><li>= <a href="#v:SC">SC</a> </li><li>| <a href="#v:NC">NC</a> </li><li>| <a href="#v:CE">CE</a> </li><li>| <a href="#v:CW">CW</a> </li><li>| <a href="#v:SE">SE</a> </li><li>| <a href="#v:SW">SW</a> </li><li>| <a href="#v:NE">NE</a> </li><li>| <a href="#v:NW">NW</a> </li><li>| <a href="#v:C">C</a> </li></ul></li><li class="src short"><a href="#v:composeOne">composeOne</a> :: [<a href="XMonad-Hooks-ManageHelpers.html#t:MaybeManageHook">MaybeManageHook</a>] -> ManageHook</li><li class="src short"><a href="#v:-45--63--62-">(-?>)</a> :: Query <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> ManageHook -> <a href="XMonad-Hooks-ManageHelpers.html#t:MaybeManageHook">MaybeManageHook</a></li><li class="src short"><a href="#v:-47--61--63-">(/=?)</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> a => Query a -> a -> Query <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:-60--61--61--63-">(<==?)</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> a => Query a -> a -> Query (Match a)</li><li class="src short"><a href="#v:-60--47--61--63-">(</=?)</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> a => Query a -> a -> Query (Match a)</li><li class="src short"><a href="#v:-45--45--62--62-">(-->>)</a> :: Query (Match a) -> (a -> ManageHook) -> ManageHook</li><li class="src short"><a href="#v:-45--63--62--62-">(-?>>)</a> :: Query (Match a) -> (a -> ManageHook) -> <a href="XMonad-Hooks-ManageHelpers.html#t:MaybeManageHook">MaybeManageHook</a></li><li class="src short"><a href="#v:isInProperty">isInProperty</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> Query <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:isKDETrayWindow">isKDETrayWindow</a> :: Query <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:isFullscreen">isFullscreen</a> :: Query <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:isDialog">isDialog</a> :: Query <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:pid">pid</a> :: Query (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-Posix-Types.html#t:ProcessID">ProcessID</a>)</li><li class="src short"><a href="#v:transientTo">transientTo</a> :: Query (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t:Window">Window</a>)</li><li class="src short"><a href="#v:maybeToDefinite">maybeToDefinite</a> :: <a href="XMonad-Hooks-ManageHelpers.html#t:MaybeManageHook">MaybeManageHook</a> -> ManageHook</li><li class="src short"><span class="keyword">type</span> <a href="#t:MaybeManageHook">MaybeManageHook</a> = Query (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Monoid.html#t:Endo">Endo</a> WindowSet))</li><li class="src short"><a href="#v:transience">transience</a> :: <a href="XMonad-Hooks-ManageHelpers.html#t:MaybeManageHook">MaybeManageHook</a></li><li class="src short"><a href="#v:transience-39-">transience'</a> :: ManageHook</li><li class="src short"><a href="#v:doRectFloat">doRectFloat</a> :: RationalRect -> ManageHook</li><li class="src short"><a href="#v:doFullFloat">doFullFloat</a> :: ManageHook</li><li class="src short"><a href="#v:doCenterFloat">doCenterFloat</a> :: ManageHook</li><li class="src short"><a href="#v:doSideFloat">doSideFloat</a> :: <a href="XMonad-Hooks-ManageHelpers.html#t:Side">Side</a> -> ManageHook</li><li class="src short"><a href="#v:doFloatAt">doFloatAt</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> -> ManageHook</li><li class="src short"><a href="#v:doFloatDep">doFloatDep</a> :: (RationalRect -> RationalRect) -> ManageHook</li><li class="src short"><a href="#v:doHideIgnore">doHideIgnore</a> :: ManageHook</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Side" class="def">Side</a> <a href="src/XMonad-Hooks-ManageHelpers.html#Side" class="link">Source</a></p><div class="doc"><p>Denotes a side of a screen. <code>S</code> stands for South, <code>NE</code> for Northeast
etc. <code>C</code> stands for Center.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:SC" class="def">SC</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:NC" class="def">NC</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:CE" class="def">CE</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:CW" class="def">CW</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:SE" class="def">SE</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:SW" class="def">SW</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:NE" class="def">NE</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:NW" class="def">NW</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:C" class="def">C</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Side" class="caption collapser" onclick="toggleSection('i:Side')">Instances</p><div id="section.i:Side" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="XMonad-Hooks-ManageHelpers.html#t:Side">Side</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> <a href="XMonad-Hooks-ManageHelpers.html#t:Side">Side</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="XMonad-Hooks-ManageHelpers.html#t:Side">Side</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:composeOne" class="def">composeOne</a> :: [<a href="XMonad-Hooks-ManageHelpers.html#t:MaybeManageHook">MaybeManageHook</a>] -> ManageHook<a href="src/XMonad-Hooks-ManageHelpers.html#composeOne" class="link">Source</a></p><div class="doc"><p>An alternative <code>ManageHook</code> composer. Unlike <code>composeAll</code> it stops as soon as
a candidate returns a <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Just">Just</a></code> value, effectively running only the first match
(whereas <code>composeAll</code> continues and executes all matching rules).
</p></div></div><div class="top"><p class="src"><a name="v:-45--63--62-" class="def">(-?>)</a> :: Query <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> ManageHook -> <a href="XMonad-Hooks-ManageHelpers.html#t:MaybeManageHook">MaybeManageHook</a><a href="src/XMonad-Hooks-ManageHelpers.html#-%3F%3E" class="link">Source</a></p><div class="doc"><p>A helper operator for use in <code><a href="XMonad-Hooks-ManageHelpers.html#v:composeOne">composeOne</a></code>. It takes a condition and an action;
if the condition fails, it returns <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> from the <code>Query</code> so <code><a href="XMonad-Hooks-ManageHelpers.html#v:composeOne">composeOne</a></code> will
go on and try the next rule.
</p></div></div><div class="top"><p class="src"><a name="v:-47--61--63-" class="def">(/=?)</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> a => Query a -> a -> Query <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/XMonad-Hooks-ManageHelpers.html#%2F%3D%3F" class="link">Source</a></p><div class="doc"><p>q /=? x. if the result of q equals x, return False
</p></div></div><div class="top"><p class="src"><a name="v:-60--61--61--63-" class="def">(<==?)</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> a => Query a -> a -> Query (Match a)<a href="src/XMonad-Hooks-ManageHelpers.html#%3C%3D%3D%3F" class="link">Source</a></p><div class="doc"><p>q <==? x. if the result of q equals x, return True grouped with q
</p></div></div><div class="top"><p class="src"><a name="v:-60--47--61--63-" class="def">(</=?)</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> a => Query a -> a -> Query (Match a)<a href="src/XMonad-Hooks-ManageHelpers.html#%3C%2F%3D%3F" class="link">Source</a></p><div class="doc"><p>q </=? x. if the result of q notequals x, return True grouped with q
</p></div></div><div class="top"><p class="src"><a name="v:-45--45--62--62-" class="def">(-->>)</a> :: Query (Match a) -> (a -> ManageHook) -> ManageHook<a href="src/XMonad-Hooks-ManageHelpers.html#--%3E%3E" class="link">Source</a></p><div class="doc"><p>A helper operator for use in <code>composeAll</code>. It takes a condition and a function taking a grouped datum to action. If <code>p</code> is true, it executes the resulting action.
</p></div></div><div class="top"><p class="src"><a name="v:-45--63--62--62-" class="def">(-?>>)</a> :: Query (Match a) -> (a -> ManageHook) -> <a href="XMonad-Hooks-ManageHelpers.html#t:MaybeManageHook">MaybeManageHook</a><a href="src/XMonad-Hooks-ManageHelpers.html#-%3F%3E%3E" class="link">Source</a></p><div class="doc"><p>A helper operator for use in <code><a href="XMonad-Hooks-ManageHelpers.html#v:composeOne">composeOne</a></code>. It takes a condition and a function taking a groupdatum to action. If <code>p</code> is true, it executes the resulting action. If it fails, it returns <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> from the <code>Query</code> so <code><a href="XMonad-Hooks-ManageHelpers.html#v:composeOne">composeOne</a></code> will go on and try the next rule.
</p></div></div><div class="top"><p class="src"><a name="v:isInProperty" class="def">isInProperty</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> Query <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/XMonad-Hooks-ManageHelpers.html#isInProperty" class="link">Source</a></p><div class="doc"><p>Helper to check if a window property contains certain value.
</p></div></div><div class="top"><p class="src"><a name="v:isKDETrayWindow" class="def">isKDETrayWindow</a> :: Query <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/XMonad-Hooks-ManageHelpers.html#isKDETrayWindow" class="link">Source</a></p><div class="doc"><p>A predicate to check whether a window is a KDE system tray icon.
</p></div></div><div class="top"><p class="src"><a name="v:isFullscreen" class="def">isFullscreen</a> :: Query <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/XMonad-Hooks-ManageHelpers.html#isFullscreen" class="link">Source</a></p><div class="doc"><p>A predicate to check whether a window wants to fill the whole screen.
See also <code><a href="XMonad-Hooks-ManageHelpers.html#v:doFullFloat">doFullFloat</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:isDialog" class="def">isDialog</a> :: Query <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/XMonad-Hooks-ManageHelpers.html#isDialog" class="link">Source</a></p><div class="doc"><p>A predicate to check whether a window is a dialog.
</p></div></div><div class="top"><p class="src"><a name="v:pid" class="def">pid</a> :: Query (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-Posix-Types.html#t:ProcessID">ProcessID</a>)<a href="src/XMonad-Hooks-ManageHelpers.html#pid" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:transientTo" class="def">transientTo</a> :: Query (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t:Window">Window</a>)<a href="src/XMonad-Hooks-ManageHelpers.html#transientTo" class="link">Source</a></p><div class="doc"><p>A predicate to check whether a window is Transient.
It holds the result which might be the window it is transient to
or it might be <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:maybeToDefinite" class="def">maybeToDefinite</a> :: <a href="XMonad-Hooks-ManageHelpers.html#t:MaybeManageHook">MaybeManageHook</a> -> ManageHook<a href="src/XMonad-Hooks-ManageHelpers.html#maybeToDefinite" class="link">Source</a></p><div class="doc"><p>converts <code><a href="XMonad-Hooks-ManageHelpers.html#t:MaybeManageHook">MaybeManageHook</a></code>s to <code>ManageHook</code>s
</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:MaybeManageHook" class="def">MaybeManageHook</a> = Query (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Monoid.html#t:Endo">Endo</a> WindowSet))<a href="src/XMonad-Hooks-ManageHelpers.html#MaybeManageHook" class="link">Source</a></p><div class="doc"><p>A ManageHook that may or may not have been executed; the outcome is embedded in the Maybe
</p></div></div><div class="top"><p class="src"><a name="v:transience" class="def">transience</a> :: <a href="XMonad-Hooks-ManageHelpers.html#t:MaybeManageHook">MaybeManageHook</a><a href="src/XMonad-Hooks-ManageHelpers.html#transience" class="link">Source</a></p><div class="doc"><p>A convenience <code><a href="XMonad-Hooks-ManageHelpers.html#t:MaybeManageHook">MaybeManageHook</a></code> that will check to see if a window
is transient, and then move it to its parent.
</p></div></div><div class="top"><p class="src"><a name="v:transience-39-" class="def">transience'</a> :: ManageHook<a href="src/XMonad-Hooks-ManageHelpers.html#transience%27" class="link">Source</a></p><div class="doc"><p><code><a href="XMonad-Hooks-ManageHelpers.html#v:transience">transience</a></code> set to a <code>ManageHook</code>
</p></div></div><div class="top"><p class="src"><a name="v:doRectFloat" class="def">doRectFloat</a><a href="src/XMonad-Hooks-ManageHelpers.html#doRectFloat" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: RationalRect</td><td class="doc"><p>The rectangle to float the window in. 0 to 1; x, y, w, h.
</p></td></tr><tr><td class="src">-> ManageHook</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Floats the new window in the given rectangle.
</p></div></div><div class="top"><p class="src"><a name="v:doFullFloat" class="def">doFullFloat</a> :: ManageHook<a href="src/XMonad-Hooks-ManageHelpers.html#doFullFloat" class="link">Source</a></p><div class="doc"><p>Floats the window and makes it use the whole screen. Equivalent to
<code><code><a href="XMonad-Hooks-ManageHelpers.html#v:doRectFloat">doRectFloat</a></code> $ <code>RationalRect</code> 0 0 1 1</code>.
</p></div></div><div class="top"><p class="src"><a name="v:doCenterFloat" class="def">doCenterFloat</a> :: ManageHook<a href="src/XMonad-Hooks-ManageHelpers.html#doCenterFloat" class="link">Source</a></p><div class="doc"><p>Floats a new window with its original size, but centered.
</p></div></div><div class="top"><p class="src"><a name="v:doSideFloat" class="def">doSideFloat</a> :: <a href="XMonad-Hooks-ManageHelpers.html#t:Side">Side</a> -> ManageHook<a href="src/XMonad-Hooks-ManageHelpers.html#doSideFloat" class="link">Source</a></p><div class="doc"><p>Floats a new window with its original size on the specified side of a
screen
</p></div></div><div class="top"><p class="src"><a name="v:doFloatAt" class="def">doFloatAt</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> -> ManageHook<a href="src/XMonad-Hooks-ManageHelpers.html#doFloatAt" class="link">Source</a></p><div class="doc"><p>Floats a new window with its original size, and its top left
corner at a specific point on the screen (both coordinates should
be in the range 0 to 1).
</p></div></div><div class="top"><p class="src"><a name="v:doFloatDep" class="def">doFloatDep</a> :: (RationalRect -> RationalRect) -> ManageHook<a href="src/XMonad-Hooks-ManageHelpers.html#doFloatDep" class="link">Source</a></p><div class="doc"><p>Floats a new window using a rectangle computed as a function of
the rectangle that it would have used by default.
</p></div></div><div class="top"><p class="src"><a name="v:doHideIgnore" class="def">doHideIgnore</a> :: ManageHook<a href="src/XMonad-Hooks-ManageHelpers.html#doHideIgnore" class="link">Source</a></p><div class="doc"><p>Hides window and ignores it.
</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>
