luadoc/keygrabber.lua

   1 --- awesome keygrabber API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008-2009 Julien Danjou
   4 module("keygrabber")
   5
   6 --- Grab keyboard and read pressed keys, calling callback function at each key
   7 -- pressed. The callback function must return a boolean value: true to
   8 -- continue grabbing, false to stop.
   9 -- The function is called with 3 arguments:
  10 -- a table containing modifiers keys, a string with the key pressed and a
  11 -- string with either "press" or "release" to indicate the event type.
  12 -- @param func A callback function as described above.
  13 -- @name run
  14 -- @class function
  15
  16 --- Stop grabbing the keyboard.
  17 -- @param -
  18 -- @name stop
  19 -- @class function