XMonad.Config.DescriptiveKeys

Specify your key-bindings with a description and zero or more tags, then add a key-binding to search through them.

Usage

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

    import XMonad.Config.DescriptiveKeys

Create an instance of DescriptiveKeys by annotating key-bindings with a description and list of tags.

     myDescriptiveKeys = wKeys $ \c -> [(modMask c, xk_z, spawn "xclock"), "opens xclock", ["open", "xclock"]

Modify your XConfig with a configuration combinator. Following is the simplest.

     myXConfig = defaultHelpPromptAndSet myDescriptiveKeys myXPConfig xConfig

This will set the keys property of the XConfig and a key-binding of mod-F1 to search.

newtype Description

Wraps an optional string to denote a description for a key-binding.

Constructors

Description (Maybe String)

Instances

Eq Description

Ord Description

Show Description

data DescriptiveKey

The data structure that denotes an annotated key-binding.

Constructors

DescriptiveKey

Fields

mask :: ButtonMask

sym :: KeySym

action :: X ()

description :: Description

tags :: Tags

defaultDescriptiveKey :: ButtonMask -> KeySym -> X () -> DescriptiveKey

A default key-binding that has no description or tags.

DescriptiveKeys data structure

data DescriptiveKeys

A list of descriptive key-bindings that have access to the XConfig.

descriptiveKeys :: (XConfig Layout -> [DescriptiveKey]) -> DescriptiveKeys

Construct a list of descriptive key-bindings.

wKeys :: (XConfig Layout -> [(KeyMask, KeySym, X (), String, [String])]) -> DescriptiveKeys

Construct a list of descriptive key-bindings by specifying the description as a string and the tags as a list of strings.

setDescriptiveKeys :: DescriptiveKeys -> XConfig l -> XConfig l

Sets the keys property of the given XConfig with the given descriptive key-bindings.

Tags

newtype Tag

Wraps a string to create a tag.

Constructors

Tag String

Instances

Eq Tag

Ord Tag

Show Tag

type Tags = Set Tag

A set of tags.

allTags :: XConfig Layout -> DescriptiveKeys -> Tags

Returns all the tags for a given list of key-bindings.

newtype SearchTags

How to produce a set of tags from a string, which will likely come from user-input.

Constructors

SearchTags

Fields

searchTags :: String -> Tags

defaultSearchTags :: SearchTags

Splits a string by spaces to produce a set of tags.

filterTags :: Tags -> DescriptiveKeys -> DescriptiveKeys

Removes all descriptive key-bindings that are not in the given set of tags.

Pretty-printing the key description

data DescriptiveKeysPP

A pretty-printer for descriptive key-bindings.

Constructors

DescriptiveKeysPP ([DescriptiveKey] -> String)

defaultDescriptiveKeysPP :: DescriptiveKeysPP

A plain-text pretty-printer that takes particular care of mod/mask keys and spacing.

The prompt text when searching

newtype SearchTextPrompt

The prompt text when searching

Constructors

SearchTextPrompt String

Instances

Eq SearchTextPrompt

Ord SearchTextPrompt

Show SearchTextPrompt

defaultSearchTextPrompt :: SearchTextPrompt

The default search prompt, Search key-bindings

The action to take to describe the keys

newtype DescribeKeys

The action to take to describe key-bindings from a string user-input.

Constructors

DescribeKeys

Fields

describeKeys :: String -> X ()

defaultDescribeKeys :: DescriptiveKeys -> XConfig Layout -> DescribeKeys

A default that opens xmessage and uses the default pretty-printer.

Configuration

data HelpPromptConfig

The attributes required to do the final configuration of the descriptive key-bindings.

Constructors

HelpPromptConfig

Fields

descriptiveHelp :: DescriptiveKeys

The descriptive key-bindings.

xpConfigHelp :: XPConfig

The XPConfig that is used.

keyHelp :: (ButtonMask, KeySym)

The key-binding to prompt the user to search.

searchTextHelp :: SearchTextPrompt

The search text prompt.

describeHelp :: DescribeKeys

The action to take after string user-input.

helpPrompt :: (XConfig Layout -> HelpPromptConfig) -> XConfig l -> XConfig l

Sets the help prompt on the given XPConfig.

helpPromptAndSet :: DescriptiveKeys -> XPConfig -> (ButtonMask, KeySym) -> SearchTextPrompt -> (XConfig Layout -> DescribeKeys) -> XConfig l -> XConfig l

Sets the help prompt on the given XPConfig and sets the keys attribute.

defaultHelpPromptAndSet :: DescriptiveKeys -> XPConfig -> XConfig l -> XConfig l

Sets the help prompt on the given XPConfig and sets the keys attribute with a default key-binding of mod-F1, default search text prompt and using xmessage to provide the descriptive response.