<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>XMonad/Layout/Named.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE FlexibleContexts, FlexibleInstances, MultiParamTypeClasses #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-4"></a><span class='hs-comment'>-- |</span>
<a name="line-5"></a><span class='hs-comment'>-- Module : XMonad.Layout.Named</span>
<a name="line-6"></a><span class='hs-comment'>-- Copyright : (c) David Roundy <droundy@darcs.net></span>
<a name="line-7"></a><span class='hs-comment'>-- License : BSD3-style (see LICENSE)</span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- Maintainer : none</span>
<a name="line-10"></a><span class='hs-comment'>-- Stability : unstable</span>
<a name="line-11"></a><span class='hs-comment'>-- Portability : unportable</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a><span class='hs-comment'>-- A module for assigning a name to a given layout.</span>
<a name="line-14"></a><span class='hs-comment'>--</span>
<a name="line-15"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-16"></a>
<a name="line-17"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Layout</span><span class='hs-varop'>.</span><span class='hs-conid'>Named</span>
<a name="line-18"></a> <span class='hs-layout'>(</span> <span class='hs-comment'>-- * Usage</span>
<a name="line-19"></a> <span class='hs-comment'>-- $usage</span>
<a name="line-20"></a> <span class='hs-varid'>named</span><span class='hs-layout'>,</span>
<a name="line-21"></a> <span class='hs-varid'>nameTail</span>
<a name="line-22"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-23"></a>
<a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Layout</span><span class='hs-varop'>.</span><span class='hs-conid'>LayoutModifier</span>
<a name="line-26"></a>
<a name="line-27"></a><span class='hs-comment'>-- $usage</span>
<a name="line-28"></a><span class='hs-comment'>-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:</span>
<a name="line-29"></a><span class='hs-comment'>--</span>
<a name="line-30"></a><span class='hs-comment'>-- > import XMonad.Layout.Named</span>
<a name="line-31"></a><span class='hs-comment'>--</span>
<a name="line-32"></a><span class='hs-comment'>-- Then edit your @layoutHook@ by adding the Named layout modifier</span>
<a name="line-33"></a><span class='hs-comment'>-- to some layout:</span>
<a name="line-34"></a><span class='hs-comment'>--</span>
<a name="line-35"></a><span class='hs-comment'>-- > myLayout = named "real big" Full ||| (nameTail $ named "real big" $ Full) ||| etc..</span>
<a name="line-36"></a><span class='hs-comment'>-- > main = xmonad defaultConfig { layoutHook = myLayout }</span>
<a name="line-37"></a><span class='hs-comment'>--</span>
<a name="line-38"></a><span class='hs-comment'>-- For more detailed instructions on editing the layoutHook see:</span>
<a name="line-39"></a><span class='hs-comment'>--</span>
<a name="line-40"></a><span class='hs-comment'>-- "XMonad.Doc.Extending#Editing_the_layout_hook"</span>
<a name="line-41"></a>
<a name="line-42"></a><a name="named"></a><span class='hs-comment'>-- | Rename a layout.</span>
<a name="line-43"></a><span class='hs-definition'>named</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>l</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ModifiedLayout</span> <span class='hs-conid'>Named</span> <span class='hs-varid'>l</span> <span class='hs-varid'>a</span>
<a name="line-44"></a><span class='hs-definition'>named</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ModifiedLayout</span> <span class='hs-layout'>(</span><span class='hs-conid'>Named</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span>
<a name="line-45"></a>
<a name="line-46"></a><a name="Named"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Named</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Named</span> <span class='hs-conid'>String</span> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span> <span class='hs-conid'>Read</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-layout'>)</span>
<a name="line-47"></a>
<a name="line-48"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>LayoutModifier</span> <span class='hs-conid'>Named</span> <span class='hs-varid'>a</span> <span class='hs-keyword'>where</span>
<a name="line-49"></a> <span class='hs-varid'>modifyDescription</span> <span class='hs-layout'>(</span><span class='hs-conid'>Named</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>n</span>
<a name="line-50"></a>
<a name="line-51"></a>
<a name="line-52"></a><a name="nameTail"></a><span class='hs-comment'>-- | Remove the first word of the name.</span>
<a name="line-53"></a><span class='hs-definition'>nameTail</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>l</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ModifiedLayout</span> <span class='hs-conid'>NameTail</span> <span class='hs-varid'>l</span> <span class='hs-varid'>a</span>
<a name="line-54"></a><span class='hs-definition'>nameTail</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ModifiedLayout</span> <span class='hs-conid'>NameTail</span>
<a name="line-55"></a>
<a name="line-56"></a><a name="NameTail"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>NameTail</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>NameTail</span> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Read</span><span class='hs-layout'>,</span><span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-57"></a>
<a name="line-58"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>LayoutModifier</span> <span class='hs-conid'>NameTail</span> <span class='hs-varid'>a</span> <span class='hs-keyword'>where</span>
<a name="line-59"></a> <span class='hs-varid'>modifyDescription</span> <span class='hs-conid'>NameTail</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>dropWhile</span> <span class='hs-layout'>(</span><span class='hs-varop'>==</span><span class='hs-chr'>' '</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>dropWhile</span> <span class='hs-layout'>(</span><span class='hs-varop'>/=</span><span class='hs-chr'>' '</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>description</span> <span class='hs-varid'>i</span>
</pre></body>
</html>
