luadoc/key.lua

   1 --- awesome key API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008-2009 Julien Danjou
   4 module("key")
   5
   6 --- Key object.
   7 -- @field key The key to press to triggers an event.
   8 -- @field keysym Same as key, but return the name of the key symbol. It can
   9 -- be identical to key, but for characters like '.' it will return 'period'.
  10 -- @field modifiers The modifier key that should be pressed while the key is
  11 -- pressed. An array with all the modifiers. Valid modifiers are: Any, Mod1,
  12 -- Mod2, Mod3, Mod4, Mod5, Shift, Lock and Control.
  13 -- @class table
  14 -- @name key
  15
  16 --- Add a signal.
  17 -- @param name A signal name.
  18 -- @param func A function to call when the signal is emitted.
  19 -- @name connect_signal
  20 -- @class function
  21
  22 --- Remove a signal.
  23 -- @param name A signal name.
  24 -- @param func A function to remove.
  25 -- @name disconnect_signal
  26 -- @class function
  27
  28 --- Emit a signal.
  29 -- @param name A signal name.
  30 -- @param ... Various arguments, optional.
  31 -- @name emit_signal
  32 -- @class function
  33
  34 --- Get the number of instances.
  35 -- @return The number of key objects alive.
  36 -- @name instances
  37 -- @class function