xmonad.hs: Minor documentation fix.

[config/dotfiles.git] / xmonad.hs

diff --git a/xmonad.hs b/xmonad.hs
index eba0cfc2c7c3d906daa3212ed4400a41c70a7440..c140f690bbe0cc5f4b507a18077e9f48b7efba95 100644 (file)
--- a/xmonad.hs
+++ b/xmonad.hs
@@ -1,6 +1,6 @@
--- XMonad configuration file.
+-- xmonad configuration file.
 --
--- Should work fine with XMonad 0.7 and above.
+-- Tested with xmonad 0.9, most settings should work fine with xmonad 0.7.
 
 
 -- "hiding" necessary for LayoutCombinators.
@@ -27,6 +27,9 @@ import XMonad.Layout.Named
 import XMonad.Layout.LayoutCombinators
 -- Necessary for Limit layout.
 import XMonad.Layout.TwoPane
+-- Necessary for the Gimp layout.
+import XMonad.Layout.PerWorkspace
+import XMonad.Layout.IM
 
 
 -- Prevent new windows from spawning in the master pane. Taken from
@@ -59,11 +62,18 @@ avoidMaster = W.modify' $ \c -> case c of
 --
 -- The limit layout displays only one window in the lower pane, thanks to to
 -- Qantourisc (2010-06-12 15:15 CEST) for the hint to use TwoPane.
-myLayoutHook = named "Default" (smartBorders $ Mirror tiled)
-           ||| named "Full" (smartBorders Full)
-           ||| named "Vertical" (smartBorders tiled)
-           ||| named "Limit" (smartBorders $ Mirror $ TwoPane delta ratio)
-    where
+--
+-- onWorkspace is used for a special layout for Gimp, thanks to Nathan Howell
+-- (http://nathanhowell.net/2009/03/08/xmonad-and-the-gimp/) for this layout
+-- (read on 2011-06-19).
+myLayoutHook =
+    onWorkspace "5" gimp
+    $ (
+        named "Default" (smartBorders $ Mirror tiled)
+        ||| named "Full" (smartBorders Full)
+        ||| named "Vertical" (smartBorders tiled)
+        ||| named "Limit" (smartBorders $ Mirror $ TwoPane delta ratio)
+    ) where
     -- Default tiling algorithm partitions the screen into two panes.
     tiled   = Tall nmaster delta ratio
     -- The default number of windows in the master pane.
@@ -72,6 +82,12 @@ myLayoutHook = named "Default" (smartBorders $ Mirror tiled)
     delta   = 3/100
     -- Default proportion of screen occupied by master pane.
     ratio   = 1/2
+    -- Special layout for Gimp: toolbox left, dock right, main window in the
+    -- center.
+    gimp    = withIM (0.11) (Role "gimp-toolbox") $
+              reflectHoriz $
+              withIM (0.15) (Role "gimp-dock")
+              Full
 
 -- Don't spawn new windows in the master pane (which is at the top of the
 -- screen). Thanks to dschoepe, aavogt and especially vav in #xmonad on
@@ -89,6 +105,8 @@ myManageHook = composeOne
     , className =? "Vncviewer"          -?> doF (W.shift "3")
     -- Wine on "4".
     , className =? "Wine"               -?> doF (W.shift "4")
+    -- Gimp on "5".
+    , className =? "Gimp"               -?> doF (W.shift "5")
 
     -- Don't spawn new windows in the master pane.
     , return True -?> doF avoidMaster
@@ -108,16 +126,17 @@ nextLayoutIncluding :: [String] -> X ()
 nextLayoutIncluding layouts = do
     cws <- gets (W.workspace . W.current . windowset)
     sendMessageWithNoRefresh NextLayout cws
-    nextLayoutIncluding' layouts
+    nextLayoutIncluding' layouts 1000 -- nobody has more than 1000 layouts
 
-nextLayoutIncluding' :: [String] -> X ()
-nextLayoutIncluding' layouts = do
+nextLayoutIncluding' :: [String] -> Int -> X ()
+nextLayoutIncluding' layouts iterations = do
     cws <- gets (W.workspace . W.current . windowset)
-    if not $ (description $ W.layout cws) `elem` layouts
+    -- iterations prevents an endless loop if no valid layout can be found.
+    if not ((description $ W.layout cws) `elem` layouts) && iterations > 0
         -- Skip over excluded layouts.
         then do
             sendMessageWithNoRefresh NextLayout cws
-            nextLayoutIncluding' layouts
+            nextLayoutIncluding' layouts (iterations - 1)
         -- Found allowed layout, show it.
         else refresh
 
@@ -136,15 +155,15 @@ myKeys = [
     ]
     ++
     -- When using multiple screens, switching to another workspace causes
-    -- Xmonad to pull the workspace to the current screen if it was also
+    -- xmonad to pull the workspace to the current screen if it was also
     -- displayed on another one. This is confusing for me so the following
     -- code changes it to just switch to the screen where the workspace is
     -- already displayed.
     --
-    -- Thanks to the Xmonad FAQ, read on 2010-06-16 13:42 CEST
+    -- Thanks to the xmonad FAQ, read on 2010-06-16 13:42 CEST
     -- (http://www.haskell.org/haskellwiki/Xmonad/Frequently_asked_questions).
-    -- Thanks to MrElendig in #xmonad on Freenode (2010-06-17 17:16 CEST) to
-    -- use the default XMonad workspaces.
+    -- Thanks to MrElendig in #xmonad on Freenode (2010-06-17 17:16 CEST) how
+    -- to use the default xmonad workspaces.
     [((m .|. mod4Mask, k), windows $ f i)
         | (i, k) <- zip (XMonad.workspaces defaultConfig) [xK_1 .. xK_9]
         , (f, m) <- [(W.view, 0), (W.shift, shiftMask)]]
@@ -162,7 +181,7 @@ main = xmonad $ defaultConfig
     , manageHook = myManageHook
     -- Use unicode rxvt as my terminal.
     , terminal = "urxvt"
-    -- Necessary for Java so it recognizes XMonad as tiling window manager.
+    -- Necessary for Java so it recognizes xmonad as tiling window manager.
     , startupHook = setWMName "LG3D"
     }
     `additionalKeys` myKeys