luadoc/root.lua

   1 --- awesome root window API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008-2009 Julien Danjou
   4 module("root")
   5
   6 --- Get or set global mouse bindings.
   7 -- This binding will be available when you'll click on root window.
   8 -- @param button_table An array of mouse button bindings objects, or nothing.
   9 -- @return The array of mouse button bindings objects.
  10 -- @name buttons
  11 -- @class function
  12
  13 --- Get or set global key bindings.
  14 -- This binding will be available when you'll press keys on root window.
  15 -- @param keys_array An array of key bindings objects, or nothing.
  16 -- @return The array of key bindings objects of this client.
  17 -- @name keys
  18 -- @class function
  19
  20 --- Set the root cursor.
  21 -- @param cursor_name A X cursor name.
  22 -- @name cursor
  23 -- @class function
  24
  25 --- Send fake events. Usually the current focused client will get it.
  26 -- @param event_type The event type: key_press, key_release, button_press, button_release
  27 -- or motion_notify.
  28 -- @param detail The detail: in case of a key event, this is the keycode to send, in
  29 -- case of a button event this is the number of the button. In case of a motion
  30 -- event, this is a boolean value which if true make the coordinates relatives.
  31 -- @param x In case of a motion event, this is the X coordinate.
  32 -- @param y In case of a motion event, this is the Y coordinate.
  33 -- @name fake_input
  34 -- @class function
  35
  36 --- Get the drawins attached to a screen.
  37 -- @return A table with all drawins.
  38 -- @name drawins
  39 -- @class function
  40
  41 --- Get the wallpaper as a cairo surface or set it as a cairo pattern.
  42 -- @param pattern A cairo pattern as light userdata
  43 -- @return A cairo surface or nothing.
  44 -- @name wallpaper
  45 -- @class function
  46
  47 --- Get the attached tags.
  48 -- @return A table with all tags.
  49 -- @name tags
  50 -- @class function