Reference

# Module `root`

awesome root window API

Author:

Julien Danjou <julien@danjou.info>

Copyright© 2008-2009 Julien Danjou

## Functions

buttons (button_table) | Get or set global mouse bindings.
cursor (cursor_name) | Set the root cursor.
fake_input (event_type, detail, x, y, screen) | Send fake events.
keys (keys_array) | Get or set global key bindings.
wiboxes () | Get the wiboxes attached to a screen.

## Functions

buttons (button_table)
  Get or set global mouse bindings. This binding will be available when you'll click on root window.

  ### Parameters

  - button_table: An array of mouse button bindings objects, or nothing.

  ### Return value:

  The array of mouse button bindings objects.
cursor (cursor_name)
  Set the root cursor.

  ### Parameters

  - cursor_name: A X cursor name.
fake_input (event_type, detail, x, y, screen)
  Send fake events. Usually the current focused client will get it.

  ### Parameters

  - event_type: The event type: key_press, key_release, button_press, button_release or motion_notify.
  - 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.
  - x: In case of a motion event, this is the X coordinate.
  - y: In case of a motion event, this is the Y coordinate.
  - screen: In case of a motion event, this is the screen number to move on. If not specified, the current one is used.
keys (keys_array)
  Get or set global key bindings. This binding will be available when you'll press keys on root window.

  ### Parameters

  - keys_array: An array of key bindings objects, or nothing.

  ### Return value:

  The array of key bindings objects of this client.
wiboxes ()
  Get the wiboxes attached to a screen.

  ### Return value:

  A table with all wiboxes.