awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc: Document the client request::default_keybindings signal.

This commit is contained in:
Emmanuel Lepage Vallee 2019-12-01 00:41:06 -05:00 committed by Emmanuel Lepage-Vallee
parent 7705ef9f1e
commit 257556793a
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
objects/client.c
View File

@ -312,6 +312,7 @@
* @signal request::default_mousebindings
* @tparam string context The reason why the signal was sent (currently always
* `startup`).
* @classsignal
*/
/** Emitted during startup to gather the default client keybindings.
@ -323,6 +324,19 @@
* @signal request::default_keybindings
* @tparam string context The reason why the signal was sent (currently always
* `startup`).
* @classsignal
*/
/** Sent once when AwesomeWM starts to add default keybindings.
*
* Keybindings can be set directly on clients. Actually, older version of
* AwesomeWM did that through the rules. However this makes it impossible for
* auto-configured modules to add their own keybindings. Using the signals,
* `rc.lua` or any module can cleanly manage keybindings.
*
* @signal request::default_keybindings
* @tparam string context The context (currently always "startup").
* @classsignal
*/
/** When a client gets tagged.