--- awesome key API -- @author Julien Danjou <julien@danjou.info> -- @copyright 2008-2009 Julien Danjou -- @release @AWESOME_VERSION@ -- @classmod key --- Key object. -- -- @field key The key to press to triggers an event. -- @field 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'. -- @field 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. -- -- @param name A signal name. -- @param func A function to call when the signal is emitted. -- @function connect_signal --- Remove a signal. -- -- @param name A signal name. -- @param func A function to remove. -- @function disconnect_signal --- Emit a signal. -- -- @param name A signal name. -- @param[opt] ... Various arguments. -- @function emit_signal --- Get the number of instances. -- -- @return The number of key objects alive. -- @function instances