Sophie

Sophie

distrib > Fedora > 14 > i386 > by-pkgid > 97b7e04d4a67814e1160568251f09714 > files > 481

ghc-xmonad-contrib-devel-0.9.1-8.fc14.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>XMonad.Layout.MessageControl</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_XMonad-Layout-MessageControl.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>xmonad-contrib-0.9.1: Third party extensions for xmonad</TD
><TD CLASS="topbut"
><A HREF="src/XMonad-Layout-MessageControl.html"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>XMonad.Layout.MessageControl</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>unportable</TD
></TR
><TR
><TD CLASS="infohead"
>Stability</TD
><TD CLASS="infoval"
>unstable</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>&lt;quentin.moser@unifr.ch&gt;</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><B
>Contents</B
></TD
></TR
><TR
><TD
><DL
><DT
><A HREF="#1"
>Usage
</A
></DT
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>Provides message &quot;escaping&quot; and filtering facilities which
 help control complex nested layouts.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AIgnore"
>Ignore</A
> m l w</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aignore"
>ignore</A
> :: (<A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AMessage"
>Message</A
> m, <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3ALayoutClass"
>LayoutClass</A
> l w) =&gt; m -&gt; l w -&gt; <A HREF="XMonad-Layout-MessageControl.html#t%3AIgnore"
>Ignore</A
> m l w</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AUnEscape"
>UnEscape</A
> w</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AunEscape"
>unEscape</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3ALayoutClass"
>LayoutClass</A
> l w =&gt; l w -&gt; <A HREF="XMonad-Layout-LayoutModifier.html#t%3AModifiedLayout"
>ModifiedLayout</A
> <A HREF="XMonad-Layout-MessageControl.html#t%3AUnEscape"
>UnEscape</A
> l w</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>newtype</SPAN
>  <A HREF="#t%3AEscapedMessage"
>EscapedMessage</A
>  = <A HREF="#v%3AEscape"
>Escape</A
> <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3ASomeMessage"
>SomeMessage</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aescape"
>escape</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AMessage"
>Message</A
> m =&gt; m -&gt; <A HREF="XMonad-Layout-MessageControl.html#t%3AEscapedMessage"
>EscapedMessage</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="1"
><A NAME="1"
>Usage
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="doc"
><P
>You can use this module by importing it into your <TT
>~/.xmonad/xmonad.hs</TT
> 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 <TT
><A HREF="XMonad-Layout-MessageControl.html#v%3AunEscape"
>unEscape</A
></TT
> 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
  <TT
>sendMessage $ escape message</TT
>, 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 <TT
><A HREF="XMonad-Layout-MessageControl.html#v%3Aignore"
>ignore</A
></TT
> modifier:
</P
><PRE
> myLayout = Tall ||| (ignore NextLayout $ ignore (JumpToLayout &quot;&quot;) $
                       unEscape $ mastered 0.01 0.5 
                         $ Full ||| simpleTabbed)
</PRE
><P
><EM
>IMPORTANT NOTE:</EM
> The standard '(|||)' operator from <A HREF="XMonad-Layout.html"
>XMonad.Layout</A
>
 does not behave correctly with <TT
><A HREF="XMonad-Layout-MessageControl.html#v%3Aignore"
>ignore</A
></TT
>. Make sure you use the one
 from <A HREF="XMonad-Layout-LayoutCombinators.html"
>XMonad.Layout.LayoutCombinators</A
>.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:Ignore"
><A NAME="t%3AIgnore"
></A
></A
><B
>Ignore</B
> m l w </TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Layout-MessageControl.html#Ignore"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>the Ignore layout modifier. Prevents its inner layout from receiving
 messages of a certain type.
</TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Ignore')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Ignore" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>(<A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AMessage"
>Message</A
> m, <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3ALayoutClass"
>LayoutClass</A
> l w) =&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3ALayoutClass"
>LayoutClass</A
> (<A HREF="XMonad-Layout-MessageControl.html#t%3AIgnore"
>Ignore</A
> m l) w</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Read.html#t%3ARead"
>Read</A
> (l w) =&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Read.html#t%3ARead"
>Read</A
> (<A HREF="XMonad-Layout-MessageControl.html#t%3AIgnore"
>Ignore</A
> m l w)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Show.html#t%3AShow"
>Show</A
> (l w) =&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Show.html#t%3AShow"
>Show</A
> (<A HREF="XMonad-Layout-MessageControl.html#t%3AIgnore"
>Ignore</A
> m l w)</TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:ignore"
><A NAME="v%3Aignore"
></A
></A
><B
>ignore</B
> :: (<A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AMessage"
>Message</A
> m, <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3ALayoutClass"
>LayoutClass</A
> l w) =&gt; m -&gt; l w -&gt; <A HREF="XMonad-Layout-MessageControl.html#t%3AIgnore"
>Ignore</A
> m l w</TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Layout-MessageControl.html#ignore"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Applies the Ignore layout modifier to a layout, blocking
 all messages of the same type as the one passed as its first argument.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:UnEscape"
><A NAME="t%3AUnEscape"
></A
></A
><B
>UnEscape</B
> w </TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Layout-MessageControl.html#UnEscape"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>the UnEscape layout modifier. Listens to <TT
><A HREF="XMonad-Layout-MessageControl.html#t%3AEscapedMessage"
>EscapedMessage</A
></TT
>s and sends
 their nested message to the inner layout.
</TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:UnEscape')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:UnEscape" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="XMonad-Layout-LayoutModifier.html#t%3ALayoutModifier"
>LayoutModifier</A
> <A HREF="XMonad-Layout-MessageControl.html#t%3AUnEscape"
>UnEscape</A
> a</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Read.html#t%3ARead"
>Read</A
> (<A HREF="XMonad-Layout-MessageControl.html#t%3AUnEscape"
>UnEscape</A
> w)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Show.html#t%3AShow"
>Show</A
> (<A HREF="XMonad-Layout-MessageControl.html#t%3AUnEscape"
>UnEscape</A
> w)</TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:unEscape"
><A NAME="v%3AunEscape"
></A
></A
><B
>unEscape</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3ALayoutClass"
>LayoutClass</A
> l w =&gt; l w -&gt; <A HREF="XMonad-Layout-LayoutModifier.html#t%3AModifiedLayout"
>ModifiedLayout</A
> <A HREF="XMonad-Layout-MessageControl.html#t%3AUnEscape"
>UnEscape</A
> l w</TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Layout-MessageControl.html#unEscape"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Applies the UnEscape layout modifier to a layout.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>newtype</SPAN
>  <A NAME="t:EscapedMessage"
><A NAME="t%3AEscapedMessage"
></A
></A
><B
>EscapedMessage</B
>  </TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Layout-MessageControl.html#EscapedMessage"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Data type for an escaped message. Send with <TT
><A HREF="XMonad-Layout-MessageControl.html#v%3Aescape"
>escape</A
></TT
>.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:Escape"
><A NAME="v%3AEscape"
></A
></A
><B
>Escape</B
> <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3ASomeMessage"
>SomeMessage</A
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:EscapedMessage')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:EscapedMessage" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Typeable.html#t%3ATypeable"
>Typeable</A
> <A HREF="XMonad-Layout-MessageControl.html#t%3AEscapedMessage"
>EscapedMessage</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AMessage"
>Message</A
> <A HREF="XMonad-Layout-MessageControl.html#t%3AEscapedMessage"
>EscapedMessage</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:escape"
><A NAME="v%3Aescape"
></A
></A
><B
>escape</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AMessage"
>Message</A
> m =&gt; m -&gt; <A HREF="XMonad-Layout-MessageControl.html#t%3AEscapedMessage"
>EscapedMessage</A
></TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Layout-MessageControl.html#escape"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Creates an <TT
><A HREF="XMonad-Layout-MessageControl.html#t%3AEscapedMessage"
>EscapedMessage</A
></TT
>.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.6.1</TD
></TR
></TABLE
></BODY
></HTML
>