Text.XkbCommon.KeyboardState

Documentation

data KeyboardState

KeyboardState represents the state of a connected keyboard. (struct xkb_state)

newKeyboardState :: Keymap -> IO KeyboardState

Create a new keyboard state object for a keymap. (xkb_state_new)

updateKeyboardStateKey :: KeyboardState -> CKeycode -> Direction -> IO StateComponent

Update the keyboard state to reflect a given key being pressed or released. (xkb_state_update_key)

updateKeyboardStateMask :: KeyboardState -> (CModMask, CModMask, CModMask) -> (CLayoutIndex, CLayoutIndex, CLayoutIndex) -> IO StateComponent

Update a keyboard state from a set of explicit masks. (xkb_state_update_mask)

getOneKeySym :: KeyboardState -> CKeycode -> IO (Maybe Keysym)

Get the single keysym obtained from pressing a particular key in a given keyboard state. (xkb_state_key_get_one_sym)

getStateSyms :: KeyboardState -> CKeycode -> IO [Keysym]

Get the keysyms obtained from pressing a particular key in a given keyboard state. This function is useful because some keycode sequences produce multiple keysyms.

(xkb_state_key_get_syms)

stateRemoveConsumed :: KeyboardState -> CKeycode -> CModMask -> IO CModMask

Remove consumed modifiers from a modifier mask for a key. (xkb_state_mod_mask_remove_consumed)

stateModNameIsActive :: KeyboardState -> String -> StateComponent -> IO Bool

Test whether a modifier is active in a given keyboard state by name. (xkb_state_mod_name_is_active)

stateModIndexIsActive :: KeyboardState -> CModIndex -> StateComponent -> IO Bool

Test whether a modifier is active in a given keyboard state by index. (xkb_state_mod_index_is_active)

stateLedNameIsActive :: KeyboardState -> String -> IO Bool

Test whether a LED is active in a given keyboard state by name. (xkb_state_led_name_is_active)

stateSerializeMods :: KeyboardState -> StateComponent -> IO CModMask

The counterpart to xkb_state_update_mask for modifiers, to be used on the server side of serialization. (xkb_state_serialize_mods)