From 59aa24736c4eb893d80a51ef29aa9de986249608 Mon Sep 17 00:00:00 2001 From: Devin Mullins Date: Sun, 25 May 2008 07:02:31 +0200 Subject: more documentation for WindowNavigation and UrgencyHook darcs-hash:20080525050231-78224-669c83df86a8b585883d0fb3ef054e37670261e8.gz --- XMonad/Actions/WindowNavigation.hs | 43 +++++++++++++++++++++++++++++++------- 1 file changed, 35 insertions(+), 8 deletions(-) (limited to 'XMonad/Actions/WindowNavigation.hs') diff --git a/XMonad/Actions/WindowNavigation.hs b/XMonad/Actions/WindowNavigation.hs index 3d636ba..2bf605c 100644 --- a/XMonad/Actions/WindowNavigation.hs +++ b/XMonad/Actions/WindowNavigation.hs @@ -1,17 +1,27 @@ ----------------------------------------------------------------------------- -- | --- Module : XMonad.Layout.WindowNavigation +-- Module : XMonad.Actions.WindowNavigation -- Copyright : (c) 2007 David Roundy , -- Devin Mullins -- Maintainer : Devin Mullins -- License : BSD3-style (see LICENSE) -- --- This is a rewrite of "XMonad.Layout.WindowNavigation", for the purposes of --- code cleanup and Xinerama support. It's not complete, so you'll want to --- use that one for now. +-- This is a rewrite of "XMonad.Layout.WindowNavigation". WindowNavigation +-- lets you assign keys to move up\/down\/left\/right, based on actual cartesian +-- window coordinates, rather than just going j\/k on the stack. -- --- WindowNavigation lets you assign keys to move up/down/left/right, based on --- actual cartesian window coordinates, rather than just going j/k on the stack. +-- This module differs from the other in a few ways: +-- +-- (1) You can go up\/down\/left\/right across multiple screens. +-- +-- (2) It doesn't provide little border colors for your neighboring windows. +-- +-- (3) It doesn't provide the \'Move\' action, which seems to be related to +-- the XMonad.Layout.Combo extension. +-- +-- (4) It tries to be slightly smarter about tracking your current position. +-- +-- (5) Configuration is different. -- ----------------------------------------------------------------------------- @@ -42,12 +52,29 @@ import Graphics.X11.Xlib -- $usage -- --- Don't use it! What, are you crazy? +-- To use it, you're going to apply the 'withWindowNavigation' function. +-- 'withWindowNavigation' performs some IO operations, so the syntax you'll use +-- is the same as the spawnPipe example in "XMonad.Hooks.DynamicLog". +-- In particular: +-- +-- > main = do +-- > config <- withWindowNavigation (xK_w, xK_a, xK_s, xK_d) +-- > $ defaultConfig { ... } +-- > xmonad config +-- +-- Here, we pass in the keys for navigation in counter-clockwise order from up. +-- It creates keybindings for @modMask@ to move to window, and @modMask .|. shiftMask@ +-- to swap windows. +-- +-- If you want more flexibility over your keybindings, you can use +-- 'withWindowNavigationKeys', which takes a list of @keys@-esque entries rather +-- than a tuple of the four directional keys. See the source code of +-- 'withWindowNavigation' for an example. -- TODO: --- - documentation :) -- - monad for WNState? -- - cleanup (including inr) +-- - more documentation -- - tests? (esp. for edge cases in currentPosition) -- - solve the 2+3, middle right to bottom left problem -- - manageHook to draw window decos? -- cgit v1.2.3