Module: cwc_kbindmap
Lua object for keybindings map.
Info:
- Copyright: 2025
- License: GPLv3
-
Originally authored by: Dwi Asmoro Bangun
(Full contributors list available on our github project)
Object properties
| active | boolean | Active state of the keybind map. | |
| member | cwc_kbind[] | Get list of all binding in the map. | Read only |
Object methods
| :bind (modifier, keyname, on_press, on_release, data) | Register a keyboard binding. | |
| :active_only () | Set this map as the only active one disabling all others map. |
Object properties
- 🔗 active boolean
-
Active state of the keybind map.
Constraints:
Default value : trueValid values : trueorfalse. - 🔗 member cwc_kbind[] · read only
-
Get list of all binding in the map.
Constraints:
Default value : {}Valid values : List of the bindings. See also:
cwc_kbind Lua Object for registered keybind. module cwc.kbd.get_default_member Get keybind object in the default map. (cwc.kbd) config functions
Object methods
- 🔗 :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.hon_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 exclusive Optional string Allow keybind to be executed even in lockscreen and shortcut inhibit repeated Optional string Repeat keybind when hold (only on_press will be executed) 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.bind Register a keyboard binding in the default map. (cwc.kbd) static module functions - 🔗 :active_only ()
- Set this map as the only active one disabling all others map.