doc: Move request:: handler to their own documentation section
This commit is contained in:
parent
47fffb5eee
commit
e78ad709e7
|
@ -35,6 +35,8 @@ new_type("function", "Functions")
|
||||||
new_type("property", "Object properties", false, "Type")
|
new_type("property", "Object properties", false, "Type")
|
||||||
-- New type for signals
|
-- New type for signals
|
||||||
new_type("signal", "Signals", false, "Arguments")
|
new_type("signal", "Signals", false, "Arguments")
|
||||||
|
-- New type for signals connections
|
||||||
|
new_type("signalhandler", "Request handlers", false, "Arguments")
|
||||||
-- Allow objects to define a set of beautiful properties affecting them
|
-- Allow objects to define a set of beautiful properties affecting them
|
||||||
new_type("beautiful", "Theme variables", false, "Type")
|
new_type("beautiful", "Theme variables", false, "Type")
|
||||||
-- Put deprecated methods in their own section
|
-- Put deprecated methods in their own section
|
||||||
|
|
|
@ -101,6 +101,7 @@ end
|
||||||
--
|
--
|
||||||
-- It is the default signal handler for `request::activate` on a `client`.
|
-- It is the default signal handler for `request::activate` on a `client`.
|
||||||
--
|
--
|
||||||
|
-- @signalhandler awful.ewmh.activate
|
||||||
-- @client c A client to use
|
-- @client c A client to use
|
||||||
-- @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:
|
||||||
|
@ -121,8 +122,11 @@ function ewmh.activate(c, context, hints) -- luacheck: no unused args
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Tag a window with its requested tag
|
--- Tag a window with its requested tag.
|
||||||
--
|
--
|
||||||
|
-- It is the default signal handler for `request::tag` on a `client`.
|
||||||
|
--
|
||||||
|
-- @signalhandler awful.ewmh.tag
|
||||||
-- @client c A client to tag
|
-- @client c A client to tag
|
||||||
-- @tag[opt] t A tag to use. If omitted, then the client is made sticky.
|
-- @tag[opt] t A tag to use. If omitted, then the client is made sticky.
|
||||||
-- @tparam[opt={}] table hints Extra information
|
-- @tparam[opt={}] table hints Extra information
|
||||||
|
@ -157,6 +161,7 @@ local context_mapper = {
|
||||||
--
|
--
|
||||||
-- This is the default geometry request handler.
|
-- This is the default geometry request handler.
|
||||||
--
|
--
|
||||||
|
-- @signalhandler awful.ewmh.geometry
|
||||||
-- @tparam client c The client
|
-- @tparam client c The client
|
||||||
-- @tparam string context The context
|
-- @tparam string context The context
|
||||||
-- @tparam[opt={}] table hints The hints to pass to the handler
|
-- @tparam[opt={}] table hints The hints to pass to the handler
|
||||||
|
|
|
@ -236,7 +236,7 @@ function mouse.client.resize(c, corner, args)
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Default handler for `request::geometry` signals with `mouse.resize` context.
|
--- Default handler for `request::geometry` signals with `mouse.resize` context.
|
||||||
-- @function awful.mouse.resize_handler
|
-- @signalhandler awful.mouse.resize_handler
|
||||||
-- @tparam client c The client
|
-- @tparam client c The client
|
||||||
-- @tparam string context The context
|
-- @tparam string context The context
|
||||||
-- @tparam[opt={}] table hints The hints to pass to the handler
|
-- @tparam[opt={}] table hints The hints to pass to the handler
|
||||||
|
|
Loading…
Reference in New Issue