23 lines
595 B
Lua
23 lines
595 B
Lua
|
--- awesome mouse API
|
||
|
-- @author Julien Danjou <julien@danjou.info>
|
||
|
-- @copyright 2008-2009 Julien Danjou
|
||
|
module("mouse")
|
||
|
|
||
|
--- Mouse library.
|
||
|
-- @field coords Mouse coordinates.
|
||
|
-- @field screen Mouse screen number.
|
||
|
-- @class table
|
||
|
-- @name mouse
|
||
|
|
||
|
--- Get or set the mouse coords.
|
||
|
-- @param coords_table None or a table with x and y keys as mouse coordinates.
|
||
|
-- @return A table with mouse coordinates.
|
||
|
-- @name coords
|
||
|
-- @class function
|
||
|
|
||
|
--- Get the client or any object which is under the pointer.
|
||
|
-- @param -
|
||
|
-- @return A client or nil.
|
||
|
-- @name object_under_pointer
|
||
|
-- @class function
|