<!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.ShowText</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-ShowText.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Actions-ShowText.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>pastorelli.mario@gmail.com</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Actions.ShowText</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>ShowText displays text for sometime on the screen similar to <a href="XMonad-Util-Dzen.html">XMonad.Util.Dzen</a>
which offers more features (currently)
</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:defaultSTConfig">defaultSTConfig</a> :: <a href="XMonad-Actions-ShowText.html#t:ShowTextConfig">ShowTextConfig</a></li><li class="src short"><a href="#v:handleTimerEvent">handleTimerEvent</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:flashText">flashText</a> :: <a href="XMonad-Actions-ShowText.html#t:ShowTextConfig">ShowTextConfig</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</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">data</span> <a href="#t:ShowTextConfig">ShowTextConfig</a> = <a href="#v:STC">STC</a> {<ul class="subs"><li><a href="#v:st_font">st_font</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li><a href="#v:st_bg">st_bg</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li><a href="#v:st_fg">st_fg</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li></ul>}</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.ShowText
</pre><p>Then add the event hook handler:
</p><pre> xmonad { handleEventHook = myHandleEventHooks <+> handleTimerEvent }
</pre><p>You can then use flashText in your keybindings:
</p><pre> ((modMask, xK_Right), flashText defaultSTConfig 1 "->" >> nextWS)
</pre></div><div class="top"><p class="src"><a name="v:defaultSTConfig" class="def">defaultSTConfig</a> :: <a href="XMonad-Actions-ShowText.html#t:ShowTextConfig">ShowTextConfig</a><a href="src/XMonad-Actions-ShowText.html#defaultSTConfig" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:handleTimerEvent" class="def">handleTimerEvent</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-Actions-ShowText.html#handleTimerEvent" class="link">Source</a></p><div class="doc"><p>Handles timer events that notify when a window should be removed
</p></div></div><div class="top"><p class="src"><a name="v:flashText" class="def">flashText</a><a href="src/XMonad-Actions-ShowText.html#flashText" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="XMonad-Actions-ShowText.html#t:ShowTextConfig">ShowTextConfig</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/Prelude.html#t:Rational">Rational</a></td><td class="doc"><p>number of seconds
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></td><td class="doc"><p>text to display
</p></td></tr><tr><td class="src">-> <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></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Shows a window in the center of the screen with the given text
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ShowTextConfig" class="def">ShowTextConfig</a> <a href="src/XMonad-Actions-ShowText.html#ShowTextConfig" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:STC" class="def">STC</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:st_font" class="def">st_font</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>Font name
</p></dd><dt class="src"><a name="v:st_bg" class="def">st_bg</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>Background color
</p></dd><dt class="src"><a name="v:st_fg" class="def">st_fg</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>Foreground color
</p></dd></dl><div class="clear"></div></div></td></tr></table></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>
