xmonad-contrib-bluetilebranch-0.8.1: Third party extensions for xmonadSource codeContentsIndex
XMonad.Layout.NoBorders
Portabilityunportable
Stabilityunstable
MaintainerSpencer Janssen <spencerjanssen@gmail.com>
Contents
Usage
Description
Make a given layout display without borders. This is useful for full-screen or tabbed layouts, where you don't really want to waste a couple of pixels of real estate just to inform yourself that the visible window has focus.
Synopsis
noBorders :: LayoutClass l Window => l Window -> ModifiedLayout WithBorder l Window
smartBorders :: LayoutClass l a => l a -> ModifiedLayout SmartBorder l a
withBorder :: LayoutClass l a => Dimension -> l a -> ModifiedLayout WithBorder l a
lessBorders :: (SetsAmbiguous p, Read p, Show p, LayoutClass l a) => p -> l a -> ModifiedLayout (ConfigurableBorder p) l a
class SetsAmbiguous p where
hiddens :: p -> WindowSet -> Maybe (Stack Window) -> [(Window, Rectangle)] -> [Window]
data Ambiguity
= Combine With Ambiguity Ambiguity
| OnlyFloat
| Never
| EmptyScreen
| OtherIndicated
| Screen
data With
= Union
| Difference
| Intersection
Usage

You can use this module with the following in your ~/.xmonad/xmonad.hs file:

 import XMonad.Layout.NoBorders

and modify the layouts to call noBorders on the layouts you want to lack borders:

 layoutHook = ... ||| noBorders Full ||| ...

For more detailed instructions on editing the layoutHook see:

XMonad.Doc.Extending

noBorders :: LayoutClass l Window => l Window -> ModifiedLayout WithBorder l WindowSource
Removes all window borders from the specified layout.
smartBorders :: LayoutClass l a => l a -> ModifiedLayout SmartBorder l aSource

Removes the borders from a window under one of the following conditions:

  • There is only one screen and only one window. In this case it's obvious that it has the focus, so no border is needed.
  • A floating window covers the entire screen (e.g. mplayer).
withBorder :: LayoutClass l a => Dimension -> l a -> ModifiedLayout WithBorder l aSource
Forces a layout to use the specified border width. noBorders is equivalent to withBorder 0.
lessBorders :: (SetsAmbiguous p, Read p, Show p, LayoutClass l a) => p -> l a -> ModifiedLayout (ConfigurableBorder p) l aSource

Apply a datatype that has a SetsAmbiguous instance to provide a list of windows that should not have borders.

This gives flexibility over when borders should be drawn, in particular with xinerama setups: Ambiguity has a number of useful SetsAmbiguous instances

class SetsAmbiguous p whereSource

SetsAmbiguous allows custom actions to generate lists of windows that should not have borders drawn through ConfigurableBorder

To add your own (though perhaps those options would better belong as an aditional constructor to Ambiguity), you can add the function as such:

 data MyAmbiguity = MyAmbiguity deriving (Read, Show)
 instance SetsAmbiguous MyAmbiguity where
  hiddens _ wset mst wrs = otherHiddens Screen \\ otherHiddens OnlyFloat
     where otherHiddens p = hiddens p wset mst wrs

The above example is redundant, because you can have the same result with:

 layoutHook = lessBorders (Combine Difference Screen OnlyFloat) (Tall 1 0.5 0.03 ||| ... )

To get the same result as smartBorders:

 layoutHook = lessBorders (Combine Never) (Tall 1 0.5 0.03 ||| ...)

This indirect method is required to keep the Read and Show for ConfigurableBorder so that xmonad can serialize state.

Methods
hiddens :: p -> WindowSet -> Maybe (Stack Window) -> [(Window, Rectangle)] -> [Window]Source
show/hide Instances
data Ambiguity Source
In order of increasing ambiguity (less borders more frequently), where subsequent constructors add additional cases where borders are not drawn than their predecessors. These behaviors make most sense with with multiple screens: for single screens, Never or smartBorders makes more sense.
Constructors
Combine With Ambiguity AmbiguityThis constructor is used to combine the borderless windows provided by the SetsAmbiguous instances from two other Ambiguity data types.
OnlyFloatOnly remove borders on floating windows that cover the whole screen
NeverNever remove borders when ambiguous: this is the same as smartBorders
EmptyScreenFocus in an empty screens does not count as ambiguous.
OtherIndicatedNo borders on full when all other screens have borders.
ScreenBorders are never drawn on singleton screens. With this one you really need another way such as a statusbar to detect focus.
show/hide Instances
data With Source
Used to indicate to the SetsAmbiguous instance for Ambiguity how two lists should be combined.
Constructors
UnionCombine with Data.List.union
DifferenceCombine with Data.List.\
IntersectionCombine with Data.List.intersect
show/hide Instances
Produced by Haddock version 2.4.2