25 lines
786 B
Lua
25 lines
786 B
Lua
--- awesome mousegrabber API
|
|
-- @author Julien Danjou <julien@danjou.info>
|
|
-- @copyright 2008-2009 Julien Danjou
|
|
-- @release @AWESOME_VERSION@
|
|
-- @module mousegrabber
|
|
|
|
--- Grab the mouse pointer and list motions, calling callback function at each
|
|
-- motion. The callback function must return a boolean value: true to
|
|
-- continue grabbing, false to stop.
|
|
-- The function is called with one argument:
|
|
-- a table containing modifiers pointer coordinates.
|
|
--
|
|
-- @param func A callback function as described above.
|
|
-- @param cursor The name of a X cursor to use while grabbing.
|
|
-- @function run
|
|
|
|
--- Stop grabbing the mouse pointer.
|
|
--
|
|
-- @function stop
|
|
|
|
--- Check if the mousegrabber is running.
|
|
--
|
|
-- @return A boolean value, true if running, false otherwise.
|
|
-- @function isrunning
|