<!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.Fullscreen</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-Fullscreen.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-Fullscreen.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>audunskaugen@gmail.com</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.Fullscreen</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">Types for reference
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Hooks for sending messages about fullscreen windows to layouts, and
a few example layout modifier that implement fullscreen windows.
</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:fullscreenFull">fullscreenFull</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFull">FullscreenFull</a> l a</li><li class="src short"><a href="#v:fullscreenFocus">fullscreenFocus</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFocus">FullscreenFocus</a> l a</li><li class="src short"><a href="#v:fullscreenFullRect">fullscreenFullRect</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-StackSet.html#t:RationalRect">RationalRect</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFull">FullscreenFull</a> l a</li><li class="src short"><a href="#v:fullscreenFocusRect">fullscreenFocusRect</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-StackSet.html#t:RationalRect">RationalRect</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFocus">FullscreenFocus</a> l a</li><li class="src short"><a href="#v:fullscreenFloat">fullscreenFloat</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFloat">FullscreenFloat</a> l a</li><li class="src short"><a href="#v:fullscreenFloatRect">fullscreenFloatRect</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-StackSet.html#t:RationalRect">RationalRect</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFloat">FullscreenFloat</a> l a</li><li class="src short"><a href="#v:fullscreenEventHook">fullscreenEventHook</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Extras.html#t:Event">Event</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:All">All</a></li><li class="src short"><a href="#v:fullscreenManageHook">fullscreenManageHook</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ManageHook">ManageHook</a></li><li class="src short"><a href="#v:fullscreenManageHookWith">fullscreenManageHookWith</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ManageHook">ManageHook</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:FullscreenMessage">FullscreenMessage</a> <ul class="subs"><li>= <a href="#v:AddFullscreen">AddFullscreen</a> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a> </li><li>| <a href="#v:RemoveFullscreen">RemoveFullscreen</a> <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a> </li><li>| <a href="#v:FullscreenChanged">FullscreenChanged</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:FullscreenFloat">FullscreenFloat</a> a</li><li class="src short"><span class="keyword">data</span> <a href="#t:FullscreenFocus">FullscreenFocus</a> a</li><li class="src short"><span class="keyword">data</span> <a href="#t:FullscreenFull">FullscreenFull</a> a</li></ul></div><div id="interface"><h1 id="g:1">Usage:
</h1><div class="doc"><p>Provides a ManageHook and an EventHook that sends layout messages
with information about fullscreening windows. This allows layouts
to make their own decisions about what they should to with a
window that requests fullscreen.
</p><p>The module also includes a few layout modifiers as an illustration
of how such layouts should behave.
</p><p>To use this module, add <code><a href="XMonad-Layout-Fullscreen.html#v:fullscreenEventHook">fullscreenEventHook</a></code> and <code><a href="XMonad-Layout-Fullscreen.html#v:fullscreenManageHook">fullscreenManageHook</a></code>
to your config, i.e.
</p><pre> xmonad defaultconfig { handleEventHook = fullscreenEventHook,
manageHook = fullscreenManageHook,
layoutHook = myLayouts }
</pre><p>Now you can use layouts that respect fullscreen, for example the
provided <code><a href="XMonad-Layout-Fullscreen.html#v:fullscreenFull">fullscreenFull</a></code>:
</p><pre> myLayouts = fullscreenFull someLayout
</pre></div><div class="top"><p class="src"><a name="v:fullscreenFull" class="def">fullscreenFull</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFull">FullscreenFull</a> l a<a href="src/XMonad-Layout-Fullscreen.html#fullscreenFull" class="link">Source</a></p><div class="doc"><p>Layout modifier that makes fullscreened window fill the
entire screen.
</p></div></div><div class="top"><p class="src"><a name="v:fullscreenFocus" class="def">fullscreenFocus</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFocus">FullscreenFocus</a> l a<a href="src/XMonad-Layout-Fullscreen.html#fullscreenFocus" class="link">Source</a></p><div class="doc"><p>Layout modifier that makes the fullscreened window fill
the entire screen only if it is currently focused.
</p></div></div><div class="top"><p class="src"><a name="v:fullscreenFullRect" class="def">fullscreenFullRect</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-StackSet.html#t:RationalRect">RationalRect</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFull">FullscreenFull</a> l a<a href="src/XMonad-Layout-Fullscreen.html#fullscreenFullRect" class="link">Source</a></p><div class="doc"><p>As above, but the fullscreened window will fill the
specified rectangle instead of the entire screen.
</p></div></div><div class="top"><p class="src"><a name="v:fullscreenFocusRect" class="def">fullscreenFocusRect</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-StackSet.html#t:RationalRect">RationalRect</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFocus">FullscreenFocus</a> l a<a href="src/XMonad-Layout-Fullscreen.html#fullscreenFocusRect" class="link">Source</a></p><div class="doc"><p>As above, but the fullscreened window will fill the
specified rectangle instead of the entire screen.
</p></div></div><div class="top"><p class="src"><a name="v:fullscreenFloat" class="def">fullscreenFloat</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFloat">FullscreenFloat</a> l a<a href="src/XMonad-Layout-Fullscreen.html#fullscreenFloat" class="link">Source</a></p><div class="doc"><p>Hackish layout modifier that makes floating fullscreened
windows fill the entire screen.
</p></div></div><div class="top"><p class="src"><a name="v:fullscreenFloatRect" class="def">fullscreenFloatRect</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:LayoutClass">LayoutClass</a> l a => <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-StackSet.html#t:RationalRect">RationalRect</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFloat">FullscreenFloat</a> l a<a href="src/XMonad-Layout-Fullscreen.html#fullscreenFloatRect" class="link">Source</a></p><div class="doc"><p>As above, but the fullscreened window will fill the
specified rectangle instead of the entire screen.
</p></div></div><div class="top"><p class="src"><a name="v:fullscreenEventHook" class="def">fullscreenEventHook</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Xlib-Extras.html#t:Event">Event</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:All">All</a><a href="src/XMonad-Layout-Fullscreen.html#fullscreenEventHook" class="link">Source</a></p><div class="doc"><p>The event hook required for the layout modifiers to work
</p></div></div><div class="top"><p class="src"><a name="v:fullscreenManageHook" class="def">fullscreenManageHook</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ManageHook">ManageHook</a><a href="src/XMonad-Layout-Fullscreen.html#fullscreenManageHook" class="link">Source</a></p><div class="doc"><p>Manage hook that sets the fullscreen property for
windows that are initially fullscreen
</p></div></div><div class="top"><p class="src"><a name="v:fullscreenManageHookWith" class="def">fullscreenManageHookWith</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:Query">Query</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ManageHook">ManageHook</a><a href="src/XMonad-Layout-Fullscreen.html#fullscreenManageHookWith" class="link">Source</a></p><div class="doc"><p>A version of fullscreenManageHook that lets you specify
your own query to decide whether a window should be fullscreen.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:FullscreenMessage" class="def">FullscreenMessage</a> <a href="src/XMonad-Layout-Fullscreen.html#FullscreenMessage" class="link">Source</a></p><div class="doc"><p>Messages that control the fullscreen state of the window.
AddFullscreen and RemoveFullscreen are sent to all layouts
when a window wants or no longer wants to be fullscreen.
FullscreenChanged is sent to the current layout after one
of the above have been sent.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:AddFullscreen" class="def">AddFullscreen</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 name="v:RemoveFullscreen" class="def">RemoveFullscreen</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 name="v:FullscreenChanged" class="def">FullscreenChanged</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:FullscreenMessage" class="caption collapser" onclick="toggleSection('i:FullscreenMessage')">Instances</p><div id="section.i:FullscreenMessage" 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-Fullscreen.html#t:FullscreenMessage">FullscreenMessage</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-Fullscreen.html#t:FullscreenMessage">FullscreenMessage</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:2">Types for reference
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:FullscreenFloat" class="def">FullscreenFloat</a> a <a href="src/XMonad-Layout-Fullscreen.html#FullscreenFloat" class="link">Source</a></p><div class="subs instances"><p id="control.i:FullscreenFloat" class="caption collapser" onclick="toggleSection('i:FullscreenFloat')">Instances</p><div id="section.i:FullscreenFloat" class="show"><table><tr><td class="src"><a href="XMonad-Layout-LayoutModifier.html#t:LayoutModifier">LayoutModifier</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFloat">FullscreenFloat</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/Data-Ord.html#t:Ord">Ord</a> a, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> a) => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-Fullscreen.html#t:FullscreenFloat">FullscreenFloat</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 => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-Fullscreen.html#t:FullscreenFloat">FullscreenFloat</a> 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:FullscreenFocus" class="def">FullscreenFocus</a> a <a href="src/XMonad-Layout-Fullscreen.html#FullscreenFocus" class="link">Source</a></p><div class="subs instances"><p id="control.i:FullscreenFocus" class="caption collapser" onclick="toggleSection('i:FullscreenFocus')">Instances</p><div id="section.i:FullscreenFocus" class="show"><table><tr><td class="src"><a href="XMonad-Layout-LayoutModifier.html#t:LayoutModifier">LayoutModifier</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFocus">FullscreenFocus</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 => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-Fullscreen.html#t:FullscreenFocus">FullscreenFocus</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 => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-Fullscreen.html#t:FullscreenFocus">FullscreenFocus</a> 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:FullscreenFull" class="def">FullscreenFull</a> a <a href="src/XMonad-Layout-Fullscreen.html#FullscreenFull" class="link">Source</a></p><div class="subs instances"><p id="control.i:FullscreenFull" class="caption collapser" onclick="toggleSection('i:FullscreenFull')">Instances</p><div id="section.i:FullscreenFull" class="show"><table><tr><td class="src"><a href="XMonad-Layout-LayoutModifier.html#t:LayoutModifier">LayoutModifier</a> <a href="XMonad-Layout-Fullscreen.html#t:FullscreenFull">FullscreenFull</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 => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-Fullscreen.html#t:FullscreenFull">FullscreenFull</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 => <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (<a href="XMonad-Layout-Fullscreen.html#t:FullscreenFull">FullscreenFull</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>
