luadoc/awesome.lua

   1 --- awesome core API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008-2009 Julien Danjou
   4 module("awesome")
   5
   6 --- awesome global table.
   7 -- @field version The version of awesome.
   8 -- @field release The release name of awesome.
   9 -- @field conffile The configuration file which has been loaded.
  10 -- @field startup_errors Error message for errors that occured during startup.
  11 -- @field composite_manager_running True if a composite manager is running.
  12 -- @class table
  13 -- @name awesome
  14
  15 --- Quit awesome.
  16 -- @name quit
  17 -- @class function
  18
  19 --- Execute another application, probably a window manager, to replace
  20 -- awesome.
  21 -- @param cmd The command line to execute.
  22 -- @name exec
  23 -- @class function
  24
  25 --- Restart awesome.
  26 -- @name restart
  27 -- @class function
  28
  29 --- Spawn a program.
  30 -- @param cmd The command to launch. Either a string or a table of strings.
  31 -- @param use_sn Use startup-notification, true or false, default to true.
  32 -- @return Process ID if everything is OK, or an error string if an error occured.
  33
  34 --- Load an image
  35 -- @param name The file name
  36 -- @return A cairo image surface as light user datum
  37 -- @name load_image
  38 -- @class function
  39
  40 --- Register a new xproperty.
  41 -- @param name The name of the X11 property
  42 -- @param type One of "string", "number" or "boolean"
  43 -- @name register_xproperty
  44 -- @class function
  45
  46 --- Add a global signal.
  47 -- @param name A string with the event name.
  48 -- @param func The function to call.
  49 -- @name connect_signal
  50 -- @class function
  51
  52 --- Remove a global signal.
  53 -- @param name A string with the event name.
  54 -- @param func The function to call.
  55 -- @name disconnect_signal
  56 -- @class function
  57
  58 --- Emit a global signal.
  59 -- @param name A string with the event name.
  60 -- @param ... Signal arguments.
  61 -- @name emit_signal
  62 -- @class function