luadoc/mouse.lua

   1 --- awesome mouse API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008-2009 Julien Danjou
   4 module("mouse")
   5
   6 --- Mouse library.
   7 -- @field coords Mouse coordinates.
   8 -- @field screen Mouse screen number.
   9 -- @class table
  10 -- @name mouse
  11
  12 --- Get or set the mouse coords.
  13 -- @param coords_table None or a table with x and y keys as mouse coordinates.
  14 -- @param silent Disable mouse::enter or mouse::leave events that could be triggered by the pointer when moving.
  15 -- @return A table with mouse coordinates.
  16 -- @name coords
  17 -- @class function
  18
  19 --- Get the client or any object which is under the pointer.
  20 -- @return A client or nil.
  21 -- @name object_under_pointer
  22 -- @class function