mirror of
https://github.com/xmonad/xmonad-contrib.git
synced 2025-05-19 11:30:22 -07:00
Submap: haddock updates
This commit is contained in:
parent
913bd274b3
commit
0cce3cff7e
@ -3,12 +3,12 @@
|
||||
-- Module : XMonad.Actions.Submap
|
||||
-- Copyright : (c) Jason Creighton <jcreigh@gmail.com>
|
||||
-- License : BSD3-style (see LICENSE)
|
||||
--
|
||||
--
|
||||
-- Maintainer : Jason Creighton <jcreigh@gmail.com>
|
||||
-- Stability : unstable
|
||||
-- Portability : unportable
|
||||
--
|
||||
-- A module that allows the user to create a sub-mapping of keys bindings.
|
||||
-- A module that allows the user to create a sub-mapping of key bindings.
|
||||
--
|
||||
-----------------------------------------------------------------------------
|
||||
|
||||
@ -27,6 +27,14 @@ import Graphics.X11.Xlib.Extras
|
||||
import qualified Data.Map as M
|
||||
|
||||
{- $usage
|
||||
|
||||
|
||||
|
||||
|
||||
First, import this module into your @~\/.xmonad\/xmonad.hs@:
|
||||
|
||||
> import XMonad.Actions.Submap
|
||||
|
||||
Allows you to create a sub-mapping of keys. Example:
|
||||
|
||||
> , ((modMask, xK_a), submap . M.fromList $
|
||||
@ -36,21 +44,22 @@ Allows you to create a sub-mapping of keys. Example:
|
||||
> , ((0, xK_space), spawn "mpc toggle")
|
||||
> ])
|
||||
|
||||
So, for example, to run 'spawn \"mpc next\"', you would hit mod-a (to trigger the
|
||||
submapping) and then 'n' to run that action. (0 means \"no modifier\"). You are,
|
||||
of course, free to use any combination of modifiers in the submapping. However,
|
||||
anyModifier will not work, because that is a special value passed to XGrabKey()
|
||||
and not an actual modifier.
|
||||
So, for example, to run 'spawn \"mpc next\"', you would hit mod-a (to
|
||||
trigger the submapping) and then 'n' to run that action. (0 means \"no
|
||||
modifier\"). You are, of course, free to use any combination of
|
||||
modifiers in the submapping. However, anyModifier will not work,
|
||||
because that is a special value passed to XGrabKey() and not an actual
|
||||
modifier.
|
||||
|
||||
For detailed instructions on editing your key bindings, see
|
||||
"XMonad.Doc.Extending#Editing_key_bindings".
|
||||
|
||||
-}
|
||||
|
||||
-- %import XMonad.Actions.Submap
|
||||
-- %keybind , ((modMask, xK_a), submap . M.fromList $
|
||||
-- %keybind [ ((0, xK_n), spawn "mpc next")
|
||||
-- %keybind , ((0, xK_p), spawn "mpc prev")
|
||||
-- %keybind , ((0, xK_z), spawn "mpc random")
|
||||
-- %keybind , ((0, xK_space), spawn "mpc toggle")
|
||||
-- %keybind ])
|
||||
|
||||
-- | Given a 'Data.Map.Map' from key bindings to X () actions, return
|
||||
-- an action which waits for a user keypress and executes the
|
||||
-- corresponding action, or does nothing if the key is not found in
|
||||
-- the map.
|
||||
submap :: M.Map (KeyMask, KeySym) (X ()) -> X ()
|
||||
submap keys = do
|
||||
XConf { theRoot = root, display = d } <- ask
|
||||
|
Loading…
x
Reference in New Issue
Block a user