<!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.Layout.Monitor</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-Layout-Monitor.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-Monitor.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>Roman Cheplyaka <roma@ro-che.info></td></tr></table><p class="caption">XMonad.Layout.Monitor</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">Hints and issues
</a></li><li><a href="#g:3">TODO
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Layout modfier for displaying some window (monitor) above other windows
</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:Monitor">Monitor</a> a = <a href="#v:Monitor">Monitor</a> {<ul class="subs"><li><a href="#v:prop">prop</a> :: <a href="XMonad-Layout-Monitor.html#t:Property">Property</a></li><li><a href="#v:rect">rect</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Xlib.html#t:Rectangle">Rectangle</a></li><li><a href="#v:visible">visible</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:name">name</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li><a href="#v:persistent">persistent</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:opacity">opacity</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a></li></ul>}</li><li class="src short"><a href="#v:monitor">monitor</a> :: <a href="XMonad-Layout-Monitor.html#t:Monitor">Monitor</a> a</li><li class="src short"><span class="keyword">data</span> <a href="#t:Property">Property</a> <ul class="subs"><li>= <a href="#v:Title">Title</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li><li>| <a href="#v:ClassName">ClassName</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li><li>| <a href="#v:Resource">Resource</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li><li>| <a href="#v:Role">Role</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li><li>| <a href="#v:Machine">Machine</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li><li>| <a href="#v:And">And</a> <a href="XMonad-Layout-Monitor.html#t:Property">Property</a> <a href="XMonad-Layout-Monitor.html#t:Property">Property</a> </li><li>| <a href="#v:Or">Or</a> <a href="XMonad-Layout-Monitor.html#t:Property">Property</a> <a href="XMonad-Layout-Monitor.html#t:Property">Property</a> </li><li>| <a href="#v:Not">Not</a> <a href="XMonad-Layout-Monitor.html#t:Property">Property</a> </li><li>| <a href="#v:Const">Const</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:MonitorMessage">MonitorMessage</a> <ul class="subs"><li>= <a href="#v:ToggleMonitor">ToggleMonitor</a> </li><li>| <a href="#v:ShowMonitor">ShowMonitor</a> </li><li>| <a href="#v:HideMonitor">HideMonitor</a> </li><li>| <a href="#v:ToggleMonitorNamed">ToggleMonitorNamed</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li><li>| <a href="#v:ShowMonitorNamed">ShowMonitorNamed</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li><li>| <a href="#v:HideMonitorNamed">HideMonitorNamed</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li></ul></li><li class="src short"><a href="#v:doHideIgnore">doHideIgnore</a> :: ManageHook</li><li class="src short"><a href="#v:manageMonitor">manageMonitor</a> :: <a href="XMonad-Layout-Monitor.html#t:Monitor">Monitor</a> a -> ManageHook</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.Layout.Monitor
</pre><p>Define <code><a href="XMonad-Layout-Monitor.html#t:Monitor">Monitor</a></code> record. <code><a href="XMonad-Layout-Monitor.html#v:monitor">monitor</a></code> can be used as a template. At least <code><a href="XMonad-Layout-Monitor.html#v:prop">prop</a></code>
and <code><a href="XMonad-Layout-Monitor.html#v:rect">rect</a></code> should be set here. Also consider setting <code><a href="XMonad-Layout-Monitor.html#v:persistent">persistent</a></code> to True.
</p><p>Minimal example:
</p><pre> myMonitor = monitor
{ prop = ClassName "SomeClass"
, rect = Rectangle 0 0 40 20 -- rectangle 40x20 in upper left corner
}
</pre><p>More interesting example:
</p><pre> clock = monitor {
-- Cairo-clock creates 2 windows with the same classname, thus also using title
prop = ClassName "Cairo-clock" `And` Title "MacSlow's Cairo-Clock"
-- rectangle 150x150 in lower right corner, assuming 1280x800 resolution
, rect = Rectangle (1280-150) (800-150) 150 150
-- avoid flickering
, persistent = True
-- make the window transparent
, opacity = 0.6
-- hide on start
, visible = False
-- assign it a name to be able to toggle it independently of others
, name = "clock"
}
</pre><p>Add ManageHook to de-manage monitor windows and apply opacity settings.
</p><pre> manageHook = myManageHook <+> manageMonitor clock
</pre><p>Apply layout modifier.
</p><pre> myLayout = ModifiedLayout clock $ tall ||| Full ||| ...
</pre><p>After that, if there exists a window with specified properties, it will be
displayed on top of all <em>tiled</em> (not floated) windows on specified
position.
</p><p>It's also useful to add some keybinding to toggle monitor visibility:
</p><pre> , ((mod1Mask, xK_u ), broadcastMessage ToggleMonitor >> refresh)
</pre><p>Screenshot: <a href="http://www.haskell.org/haskellwiki/Image:Xmonad-clock.png">http://www.haskell.org/haskellwiki/Image:Xmonad-clock.png</a>
</p></div><h1 id="g:2">Hints and issues
</h1><div class="doc"><ul><li> This module assumes that there is only one window satisfying property exists.
</li><li> If your monitor is available on <em>all</em> layouts, set
<code><a href="XMonad-Layout-Monitor.html#v:persistent">persistent</a></code> to <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code> to avoid unnecessary
flickering. You can still toggle monitor with a keybinding.
</li><li> You can use several monitors with nested modifiers. Give them names
</li></ul></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Monitor" class="def">Monitor</a> a <a href="src/XMonad-Layout-Monitor.html#Monitor" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Monitor" class="def">Monitor</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:prop" class="def">prop</a> :: <a href="XMonad-Layout-Monitor.html#t:Property">Property</a></dt><dd class="doc"><p>property which uniquely identifies monitor window
</p></dd><dt class="src"><a name="v:rect" class="def">rect</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Xlib.html#t:Rectangle">Rectangle</a></dt><dd class="doc"><p>specifies where to put monitor
</p></dd><dt class="src"><a name="v:visible" class="def">visible</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>is it visible by default?
</p></dd><dt class="src"><a name="v:name" class="def">name</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></dt><dd class="doc"><p>name of monitor (useful when we have many of them)
</p></dd><dt class="src"><a name="v:persistent" class="def">persistent</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>is it shown on all layouts?
</p></dd><dt class="src"><a name="v:opacity" class="def">opacity</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Rational">Rational</a></dt><dd class="doc"><p>opacity level
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:Monitor" class="caption collapser" onclick="toggleSection('i:Monitor')">Instances</p><div id="section.i:Monitor" class="show"><table><tr><td class="src"><a href="XMonad-Layout-LayoutModifier.html#t:LayoutModifier">LayoutModifier</a> <a href="XMonad-Layout-Monitor.html#t:Monitor">Monitor</a> <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t:Window">Window</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-Layout-Monitor.html#t:Monitor">Monitor</a> 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-Layout-Monitor.html#t:Monitor">Monitor</a> a)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:monitor" class="def">monitor</a> :: <a href="XMonad-Layout-Monitor.html#t:Monitor">Monitor</a> a<a href="src/XMonad-Layout-Monitor.html#monitor" class="link">Source</a></p><div class="doc"><p>Template for <code><a href="XMonad-Layout-Monitor.html#t:Monitor">Monitor</a></code> record. At least <code><a href="XMonad-Layout-Monitor.html#v:prop">prop</a></code> and <code><a href="XMonad-Layout-Monitor.html#v:rect">rect</a></code> should be
redefined. Default settings: <code><a href="XMonad-Layout-Monitor.html#v:visible">visible</a></code> is <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code>, <code><a href="XMonad-Layout-Monitor.html#v:persistent">persistent</a></code> is <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:False">False</a></code>.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Property" class="def">Property</a> <a href="src/XMonad-Util-WindowProperties.html#Property" class="link">Source</a></p><div class="doc"><p>Most of the property constructors are quite self-explaining.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Title" class="def">Title</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ClassName" class="def">ClassName</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Resource" class="def">Resource</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Role" class="def">Role</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>WM_WINDOW_ROLE property
</p></td></tr><tr><td class="src"><a name="v:Machine" class="def">Machine</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>WM_CLIENT_MACHINE property
</p></td></tr><tr><td class="src"><a name="v:And" class="def">And</a> <a href="XMonad-Layout-Monitor.html#t:Property">Property</a> <a href="XMonad-Layout-Monitor.html#t:Property">Property</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Or" class="def">Or</a> <a href="XMonad-Layout-Monitor.html#t:Property">Property</a> <a href="XMonad-Layout-Monitor.html#t:Property">Property</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Not" class="def">Not</a> <a href="XMonad-Layout-Monitor.html#t:Property">Property</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Const" class="def">Const</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Property" class="caption collapser" onclick="toggleSection('i:Property')">Instances</p><div id="section.i:Property" class="show"><table><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-Layout-Monitor.html#t:Property">Property</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-Layout-Monitor.html#t:Property">Property</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:MonitorMessage" class="def">MonitorMessage</a> <a href="src/XMonad-Layout-Monitor.html#MonitorMessage" class="link">Source</a></p><div class="doc"><p>Messages without names affect all monitors. Messages with names affect only
monitors whose names match.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ToggleMonitor" class="def">ToggleMonitor</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ShowMonitor" class="def">ShowMonitor</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:HideMonitor" class="def">HideMonitor</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ToggleMonitorNamed" class="def">ToggleMonitorNamed</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ShowMonitorNamed" class="def">ShowMonitorNamed</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:HideMonitorNamed" class="def">HideMonitorNamed</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:MonitorMessage" class="caption collapser" onclick="toggleSection('i:MonitorMessage')">Instances</p><div id="section.i:MonitorMessage" 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-Layout-Monitor.html#t:MonitorMessage">MonitorMessage</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-Layout-Monitor.html#t:MonitorMessage">MonitorMessage</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-Layout-Monitor.html#t:MonitorMessage">MonitorMessage</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/Data-Typeable.html#t:Typeable">Typeable</a> <a href="XMonad-Layout-Monitor.html#t:MonitorMessage">MonitorMessage</a></td><td class="doc empty"> </td></tr><tr><td class="src">Message <a href="XMonad-Layout-Monitor.html#t:MonitorMessage">MonitorMessage</a></td><td class="doc empty"> </td></tr></table></div></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 class="top"><p class="src"><a name="v:manageMonitor" class="def">manageMonitor</a> :: <a href="XMonad-Layout-Monitor.html#t:Monitor">Monitor</a> a -> ManageHook<a href="src/XMonad-Layout-Monitor.html#manageMonitor" class="link">Source</a></p><div class="doc"><p>ManageHook which demanages monitor window and applies opacity settings.
</p></div></div><h1 id="g:3">TODO
</h1><div class="doc"><ul><li> make Monitor remember the window it manages
</li><li> specify position relative to the screen
</li></ul></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>
