Sophie

Sophie

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

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.Hooks.DynamicHooks</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-Hooks-DynamicHooks.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-Hooks-DynamicHooks.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.Hooks.DynamicHooks</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"
>Braden.Shepherdson@gmail.com</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"
>One-shot and permanent ManageHooks that can be updated at runtime.
</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"
><A HREF="#v%3AinitDynamicHooks"
>initDynamicHooks</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-IORef.html#t%3AIORef"
>IORef</A
> DynamicHooks)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdynamicMasterHook"
>dynamicMasterHook</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-IORef.html#t%3AIORef"
>IORef</A
> DynamicHooks -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AaddDynamicHook"
>addDynamicHook</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-IORef.html#t%3AIORef"
>IORef</A
> DynamicHooks -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AX"
>X</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AupdateDynamicHook"
>updateDynamicHook</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-IORef.html#t%3AIORef"
>IORef</A
> DynamicHooks -&gt; (<A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
>) -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AX"
>X</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AoneShotHook"
>oneShotHook</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-IORef.html#t%3AIORef"
>IORef</A
> DynamicHooks -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AQuery"
>Query</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AX"
>X</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</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
>Provides two new kinds of ManageHooks that can be defined at runtime.
</P
><UL
><LI
> One-shot ManageHooks that are deleted after they execute.
</LI
><LI
> Permanent ManageHooks (unless you want to destroy them)
</LI
></UL
><P
>Note that you will lose all dynamically defined <TT
><A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TT
>s when you <TT
>mod+q</TT
>!
 If you want them to last, you should create them as normal in your <TT
>xmonad.hs</TT
>.
</P
><P
>First, you must execute <TT
><A HREF="XMonad-Hooks-DynamicHooks.html#v%3AinitDynamicHooks"
>initDynamicHooks</A
></TT
> from main in your <TT
>xmonad.hs</TT
>:
</P
><PRE
> dynHooksRef &lt;- initDynamicHooks
</PRE
><P
>and then pass this value to the other functions in this module.
</P
><P
>You also need to add the base <TT
><A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TT
>:
</P
><PRE
> xmonad { manageHook = myManageHook &lt;+&gt; dynamicMasterHook dynHooksRef }
</PRE
><P
>You must include this <TT
>dynHooksRef</TT
> value when using the functions in this
 module:
</P
><PRE
> xmonad { keys = myKeys `Data.Map.union` Data.Map.fromList
                   [((modm, xK_i), oneShotHook dynHooksRef
                    &quot;FFlaunchHook&quot; (className =? &quot;firefox&quot;) (doShift &quot;3&quot;)
                    &gt;&gt; spawn &quot;firefox&quot;)
                   ,((modm, xK_u), addDynamicHook dynHooksRef
                     (className =? &quot;example&quot; --&gt; doFloat))
                   ,((modm, xK_y), updatePermanentHook dynHooksRef
                     (const idHook))) ]  -- resets the permanent hook.
</PRE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:initDynamicHooks"
><A NAME="v%3AinitDynamicHooks"
></A
></A
><B
>initDynamicHooks</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-IORef.html#t%3AIORef"
>IORef</A
> DynamicHooks)</TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Hooks-DynamicHooks.html#initDynamicHooks"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Creates the <TT
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-IORef.html#t%3AIORef"
>IORef</A
></TT
> that stores the dynamically created <TT
><A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TT
>s.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:dynamicMasterHook"
><A NAME="v%3AdynamicMasterHook"
></A
></A
><B
>dynamicMasterHook</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-IORef.html#t%3AIORef"
>IORef</A
> DynamicHooks -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Hooks-DynamicHooks.html#dynamicMasterHook"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Master <TT
><A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TT
> that must be in your <TT
>xmonad.hs</TT
> <TT
><A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TT
>.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:addDynamicHook"
><A NAME="v%3AaddDynamicHook"
></A
></A
><B
>addDynamicHook</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-IORef.html#t%3AIORef"
>IORef</A
> DynamicHooks -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AX"
>X</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Hooks-DynamicHooks.html#addDynamicHook"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Appends the given <TT
><A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TT
> to the permanent dynamic <TT
><A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TT
>.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:updateDynamicHook"
><A NAME="v%3AupdateDynamicHook"
></A
></A
><B
>updateDynamicHook</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-IORef.html#t%3AIORef"
>IORef</A
> DynamicHooks -&gt; (<A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
>) -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AX"
>X</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Hooks-DynamicHooks.html#updateDynamicHook"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Modifies the permanent <TT
><A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TT
> with an arbitrary function.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:oneShotHook"
><A NAME="v%3AoneShotHook"
></A
></A
><B
>oneShotHook</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-IORef.html#t%3AIORef"
>IORef</A
> DynamicHooks -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AQuery"
>Query</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AX"
>X</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Hooks-DynamicHooks.html#oneShotHook"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Creates a one-shot <TT
><A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TT
>. Note that you have to specify the two
 parts of the <TT
><A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TT
> separately. Where you would usually write:
</P
><PRE
> className =? &quot;example&quot; --&gt; doFloat
</PRE
><P
>you must call <TT
><A HREF="XMonad-Hooks-DynamicHooks.html#v%3AoneShotHook"
>oneShotHook</A
></TT
> as
</P
><PRE
> oneShotHook dynHooksRef (className =? &quot;example) doFloat
</PRE
></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
>