luadoc/drawin.lua

   1 --- awesome drawin API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008-2009 Julien Danjou
   4 module("drawin")
   5
   6 --- Drawin object.
   7 -- @field screen Screen number.
   8 -- @field border_width Border width.
   9 -- @field border_color Border color.
  10 -- @field ontop On top of other windows.
  11 -- @field cursor The mouse cursor.
  12 -- @field visible Visibility.
  13 -- @field opacity The opacity of the drawin, between 0 and 1.
  14 -- @field x The x coordinates.
  15 -- @field y The y coordinates.
  16 -- @field width The width of the drawin.
  17 -- @field height The height of the drawin.
  18 -- @field surface A oocairo surface that can be used for drawing.
  19 -- @class table
  20 -- @name drawin
  21
  22 --- Get or set mouse buttons bindings to a drawin.
  23 -- @param buttons_table A table of buttons objects, or nothing.
  24 -- @name buttons
  25 -- @class function
  26
  27 --- Get or set drawin struts.
  28 -- @param strut A table with new strut, or nothing
  29 -- @return The drawin strut in a table.
  30 -- @name struts
  31 -- @class function
  32
  33 --- Get or set drawin geometry. That's the same as accessing or setting the x, y, width or height
  34 -- properties of a drawin.
  35 -- @param A table with coordinates to modify.
  36 -- @return A table with drawin coordinates and geometry.
  37 -- @name geometry
  38 -- @class function
  39
  40 --- Refresh the drawin. When you are drawing to the window's surface, you have
  41 -- call this function when you are done to make the result visible.
  42 -- @param no_params luadoc is buggy.
  43 -- @name refresh
  44 -- @class function
  45
  46 --- Add a signal.
  47 -- @param name A signal name.
  48 -- @param func A function to call when the signal is emitted.
  49 -- @name connect_signal
  50 -- @class function
  51
  52 --- Remove a signal.
  53 -- @param name A signal name.
  54 -- @param func A function to remove.
  55 -- @name disconnect_signal
  56 -- @class function
  57
  58 --- Emit a signal.
  59 -- @param name A signal name.
  60 -- @param ... Various arguments, optional.
  61 -- @name emit_signal
  62 -- @class function
  63
  64 --- Get the number of instances.
  65 -- @param no_params luadoc is buggy.
  66 -- @return The number of drawin objects alive.
  67 -- @name instances
  68 -- @class function