SinkAll: haddock updates

This commit is contained in:
Brent Yorgey
2007-11-27 19:13:18 +00:00
parent dbff738cda
commit 913bd274b3

View File

@@ -15,24 +15,28 @@ module XMonad.Actions.SinkAll (
sinkAll) where
import XMonad.Operations
import XMonad
import XMonad.Core
import XMonad.StackSet
import Graphics.X11.Xlib
-- $usage
-- > import XMonad.Actions.SinkAll
-- > keys x = [ ((modMask x .|. shiftMask, xK_t), sinkAll) ]
--
-- where 'x' is your XConfig.
-- %import XMonad.Actions.SinkAll
-- %keybind , ((modMask x .|. shiftMask, xK_t), sinkAll)
-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
--
-- > import XMonad.Actions.SinkAll
--
-- then add a keybinding; for example:
--
-- , ((modMask x .|. shiftMask, xK_t), sinkAll)
--
-- For detailed instructions on editing your key bindings, see
-- "XMonad.Doc.Extending#Editing_key_bindings".
-- | Un-float all floating windows on the current workspace.
sinkAll :: X ()
sinkAll = withAll sink
-- Apply a function to all windows on current workspace.
-- | Apply a function to all windows on current workspace.
withAll :: (Window -> WindowSet -> WindowSet) -> X ()
withAll f = windows $ \ws -> let all' = integrate' . stack . workspace . current $ ws
in foldr f ws all'