Document XState fields

This commit is contained in:
Spencer Janssen
2007-04-09 07:34:14 +00:00
parent a0f7df2fa6
commit 8c88e102b4

View File

@@ -33,21 +33,19 @@ import qualified Data.Map as M
-- | XState, the window manager state. -- | XState, the window manager state.
-- Just the display, width, height and a window list -- Just the display, width, height and a window list
data XState = XState data XState = XState
{ display :: Display { display :: Display -- ^ the X11 display
, screen :: !ScreenNumber , screen :: !ScreenNumber
, xineScreens :: ![Rectangle] , xineScreens :: ![Rectangle] -- ^ dimensions of each screen
-- a mapping of workspaces to xinerama screen numbers
, wsOnScreen :: !(M.Map Int Int) , wsOnScreen :: !(M.Map Int Int) -- ^ mapping of workspaces to xinerama screen numbers
, theRoot :: !Window , theRoot :: !Window -- ^ the root window
, wmdelete :: !Atom , wmdelete :: !Atom -- ^ window deletion atom
, wmprotocols :: !Atom , wmprotocols :: !Atom -- ^ wm protocols atom
, dimensions :: !(Int,Int) , dimensions :: !(Int,Int) -- ^ dimensions of the screen, used for hiding windows
, workspace :: !WorkSpace -- ^ workspace list , workspace :: !WorkSpace -- ^ workspace list
, defaultLayoutDesc :: !LayoutDesc , defaultLayoutDesc :: !LayoutDesc -- ^ default layout
, layoutDescs :: !(M.Map Int LayoutDesc) , layoutDescs :: !(M.Map Int LayoutDesc) -- ^ mapping of workspaces to descriptions of their layouts
-- ^ mapping of workspaces to descriptions of their layouts
} }
type WorkSpace = StackSet Window type WorkSpace = StackSet Window