Module: cwc_kbind

Lua object for registered keybind.

Info:

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

Object properties

description string User defined description of the keybind.
group string User defined group name of the keybind.
exclusive boolean Exclusivity option of the keybind.
repeated boolean Repeat option of the keybind.
modifier number[] Registered modifiers of this keybind. Read only
modifier_name string[] Like modifier but return the name. Read only
keyname string The name of the registered keysym. Read only
keysym number Registered xkb keysym. Read only


Object properties

🔗 description string
User defined description of the keybind.

Constraints:

Default value : ''
🔗 group string
User defined group name of the keybind.

Constraints:

Default value : ''
🔗 exclusive boolean
Exclusivity option of the keybind.

Constraints:

Default value : false
Valid values : true or false.
🔗 repeated boolean
Repeat option of the keybind.

Constraints:

Default value : false
Valid values : true or false.
🔗 modifier number[] · read only
Registered modifiers of this keybind.

Constraints:

Default value : {}
Valid values : List of modifiers

See also:

cuteful.enum.modifier Keyboard modifier constant mapped from wlr_keyboard.h (cuteful.enum) tables
🔗 modifier_name string[] · read only
Like modifier but return the name.

Constraints:

Default value : {}
Valid values : List of modifier in human readable

See also:

cuteful.enum.modifier Keyboard modifier constant mapped from wlr_keyboard.h (cuteful.enum) tables
🔗 keyname string · read only
The name of the registered keysym.

Constraints:

Default value : ''
Valid values : The name of the key

See also:

cuteful.enum.modifier Keyboard modifier constant mapped from wlr_keyboard.h (cuteful.enum) tables
🔗 keysym number · read only
Registered xkb keysym.

Constraints:

Default value : 0
Negative allowed : false
Valid values : The keysym number

See also:

cuteful.enum.modifier Keyboard modifier constant mapped from wlr_keyboard.h (cuteful.enum) tables
generated by LDoc 1.5.0 based on AwesomeWM template