Module key
awesome key API
Info:
- Author: Julien Danjou <julien@danjou.info>
- Copyright: 2008-2009 Julien Danjou
Functions
connect_signal (name, func) | Add a signal. |
disconnect_signal (name, func) | Remove a signal. |
emit_signal (name, ...) | Emit a signal. |
instances () | Get the number of instances. |
Tables
key | Key object. |
Functions
- connect_signal (name, func)
-
Add a signal.
Parameters:
- name A signal name.
- func A function to call when the signal is emitted.
- disconnect_signal (name, func)
-
Remove a signal.
Parameters:
- name A signal name.
- func A function to remove.
- emit_signal (name, ...)
-
Emit a signal.
Parameters:
- name A signal name.
- ... Various arguments, optional.
- instances ()
-
Get the number of instances.
Returns:
-
The number of key objects alive.
Tables
- key
-
Key object.
Fields:
- key The key to press to triggers an event.
- 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'.
- 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.