<!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.ImageButtonDecoration</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-ImageButtonDecoration.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Layout-ImageButtonDecoration.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>trupill@gmail.com</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Layout.ImageButtonDecoration</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>A decoration that includes small image buttons on both ends which invoke
various actions when clicked on: Show a window menu (see
<a href="XMonad-Actions-WindowMenu.html">XMonad.Actions.WindowMenu</a>), minimize, maximize or close the window.
</p><p>Note: For maximizing and minimizing to actually work, you will need
to integrate <a href="XMonad-Layout-Maximize.html">XMonad.Layout.Maximize</a> and <a href="XMonad-Layout-Minimize.html">XMonad.Layout.Minimize</a> into your
setup. See the documentation of those modules for more information.
</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:imageButtonDeco">imageButtonDeco</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="XMonad-Layout-Decoration.html#t:Shrinker">Shrinker</a> s) => s -> <a href="XMonad-Layout-Decoration.html#t:Theme">Theme</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> (<a href="XMonad-Layout-Decoration.html#t:Decoration">Decoration</a> <a href="XMonad-Layout-ImageButtonDecoration.html#t:ImageButtonDecoration">ImageButtonDecoration</a> s) l a</li><li class="src short"><a href="#v:defaultThemeWithImageButtons">defaultThemeWithImageButtons</a> :: <a href="XMonad-Layout-Decoration.html#t:Theme">Theme</a></li><li class="src short"><a href="#v:imageTitleBarButtonHandler">imageTitleBarButtonHandler</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</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-Bool.html#t:Bool">Bool</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:ImageButtonDecoration">ImageButtonDecoration</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.ImageButtonDecoration
</pre><p>Then edit your <code>layoutHook</code> by adding the ImageButtonDecoration to
your layout:
</p><pre> myL = imageButtonDeco shrinkText defaultThemeWithImageButtons (layoutHook defaultConfig)
main = xmonad defaultConfig { layoutHook = myL }
</pre></div><div class="top"><p class="src"><a name="v:imageButtonDeco" class="def">imageButtonDeco</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> a, <a href="XMonad-Layout-Decoration.html#t:Shrinker">Shrinker</a> s) => s -> <a href="XMonad-Layout-Decoration.html#t:Theme">Theme</a> -> l a -> <a href="XMonad-Layout-LayoutModifier.html#t:ModifiedLayout">ModifiedLayout</a> (<a href="XMonad-Layout-Decoration.html#t:Decoration">Decoration</a> <a href="XMonad-Layout-ImageButtonDecoration.html#t:ImageButtonDecoration">ImageButtonDecoration</a> s) l a<a href="src/XMonad-Layout-ImageButtonDecoration.html#imageButtonDeco" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:defaultThemeWithImageButtons" class="def">defaultThemeWithImageButtons</a> :: <a href="XMonad-Layout-Decoration.html#t:Theme">Theme</a><a href="src/XMonad-Layout-ImageButtonDecoration.html#defaultThemeWithImageButtons" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:imageTitleBarButtonHandler" class="def">imageTitleBarButtonHandler</a> :: <a href="/usr/share/doc/ghc/html/libraries/X11-1.6.0/Graphics-X11-Types.html#t:Window">Window</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</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-Bool.html#t:Bool">Bool</a><a href="src/XMonad-Layout-ImageButtonDecoration.html#imageTitleBarButtonHandler" class="link">Source</a></p><div class="doc"><p>A function intended to be plugged into the <code><a href="XMonad-Layout-Decoration.html#v:decorationCatchClicksHook">decorationCatchClicksHook</a></code> of a decoration.
It will intercept clicks on the buttons of the decoration and invoke the associated action.
To actually see the buttons, you will need to use a theme that includes them.
See <code><a href="XMonad-Layout-ImageButtonDecoration.html#v:defaultThemeWithImageButtons">defaultThemeWithImageButtons</a></code> below.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ImageButtonDecoration" class="def">ImageButtonDecoration</a> a <a href="src/XMonad-Layout-ImageButtonDecoration.html#ImageButtonDecoration" class="link">Source</a></p><div class="subs instances"><p id="control.i:ImageButtonDecoration" class="caption collapser" onclick="toggleSection('i:ImageButtonDecoration')">Instances</p><div id="section.i:ImageButtonDecoration" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> a => <a href="XMonad-Layout-Decoration.html#t:DecorationStyle">DecorationStyle</a> <a href="XMonad-Layout-ImageButtonDecoration.html#t:ImageButtonDecoration">ImageButtonDecoration</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-Read.html#t:Read">Read</a> (<a href="XMonad-Layout-ImageButtonDecoration.html#t:ImageButtonDecoration">ImageButtonDecoration</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-ImageButtonDecoration.html#t:ImageButtonDecoration">ImageButtonDecoration</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>
