|xmonad-contrib-0.7: Third party extensions for xmonad||Contents||Index|
|A layout modifier and a class for easily creating decorated
This module is intended for layout developers, who want to decorate
their layouts. End users will not find here very much for them.
For examples of DecorationStyle instances you can have a look at
XMonad.Layout.DwmStyle, or XMonad.Layout.TabBarDecoration.
|decoration :: (DecorationStyle ds a, Shrinker s) => s -> Theme -> ds a -> l a -> ModifiedLayout (Decoration ds s) l a|
A layout modifier that, with a Shrinker, a Theme, a
DecorationStyle, and a layout, will decorate this layout
according to the decoration style provided.
For some usage examples see XMonad.Layout.DecorationMadness.
|data Theme |
A Theme is a record of colors, font etc., to customize a
For a collection of Themes see XMonad.Util.Themes
|activeColor :: String||Color of the active window
|inactiveColor :: String||Color of the inactive window
|urgentColor :: String||Color of the urgent window
|activeBorderColor :: String||Color of the border of the active window
|inactiveBorderColor :: String||Color of the border of the inactive window
|urgentBorderColor :: String||Color of the border of the urgent window
|activeTextColor :: String||Color of the text of the active window
|inactiveTextColor :: String||Color of the text of the inactive window
|urgentTextColor :: String||Color of the text of the urgent window
|fontName :: String||Font name
|decoWidth :: Dimension||Maximum width of the decorations (if supported by the DecorationStyle)
|decoHeight :: Dimension||Height of the decorations
|defaultTheme :: Theme|
|The default xmonad Theme.
|data Decoration ds s a|
|data DecorationMsg |
|A Decoration layout modifier will handle SetTheme, a message
to dynamically change the decoration Theme.
|class (Read (ds a), Show (ds a), Eq a) => DecorationStyle ds a where|
|The DecorationStyle class, defines methods used in the
implementation of the Decoration LayoutModifier instance. A
type instance of this class is passed to the Decoration type in
order to decorate a layout, by using these methods.
|describeDeco :: ds a -> String|
|The description that the Decoration modifier will display.
|shrink :: ds a -> Rectangle -> Rectangle -> Rectangle|
|Shrink the window's rectangle when applying a decoration.
|decorationEventHook :: ds a -> DecorationState -> Event -> X ()|
|The decoration event hook, where the
decorationMouseFocusHook and decorationMouseDragHook are
called. If you reimplement it those methods will not be
|decorationMouseFocusHook :: ds a -> DecorationState -> Event -> X ()|
|This method is called when the user clicks the pointer over
|decorationMouseDragHook :: ds a -> DecorationState -> Event -> X ()|
|This method is called when the user starts grabbing the
|pureDecoration :: ds a -> Dimension -> Dimension -> Rectangle -> Stack a -> [(a, Rectangle)] -> (a, Rectangle) -> Maybe Rectangle|
|The pure version of the main method, decorate.
|decorate :: ds a -> Dimension -> Dimension -> Rectangle -> Stack a -> [(a, Rectangle)] -> (a, Rectangle) -> X (Maybe Rectangle)|
|Given the theme's decoration width and height, the screen
rectangle, the windows stack, the list of windows and
rectangles returned by the underlying layout and window to be
decorated, tupled with its rectangle, produce a Just
Rectangle or Nothing if the window is not to be decorated.
|data DefaultDecoration a|
|The default DecorationStyle, with just the default methods'
|class (Read s, Show s) => Shrinker s where|
|data DefaultShrinker |
|shrinkText :: DefaultShrinker|
|data CustomShrink |
|isInStack :: Eq a => Stack a -> a -> Bool|
|True if the window is in the Stack. The Window comes second
to facilitate list processing, even though w `isInStack` s won't
|isVisible :: Rectangle -> [Rectangle] -> Bool|
|Given a Rectangle and a list of Rectangles is True if the
Rectangle is not completely contained by any Rectangle of the
|isInvisible :: Rectangle -> [Rectangle] -> Bool|
|The contrary of isVisible.
|isWithin :: Rectangle -> Rectangle -> Bool|
|True is the first Rectangle is totally within the second
|fi :: (Integral a, Num b) => a -> b|
|Short-hand for fromIntegral
|Produced by Haddock version 0.8|