luadoc/wibox.lua

   1 --- awesome wibox API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008-2009 Julien Danjou
   4 module("wibox")
   5
   6 --- Wibox object.
   7 -- @field screen Screen number.
   8 -- @field client The client attached to (titlebar only).
   9 -- @field border_width Border width.
  10 -- @field border_color Border color.
  11 -- @field align The alignment (titlebar only).
  12 -- @field fg Foreground color.
  13 -- @field bg Background color.
  14 -- @field bg_image Background image.
  15 -- @field position The position (titlebar only).
  16 -- @field ontop On top of other windows.
  17 -- @field cursor The mouse cursor.
  18 -- @field visible Visibility.
  19 -- @field orientation The drawing orientation: east, north or south.
  20 -- @field widgets A table with all widgets drawn on this wibox.
  21 -- @field opacity The opacity of the wibox, between 0 and 1.
  22 -- @field x The x coordinates.
  23 -- @field y The y coordinates.
  24 -- @field width The width of the wibox.
  25 -- @field height The height of the wibox.
  26 -- @field shape_bounding Image describing the window's border shape.
  27 -- @field shape_clip Image describing the window's content shape.
  28 -- @class table
  29 -- @name wibox
  30
  31 --- Get or set mouse buttons bindings to a wibox.
  32 -- @param buttons_table A table of buttons objects, or nothing.
  33 -- @name buttons
  34 -- @class function
  35
  36 --- Get or set wibox struts.
  37 -- @param strut A table with new strut, or nothing
  38 -- @return The wibox strut in a table.
  39 -- @name struts
  40 -- @class function
  41
  42 --- Get or set wibox geometry. That's the same as accessing or setting the x, y, width or height
  43 -- properties of a wibox.
  44 -- @param A table with coordinates to modify.
  45 -- @return A table with wibox coordinates and geometry.
  46 -- @name geometry
  47 -- @class function
  48
  49 --- Add a signal.
  50 -- @param name A signal name.
  51 -- @param func A function to call when the signal is emited.
  52 -- @name add_signal
  53 -- @class function
  54
  55 --- Remove a signal.
  56 -- @param name A signal name.
  57 -- @param func A function to remove.
  58 -- @name remove_signal
  59 -- @class function
  60
  61 --- Emit a signal.
  62 -- @param name A signal name.
  63 -- @param ... Various arguments, optional.
  64 -- @name emit_signal
  65 -- @class function