aboutsummaryrefslogtreecommitdiffstats
path: root/XMonad
diff options
context:
space:
mode:
authorAndrea Rossato <andrea.rossato@unibz.it>2008-02-10 12:31:59 +0100
committerAndrea Rossato <andrea.rossato@unibz.it>2008-02-10 12:31:59 +0100
commitc85a3186c5116be2a0b3f99056af574e3aedff19 (patch)
tree1a2015a18f234853a54ddb4a2fdc26b3470c6dfd /XMonad
parent273410553233b840e2223eaa924300599dce4255 (diff)
downloadXMonadContrib-c85a3186c5116be2a0b3f99056af574e3aedff19.tar.gz
XMonadContrib-c85a3186c5116be2a0b3f99056af574e3aedff19.tar.xz
XMonadContrib-c85a3186c5116be2a0b3f99056af574e3aedff19.zip
SimpleFloat: export SimpleFloat and add documentation
darcs-hash:20080210113159-32816-4821b7c8d4d18ec8c5d47c7b1620f280f2c9625c.gz
Diffstat (limited to 'XMonad')
-rw-r--r--XMonad/Layout/SimpleFloat.hs11
1 files changed, 8 insertions, 3 deletions
diff --git a/XMonad/Layout/SimpleFloat.hs b/XMonad/Layout/SimpleFloat.hs
index cd90306..4aa8e4f 100644
--- a/XMonad/Layout/SimpleFloat.hs
+++ b/XMonad/Layout/SimpleFloat.hs
@@ -18,6 +18,7 @@ module XMonad.Layout.SimpleFloat
simpleFloat
, simpleFloat'
, SimpleDecoration (..)
+ , SimpleFloat (..)
, shrinkText, CustomShrink(CustomShrink)
, Shrinker(..)
) where
@@ -43,13 +44,17 @@ import XMonad.Layout.WindowArranger
--
-- "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)
(ModifiedLayout WindowArranger SimpleFloat) a
simpleFloat = decoration shrinkText defaultTheme (Simple False) (windowArrangeAll $ SF 20)
--- | FIXME
-simpleFloat' :: Shrinker s => s -> Theme ->
+-- | Same as 'simpleFloat', but with the possibility of setting a
+-- custom shrinker and a custom theme.
+simpleFloat' :: Shrinker s => s -> Theme ->
ModifiedLayout (Decoration SimpleDecoration s)
(ModifiedLayout WindowArranger SimpleFloat) a
simpleFloat' s c = decoration s c (Simple False) (windowArrangeAll $ SF (decoHeight c))