twin/xmonad-contrib
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad-contrib.git synced 2025-07-31 20:21:51 -07:00
Code Issues Packages Projects Releases Wiki Activity

X.D.Extending: Rewrite keyDel

Browse Source 
Nowadays, removing keys is mostly done via removeKeys and removeKeysP,
so the documentation should reflect that fact.  This part is less
step-by-step instructive than the section about adding keys, but read in
succession it presents a way to deepen the newly acquired knowledge.
This commit is contained in:
Tony Zorman
2022-09-05 08:26:06 +02:00
parent 9809b2013f
commit cedb8d7c78
1 changed files with 49 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
XMonad/Doc/Extending.hs
View File

@@ -388,42 +388,63 @@ extend xmonad an scratch a particular itch!
{- $keyDel {- $keyDel
#Removing_key_bindings# #Removing_key_bindings#
Removing key bindings requires modifying the 'Data.Map.Strict.Map' which As we've learned, XMonad stores keybindings inside of a
stores the key bindings. This can be done with 'Data.Map.difference' or 'Data.Map.Strict.Map', which means that removing keybindings requires
with 'Data.Map.Strict.delete'. modifying it. This can be done with 'Data.Map.difference' or with
'Data.Map.Strict.delete'.
For example, suppose you want to get rid of @mod-q@ and @mod-shift-q@ For example, suppose you want to entirely rid yourself of @"M-q"@ and
(you just want to leave xmonad running forever). To do this you need to @"M-s-q"@ (you just want to leave xmonad running forever). To do this
define @newKeys@ as a 'Data.Map.Strict.difference' between the default with bare @xmonad@, you need to define @newKeys@ as a
map and the map of the key bindings you want to remove. Like so: 'Data.Map.Strict.difference' between the default map and the map of the
key bindings you want to remove. Like so:
> newKeys x = keys def x `M.difference` keysToRemove x > newKeys :: XConfig l -> Map (KeyMask, KeySym) (X ())
> newKeys x = keys def x `M.difference` keysToRemove x
> >
> keysToRemove :: XConfig Layout -> M.Map (KeyMask, KeySym) (X ()) > keysToRemove :: XConfig l -> Map (KeyMask, KeySym) (X ())
> keysToRemove x = M.fromList > keysToRemove x = M.fromList
> [ ((modm , xK_q ), return ()) > [ ((modm , xK_q ), return ())
> , ((modm .|. shiftMask, xK_q ), return ()) > , ((modm .|. shiftMask, xK_q ), return ())
> ] > ]
As you can see, it doesn't matter what actions we associate with the As you can see, it doesn't matter what actions we associate with the
keys listed in @keysToRemove@, so we just use @return ()@ (the keys listed in @keysToRemove@, so we just use @return ()@ (the \"null\"
\"null\" action). action). Since @newKeys@ contains all of the default keys, you can
simply pass it to 'XMonad.Core.XConfig' as your map of keybindings:
It is also possible to simply define a list of keys we want to unbind > main :: IO ()
and then use 'Data.Map.Strict.delete' to remove them. In that case we > main = xmonad $ def { keys = newKeys }
would write something like:
> newKeys x = foldr M.delete (keys def x) (keysToRemove x) However, having to manually type @return ()@ every time seems like a
> drag, doesn't it? And this approach isn't at all compatible with adding
> keysToRemove :: XConfig Layout -> [(KeyMask, KeySym)] custom keybindings via 'XMonad.Util.EZConfig.additionalKeysP'! Well,
> keysToRemove x = good thing "XMonad.Util.EZConfig" also sports
> [ (modm , xK_q ) 'XMonad.Util.EZConfig.removeKeysP'. You can use it as you would expect.
> , (modm .|. shiftMask, xK_q )
> ]
Another even simpler possibility is the use of some of the utilities > main :: IO ()
provided by the xmonad-contrib library. Look, for instance, at > main = xmonad $ def
'XMonad.Util.EZConfig.removeKeys'. > { … }
> `removeKeysP` ["M-q", "M-S-q"]
Can you guess how 'XMonad.Util.EZConfig.removeKeysP' works? It's almost
the same code we wrote above, just accepting a list of keybindings. Try
to see if you can come up with an implementation of
> removeKeysP :: XConfig l -> [String] -> XConfig l
If you're done, just click on @# Source@ when viewing the
'XMonad.Util.EZConfig.removeKeysP' documentation (did you know that
Haddock lets you do that for every function?) and compare.
If you don't use the @P@ alternatives of EZConfig, there is also an
aptly named 'XMonad.Util.EZConfig.removeKeys'. Again, can you try to
come up with an implementation yourself that has the correct signature?
> removeKeys :: XConfig a -> [(KeyMask, KeySym)] -> XConfig a
In addition to 'Data.Map.Strict.delete', you will probably need to use
'foldr'.
-} -}