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 border_width Border width.
   8 -- @field border_color Border color.
   9 -- @field ontop On top of other windows.
  10 -- @field cursor The mouse cursor.
  11 -- @field visible Visibility.
  12 -- @field opacity The opacity of the drawin, between 0 and 1.
  13 -- @field type The window type (desktop, normal, dock, …).
  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 drawable The drawin's drawable.
  19 -- @field window The X window id.
  20 -- @field shape_bounding The drawin's bounding shape as a (native) cairo surface.
  21 -- @field shape_clip The drawin's clip shape as a (native) cairo surface.
  22 -- @class table
  23 -- @name drawin
  24
  25 --- Get or set mouse buttons bindings to a drawin.
  26 -- @param buttons_table A table of buttons objects, or nothing.
  27 -- @name buttons
  28 -- @class function
  29
  30 --- Get or set drawin struts.
  31 -- @param strut A table with new strut, or nothing
  32 -- @return The drawin strut in a table.
  33 -- @name struts
  34 -- @class function
  35
  36 --- Get or set drawin geometry. That's the same as accessing or setting the x, y, width or height
  37 -- properties of a drawin.
  38 -- @param A table with coordinates to modify.
  39 -- @return A table with drawin coordinates and geometry.
  40 -- @name geometry
  41 -- @class function
  42
  43 --- Change a xproperty.
  44 -- @param name The name of the X11 property
  45 -- @param value The new value for the property
  46 -- @name set_xproperty
  47 -- @class function
  48
  49 --- Get the value of a xproperty.
  50 -- @param name The name of the X11 property
  51 -- @name get_xproperty
  52 -- @class function
  53
  54 --- Add a signal.
  55 -- @param name A signal name.
  56 -- @param func A function to call when the signal is emitted.
  57 -- @name connect_signal
  58 -- @class function
  59
  60 --- Remove a signal.
  61 -- @param name A signal name.
  62 -- @param func A function to remove.
  63 -- @name disconnect_signal
  64 -- @class function
  65
  66 --- Emit a signal.
  67 -- @param name A signal name.
  68 -- @param ... Various arguments, optional.
  69 -- @name emit_signal
  70 -- @class function
  71
  72 --- Get the number of instances.
  73 -- @return The number of drawin objects alive.
  74 -- @name instances
  75 -- @class function