awesome/docs/common/signals.ldoc

30 lines
861 B
Plaintext
Raw Normal View History

--- Connect a global signal on the module.
--
-- Functions connected to this signal source will be executed when any
-- module object emits the signal.
--
-- It is also used for some generic module signals such as
-- `request::display`.
--
-- @tparam string name The name of the signal
-- @tparam function func The function to attach
-- @noreturn
2021-12-17 22:46:08 +01:00
-- @staticfct naughty.connect_signal
-- @usage naughty.connect_signal("added", function(notif)
-- -- do something
-- end)
--- Emit a module signal.
-- @tparam string name The signal name.
-- @param ... The signal callback arguments
-- @noreturn
2021-12-17 22:46:08 +01:00
-- @staticfct naughty.emit_signal
--- Disconnect a signal from a source.
-- @tparam string name The name of the signal
-- @tparam function func The attached function
2021-12-17 22:46:08 +01:00
-- @staticfct naughty.disconnect_signal
-- @treturn boolean If the disconnection was successful