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. Alternatively, if RANDR information
   8 -- is available, you can use output names for finding screen objects.
   9 -- Each screen has a set of properties.
  10 -- @field geometry The screen coordinates. Immutable.
  11 -- @field workarea The screen workarea.
  12 -- @field index The screen number.
  13 -- @field outputs If RANDR information is available, a list of outputs for this
  14 -- screen and their size in mm.
  15 -- @class table
  16 -- @name screen
  17
  18 --- Get the number of screen.
  19 -- @return The screen count, at least 1.
  20 -- @name count
  21 -- @class function
  22
  23 --- Add a signal to a screen.
  24 -- @param name A signal name.
  25 -- @param func A function to call when the signal is emitted.
  26 -- @name connect_signal
  27 -- @class function
  28
  29 --- Remove a signal to a screen.
  30 -- @param name A signal name.
  31 -- @param func A function to remove
  32 -- @name disconnect_signal
  33 -- @class function
  34
  35 --- Emit a signal to a screen.
  36 -- @param name A signal name.
  37 -- @param ... Various arguments, optional.
  38 -- @name emit_signal
  39 -- @class function