Copyright | (c) Matt Kingston <mattkingston@gmail.com> |
---|---|
License | BSD3-style (see LICENSE) |
Maintainer | mattkingston@gmail.com |
Stability | unstable |
Portability | unportable |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Provides functionality to use key chords to focus a visible window. Overlays a unique key chord (a string) above each visible window and allows the user to select a window by typing that chord. Inspired by vim-easymotion. Thanks to Tom Hinton for some feature inspiration and window sorting code.
Synopsis
- selectWindow :: EasyMotionConfig -> X (Maybe Window)
- data EasyMotionConfig = EMConf {}
- data ChordKeys
- def :: Default a => a
- fullSize :: Position -> Rectangle -> Rectangle
- fixedSize :: (Integral a, Integral b) => a -> b -> Position -> Rectangle -> Rectangle
- textSize :: Position -> Rectangle -> Rectangle
- proportional :: RealFrac f => f -> Position -> Rectangle -> Rectangle
- bar :: RealFrac f => f -> Position -> Rectangle -> Rectangle
Usage
You can use this module's basic functionality with the following in your
xmonad.hs
:
import XMonad.Actions.EasyMotion (selectWindow)
To customise
import XMonad.Actions.EasyMotion (selectWindow, EasyMotionConfig(..))
Then add a keybinding and an action to the selectWindow
function.
In this case M-f
to focus the selected window:
, ((modm, xK_f), selectWindow def >>= (`whenJust` windows . W.focusWindow))
Similarly, to kill a window with M-f
:
, ((modm, xK_f), selectWindow def >>= (`whenJust` killWindow))
See EasyMotionConfig
for all configuration options. A short summary follows.
Default chord keys are s,d,f,j,k,l
. To customise these and display options assign
different values to def
(the default configuration):
, ((modm, xK_f), (selectWindow def{sKeys = AnyKeys [xK_f, xK_d]}) >>= (`whenJust` windows . W.focusWindow))
You must supply at least two different keys in the sKeys
list. Keys provided earlier in the list
will be used preferentially—therefore, keys you would like to use more frequently should be
earlier in the list.
To map different sets of keys to different screens. The following configuration maps keys fdsa
to screen 0 and hjkl
to screen 1. Keys provided earlier in the list will be used preferentially.
Providing the same key for multiple screens is possible but will break down in some scenarios.
import qualified Data.Map.Strict as StrictMap (fromList) emConf :: EasyMotionConfig emConf = def { sKeys = PerScreenKeys $ StrictMap.fromList [(0, [xK_f, xK_d, xK_s, xK_a]), (1, [xK_h, xK_j, xK_k, xK_l])] } -- key bindings , ((modm, xK_f), selectWindow emConf >>= (`whenJust` windows . W.focusWindow))
To customise the font:
, ((modm, xK_f), (selectWindow def{emFont = "xft: Sans-40"}) >>= (`whenJust` windows . W.focusWindow))
The emFont
field provided is supplied directly to the initXMF
function. The default is
"xft:Sans-100"
. Some example options:
"xft: Sans-40" "xft: Arial-100" "xft: Cambria-80"
Customise the overlay by supplying a function to overlayF
. The signature is
. The parameters are the height in pixels of
the selection chord and the rectangle of the window to be overlaid. Some are provided:Position
-> Rectangle
-> Rectangle
import XMonad.Actions.EasyMotion (selectWindow, EasyMotionConfig(..), proportional, bar, fullSize) , ((modm, xK_f), (selectWindow def{ overlayF = proportional 0.3 }) >>= (`whenJust` windows . W.focusWindow)) , ((modm, xK_f), (selectWindow def{ overlayF = bar 0.5 }) >>= (`whenJust` windows . W.focusWindow)) , ((modm, xK_f), (selectWindow def{ overlayF = fullSize }) >>= (`whenJust` windows . W.focusWindow)) , ((modm, xK_f), (selectWindow def{ overlayF = fixedSize 300 350 }) >>= (`whenJust` windows . W.focusWindow))
selectWindow :: EasyMotionConfig -> X (Maybe Window) Source #
Display overlay windows and chords for window selection
Configuration
data EasyMotionConfig Source #
Configuration options for EasyMotion.
All colors are hex strings, e.g. "#000000"
If the number of windows for which chords are required exceeds maxChordLen
, chords
will simply not be generated for these windows. In this way, single-key selection may be
preferred over the ability to select any window.
cancelKey
, xK_BackSpace
and any duplicates will be removed from sKeys
if included.
See Usage
for examples of sKeys
.
EMConf | |
|
Instances
Default EasyMotionConfig Source # | |
Defined in XMonad.Actions.EasyMotion def :: EasyMotionConfig # |
Maps keys to windows. AnyKeys
maps keys to windows regardless which screen they're on.
PerScreenKeys
maps keys to screens to windows. See Usage
for more examples.
Creating overlays
fullSize :: Position -> Rectangle -> Rectangle Source #
Create overlay windows of the same size as the window they select
fixedSize :: (Integral a, Integral b) => a -> b -> Position -> Rectangle -> Rectangle Source #
Create fixed-size overlay windows
textSize :: Position -> Rectangle -> Rectangle Source #
Create overlay windows the minimum size to contain their key chord