awesome/docs/capi/root.lua.in

--- awesome root window API
-- @author Julien Danjou <julien@danjou.info>
-- @copyright 2008-2009 Julien Danjou
-- @release @AWESOME_VERSION@
-- @module root

--- Get or set global mouse bindings.
-- This binding will be available when you'll click on root window.
--
-- @param button_table An array of mouse button bindings objects, or nothing.
-- @return The array of mouse button bindings objects.
-- @function buttons

--- Get or set global key bindings.
-- These binding will be available when you press keys on the root window.
-- @tparam table|nil keys_array An array of key binding objects, or nothing.
-- @return The array of key bindings objects of this client.
-- @function keys

--- Set the root cursor.
--
-- @param cursor_name A X cursor name.
-- @function cursor

--- Send fake events. Usually the current focused client will get it.
--
-- @param event_type The event type: key_press, key_release, button_press, button_release
--   or motion_notify.
-- @param detail The detail: in case of a key event, this is the keycode to send, in
--   case of a button event this is the number of the button. In case of a
--   motion event, this is a boolean value which if true make the coordinates
--   relatives.
-- @param x In case of a motion event, this is the X coordinate.
-- @param y In case of a motion event, this is the Y coordinate.
-- @function fake_input

--- Get the drawins attached to a screen.
--
-- @return A table with all drawins.
-- @function drawins

--- Get the wallpaper as a cairo surface or set it as a cairo pattern.
--
-- @param pattern A cairo pattern as light userdata
-- @return A cairo surface or nothing.
-- @function wallpaper

--- Get the attached tags.
--
-- @return A table with all tags.
-- @function tags