wild-bind-x11-0.2.0.17: X11-specific implementation for WildBind
MaintainerToshio Ito <debug.ito@gmail.com>
Safe HaskellSafe-Inferred
LanguageHaskell2010

WildBind.X11.Internal.Key

Description

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

Synopsis

Key

class XKeyInput k where Source #

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 Source #

Get the X11 keysym for this input.

toModifierMasks :: KeyMaskMap -> k -> NonEmpty KeyMask Source #

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 Source #

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

Instances

Instances details
XKeyInput NumPadLocked Source #

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

Instance details

Defined in WildBind.X11.Internal.Key

Methods

toKeySym :: NumPadLocked -> KeySym Source #

toModifierMasks :: KeyMaskMap -> NumPadLocked -> NonEmpty KeyMask Source #

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

XKeyInput NumPadUnlocked Source #

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

Instance details

Defined in WildBind.X11.Internal.Key

Methods

toKeySym :: NumPadUnlocked -> KeySym Source #

toModifierMasks :: KeyMaskMap -> NumPadUnlocked -> NonEmpty KeyMask Source #

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

XKeyInput XKeyEvent Source #

fromKeyEvent always returns Just.

Instance details

Defined in WildBind.X11.Internal.Key

Methods

toKeySym :: XKeyEvent -> KeySym Source #

toModifierMasks :: KeyMaskMap -> XKeyEvent -> NonEmpty KeyMask Source #

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

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

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

Instance details

Defined in WildBind.X11.Internal.Key

Methods

toKeySym :: Either a b -> KeySym Source #

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

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

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

Extract the XKeyInput from the XKeyEvent.

Since: 0.2.0.0

data KeyEventType Source #

Whether the key is pressed or released.

Since: 0.2.0.0

Constructors

KeyPress 
KeyRelease 

Instances

Instances details
Bounded KeyEventType Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

minBound :: KeyEventType #

maxBound :: KeyEventType #

Enum KeyEventType Source # 
Instance details

Defined in WildBind.X11.Internal.Key

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] #

Show KeyEventType Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

showsPrec :: Int -> KeyEventType -> ShowS #

show :: KeyEventType -> String #

showList :: [KeyEventType] -> ShowS #

Eq KeyEventType Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

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

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

Ord KeyEventType Source # 
Instance details

Defined in WildBind.X11.Internal.Key

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 #

Modifiers

data KeyMaskMap Source #

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

Instances

Instances details
Show KeyMaskMap Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

showsPrec :: Int -> KeyMaskMap -> ShowS #

show :: KeyMaskMap -> String #

showList :: [KeyMaskMap] -> ShowS #

Eq KeyMaskMap Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

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

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

Ord KeyMaskMap Source # 
Instance details

Defined in WildBind.X11.Internal.Key

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 #

getKeyMaskMap :: Display -> IO KeyMaskMap Source #

Get current KeyMaskMap.

Since: 0.2.0.0

XKeyEvent

data XKeyEvent Source #

High-level X11 key event.

Since: 0.2.0.0

Constructors

XKeyEvent 

Fields

Instances

Instances details
Show XKeyEvent Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

showsPrec :: Int -> XKeyEvent -> ShowS #

show :: XKeyEvent -> String #

showList :: [XKeyEvent] -> ShowS #

Eq XKeyEvent Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

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

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

Ord XKeyEvent Source # 
Instance details

Defined in WildBind.X11.Internal.Key

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 #

Describable XKeyEvent Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

describe :: XKeyEvent -> ActionDescription #

ToXKeyEvent XKeyEvent Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

toXKeyEvent :: XKeyEvent -> XKeyEvent Source #

XKeyInput XKeyEvent Source #

fromKeyEvent always returns Just.

Instance details

Defined in WildBind.X11.Internal.Key

Methods

toKeySym :: XKeyEvent -> KeySym Source #

toModifierMasks :: KeyMaskMap -> XKeyEvent -> NonEmpty KeyMask Source #

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

data XMod Source #

X11 key modifiers.

Since: 0.2.0.0

Constructors

Shift 
Ctrl 
Alt 
Super 

Instances

Instances details
Bounded XMod Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

minBound :: XMod #

maxBound :: XMod #

Enum XMod Source # 
Instance details

Defined in WildBind.X11.Internal.Key

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] #

Show XMod Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

showsPrec :: Int -> XMod -> ShowS #

show :: XMod -> String #

showList :: [XMod] -> ShowS #

Eq XMod Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

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

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

Ord XMod Source # 
Instance details

Defined in WildBind.X11.Internal.Key

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 #

class ToXKeyEvent k where Source #

Something that can converted to XKeyEvent.

Since: 0.2.0.0

Methods

toXKeyEvent :: k -> XKeyEvent Source #

Instances

Instances details
ToXKeyEvent KeySym Source #

KeyPress event of KeySym with empty XMod set.

Instance details

Defined in WildBind.X11.Internal.Key

Methods

toXKeyEvent :: KeySym -> XKeyEvent Source #

ToXKeyEvent XKeyEvent Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

toXKeyEvent :: XKeyEvent -> XKeyEvent Source #

(ToXKeyEvent a, ToXKeyEvent b) => ToXKeyEvent (Either a b) Source # 
Instance details

Defined in WildBind.X11.Internal.Key

Methods

toXKeyEvent :: Either a b -> XKeyEvent Source #

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

Add a XMod to xKeyEventMods.

Since: 0.2.0.0

press :: ToXKeyEvent k => k -> XKeyEvent Source #

Set KeyPress to xKeyEventType.

Since: 0.2.0.0

release :: ToXKeyEvent k => k -> XKeyEvent Source #

Set KeyRelease to xKeyEventType.

Since: 0.2.0.0

shift :: ToXKeyEvent k => k -> XKeyEvent Source #

Add Shift modifier to xKeyEventMods.

Since: 0.2.0.0

ctrl :: ToXKeyEvent k => k -> XKeyEvent Source #

Add Ctrl modifier to xKeyEventMods.

Since: 0.2.0.0

alt :: ToXKeyEvent k => k -> XKeyEvent Source #

Add Alt modifier to xKeyEventMods.

Since: 0.2.0.0

super :: ToXKeyEvent k => k -> XKeyEvent Source #

Add Super modifier to xKeyEventMods.

Since: 0.2.0.0

Grabs

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

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 () Source #

Release the grab on the specified key.

Since: 0.2.0.0

Event generation

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

Send a XKeyEvent to the window.

Since: 0.2.0.0