SimpleFloat: export SimpleFloat and add documentation

This commit is contained in:
Andrea Rossato 2008-02-10 11:31:59 +00:00
parent 041f12f21d
commit ab38525b72

View File

@ -18,6 +18,7 @@ module XMonad.Layout.SimpleFloat
simpleFloat simpleFloat
, simpleFloat' , simpleFloat'
, SimpleDecoration (..) , SimpleDecoration (..)
, SimpleFloat (..)
, shrinkText, CustomShrink(CustomShrink) , shrinkText, CustomShrink(CustomShrink)
, Shrinker(..) , Shrinker(..)
) where ) where
@ -43,13 +44,17 @@ import XMonad.Layout.WindowArranger
-- --
-- "XMonad.Doc.Extending#Editing_the_layout_hook" -- "XMonad.Doc.Extending#Editing_the_layout_hook"
-- | FIXME -- | A simple floating layout where every window is placed according
-- to the window's initial attributes.
--
-- This version is decorated with the 'SimpleDecoration' style.
simpleFloat :: ModifiedLayout (Decoration SimpleDecoration DefaultShrinker) simpleFloat :: ModifiedLayout (Decoration SimpleDecoration DefaultShrinker)
(ModifiedLayout WindowArranger SimpleFloat) a (ModifiedLayout WindowArranger SimpleFloat) a
simpleFloat = decoration shrinkText defaultTheme (Simple False) (windowArrangeAll $ SF 20) simpleFloat = decoration shrinkText defaultTheme (Simple False) (windowArrangeAll $ SF 20)
-- | FIXME -- | Same as 'simpleFloat', but with the possibility of setting a
simpleFloat' :: Shrinker s => s -> Theme -> -- custom shrinker and a custom theme.
simpleFloat' :: Shrinker s => s -> Theme ->
ModifiedLayout (Decoration SimpleDecoration s) ModifiedLayout (Decoration SimpleDecoration s)
(ModifiedLayout WindowArranger SimpleFloat) a (ModifiedLayout WindowArranger SimpleFloat) a
simpleFloat' s c = decoration s c (Simple False) (windowArrangeAll $ SF (decoHeight c)) simpleFloat' s c = decoration s c (Simple False) (windowArrangeAll $ SF (decoHeight c))