<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>XMonad.Layout.LayoutHints</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_XMonad-Layout-LayoutHints.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-LayoutHints.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">xmonad-contrib-0.9.2: Third party extensions for xmonad</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>unportable</td></tr><tr><th>Stability</th><td>unstable</td></tr><tr><th>Maintainer</th><td>none</td></tr></table><p class="caption">XMonad.Layout.LayoutHints</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">usage
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Make layouts respect size hints.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:layoutHints">layoutHints</a> :: LayoutClass l a => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-LayoutHints.html#t:LayoutHints">LayoutHints</a> l a</li><li class="src short"><a href="#v:layoutHintsWithPlacement">layoutHintsWithPlacement</a> :: LayoutClass l a => (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Double">Double</a>, <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Double">Double</a>) -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-LayoutHints.html#t:LayoutHints">LayoutHints</a> l a</li><li class="src short"><a href="#v:layoutHintsToCenter">layoutHintsToCenter</a> :: LayoutClass l a => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> LayoutHintsToCenter l a</li><li class="src short"><span class="keyword">data</span> <a href="#t:LayoutHints">LayoutHints</a> a</li></ul></div><div id="interface"><h1 id="g:1">usage
</h1><div class="doc"><p>You can use this module with the following in your <code>~/.xmonad/xmonad.hs</code>:
</p><pre> import XMonad.Layout.LayoutHints
</pre><p>Then edit your <code>layoutHook</code> by adding the <code><a href="XMonad-Layout-LayoutHints.html#v:layoutHints">layoutHints</a></code> layout modifier
to some layout:
</p><pre> myLayout = layoutHints (Tall 1 (3/100) (1/2)) ||| Full ||| etc..
main = xmonad defaultConfig { layoutHook = myLayout }
</pre><p>Or, to center the adapted window in its available area:
</p><pre> myLayout = layoutHintsWithPlacement (0.5, 0.5) (Tall 1 (3/100) (1/2))
||| Full ||| etc..
</pre><p>Or, to make a reasonable attempt to eliminate gaps between windows:
</p><pre> myLayout = layoutHintsToCenter (Tall 1 (3/100) (1/2))
</pre><p>For more detailed instructions on editing the layoutHook see:
</p><p><a href="XMonad-Doc-Extending.html#Editing_the_layout_hook">XMonad.Doc.Extending</a>
</p></div><div class="top"><p class="src"><a name="v:layoutHints" class="def">layoutHints</a> :: LayoutClass l a => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-LayoutHints.html#t:LayoutHints">LayoutHints</a> l a<a href="src/XMonad-Layout-LayoutHints.html#layoutHints" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:layoutHintsWithPlacement" class="def">layoutHintsWithPlacement</a> :: LayoutClass l a => (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Double">Double</a>, <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Double">Double</a>) -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-LayoutHints.html#t:LayoutHints">LayoutHints</a> l a<a href="src/XMonad-Layout-LayoutHints.html#layoutHintsWithPlacement" class="link">Source</a></p><div class="doc"><p><code>layoutHintsWithPlacement (rx, ry) layout</code> will adapt the sizes of a layout's
windows according to their size hints, and position them inside their
originally assigned area according to the <code>rx</code> and <code>ry</code> parameters.
(0, 0) places the window at the top left, (1, 0) at the top right, (0.5, 0.5)
at the center, etc.
</p></div></div><div class="top"><p class="src"><a name="v:layoutHintsToCenter" class="def">layoutHintsToCenter</a> :: LayoutClass l a => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> LayoutHintsToCenter l a<a href="src/XMonad-Layout-LayoutHints.html#layoutHintsToCenter" class="link">Source</a></p><div class="doc"><p><code>layoutHintsToCenter layout</code> applies hints, sliding the window to the
center of the screen and expanding its neighbors to fill the gaps. Windows
are never expanded in a way that increases overlap.
</p><p><code>layoutHintsToCenter</code> only makes one pass at resizing the neighbors of
hinted windows, so with some layouts (ex. the arrangement with two <code>Mirror</code>
<code>Tall</code> stacked vertically), <code>layoutHintsToCenter</code> may leave some gaps.
Simple layouts like <code>Tall</code> are unaffected.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:LayoutHints" class="def">LayoutHints</a> a <a href="src/XMonad-Layout-LayoutHints.html#LayoutHints" class="link">Source</a></p><div class="subs instances"><p id="control.i:LayoutHints" class="caption collapser" onclick="toggleSection('i:LayoutHints')">Instances</p><div id="section.i:LayoutHints" class="show"><table><tr><td class="src"><a href="XMonad-Layout-LayoutModifier.html#t:LayoutModifier">LayoutModifier</a> <a href="XMonad-Layout-LayoutHints.html#t:LayoutHints">LayoutHints</a> <a href="/usr/share/doc/ghc/html/libraries/X11-1.5.0.0/Graphics-X11-Types.html#t:Window">Window</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-LayoutHints.html#t:LayoutHints">LayoutHints</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-LayoutHints.html#t:LayoutHints">LayoutHints</a> a)</td><td class="doc empty"> </td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
