luadoc/drawable.lua

   1 --- awesome drawable API
   2 -- @author Uli Schlachter &lt;psychon@znc.in&gt;
   3 -- @copyright 2012 Uli Schlachter
   4 module("drawable")
   5
   6 --- Drawable object.
   7 -- @field surface The drawable's cairo surface.
   8 -- @name drawable
   9 -- @class table
  10
  11 --- Get drawable geometry. The geometry consists of x, y, width and height.
  12 -- @return A table with drawable coordinates and geometry.
  13 -- @name geometry
  14 -- @class function
  15
  16 --- Refresh the drawable. When you are drawing to the surface, you have
  17 -- call this function when you are done to make the result visible.
  18 -- @name refresh
  19 -- @class function
  20
  21 --- Add a signal.
  22 -- @param name A signal name.
  23 -- @param func A function to call when the signal is emitted.
  24 -- @name connect_signal
  25 -- @class function
  26
  27 --- Remove a signal.
  28 -- @param name A signal name.
  29 -- @param func A function to remove.
  30 -- @name disconnect_signal
  31 -- @class function
  32
  33 --- Emit a signal.
  34 -- @param name A signal name.
  35 -- @param ... Various arguments, optional.
  36 -- @name emit_signal
  37 -- @class function
  38
  39 --- Get the number of instances.
  40 -- @return The number of drawable objects alive.
  41 -- @name instances
  42 -- @class function