Class awful.wibar

Wibox module for awful.

This module allows you to easily create wibox and attach them to the edge of a screen.

Info:

  • Copyright: 2016 Emmanuel Lepage Vallee
  • Author: Emmanuel Lepage Vallee <elv1313@gmail.com>

Functions

awful.wibar ([arg=nil]) Create a new wibox and attach it to a screen edge.

Object properties

awful.wibar.position The wibox position.
awful.wibar.stretch Stretch the wibar.

Deprecated functions

awful.wibar.get_position Get a wibox position if it has been set, or return top.
awful.wibar.set_position Put a wibox on a screen at this position.
awful.wibar.attach Attach a wibox to a screen.
awful.wibar.align Align a wibox.
awful.wibox.stretch Stretch a wibox so it takes all screen width or height.

Methods

awful.wibar:remove () Remove a wibar.


Functions

awful.wibar ([arg=nil])
Create a new wibox and attach it to a screen edge. You can add also position key with value top, bottom, left or right. You can also use width or height in % and set align to center, right or left. You can also set the screen key with a screen number to attach the wibox. If not specified, the primary screen is assumed.
  • arg
    • position string The position.
    • stretch string If the wibar need to be stretched to fill the screen.
    • border_width integer Border width.
    • border_color string Border color.
    • ontop boolean On top of other windows.
    • cursor string The mouse cursor.
    • visible boolean Visibility.
    • opacity number The opacity of the wibox, between 0 and 1.
    • type string The window type (desktop, normal, dock, …).
    • x integer The x coordinates.
    • y integer The y coordinates.
    • width integer The width of the wibox.
    • height integer The height of the wibox.
    • screen screen The wibox screen.
    • widget wibox.widget The widget that the wibox displays.
    • shape_bounding The wibox’s bounding shape as a (native) cairo surface.
    • shape_clip The wibox’s clip shape as a (native) cairo surface.
    • bg color The background of the wibox.
    • bgimage surface The background image of the drawable.
    • fg color The foreground (text) of the wibox.

Returns:

    The new wibar

See also:

Object properties

awful.wibar.position
The wibox position.

Type:

  • string Either "left", right", "top" or "bottom"
awful.wibar.stretch
Stretch the wibar.

Type:

  • boolean (default true)

Deprecated functions

awful.wibar.get_position
Get a wibox position if it has been set, or return top.

param:

  • wb The wibox
awful.wibar.set_position
Put a wibox on a screen at this position.

param:

  • wb The wibox to attach.
  • position The position: top, bottom left or right.
  • screen This argument is deprecated, use wb.screen directly.
awful.wibar.attach
Attach a wibox to a screen.

This function has been moved to the awful.placement module. Calling this no longer does anything.

param:

  • wb The wibox to attach.
  • position The position of the wibox: top, bottom, left or right.
  • screen The screen to attach to

See also:

awful.wibar.align
Align a wibox.

Supported alignment are:

* top_left * top_right * bottom_left * bottom_right * left * right * top * bottom * centered * center_vertical * center_horizontal

param:

  • wb The wibox.
  • align The alignment
  • screen This argument is deprecated. It is not used. Use wb.screen directly.

See also:

awful.wibox.stretch
Stretch a wibox so it takes all screen width or height.

**This function has been removed.**

See also:

Methods

awful.wibar:remove ()
Remove a wibar.
generated by LDoc 1.4.2