twin/xmonad-contrib
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad-contrib.git synced 2025-07-31 20:21:51 -07:00
Code Issues Packages Projects Releases Wiki Activity

Structure L.MouseResizableTile documentation.

Browse Source
This commit is contained in:
Adam Vogt
2010-04-16 16:06:41 +00:00
parent 7129622eb9
commit 4950c69dbd
1 changed files with 21 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
XMonad/Layout/MouseResizableTile.hs
View File

@@ -20,13 +20,16 @@ module XMonad.Layout.MouseResizableTile (
mouseResizableTile,
mouseResizableTileMirrored,
MRTMessage (ShrinkSlave, ExpandSlave),
DraggerType (..),
-- * Parameters
-- $mrtParameters
nmaster,
masterFrac,
slaveFrac,
fracIncrement,
isMirrored,
draggerType,
isMirrored
DraggerType (..),
) where
import XMonad hiding (tile, splitVertically, splitHorizontallyBy)
@@ -46,15 +49,6 @@ import Control.Applicative((<$>))
-- > myLayout = mouseResizableTile ||| etc..
-- > main = xmonad defaultConfig { layoutHook = myLayout }
--
-- or
--
-- > myLayout = mouseResizableTileMirrored ||| etc..
-- > main = xmonad defaultConfig { layoutHook = myLayout }
--
-- Additionally, some parameters may be tweaked (see the rest of this document
-- for a list of them):
--
-- > myLayout = mouseResizableTile { draggerType = BordersDragger } ||| etc..
--
-- For more detailed instructions on editing the layoutHook see:
--
@@ -69,6 +63,17 @@ import Control.Applicative((<$>))
--
-- "XMonad.Doc.Extending#Editing_key_bindings".
-- $mrtParameters
-- The following functions are also labels for updating the @data@ (whose
-- representation is otherwise hidden) produced by 'mouseResizableTile'.
--
-- Usage:
--
-- > myLayout = mouseResizableTile{ masterFrac = 0.7,
-- > fracIncrement = 0.05,
-- > draggerType = BordersDragger }
-- > ||| etc..
data MRTMessage = SetMasterFraction Rational
| SetLeftSlaveFraction Int Rational
| SetRightSlaveFraction Int Rational
@@ -96,43 +101,30 @@ type DraggerGeometry = (Position, Dimension, Position, Dimension)
data MouseResizableTile a = MRT { nmaster :: Int,
-- ^ Get/set the number of windows in
-- master pane (default: 1). Usage:
--
-- > mouseResizableTile { nmaster = ... }
-- master pane (default: 1).
masterFrac :: Rational,
-- ^ Get/set the proportion of screen
-- occupied by master pane (default: 1/2).
-- Usage:
--
-- > mouseResizableTile { masterFrac = ... }
slaveFrac :: Rational,
-- ^ Get/set the proportion of remaining
-- space in a column occupied by a slave
-- window (default: 1/2). Usage:
--
-- > mouseResizableTile { slaveFrac = ... }
-- window (default: 1/2).
fracIncrement :: Rational,
-- ^ Get/set the increment used when
-- modifying masterFrac/slaveFrac by the
-- Shrink, Expand, etc. messages (default:
-- 3/100). Usage:
--
-- > mouseResizableTile { fracIncrement = ... }
-- 3/100).
leftFracs :: [Rational],
rightFracs :: [Rational],
draggers :: [DraggerWithWin],
draggerType :: DraggerType,
-- ^ Get/set dragger and gap dimensions
-- (default: FixedDragger 6 6). Usage:
--
-- > mouseResizableTile { draggerType = ... }
-- (default: FixedDragger 6 6).
focusPos :: Int,
numWindows :: Int,
isMirrored :: Bool
-- ^ Get/set whether the layout is
-- mirrored (default: False). Usage:
--
-- > mouseResizableTile { isMirrored = ... }
-- mirrored (default: False).
} deriving (Show, Read)
mouseResizableTile :: MouseResizableTile a