Reference

# Module `key`

awesome key API

Author:

Julien Danjou <julien@danjou.info>

Copyright© 2008-2009 Julien Danjou

## Functions

add_signal (name, func) | Add a signal.
emit_signal (name, ...) | Emit a signal.
remove_signal (name, func) | Remove a signal.

## Tables

key | Key object.

## Functions

add_signal (name, func)
  Add a signal.

  ### Parameters

  - name: A signal name.
  - func: A function to call when the signal is emitted.
emit_signal (name, ...)
  Emit a signal.

  ### Parameters

  - name: A signal name.
  - ...: Various arguments, optional.
remove_signal (name, func)
  Remove a signal.

  ### Parameters

  - name: A signal name.
  - func: A function to remove.

## 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.