<!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.MouseResizableTile</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-MouseResizableTile.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-MouseResizableTile.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.11: Third party extensions for xmonad</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>not portable</td></tr><tr><th>Stability</th><td>unstable</td></tr><tr><th>Maintainer</th><td>jan.vornberger@informatik.uni-oldenburg.de</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.MouseResizableTile</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Usage
</a></li><li><a href="#g:2">Parameters
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A layout in the spirit of <a href="XMonad-Layout-ResizableTile.html">XMonad.Layout.ResizableTile</a>, but with the option
to use the mouse to adjust the layout.
</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:mouseResizableTile">mouseResizableTile</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a</li><li class="src short"><a href="#v:mouseResizableTileMirrored">mouseResizableTileMirrored</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a</li><li class="src short"><span class="keyword">data</span> <a href="#t:MRTMessage">MRTMessage</a> <ul class="subs"><li>= <a href="#v:ShrinkSlave">ShrinkSlave</a> </li><li>| <a href="#v:ExpandSlave">ExpandSlave</a> </li></ul></li><li class="src short"><a href="#v:nmaster">nmaster</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:masterFrac">masterFrac</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a></li><li class="src short"><a href="#v:slaveFrac">slaveFrac</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a></li><li class="src short"><a href="#v:fracIncrement">fracIncrement</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a></li><li class="src short"><a href="#v:isMirrored">isMirrored</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:draggerType">draggerType</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a -> <a href="XMonad-Layout-MouseResizableTile.html#t:DraggerType">DraggerType</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:DraggerType">DraggerType</a> <ul class="subs"><li>= <a href="#v:FixedDragger">FixedDragger</a> { <ul class="subs"><li><a href="#v:gapWidth">gapWidth</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Dimension">Dimension</a></li><li><a href="#v:draggerWidth">draggerWidth</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Dimension">Dimension</a></li></ul> }</li><li>| <a href="#v:BordersDragger">BordersDragger</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:MouseResizableTile">MouseResizableTile</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.MouseResizableTile
</pre><p>Then edit your <code>layoutHook</code> by adding the MouseResizableTile layout.
Either in its normal form or the mirrored version. (The mirror layout modifier
will not work correctly here because of the use of the mouse.)
</p><pre> myLayout = mouseResizableTile ||| etc..
main = xmonad defaultConfig { layoutHook = myLayout }
</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><p>You may also want to add the following key bindings:
</p><pre> , ((modm, xK_u), sendMessage ShrinkSlave) -- %! Shrink a slave area
, ((modm, xK_i), sendMessage ExpandSlave) -- %! Expand a slave area
</pre><p>For detailed instruction on editing the key binding see:
</p><p><a href="XMonad-Doc-Extending.html#Editing_key_bindings">XMonad.Doc.Extending</a>.
</p></div><div class="top"><p class="src"><a name="v:mouseResizableTile" class="def">mouseResizableTile</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a<a href="src/XMonad-Layout-MouseResizableTile.html#mouseResizableTile" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:mouseResizableTileMirrored" class="def">mouseResizableTileMirrored</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a<a href="src/XMonad-Layout-MouseResizableTile.html#mouseResizableTileMirrored" class="link">Source</a></p><div class="doc"><p>May be removed in favor of <code>mouseResizableTile { isMirrored = True }</code>
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:MRTMessage" class="def">MRTMessage</a> <a href="src/XMonad-Layout-MouseResizableTile.html#MRTMessage" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ShrinkSlave" class="def">ShrinkSlave</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ExpandSlave" class="def">ExpandSlave</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:MRTMessage" class="caption collapser" onclick="toggleSection('i:MRTMessage')">Instances</p><div id="section.i:MRTMessage" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> <a href="XMonad-Layout-MouseResizableTile.html#t:MRTMessage">MRTMessage</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Message">Message</a> <a href="XMonad-Layout-MouseResizableTile.html#t:MRTMessage">MRTMessage</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:2">Parameters
</h1><div class="doc"><p>The following functions are also labels for updating the <code>data</code> (whose
representation is otherwise hidden) produced by <code><a href="XMonad-Layout-MouseResizableTile.html#v:mouseResizableTile">mouseResizableTile</a></code>.
</p><p>Usage:
</p><pre> myLayout = mouseResizableTile{ masterFrac = 0.7,
fracIncrement = 0.05,
draggerType = BordersDragger }
||| etc..
</pre></div><div class="top"><p class="src"><a name="v:nmaster" class="def">nmaster</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a><a href="src/XMonad-Layout-MouseResizableTile.html#nmaster" class="link">Source</a></p><div class="doc"><p>Get/set the number of windows in
master pane (default: 1).
</p></div></div><div class="top"><p class="src"><a name="v:masterFrac" class="def">masterFrac</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a><a href="src/XMonad-Layout-MouseResizableTile.html#masterFrac" class="link">Source</a></p><div class="doc"><p>Get/set the proportion of screen
occupied by master pane (default: 1/2).
</p></div></div><div class="top"><p class="src"><a name="v:slaveFrac" class="def">slaveFrac</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a><a href="src/XMonad-Layout-MouseResizableTile.html#slaveFrac" class="link">Source</a></p><div class="doc"><p>Get/set the proportion of remaining
space in a column occupied by a slave
window (default: 1/2).
</p></div></div><div class="top"><p class="src"><a name="v:fracIncrement" class="def">fracIncrement</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a><a href="src/XMonad-Layout-MouseResizableTile.html#fracIncrement" class="link">Source</a></p><div class="doc"><p>Get/set the increment used when
modifying masterFrac/slaveFrac by the
Shrink, Expand, etc. messages (default:
3/100).
</p></div></div><div class="top"><p class="src"><a name="v:isMirrored" class="def">isMirrored</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/XMonad-Layout-MouseResizableTile.html#isMirrored" class="link">Source</a></p><div class="doc"><p>Get/set whether the layout is
mirrored (default: False).
</p></div></div><div class="top"><p class="src"><a name="v:draggerType" class="def">draggerType</a> :: <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a -> <a href="XMonad-Layout-MouseResizableTile.html#t:DraggerType">DraggerType</a><a href="src/XMonad-Layout-MouseResizableTile.html#draggerType" class="link">Source</a></p><div class="doc"><p>Get/set dragger and gap dimensions
(default: FixedDragger 6 6).
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:DraggerType" class="def">DraggerType</a> <a href="src/XMonad-Layout-MouseResizableTile.html#DraggerType" class="link">Source</a></p><div class="doc"><p>Specifies the size of the clickable area between windows.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:FixedDragger" class="def">FixedDragger</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:gapWidth" class="def">gapWidth</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Dimension">Dimension</a></dt><dd class="doc"><p>width of a gap between windows
</p></dd><dt class="src"><a name="v:draggerWidth" class="def">draggerWidth</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Types.html#t:Dimension">Dimension</a></dt><dd class="doc"><p>width of the dragger itself
(will overlap windows if greater than gap)
</p></dd></dl><div class="clear"></div></div></td></tr><tr><td class="src"><a name="v:BordersDragger" class="def">BordersDragger</a></td><td class="doc"><p>no gaps, draggers overlap window borders
</p></td></tr></table></div><div class="subs instances"><p id="control.i:DraggerType" class="caption collapser" onclick="toggleSection('i:DraggerType')">Instances</p><div id="section.i:DraggerType" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> <a href="XMonad-Layout-MouseResizableTile.html#t:DraggerType">DraggerType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="XMonad-Layout-MouseResizableTile.html#t:DraggerType">DraggerType</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:MouseResizableTile" class="def">MouseResizableTile</a> a <a href="src/XMonad-Layout-MouseResizableTile.html#MouseResizableTile" class="link">Source</a></p><div class="subs instances"><p id="control.i:MouseResizableTile" class="caption collapser" onclick="toggleSection('i:MouseResizableTile')">Instances</p><div id="section.i:MouseResizableTile" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> <a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.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.5.0.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-MouseResizableTile.html#t:MouseResizableTile">MouseResizableTile</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.10.0</p></div></body></html>
