<!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.FadeWindows</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-FadeWindows.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Hooks-FadeWindows.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>Brandon S Allbery KF8NH</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Hooks.FadeWindows</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">The <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#v:logHook">logHook</a></code> for window fading
</a></li><li><a href="#g:3">The <code><a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></code>
</a></li><li><a href="#g:4">Predefined <code><a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></code>s
</a></li><li><a href="#g:5"><code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#v:handleEventHook">handleEventHook</a></code> for mapped/unmapped windows
</a></li><li><a href="#g:6"><code>doF</code> for simple hooks
</a></li><li><a href="#g:7">Useful <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a></code>s for <code><a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></code>s
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A more flexible and general compositing interface than FadeInactive.
Windows can be selected and opacity specified by means of FadeHooks,
which are very similar to ManageHooks and use the same machinery.
</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:fadeWindowsLogHook">fadeWindowsLogHook</a> :: <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</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"><span class="keyword">type</span> <a href="#t:FadeHook">FadeHook</a> = <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a> <a href="XMonad-Hooks-FadeWindows.html#t:Opacity">Opacity</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:Opacity">Opacity</a> </li><li class="src short"><a href="#v:idFadeHook">idFadeHook</a> :: <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></li><li class="src short"><a href="#v:opaque">opaque</a> :: <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></li><li class="src short"><a href="#v:invisible">invisible</a>, <a href="#v:solid">solid</a> :: <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></li><li class="src short"><a href="#v:transparent">transparent</a> :: <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></li><li class="src short"><a href="#v:transparency">transparency</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a> -> <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></li><li class="src short"><a href="#v:fadeTo">fadeTo</a>, <a href="#v:fadeBy">fadeBy</a>, <a href="#v:translucence">translucence</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a> -> <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></li><li class="src short"><a href="#v:opacity">opacity</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a> -> <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></li><li class="src short"><a href="#v:fadeWindowsEventHook">fadeWindowsEventHook</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><li class="src short"><a href="#v:doS">doS</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Monoid">Monoid</a> m => m -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a> m</li><li class="src short"><a href="#v:isFloating">isFloating</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:isUnfocused">isUnfocused</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>To use this module, make sure your <code>xmonad</code> core supports generalized
<code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ManageHook">ManageHook</a></code>s (check the type of <code>idHook</code>; if it's <code>ManageHook</code> then
your <code>xmonad</code> is too old) and then add <code>fadeWindowsLogHook</code> to your
<code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#v:logHook">logHook</a></code> and <code>fadeWindowsEventHook</code> to your <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#v:handleEventHook">handleEventHook</a></code>:
</p><pre> , logHook = fadeWindowsLogHook myFadeHook
, handleEventHook = fadeWindowsEventHook
{- ... -}
myFadeHook = composeAll [isUnfocused --> transparency 0.2
, opaque
]
</pre><p>The above is like FadeInactive with a fade value of 0.2.
</p><p>FadeHooks do not accumulate; instead, they compose from right to
left like <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ManageHook">ManageHook</a></code>s, so the above example <code>myFadeHook</code> will
render unfocused windows at 4/5 opacity and the focused window
as opaque. The <code><a href="XMonad-Hooks-FadeWindows.html#v:opaque">opaque</a></code> hook above is optional, by the way, as any
unmatched window will be opaque by default.
</p><p>This module is best used with <a href="XMonad-Hooks-MoreManageHelpers.html">XMonad.Hooks.MoreManageHelpers</a>, which
exports a number of Queries that can be used in either <code>ManageHook</code>
or <code>FadeHook</code>.
</p><p>Note that you need a compositing manager such as <code>xcompmgr</code>,
<code>dcompmgr</code>, or <code>cairo-compmgr</code> for window fading to work. If you
aren't running a compositing manager, the opacity will be recorded
but won't take effect until a compositing manager is started.
</p><p>For more detailed instructions on editing the <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#v:logHook">logHook</a></code> see:
</p><p><a href="XMonad-Doc-Extending.html#The_log_hook_and_external_status_bars">XMonad.Doc.Extending</a>
</p><p>For more detailed instructions on editing the <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#v:handleEventHook">handleEventHook</a></code>,
see:
</p><p><a href="XMonad-Doc-Extending.html#Editing_the_event_hook">XMonad.Doc.Extending</a>
(which sadly doesnt exist at the time of writing...)
</p><p><em>WARNING:</em> This module is very good at triggering bugs in
compositing managers. Symptoms range from windows not being
repainted until the compositing manager is restarted or the
window is unmapped and remapped, to the machine becoming sluggish
until the compositing manager is restarted (at which point a
popup/dialog will suddenly appear; apparently it's getting into
a tight loop trying to fade the popup in). I find it useful to
have a key binding to restart the compositing manager; for example,
</p><p>main = xmonad $ defaultConfig {
{- ... -}
}
<code>additionalKeysP</code>
[(<a href="M-S-4.html">M-S-4</a>,spawn <a href="killall xcompmgr; sleep 1; xcompmgr -cCfF &.html">killall xcompmgr; sleep 1; xcompmgr -cCfF &</a>)]
{- ... -}
]
</p><p>(See <a href="XMonad-Util-EZConfig.html">XMonad.Util.EZConfig</a> for <code>additionalKeysP</code>.)
</p></div><h1 id="g:2">The <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#v:logHook">logHook</a></code> for window fading
</h1><div class="top"><p class="src"><a name="v:fadeWindowsLogHook" class="def">fadeWindowsLogHook</a> :: <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</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-FadeWindows.html#fadeWindowsLogHook" class="link">Source</a></p><div class="doc"><p>A <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#v:logHook">logHook</a></code> to fade windows under control of a <code><a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></code>, which is
similar to but not identical to <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ManageHook">ManageHook</a></code>.
</p></div></div><h1 id="g:3">The <code><a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></code>
</h1><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:FadeHook" class="def">FadeHook</a> = <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a> <a href="XMonad-Hooks-FadeWindows.html#t:Opacity">Opacity</a><a href="src/XMonad-Hooks-FadeWindows.html#FadeHook" class="link">Source</a></p><div class="doc"><p>A FadeHook is similar to a ManageHook, but records window opacity.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Opacity" class="def">Opacity</a> <a href="src/XMonad-Hooks-FadeWindows.html#Opacity" class="link">Source</a></p><div class="subs instances"><p id="control.i:Opacity" class="caption collapser" onclick="toggleSection('i:Opacity')">Instances</p><div id="section.i:Opacity" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Monoid">Monoid</a> <a href="XMonad-Hooks-FadeWindows.html#t:Opacity">Opacity</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:idFadeHook" class="def">idFadeHook</a> :: <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a><a href="src/XMonad-Hooks-FadeWindows.html#idFadeHook" class="link">Source</a></p><div class="doc"><p>The identity <code><a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></code>, which renders windows <code><a href="XMonad-Hooks-FadeWindows.html#v:opaque">opaque</a></code>.
</p></div></div><h1 id="g:4">Predefined <code><a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></code>s
</h1><div class="top"><p class="src"><a name="v:opaque" class="def">opaque</a> :: <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a><a href="src/XMonad-Hooks-FadeWindows.html#opaque" class="link">Source</a></p><div class="doc"><p>Render a window fully opaque.
</p></div></div><div class="top"><p class="src"><a name="v:invisible" class="def">invisible</a>, <a name="v:solid" class="def">solid</a> :: <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a><a href="src/XMonad-Hooks-FadeWindows.html#invisible" class="link">Source</a></p><div class="doc"><p>An alias for <code><a href="XMonad-Hooks-FadeWindows.html#v:transparent">transparent</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:transparent" class="def">transparent</a> :: <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a><a href="src/XMonad-Hooks-FadeWindows.html#transparent" class="link">Source</a></p><div class="doc"><p>Render a window fully transparent.
</p></div></div><div class="top"><p class="src"><a name="v:transparency" class="def">transparency</a><a href="src/XMonad-Hooks-FadeWindows.html#transparency" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a></td><td class="doc"><p>The window's transparency as a fraction.
<code>transparency 1</code> is the same as <code><a href="XMonad-Hooks-FadeWindows.html#v:transparent">transparent</a></code>,
whereas <code>transparency 0</code> is the same as <code><a href="XMonad-Hooks-FadeWindows.html#v:opaque">opaque</a></code>.
</p></td></tr><tr><td class="src">-> <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Specify a window's transparency.
</p></div></div><div class="top"><p class="src"><a name="v:fadeTo" class="def">fadeTo</a>, <a name="v:fadeBy" class="def">fadeBy</a>, <a name="v:translucence" class="def">translucence</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a> -> <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a><a href="src/XMonad-Hooks-FadeWindows.html#fadeTo" class="link">Source</a></p><div class="doc"><p>An alias for <code><a href="XMonad-Hooks-FadeWindows.html#v:transparency">transparency</a></code>.
</p><p>An alias for <code><a href="XMonad-Hooks-FadeWindows.html#v:transparency">transparency</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:opacity" class="def">opacity</a><a href="src/XMonad-Hooks-FadeWindows.html#opacity" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a></td><td class="doc"><p>The opacity of a window as a fraction.
<code>opacity 1</code> is the same as <code><a href="XMonad-Hooks-FadeWindows.html#v:opaque">opaque</a></code>,
whereas <code>opacity 0</code> is the same as <code><a href="XMonad-Hooks-FadeWindows.html#v:transparent">transparent</a></code>.
</p></td></tr><tr><td class="src">-> <a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Specify a window's opacity; this is the inverse of <code><a href="XMonad-Hooks-FadeWindows.html#v:transparency">transparency</a></code>.
</p></div></div><h1 id="g:5"><code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#v:handleEventHook">handleEventHook</a></code> for mapped/unmapped windows
</h1><div class="top"><p class="src"><a name="v:fadeWindowsEventHook" class="def">fadeWindowsEventHook</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-FadeWindows.html#fadeWindowsEventHook" class="link">Source</a></p><div class="doc"><p>A <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#v:handleEventHook">handleEventHook</a></code> to handle fading and unfading of newly mapped
or unmapped windows; this avoids problems with layouts such as
<a href="XMonad-Layout-Full.html">XMonad.Layout.Full</a> or <a href="XMonad-Layout-Tabbed.html">XMonad.Layout.Tabbed</a>. This hook may
also be useful with <a href="XMonad-Hooks-FadeInactive.html">XMonad.Hooks.FadeInactive</a>.
</p></div></div><h1 id="g:6"><code>doF</code> for simple hooks
</h1><div class="top"><p class="src"><a name="v:doS" class="def">doS</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Monoid">Monoid</a> m => m -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a> m<a href="src/XMonad-Hooks-FadeWindows.html#doS" class="link">Source</a></p><div class="doc"><p>Like <code>doF</code>, but usable with <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ManageHook">ManageHook</a></code>-like hooks that
aren't <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a></code> wrapped around transforming functions (<code><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Endo">Endo</a></code>).
</p></div></div><h1 id="g:7">Useful <code><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a></code>s for <code><a href="XMonad-Hooks-FadeWindows.html#t:FadeHook">FadeHook</a></code>s
</h1><div class="top"><p class="src"><a name="v:isFloating" class="def">isFloating</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/XMonad-Hooks-FadeWindows.html#isFloating" class="link">Source</a></p><div class="doc"><p>A Query to determine if a window is floating.
</p></div></div><div class="top"><p class="src"><a name="v:isUnfocused" class="def">isUnfocused</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/XMonad-Hooks-FadeInactive.html#isUnfocused" class="link">Source</a></p><div class="doc"><p>Returns True if the window doesn't have the focus.
</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>
