WindowNavigation: haddock documentation

This commit is contained in:
Andrea Rossato
2007-11-23 12:11:29 +00:00
parent ea2102f93c
commit 33bca8260f

View File

@@ -37,37 +37,35 @@ import XMonad.Util.Invisible
import XMonad.Util.XUtils
-- $usage
-- You can use this module with the following in your Config.hs file:
-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
--
-- > import XMonad.Layout.WindowNavigation
-- >
-- > layoutHook = Layout $ windowNavigation $ Select ...
--
-- or perhaps
-- Then edit your @layoutHook@ by adding the WindowNavigation layout modifier
-- to some layout:
--
-- > layoutHook = Layout $ configurableNavigation (navigateColor "green") $ Select ...
-- > myLayouts = windowNavigation (Tall 1 (3/100) (1/2)) ||| Full ||| etc..
-- > main = xmonad dafaultConfig { layoutHook = myLayouts }
--
-- For more detailed instructions on editing the layoutHook see:
--
-- "XMonad.Doc.Extending#Editing_the_layout_hook"
--
-- In keybindings:
--
-- > , ((modMask, xK_Right), sendMessage $ Go R)
-- > , ((modMask, xK_Left ), sendMessage $ Go L)
-- > , ((modMask, xK_Up ), sendMessage $ Go U)
-- > , ((modMask, xK_Down ), sendMessage $ Go D)
-- > , ((modMask x, xK_Right), sendMessage $ Go R)
-- > , ((modMask x, xK_Left ), sendMessage $ Go L)
-- > , ((modMask x, xK_Up ), sendMessage $ Go U)
-- > , ((modMask x, xK_Down ), sendMessage $ Go D)
-- > , ((modMask x .|. controlMask, xK_Right), sendMessage $ Swap R)
-- > , ((modMask x .|. controlMask, xK_Left ), sendMessage $ Swap L)
-- > , ((modMask x .|. controlMask, xK_Up ), sendMessage $ Swap U)
-- > , ((modMask x .|. controlMask, xK_Down ), sendMessage $ Swap D)
--
-- For detailed instruction on editing the key binding see:
--
-- "XMonad.Doc.Extending#Editing_key_bindings".
-- %import XMonad.Layout.WindowNavigation
-- %keybind , ((modMask, xK_Right), sendMessage $ Go R)
-- %keybind , ((modMask, xK_Left ), sendMessage $ Go L)
-- %keybind , ((modMask, xK_Up ), sendMessage $ Go U)
-- %keybind , ((modMask, xK_Down ), sendMessage $ Go D)
-- %keybind , ((modMask .|. controlMask, xK_Right), sendMessage $ Swap R)
-- %keybind , ((modMask .|. controlMask, xK_Left ), sendMessage $ Swap L)
-- %keybind , ((modMask .|. controlMask, xK_Up ), sendMessage $ Swap U)
-- %keybind , ((modMask .|. controlMask, xK_Down ), sendMessage $ Swap D)
-- %layout -- include 'windowNavigation' in layoutHook definition above.
-- %layout -- just before the list, like the following (don't uncomment next line):
-- %layout -- layoutHook = Layout $ windowNavigation $ ...
-- %layout -- or
-- %layout -- layoutHook = Layout $ configurableNavigation (navigateColor "green") $ ...
data MoveWindowToWindow a = MoveWindowToWindow a a deriving ( Read, Show, Typeable )
instance Typeable a => Message (MoveWindowToWindow a)