XMonad.Actions.CopyWindow

xmonad-contrib-0.12: Third party extensions for xmonad

Copyright | (c) David Roundy <droundy@darcs.net>, Ivan Veselov <veselov@gmail.com>, Lanny Ripple <lan3ny@gmail.com>
License | BSD3-style (see LICENSE)
Maintainer | ???
Stability | unstable
Portability | unportable
Safe Haskell | None
Language | Haskell98

XMonad.Actions.CopyWindow

Contents

- Usage
- Highlight workspaces containing copies in logHook

Description

Provides bindings to duplicate a window on multiple workspaces, providing dwm-like tagging functionality.

Synopsis

- copy :: (Eq s, Eq i, Eq a) => i -> StackSet i l a s sd -> StackSet i l a s sd
- copyToAll :: (Eq s, Eq i, Eq a) => StackSet i l a s sd -> StackSet i l a s sd
- copyWindow :: (Eq a, Eq i, Eq s) => a -> i -> StackSet i l a s sd -> StackSet i l a s sd
- runOrCopy :: String -> Query Bool -> X ()
- killAllOtherCopies :: X ()
- kill1 :: X ()
- wsContainingCopies :: X [WorkspaceId]

# Usage

You can use this module with the following in your `~/.xmonad/xmonad.hs` file:

    import XMonad.Actions.CopyWindow

Then add something like this to your keybindings:

    -- mod-[1..9] @@ Switch to workspace N
    -- mod-shift-[1..9] @@ Move client to workspace N
    -- mod-control-shift-[1..9] @@ Copy client to workspace N
    [((m .|. modm, k), windows $ f i)
        | (i, k) <- zip (workspaces x) [xK_1 ..]
        , (f, m) <- [(W.view, 0), (W.shift, shiftMask), (copy, shiftMask .|. controlMask)]]

To use the above key bindings you need also to import XMonad.StackSet:

    import qualified XMonad.StackSet as W

You may also wish to redefine the binding to kill a window so it only removes it from the current workspace, if it's present elsewhere:

     , ((modm .|. shiftMask, xK_c     ), kill1) -- @@ Close the focused window

Instead of copying a window from one workspace to another maybe you don't want to have to remember where you placed it. For that consider:

     , ((modm, xK_b    ), runOrCopy "firefox" (className =? "Firefox")) -- @@ run or copy firefox

Another possibility which this extension provides is 'making window always visible' (i.e. always on current workspace), similar to corresponding metacity functionality. This behaviour is emulated through copying given window to all the workspaces and then removing it when it's unneeded on all workspaces any more.

Here is the example of keybindings which provide these actions:

     , ((modm, xK_v ), windows copyToAll) -- @@ Make focused window always visible
     , ((modm .|. shiftMask, xK_v ),  killAllOtherCopies) -- @@ Toggle window state back

For detailed instructions on editing your key bindings, see XMonad.Doc.Extending.

copy :: (Eq s, Eq i, Eq a) => i -> StackSet i l a s sd -> StackSet i l a s sd

Copy the focused window to a workspace.

copyToAll :: (Eq s, Eq i, Eq a) => StackSet i l a s sd -> StackSet i l a s sd

Copy the focused window to all workspaces.

copyWindow :: (Eq a, Eq i, Eq s) => a -> i -> StackSet i l a s sd -> StackSet i l a s sd

Copy an arbitrary window to a workspace.

runOrCopy :: String -> Query Bool -> X ()

runOrCopy will run the provided shell command unless it can find a specified window in which case it will copy the window to the current workspace. Similar to (i.e., stolen from) XMonad.Actions.WindowGo.

killAllOtherCopies :: X ()

Kill all other copies of focused window (if they're present). 'All other' means here 'copies which are not on the current workspace'.

kill1 :: X ()

Remove the focused window from this workspace. If it's present in no other workspace, then kill it instead. If we do kill it, we'll get a delete notify back from X.

There are two ways to delete a window. Either just kill it, or if it supports the delete protocol, send a delete event (e.g. firefox).

# Highlight workspaces containing copies in logHook

To distinguish workspaces containing copies of the focused window use something like:

    sampleLogHook h = do
       copies <- wsContainingCopies
       let check ws | ws `elem` copies = pad . xmobarColor "red" "black" $ ws
                    | otherwise = pad ws
       dynamicLogWithPP myPP {ppHidden = check, ppOutput = hPutStrLn h}

    main = do
       h <- spawnPipe "xmobar"
       xmonad def { logHook = sampleLogHook h }

wsContainingCopies :: X [WorkspaceId]

A list of hidden workspaces containing a copy of the focused window.