XMonad.Layout.MessageControl

Provides message "escaping" and filtering facilities which help control complex nested layouts.

Usage

You can use this module by importing it into your ~/.xmonad/xmonad.hs file:

import XMonad.Layout.MessageEscape

Then, if you use a modified layout where the modifier would intercept a message, but you'd want to be able to send it to the inner layout only, add the unEscape modifier to the inner layout like so:

import XMonad.Layout.Master (mastered)
import XMonad.Layout.Tabbed (simpleTabbed)
import XMonad.Layout.LayoutCombinators ((|||))

myLayout = Tall ||| unEscape (mastered 0.01 0.5 $ Full ||| simpleTabbed)

you can now send a message to the inner layout with sendMessage $ escape message, e.g.

-- Change the inner layout
((modm .|. controlMask, xK_space), sendMessage $ escape NextLayout)

If you want unescaped messages to be handled only by the enclosing layout, use the ignore modifier:

myLayout = Tall ||| (ignore NextLayout $ ignore (JumpToLayout "") $
                      unEscape $ mastered 0.01 0.5
                        $ Full ||| simpleTabbed)

IMPORTANT NOTE: The standard '(|||)' operator from XMonad.Layout does not behave correctly with ignore. Make sure you use the one from XMonad.Layout.LayoutCombinators.

data Ignore m l w

the Ignore layout modifier. Prevents its inner layout from receiving messages of a certain type.

Instances

(Message m, LayoutClass l w) => LayoutClass (Ignore m l) w

Methods

runLayout :: Workspace WorkspaceId (Ignore m l w) w -> Rectangle -> X ([(w, Rectangle)], Maybe (Ignore m l w))

doLayout :: Ignore m l w -> Rectangle -> Stack w -> X ([(w, Rectangle)], Maybe (Ignore m l w))

pureLayout :: Ignore m l w -> Rectangle -> Stack w -> [(w, Rectangle)]

emptyLayout :: Ignore m l w -> Rectangle -> X ([(w, Rectangle)], Maybe (Ignore m l w))

handleMessage :: Ignore m l w -> SomeMessage -> X (Maybe (Ignore m l w))

pureMessage :: Ignore m l w -> SomeMessage -> Maybe (Ignore m l w)

description :: Ignore m l w -> String

Read (l w) => Read (Ignore m l w)

Methods

readsPrec :: Int -> ReadS (Ignore m l w)

readList :: ReadS [Ignore m l w]

readPrec :: ReadPrec (Ignore m l w)

readListPrec :: ReadPrec [Ignore m l w]

Show (l w) => Show (Ignore m l w)

Methods

showsPrec :: Int -> Ignore m l w -> ShowS

show :: Ignore m l w -> String

showList :: [Ignore m l w] -> ShowS

ignore :: (Message m, LayoutClass l w) => m -> l w -> Ignore m l w

Applies the Ignore layout modifier to a layout, blocking all messages of the same type as the one passed as its first argument.

data UnEscape w

the UnEscape layout modifier. Listens to EscapedMessages and sends their nested message to the inner layout.

Instances

LayoutModifier UnEscape a

Methods

modifyLayout :: LayoutClass l a => UnEscape a -> Workspace WorkspaceId (l a) a -> Rectangle -> X ([(a, Rectangle)], Maybe (l a))

modifyLayoutWithUpdate :: LayoutClass l a => UnEscape a -> Workspace WorkspaceId (l a) a -> Rectangle -> X (([(a, Rectangle)], Maybe (l a)), Maybe (UnEscape a))

handleMess :: UnEscape a -> SomeMessage -> X (Maybe (UnEscape a))

handleMessOrMaybeModifyIt :: UnEscape a -> SomeMessage -> X (Maybe (Either (UnEscape a) SomeMessage))

pureMess :: UnEscape a -> SomeMessage -> Maybe (UnEscape a)

redoLayout :: UnEscape a -> Rectangle -> Maybe (Stack a) -> [(a, Rectangle)] -> X ([(a, Rectangle)], Maybe (UnEscape a))

pureModifier :: UnEscape a -> Rectangle -> Maybe (Stack a) -> [(a, Rectangle)] -> ([(a, Rectangle)], Maybe (UnEscape a))

hook :: UnEscape a -> X ()

unhook :: UnEscape a -> X ()

modifierDescription :: UnEscape a -> String

modifyDescription :: LayoutClass l a => UnEscape a -> l a -> String

Read (UnEscape w)

Methods

readsPrec :: Int -> ReadS (UnEscape w)

readList :: ReadS [UnEscape w]

readPrec :: ReadPrec (UnEscape w)

readListPrec :: ReadPrec [UnEscape w]

Show (UnEscape w)

Methods

showsPrec :: Int -> UnEscape w -> ShowS

show :: UnEscape w -> String

showList :: [UnEscape w] -> ShowS

unEscape :: LayoutClass l w => l w -> ModifiedLayout UnEscape l w

Applies the UnEscape layout modifier to a layout.

newtype EscapedMessage

Data type for an escaped message. Send with escape.

Constructors

Escape SomeMessage

Instances

Message EscapedMessage

escape :: Message m => m -> EscapedMessage

Creates an EscapedMessage.