Reference

# Module `wibox`

awesome wibox API

Author:

Julien Danjou <julien@danjou.info>

Copyright© 2008-2009 Julien Danjou

## Functions

add_signal (name, func) | Add a signal.
buttons (buttons_table) | Get or set mouse buttons bindings to a wibox.
emit_signal (name, ...) | Emit a signal.
geometry (A) | Get or set wibox geometry.
remove_signal (name, func) | Remove a signal.
struts (strut) | Get or set wibox struts.

## Tables

wibox | Wibox object.

## Functions

add_signal (name, func)
  Add a signal.

  ### Parameters

  - name: A signal name.
  - func: A function to call when the signal is emitted.
buttons (buttons_table)
  Get or set mouse buttons bindings to a wibox.

  ### Parameters

  - buttons_table: A table of buttons objects, or nothing.
emit_signal (name, ...)
  Emit a signal.

  ### Parameters

  - name: A signal name.
  - ...: Various arguments, optional.
geometry (A)
  Get or set wibox geometry. That's the same as accessing or setting the x, y, width or height properties of a wibox.

  ### Parameters

  - A: table with coordinates to modify.

  ### Return value:

  A table with wibox coordinates and geometry.
remove_signal (name, func)
  Remove a signal.

  ### Parameters

  - name: A signal name.
  - func: A function to remove.
struts (strut)
  Get or set wibox struts.

  ### Parameters

  - strut: A table with new strut, or nothing

  ### Return value:

  The wibox strut in a table.

## Tables

wibox
  Wibox object. Fields
  - screen: Screen number.
  - client: The client attached to (titlebar only).
  - border_width: Border width.
  - border_color: Border color.
  - align: The alignment (titlebar only).
  - fg: Foreground color.
  - bg: Background color.
  - bg_image: Background image.
  - position: The position (titlebar only).
  - ontop: On top of other windows.
  - cursor: The mouse cursor.
  - visible: Visibility.
  - orientation: The drawing orientation: east, north or south.
  - widgets: A table with all widgets drawn on this wibox.
  - opacity: The opacity of the wibox, between 0 and 1.
  - x: The x coordinates.
  - y: The y coordinates.
  - width: The width of the wibox.
  - height: The height of the wibox.
  - shape_bounding: Image describing the window's border shape.
  - shape_clip: Image describing the window's content shape.