40 lines
1.1 KiB
Lua
40 lines
1.1 KiB
Lua
--- awesome key API
|
|
-- @author Julien Danjou <julien@danjou.info>
|
|
-- @copyright 2008-2009 Julien Danjou
|
|
-- @release @AWESOME_VERSION@
|
|
-- @classmod key
|
|
|
|
--- Key object.
|
|
--
|
|
-- @tfield string key The key to trigger an event.
|
|
-- @tfield string keysym Same as key, but return the name of the key symbol. It
|
|
-- can be identical to key, but for characters like '.' it will return
|
|
-- 'period'.
|
|
-- @tfield table modifiers The modifier key that should be pressed while the
|
|
-- key is pressed. An array with all the modifiers. Valid modifiers are: Any,
|
|
-- Mod1, Mod2, Mod3, Mod4, Mod5, Shift, Lock and Control.
|
|
-- @table key
|
|
|
|
--- Add a signal.
|
|
--
|
|
-- @tparam string name A signal name.
|
|
-- @tparam function func A function to call when the signal is emitted.
|
|
-- @function connect_signal
|
|
|
|
--- Remove a signal.
|
|
--
|
|
-- @tparam string name A signal name.
|
|
-- @tparam function func A function to remove.
|
|
-- @function disconnect_signal
|
|
|
|
--- Emit a signal.
|
|
--
|
|
-- @tparam string name A signal name.
|
|
-- @param[opt] ... Various arguments.
|
|
-- @function emit_signal
|
|
|
|
--- Get the number of instances.
|
|
--
|
|
-- @treturn number The number of key objects alive.
|
|
-- @function instances
|