WildBind.X11.Internal.Key

This is an internal module. Package users should not rely on this.

Key

class XKeyInput k where

Class of data types that can be handled by X11. The data type can tell X11 to grab key with optional modifiers, and it can be extracted from a X11 Event object.

Since: 0.2.0.0

Minimal complete definition

toKeySym, fromKeyEvent

Methods

toKeySym :: k -> KeySym

Get the X11 keysym for this input.

toModifierMasks :: KeyMaskMap -> k -> NonEmpty KeyMask

Get modifer masks to grab the keysym. The grab action is repeated for all modifier masks. By default, it just returns 0.

fromKeyEvent :: KeyMaskMap -> KeyEventType -> KeySym -> KeyMask -> Maybe k

Create the input object from a key event type, a keysym and a modifier (got from XEvent.)

Instances

XKeyInput NumPadUnlocked

This input event captures the KeyRelease event only. That way, you can deliver events to the window that originally has the keyboard focus.

Methods

toKeySym :: NumPadUnlocked -> KeySym

toModifierMasks :: KeyMaskMap -> NumPadUnlocked -> NonEmpty KeyMask

fromKeyEvent :: KeyMaskMap -> KeyEventType -> KeySym -> KeyMask -> Maybe NumPadUnlocked

XKeyInput NumPadLocked

This input event captures the KeyRelease event only. That way, you can deliver events to the window that originally has the keyboard focus.

Methods

toKeySym :: NumPadLocked -> KeySym

toModifierMasks :: KeyMaskMap -> NumPadLocked -> NonEmpty KeyMask

fromKeyEvent :: KeyMaskMap -> KeyEventType -> KeySym -> KeyMask -> Maybe NumPadLocked

XKeyInput XKeyEvent

fromKeyEvent always returns Just.

Methods

toKeySym :: XKeyEvent -> KeySym

toModifierMasks :: KeyMaskMap -> XKeyEvent -> NonEmpty KeyMask

fromKeyEvent :: KeyMaskMap -> KeyEventType -> KeySym -> KeyMask -> Maybe XKeyEvent

(XKeyInput a, XKeyInput b) => XKeyInput (Either a b)

fromKeyEvent first tries to create Left (type a). If it fails, then it tries to create Right (type b).

Methods

toKeySym :: Either a b -> KeySym

toModifierMasks :: KeyMaskMap -> Either a b -> NonEmpty KeyMask

fromKeyEvent :: KeyMaskMap -> KeyEventType -> KeySym -> KeyMask -> Maybe (Either a b)

xKeyEventToXKeyInput :: XKeyInput k => KeyMaskMap -> KeyEventType -> XKeyEventPtr -> MaybeT IO k

Extract the XKeyInput from the XKeyEvent.

Since: 0.2.0.0

data KeyEventType

Whether the key is pressed or released.

Since: 0.2.0.0

Constructors

KeyPress

KeyRelease

Instances

Bounded KeyEventType

Methods

minBound :: KeyEventType

maxBound :: KeyEventType

Enum KeyEventType

Methods

succ :: KeyEventType -> KeyEventType

pred :: KeyEventType -> KeyEventType

toEnum :: Int -> KeyEventType

fromEnum :: KeyEventType -> Int

enumFrom :: KeyEventType -> [KeyEventType]

enumFromThen :: KeyEventType -> KeyEventType -> [KeyEventType]

enumFromTo :: KeyEventType -> KeyEventType -> [KeyEventType]

enumFromThenTo :: KeyEventType -> KeyEventType -> KeyEventType -> [KeyEventType]

Eq KeyEventType

Methods

(==) :: KeyEventType -> KeyEventType -> Bool

(/=) :: KeyEventType -> KeyEventType -> Bool

Ord KeyEventType

Methods

compare :: KeyEventType -> KeyEventType -> Ordering

(<) :: KeyEventType -> KeyEventType -> Bool

(<=) :: KeyEventType -> KeyEventType -> Bool

(>) :: KeyEventType -> KeyEventType -> Bool

(>=) :: KeyEventType -> KeyEventType -> Bool

max :: KeyEventType -> KeyEventType -> KeyEventType

min :: KeyEventType -> KeyEventType -> KeyEventType

Show KeyEventType

Methods

showsPrec :: Int -> KeyEventType -> ShowS

show :: KeyEventType -> String

showList :: [KeyEventType] -> ShowS

Modifiers

data KeyMaskMap

KeyMask values assigned to each modifier keys/states. If the modifier doesn't exist, the mask is 0.

Since: 0.2.0.0

Constructors

KeyMaskMap

Fields

• maskShift :: KeyMask
• maskControl :: KeyMask
• maskAlt :: KeyMask
• maskSuper :: KeyMask
• maskNumLock :: KeyMask
• maskCapsLock :: KeyMask
• maskShiftLock :: KeyMask
• maskScrollLock :: KeyMask

Instances

Eq KeyMaskMap

Methods

(==) :: KeyMaskMap -> KeyMaskMap -> Bool

(/=) :: KeyMaskMap -> KeyMaskMap -> Bool

Ord KeyMaskMap

Methods

compare :: KeyMaskMap -> KeyMaskMap -> Ordering

(<) :: KeyMaskMap -> KeyMaskMap -> Bool

(<=) :: KeyMaskMap -> KeyMaskMap -> Bool

(>) :: KeyMaskMap -> KeyMaskMap -> Bool

(>=) :: KeyMaskMap -> KeyMaskMap -> Bool

max :: KeyMaskMap -> KeyMaskMap -> KeyMaskMap

min :: KeyMaskMap -> KeyMaskMap -> KeyMaskMap

Show KeyMaskMap

Methods

showsPrec :: Int -> KeyMaskMap -> ShowS

show :: KeyMaskMap -> String

showList :: [KeyMaskMap] -> ShowS

getKeyMaskMap :: Display -> IO KeyMaskMap

Get current KeyMaskMap.

Since: 0.2.0.0

XKeyEvent

data XKeyEvent

High-level X11 key event.

Since: 0.2.0.0

Constructors

XKeyEvent

Fields

• xKeyEventType :: KeyEventType
• xKeyEventMods :: Set XMod

  set of key modifiers enabled.

• xKeyEventKeySym :: KeySym

  X11 KeySym for the key. WildBind.X11.KeySym re-exports KeySym values.

Instances

Eq XKeyEvent

Methods

(==) :: XKeyEvent -> XKeyEvent -> Bool

(/=) :: XKeyEvent -> XKeyEvent -> Bool

Ord XKeyEvent

Methods

compare :: XKeyEvent -> XKeyEvent -> Ordering

(<) :: XKeyEvent -> XKeyEvent -> Bool

(<=) :: XKeyEvent -> XKeyEvent -> Bool

(>) :: XKeyEvent -> XKeyEvent -> Bool

(>=) :: XKeyEvent -> XKeyEvent -> Bool

max :: XKeyEvent -> XKeyEvent -> XKeyEvent

min :: XKeyEvent -> XKeyEvent -> XKeyEvent

Show XKeyEvent

Methods

showsPrec :: Int -> XKeyEvent -> ShowS

show :: XKeyEvent -> String

showList :: [XKeyEvent] -> ShowS

Describable XKeyEvent

Methods

describe :: XKeyEvent -> ActionDescription

ToXKeyEvent XKeyEvent

Methods

toXKeyEvent :: XKeyEvent -> XKeyEvent

XKeyInput XKeyEvent

fromKeyEvent always returns Just.

Methods

toKeySym :: XKeyEvent -> KeySym

toModifierMasks :: KeyMaskMap -> XKeyEvent -> NonEmpty KeyMask

fromKeyEvent :: KeyMaskMap -> KeyEventType -> KeySym -> KeyMask -> Maybe XKeyEvent

data XMod

X11 key modifiers.

Since: 0.2.0.0

Constructors

Shift

Ctrl

Alt

Super

Instances

Bounded XMod

Methods

minBound :: XMod

maxBound :: XMod

Enum XMod

Methods

succ :: XMod -> XMod

pred :: XMod -> XMod

toEnum :: Int -> XMod

fromEnum :: XMod -> Int

enumFrom :: XMod -> [XMod]

enumFromThen :: XMod -> XMod -> [XMod]

enumFromTo :: XMod -> XMod -> [XMod]

enumFromThenTo :: XMod -> XMod -> XMod -> [XMod]

Eq XMod

Methods

(==) :: XMod -> XMod -> Bool

(/=) :: XMod -> XMod -> Bool

Ord XMod

Methods

compare :: XMod -> XMod -> Ordering

(<) :: XMod -> XMod -> Bool

(<=) :: XMod -> XMod -> Bool

(>) :: XMod -> XMod -> Bool

(>=) :: XMod -> XMod -> Bool

max :: XMod -> XMod -> XMod

min :: XMod -> XMod -> XMod

Show XMod

Methods

showsPrec :: Int -> XMod -> ShowS

show :: XMod -> String

showList :: [XMod] -> ShowS

class ToXKeyEvent k where

Something that can converted to XKeyEvent.

Since: 0.2.0.0

Minimal complete definition

toXKeyEvent

Methods

toXKeyEvent :: k -> XKeyEvent

Instances

ToXKeyEvent KeySym

KeyPress event of KeySym with empty XMod set.

Methods

toXKeyEvent :: KeySym -> XKeyEvent

ToXKeyEvent XKeyEvent

Methods

toXKeyEvent :: XKeyEvent -> XKeyEvent

(ToXKeyEvent a, ToXKeyEvent b) => ToXKeyEvent (Either a b)

Methods

toXKeyEvent :: Either a b -> XKeyEvent

addXMod :: ToXKeyEvent k => XMod -> k -> XKeyEvent

Add a XMod to xKeyEventMods.

Since: 0.2.0.0

press :: ToXKeyEvent k => k -> XKeyEvent

Set KeyPress to xKeyEventType.

Since: 0.2.0.0

release :: ToXKeyEvent k => k -> XKeyEvent

Set KeyRelease to xKeyEventType.

Since: 0.2.0.0

shift :: ToXKeyEvent k => k -> XKeyEvent

Add Shift modifier to xKeyEventMods.

Since: 0.2.0.0

ctrl :: ToXKeyEvent k => k -> XKeyEvent

Add Ctrl modifier to xKeyEventMods.

Since: 0.2.0.0

alt :: ToXKeyEvent k => k -> XKeyEvent

Add Alt modifier to xKeyEventMods.

Since: 0.2.0.0

super :: ToXKeyEvent k => k -> XKeyEvent

Add Super modifier to xKeyEventMods.

Since: 0.2.0.0

Grabs

xGrabKey :: Display -> Window -> KeySym -> KeyMask -> IO ()

Grab the specified key on the specified window. The key is captured from now on, so the window won't get that.

Since: 0.2.0.0

xUngrabKey :: Display -> Window -> KeySym -> KeyMask -> IO ()

Release the grab on the specified key.

Since: 0.2.0.0

Event generation

xSendKeyEvent :: KeyMaskMap -> Display -> Window -> XKeyEvent -> IO ()

Send a XKeyEvent to the window.

Since: 0.2.0.0