luadoc/mousegrabber.lua

   1 --- awesome mousegrabber API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008-2009 Julien Danjou
   4 module("mousegrabber")
   5
   6 --- Grab the mouse pointer and list motions, calling callback function at each
   7 -- motion. The callback function must return a boolean value: true to
   8 -- continue grabbing, false to stop.
   9 -- The function is called with one argument:
  10 -- a table containing modifiers pointer coordinates.
  11 -- @param func A callback function as described above.
  12 -- @param cursor The name of a X cursor to use while grabbing.
  13 -- @name run
  14 -- @class function
  15
  16 --- Stop grabbing the mouse pointer.
  17 -- @name stop
  18 -- @class function
  19
  20 --- Check if the mousegrabber is running.
  21 -- @return A boolean value, true if running, false otherwise.
  22 -- @name isrunning
  23 -- @class function