luadoc/screen.lua

   1 --- awesome screen API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008-2009 Julien Danjou
   4 module("screen")
   5
   6 --- Screen is a table where indexes are screen number. You can use screen[1]
   7 -- to get access to the first screen, etc. Each screen has a set of properties.
   8 -- @field geometry The screen coordinates. Immutable.
   9 -- @field workarea The screen workarea.
  10 -- @field index The screen number.
  11 -- @class table
  12 -- @name screen
  13
  14 --- Get the number of screen.
  15 -- @param -
  16 -- @return The screen count, at least 1.
  17 -- @name count
  18 -- @class function
  19
  20 --- Add a signal to a screen.
  21 -- @param name A signal name.
  22 -- @param func A function to call when the signal is emitted.
  23 -- @name add_signal
  24 -- @class function
  25
  26 --- Remove a signal to a screen.
  27 -- @param name A signal name.
  28 -- @param func A function to remove
  29 -- @name remove_signal
  30 -- @class function
  31
  32 --- Emit a signal to a screen.
  33 -- @param name A signal name.
  34 -- @param ... Various arguments, optional.
  35 -- @name emit_signal
  36 -- @class function
  37
  38 --- Get or set screen tags.
  39 -- @param tags_table None or a table of tags to set to the screen.
  40 -- The table must contains at least one tag.
  41 -- @name tags
  42 -- @class function