Module: cwc.kbd

Low-level API to manage keyboard behavior

Info:

  • Copyright: 2024
  • License: GPLv3
  • Originally authored by: Dwi Asmoro Bangun
    (Full contributors list available on our github project)

Static module functions

cwc.kbd.bind (modifier, keyname, on_press, on_release, data) Register a keyboard binding.
cwc.kbd.clear (common_key) Clear all keyboard binding

Config functions

cwc.kbd.set_repeat_rate (rate) Set keyboard repeat rate
cwc.kbd.set_repeat_delay (delay) Set keyboard repeat delay


Static module functions

🔗 cwc.kbd.bind (modifier, keyname, on_press, on_release, data)
Register a keyboard binding.

Parameters:

Name Type(s) Description
modifier table or number Table of modifier or modifier bitfield
keyname string Keyname from xkbcommon-keysyms.h
on_press func Function to execute when pressed
on_release Optional func Function to execute when released
data Optional table Additional data
group Optional string Keybinding group
description Optional string Keybinding description

See also:

cuteful.enum.modifier Keyboard modifier constant mapped from wlr_keyboard.h (cuteful.enum) tables
cwc.pointer.bind Register a mouse binding. (cwc.pointer) static module functions
🔗 cwc.kbd.clear (common_key)
Clear all keyboard binding

Parameters:

Name Type(s) Description Default value
common_key Optional boolean Also clear common key (chvt key) false

Config functions

🔗 cwc.kbd.set_repeat_rate (rate)
Set keyboard repeat rate

Parameters:

Name Type(s) Description
rate number Rate in hertz
🔗 cwc.kbd.set_repeat_delay (delay)
Set keyboard repeat delay

Parameters:

Name Type(s) Description
delay number Delay in miliseconds
generated by LDoc 1.5.0 based on AwesomeWM template