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::activate contexts

This commit is contained in:
Emmanuel Lepage Vallee 2016-10-04 00:40:34 -04:00
parent a2748a1fa3
commit c214a9b111
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
objects/client.c
View File

@ -152,8 +152,34 @@
*/ */
/** When a client should get activated (focused and/or raised). /** When a client should get activated (focused and/or raised).
*
* **Contexts are:**
*
* * *ewmh*: When a client ask for focus (from `X11` events)
* * *autofocus.check_focus*: When autofocus is enabled(from `awful.autofocus`)
* * *autofocus.check_focus_tag*: When autofocus is enabled
* (from `awful.autofocus`)
* * *client.jumpto*: When a custom lua extension ask a client to be focused
* (from `client.jump_to`)
* * *client.swap.global_bydirection*: When client swapping require a focus
* change (from `awful.client.swap.bydirection`)
* * *client.movetotag*: When a client is moved to a new tag
* (from `client.move_to_tag`)
* * *client.movetoscreen*: When the client is moved to a new screen
* (from `client.move_to_screen`)
* * *client.focus.byidx*: When selecting a client using its index
* (from `awful.client.focus.byidx`)
* * *client.focus.history.previous*: When cycling through history
* (from `awful.client.focus.history.previous`)
* * *menu.clients*: When using the build in client menu
* (from `awful.menu.clients`)
* * *rules*: When a new client is focused from a rule (from `awful.rules`)
* * *screen.focus*: When a screen is focused (from `awful.screen.focus`)
* *
* Default implementation: `awful.ewmh.activate`. * Default implementation: `awful.ewmh.activate`.
*
* To implement focus stealing filters see `awful.ewmh.add_activate_filter`.
*
* @signal request::activate * @signal request::activate
* @tparam string context The context where this signal was used. * @tparam string context The context where this signal was used.
* @tparam[opt] table hints A table with additional hints: * @tparam[opt] table hints A table with additional hints: