<!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.Magnifier</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-Magnifier.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-Magnifier.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>unportable</td></tr><tr><th>Stability</th><td>unstable</td></tr><tr><th>Maintainer</th><td>andrea.rossato@unibz.it</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.Magnifier</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>Screenshot : <a href="http://caladan.rave.org/magnifier.png">http://caladan.rave.org/magnifier.png</a>
</p><p>This is a layout modifier that will make a layout increase the size
of the window that has focus.
</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:magnifier">magnifier</a> :: l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</a> l a</li><li class="src short"><a href="#v:magnifier-39-">magnifier'</a> :: l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</a> l a</li><li class="src short"><a href="#v:magnifierOff">magnifierOff</a> :: l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</a> l a</li><li class="src short"><a href="#v:magnifiercz">magnifiercz</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</a> l a</li><li class="src short"><a href="#v:magnifiercz-39-">magnifiercz'</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</a> l a</li><li class="src short"><a href="#v:maximizeVertical">maximizeVertical</a> :: l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</a> l a</li><li class="src short"><span class="keyword">data</span> <a href="#t:MagnifyMsg">MagnifyMsg</a> <ul class="subs"><li>= <a href="#v:MagnifyMore">MagnifyMore</a> </li><li>| <a href="#v:MagnifyLess">MagnifyLess</a> </li><li>| <a href="#v:ToggleOn">ToggleOn</a> </li><li>| <a href="#v:ToggleOff">ToggleOff</a> </li><li>| <a href="#v:Toggle">Toggle</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Magnifier">Magnifier</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.Magnifier
</pre><p>Then edit your <code>layoutHook</code> by adding the <code><a href="XMonad-Layout-Magnifier.html#v:magnifier">magnifier</a></code> layout modifier
to some layout:
</p><pre> myLayout = magnifier (Tall 1 (3/100) (1/2)) ||| Full ||| etc..
main = xmonad defaultConfig { layoutHook = myLayout }
</pre><p>By default magnifier increases the focused window's size by 1.5.
You can also use:
</p><pre> magnifiercz 1.2
</pre><p>to use a custom level of magnification. You can even make the focused
window smaller for a pop in effect.
</p><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>Magnifier supports some commands. To use them add something like
this to your key bindings:
</p><pre> , ((modm .|. controlMask , xK_plus ), sendMessage MagnifyMore)
, ((modm .|. controlMask , xK_minus), sendMessage MagnifyLess)
, ((modm .|. controlMask , xK_o ), sendMessage ToggleOff )
, ((modm .|. controlMask .|. shiftMask, xK_o ), sendMessage ToggleOn )
, ((modm .|. controlMask , xK_m ), sendMessage Toggle )
</pre><p>Note that a few other extension modules, such as
<a href="XMonad-Layout-MultiToggle.html">XMonad.Layout.MultiToggle</a> and <a href="XMonad-Layout-ToggleLayouts.html">XMonad.Layout.ToggleLayouts</a>, also
define a message named <code>Toggle</code>. To avoid conflicts when using
these modules together, you can import Magnifier qualified, like
this:
</p><pre> import qualified XMonad.Layout.Magnifier as Mag
</pre><p>and then prefix <code>Mag</code> to the front of everything from this module,
like <code>Mag.Toggle</code>, <code>Mag.magnifier</code>, and so on.
</p><p>For detailed instruction on editing the key binding see
<a href="XMonad-Doc-Extending.html#Editing_key_bindings">XMonad.Doc.Extending</a>.
</p></div><div class="top"><p class="src"><a name="v:magnifier" class="def">magnifier</a> :: l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</a> l a<a href="src/XMonad-Layout-Magnifier.html#magnifier" class="link">Source</a></p><div class="doc"><p>Increase the size of the window that has focus
</p></div></div><div class="top"><p class="src"><a name="v:magnifier-39-" class="def">magnifier'</a> :: l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</a> l a<a href="src/XMonad-Layout-Magnifier.html#magnifier%27" class="link">Source</a></p><div class="doc"><p>Increase the size of the window that has focus, unless if it is the
master window.
</p></div></div><div class="top"><p class="src"><a name="v:magnifierOff" class="def">magnifierOff</a> :: l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</a> l a<a href="src/XMonad-Layout-Magnifier.html#magnifierOff" class="link">Source</a></p><div class="doc"><p>Magnifier that defaults to Off
</p></div></div><div class="top"><p class="src"><a name="v:magnifiercz" class="def">magnifiercz</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</a> l a<a href="src/XMonad-Layout-Magnifier.html#magnifiercz" class="link">Source</a></p><div class="doc"><p>Change the size of the window that has focus by a custom zoom
</p></div></div><div class="top"><p class="src"><a name="v:magnifiercz-39-" class="def">magnifiercz'</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#t:Rational">Rational</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</a> l a<a href="src/XMonad-Layout-Magnifier.html#magnifiercz%27" class="link">Source</a></p><div class="doc"><p>Increase the size of the window that has focus by a custom zoom,
unless if it is the master window.
</p></div></div><div class="top"><p class="src"><a name="v:maximizeVertical" class="def">maximizeVertical</a> :: l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</a> l a<a href="src/XMonad-Layout-Magnifier.html#maximizeVertical" class="link">Source</a></p><div class="doc"><p>A magnifier that greatly magnifies just the vertical direction
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:MagnifyMsg" class="def">MagnifyMsg</a> <a href="src/XMonad-Layout-Magnifier.html#MagnifyMsg" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:MagnifyMore" class="def">MagnifyMore</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:MagnifyLess" class="def">MagnifyLess</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ToggleOn" class="def">ToggleOn</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ToggleOff" class="def">ToggleOff</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Toggle" class="def">Toggle</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:MagnifyMsg" class="caption collapser" onclick="toggleSection('i:MagnifyMsg')">Instances</p><div id="section.i:MagnifyMsg" 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-Magnifier.html#t:MagnifyMsg">MagnifyMsg</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-Magnifier.html#t:MagnifyMsg">MagnifyMsg</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:Magnifier" class="def">Magnifier</a> a <a href="src/XMonad-Layout-Magnifier.html#Magnifier" class="link">Source</a></p><div class="subs instances"><p id="control.i:Magnifier" class="caption collapser" onclick="toggleSection('i:Magnifier')">Instances</p><div id="section.i:Magnifier" class="show"><table><tr><td class="src"><a href="XMonad-Layout-LayoutModifier.html#t:LayoutModifier">LayoutModifier</a> <a href="XMonad-Layout-Magnifier.html#t:Magnifier">Magnifier</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-Magnifier.html#t:Magnifier">Magnifier</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-Magnifier.html#t:Magnifier">Magnifier</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>
