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 True if we are still in startup, false otherwise.
  11 -- @field startup_errors Error message for errors that occured during startup.
  12 -- @field composite_manager_running True if a composite manager is running.
  13 -- @class table
  14 -- @name awesome
  15
  16 --- Quit awesome.
  17 -- @name quit
  18 -- @class function
  19
  20 --- Execute another application, probably a window manager, to replace
  21 -- awesome.
  22 -- @param cmd The command line to execute.
  23 -- @name exec
  24 -- @class function
  25
  26 --- Restart awesome.
  27 -- @name restart
  28 -- @class function
  29
  30 --- Spawn a program.
  31 -- @param cmd The command to launch. Either a string or a table of strings.
  32 -- @param use_sn Use startup-notification, true or false, default to true.
  33 -- @return Process ID if everything is OK, or an error string if an error occured.
  34
  35 --- Load an image
  36 -- @param name The file name
  37 -- @return A cairo image surface as light user datum
  38 -- @name load_image
  39 -- @class function
  40
  41 --- Register a new xproperty.
  42 -- @param name The name of the X11 property
  43 -- @param type One of "string", "number" or "boolean"
  44 -- @name register_xproperty
  45 -- @class function
  46
  47 --- Change a xproperty.
  48 -- @param name The name of the X11 property
  49 -- @param value The new value for the property
  50 -- @name set_xproperty
  51 -- @class function
  52
  53 --- Get the value of a xproperty.
  54 -- @param name The name of the X11 property
  55 -- @name get_xproperty
  56 -- @class function
  57
  58 --- Add a global signal.
  59 -- @param name A string with the event name.
  60 -- @param func The function to call.
  61 -- @name connect_signal
  62 -- @class function
  63
  64 --- Remove a global signal.
  65 -- @param name A string with the event name.
  66 -- @param func The function to call.
  67 -- @name disconnect_signal
  68 -- @class function
  69
  70 --- Emit a global signal.
  71 -- @param name A string with the event name.
  72 -- @param ... Signal arguments.
  73 -- @name emit_signal
  74 -- @class function