<!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.MessageControl</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-MessageControl.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-MessageControl.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>orphaned</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.MessageControl</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>Provides message "escaping" and filtering facilities which
help control complex nested layouts.
</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:Ignore">Ignore</a> m l w</li><li class="src short"><a href="#v:ignore">ignore</a> :: (<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Message">Message</a> m, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l w) => m -> l w -> <a href="XMonad-Layout-MessageControl.html#t:Ignore">Ignore</a> m l w</li><li class="src short"><span class="keyword">data</span> <a href="#t:UnEscape">UnEscape</a> w</li><li class="src short"><a href="#v:unEscape">unEscape</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l w => l w -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-MessageControl.html#t:UnEscape">UnEscape</a> l w</li><li class="src short"><span class="keyword">newtype</span> <a href="#t:EscapedMessage">EscapedMessage</a> = <a href="#v:Escape">Escape</a> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:SomeMessage">SomeMessage</a></li><li class="src short"><a href="#v:escape">escape</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Message">Message</a> m => m -> <a href="XMonad-Layout-MessageControl.html#t:EscapedMessage">EscapedMessage</a></li></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>You can use this module by importing it into your <code>~/.xmonad/xmonad.hs</code> file:
</p><pre> import XMonad.Layout.MessageEscape
</pre><p>Then, if you use a modified layout where the modifier would intercept
a message, but you'd want to be able to send it to the inner layout
only, add the <code><a href="XMonad-Layout-MessageControl.html#v:unEscape">unEscape</a></code> modifier to the inner layout like so:
</p><pre> import XMonad.Layout.Master (mastered)
import XMonad.Layout.Tabbed (simpleTabbed)
import XMonad.Layout.LayoutCombinators ((|||))
myLayout = Tall ||| unEscape (mastered 0.01 0.5 $ Full ||| simpleTabbed)
</pre><p>you can now send a message to the inner layout with
<code>sendMessage $ escape message</code>, e.g.
</p><pre> -- Change the inner layout
((modm .|. controlMask, xK_space), sendMessage $ escape NextLayout)
</pre><p>If you want unescaped messages to be handled <em>only</em> by the enclosing
layout, use the <code><a href="XMonad-Layout-MessageControl.html#v:ignore">ignore</a></code> modifier:
</p><pre> myLayout = Tall ||| (ignore NextLayout $ ignore (JumpToLayout "") $
unEscape $ mastered 0.01 0.5
$ Full ||| simpleTabbed)
</pre><p><em>IMPORTANT NOTE:</em> The standard '(|||)' operator from <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Layout.html">XMonad.Layout</a>
does not behave correctly with <code><a href="XMonad-Layout-MessageControl.html#v:ignore">ignore</a></code>. Make sure you use the one
from <a href="XMonad-Layout-LayoutCombinators.html">XMonad.Layout.LayoutCombinators</a>.
</p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Ignore" class="def">Ignore</a> m l w <a href="src/XMonad-Layout-MessageControl.html#Ignore" class="link">Source</a></p><div class="doc"><p>the Ignore layout modifier. Prevents its inner layout from receiving
messages of a certain type.
</p></div><div class="subs instances"><p id="control.i:Ignore" class="caption collapser" onclick="toggleSection('i:Ignore')">Instances</p><div id="section.i:Ignore" class="show"><table><tr><td class="src">(<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Message">Message</a> m, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l w) => <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> (<a href="XMonad-Layout-MessageControl.html#t:Ignore">Ignore</a> m l) w</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (l w) => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-MessageControl.html#t:Ignore">Ignore</a> m l w)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (l w) => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-MessageControl.html#t:Ignore">Ignore</a> m l w)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:ignore" class="def">ignore</a> :: (<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Message">Message</a> m, <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l w) => m -> l w -> <a href="XMonad-Layout-MessageControl.html#t:Ignore">Ignore</a> m l w<a href="src/XMonad-Layout-MessageControl.html#ignore" class="link">Source</a></p><div class="doc"><p>Applies the Ignore layout modifier to a layout, blocking
all messages of the same type as the one passed as its first argument.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:UnEscape" class="def">UnEscape</a> w <a href="src/XMonad-Layout-MessageControl.html#UnEscape" class="link">Source</a></p><div class="doc"><p>the UnEscape layout modifier. Listens to <code><a href="XMonad-Layout-MessageControl.html#t:EscapedMessage">EscapedMessage</a></code>s and sends
their nested message to the inner layout.
</p></div><div class="subs instances"><p id="control.i:UnEscape" class="caption collapser" onclick="toggleSection('i:UnEscape')">Instances</p><div id="section.i:UnEscape" class="show"><table><tr><td class="src"><a href="XMonad-Layout-LayoutModifier.html#t:LayoutModifier">LayoutModifier</a> <a href="XMonad-Layout-MessageControl.html#t:UnEscape">UnEscape</a> 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/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-MessageControl.html#t:UnEscape">UnEscape</a> w)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-MessageControl.html#t:UnEscape">UnEscape</a> w)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:unEscape" class="def">unEscape</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l w => l w -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-MessageControl.html#t:UnEscape">UnEscape</a> l w<a href="src/XMonad-Layout-MessageControl.html#unEscape" class="link">Source</a></p><div class="doc"><p>Applies the UnEscape layout modifier to a layout.
</p></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:EscapedMessage" class="def">EscapedMessage</a> <a href="src/XMonad-Layout-MessageControl.html#EscapedMessage" class="link">Source</a></p><div class="doc"><p>Data type for an escaped message. Send with <code><a href="XMonad-Layout-MessageControl.html#v:escape">escape</a></code>.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Escape" class="def">Escape</a> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:SomeMessage">SomeMessage</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:EscapedMessage" class="caption collapser" onclick="toggleSection('i:EscapedMessage')">Instances</p><div id="section.i:EscapedMessage" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> <a href="XMonad-Layout-MessageControl.html#t:EscapedMessage">EscapedMessage</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Message">Message</a> <a href="XMonad-Layout-MessageControl.html#t:EscapedMessage">EscapedMessage</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:escape" class="def">escape</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Message">Message</a> m => m -> <a href="XMonad-Layout-MessageControl.html#t:EscapedMessage">EscapedMessage</a><a href="src/XMonad-Layout-MessageControl.html#escape" class="link">Source</a></p><div class="doc"><p>Creates an <code><a href="XMonad-Layout-MessageControl.html#t:EscapedMessage">EscapedMessage</a></code>.
</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>
