Sophie

Sophie

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

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.Util.NamedScratchpad</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-Util-NamedScratchpad.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-Util-NamedScratchpad.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.Util.NamedScratchpad</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"
>Konstantin Sobolev &lt;konstantin.sobolev@gmail.com&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"
>Named scratchpads that support several arbitrary applications at the same time.
</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%3ANamedScratchpad"
>NamedScratchpad</A
>  = <A HREF="#v%3ANS"
>NS</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3Aname"
>name</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Acmd"
>cmd</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Aquery"
>query</A
> :: <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
></TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Ahook"
>hook</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TD
></TR
></TABLE
>}</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AnonFloating"
>nonFloating</A
> :: <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%3AdefaultFloating"
>defaultFloating</A
> :: <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%3AcustomFloating"
>customFloating</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-StackSet.html#t%3ARationalRect"
>RationalRect</A
> -&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"
><SPAN CLASS="keyword"
>type</SPAN
> <A HREF="#t%3ANamedScratchpads"
>NamedScratchpads</A
> = [<A HREF="XMonad-Util-NamedScratchpad.html#t%3ANamedScratchpad"
>NamedScratchpad</A
>]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AnamedScratchpadAction"
>namedScratchpadAction</A
> :: <A HREF="XMonad-Util-NamedScratchpad.html#t%3ANamedScratchpads"
>NamedScratchpads</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</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%3AnamedScratchpadManageHook"
>namedScratchpadManageHook</A
> :: <A HREF="XMonad-Util-NamedScratchpad.html#t%3ANamedScratchpads"
>NamedScratchpads</A
> -&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%3AnamedScratchpadFilterOutWorkspace"
>namedScratchpadFilterOutWorkspace</A
> :: [<A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AWindowSpace"
>WindowSpace</A
>] -&gt; [<A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AWindowSpace"
>WindowSpace</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
>Allows to have several floating scratchpads running different applications.
 Bind a key to namedScratchpadSpawnAction.
 Pressing it will spawn configured application, or bring it to the current
 workspace if it already exists.
 Pressing the key with the application on the current workspace will
 send it to a hidden workspace called <TT
>NSP</TT
>.
</P
><P
>If you already have a workspace called <TT
>NSP</TT
>, it will use that.
 <TT
>NSP</TT
> will also appear in xmobar and dzen status bars. You can tweak your
 <TT
>dynamicLog</TT
> settings to filter it out if you like.
</P
><P
>Create named scratchpads configuration in your xmonad.hs like this:
</P
><PRE
> import XMonad.StackSet as W
 import XMonad.ManageHook
 import XMonad.Util.NamedScratchpad

 scratchpads = [
 -- run htop in xterm, find it by title, use default floating window placement
     NS &quot;htop&quot; &quot;xterm -e htop&quot; (title =? &quot;htop&quot;) defaultFloating ,

 -- run stardict, find it by class name, place it in the floating window
 -- 1/6 of screen width from the left, 1/6 of screen height
 -- from the top, 2/3 of screen width by 2/3 of screen height
     NS &quot;stardict&quot; &quot;stardict&quot; (className =? &quot;Stardict&quot;)
         (customFloating $ W.RationalRect (1/6) (1/6) (2/3) (2/3)) ,

 -- run gvim, find by role, don't float
     NS &quot;notes&quot; &quot;gvim --role notes ~/notes.txt&quot; (role =? &quot;notes&quot;) nonFloating
 ] where role = stringProperty &quot;WM_WINDOW_ROLE&quot;
</PRE
><P
>Add keybindings:
</P
><PRE
>  , ((modm .|. controlMask .|. shiftMask, xK_t), namedScratchpadAction scratchpads &quot;htop&quot;)
  , ((modm .|. controlMask .|. shiftMask, xK_s), namedScratchpadAction scratchpads &quot;stardict&quot;)
  , ((modm .|. controlMask .|. shiftMask, xK_n), namedScratchpadAction scratchpads &quot;notes&quot;)
</PRE
><P
>... and a manage hook:
</P
><PRE
>  , manageHook = namedScratchpadManageHook scratchpads
</PRE
><P
>For detailed instruction on editing the key binding see
 <A HREF="XMonad-Doc-Extending.html#Editing_key_bindings"
>XMonad.Doc.Extending</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:NamedScratchpad"
><A NAME="t%3ANamedScratchpad"
></A
></A
><B
>NamedScratchpad</B
>  </TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Util-NamedScratchpad.html#NamedScratchpad"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Single named scratchpad configuration
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="5" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:NS"
><A NAME="v%3ANS"
></A
></A
><B
>NS</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="body" COLSPAN="2"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:name"
><A NAME="v%3Aname"
></A
></A
><B
>name</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>Scratchpad name
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:cmd"
><A NAME="v%3Acmd"
></A
></A
><B
>cmd</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>Command used to run application
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:query"
><A NAME="v%3Aquery"
></A
></A
><B
>query</B
> :: <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
></TD
><TD CLASS="rdoc"
>Query to find already running application
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:hook"
><A NAME="v%3Ahook"
></A
></A
><B
>hook</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TD
><TD CLASS="rdoc"
>Manage hook called for application window, use it to define the placement. See <TT
>nonFloating</TT
>, <TT
>defaultFloating</TT
> and <TT
>customFloating</TT
>
</TD
></TR
></TABLE
></TD
></TR
></TABLE
></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:nonFloating"
><A NAME="v%3AnonFloating"
></A
></A
><B
>nonFloating</B
> :: <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-Util-NamedScratchpad.html#nonFloating"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Manage hook that makes the window non-floating
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:defaultFloating"
><A NAME="v%3AdefaultFloating"
></A
></A
><B
>defaultFloating</B
> :: <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-Util-NamedScratchpad.html#defaultFloating"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Manage hook that makes the window floating with the default placement
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:customFloating"
><A NAME="v%3AcustomFloating"
></A
></A
><B
>customFloating</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-StackSet.html#t%3ARationalRect"
>RationalRect</A
> -&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-Util-NamedScratchpad.html#customFloating"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Manage hook that makes the window floating with custom placement
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>type</SPAN
> <A NAME="t:NamedScratchpads"
><A NAME="t%3ANamedScratchpads"
></A
></A
><B
>NamedScratchpads</B
> = [<A HREF="XMonad-Util-NamedScratchpad.html#t%3ANamedScratchpad"
>NamedScratchpad</A
>]</TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Util-NamedScratchpad.html#NamedScratchpads"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Named scratchpads configuration
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:namedScratchpadAction"
><A NAME="v%3AnamedScratchpadAction"
></A
></A
><B
>namedScratchpadAction</B
></TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Util-NamedScratchpad.html#namedScratchpadAction"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="XMonad-Util-NamedScratchpad.html#t%3ANamedScratchpads"
>NamedScratchpads</A
></TD
><TD CLASS="rdoc"
>Named scratchpads configuration
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>Scratchpad name
</TD
></TR
><TR
><TD CLASS="arg"
>-&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="rdoc"
></TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
>Action to pop up specified named scratchpad
</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:namedScratchpadManageHook"
><A NAME="v%3AnamedScratchpadManageHook"
></A
></A
><B
>namedScratchpadManageHook</B
></TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Util-NamedScratchpad.html#namedScratchpadManageHook"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="XMonad-Util-NamedScratchpad.html#t%3ANamedScratchpads"
>NamedScratchpads</A
></TD
><TD CLASS="rdoc"
>Named scratchpads configuration
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AManageHook"
>ManageHook</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
>Manage hook to use with named scratchpads
</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:namedScratchpadFilterOutWorkspace"
><A NAME="v%3AnamedScratchpadFilterOutWorkspace"
></A
></A
><B
>namedScratchpadFilterOutWorkspace</B
> :: [<A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AWindowSpace"
>WindowSpace</A
>] -&gt; [<A HREF="/usr/share/doc/ghc/html/libraries/xmonad-0.9.1/XMonad-Core.html#t%3AWindowSpace"
>WindowSpace</A
>]</TD
><TD CLASS="declbut"
><A HREF="src/XMonad-Util-NamedScratchpad.html#namedScratchpadFilterOutWorkspace"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Transforms a workspace list containing the NSP workspace into one that
 doesn't contain it. Intended for use with logHooks.
</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
>