From c214a9b111bc69bfd820dfb465d5a6399c97a88d Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Tue, 4 Oct 2016 00:40:34 -0400 Subject: [PATCH] doc: Document the client request::activate contexts --- objects/client.c | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/objects/client.c b/objects/client.c index 6d28b5aa3..0b81bdc1b 100644 --- a/objects/client.c +++ b/objects/client.c @@ -152,8 +152,34 @@ */ /** 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`. + * + * To implement focus stealing filters see `awful.ewmh.add_activate_filter`. + * * @signal request::activate * @tparam string context The context where this signal was used. * @tparam[opt] table hints A table with additional hints: