Module awful.wibox
Wibox module for awful. This module allows you to easily create wibox and attach them to the edge of a screen.
Author:
Julien Danjou <julien@danjou.info> |
Copyright© 2009 Julien Danjou
Release: v3.4.6
Functions
align (wibox, align, screen) | Align a wibox. |
attach (wibox, position) | Attach a wibox to a screen. |
get_position (wibox) | Get a wibox position if it has been set, or return top. |
new (arg, args) | Create a new wibox and attach it to a screen edge. |
rounded_corners (wibox, corner_size) | Add rounded corners to a wibox |
set_position (wibox, position, screen) | Put a wibox on a screen at this position. |
stretch (wibox, screen) | Stretch a wibox so it takes all screen width or height. |
Functions
- align (wibox, align, screen)
-
Align a wibox.
Parameters
- wibox: The wibox.
- align: The alignment: left, right or center.
- screen: If the wibox is not attached to any screen, you can specify the screen where to align. Otherwise 1 is assumed.
- attach (wibox, position)
-
Attach a wibox to a screen. If a wibox is attached, it will be automatically be moved when other wiboxes will be attached.
Parameters
- wibox: The wibox to attach.
- position: The position of the wibox: top, bottom, left or right.
- get_position (wibox)
-
Get a wibox position if it has been set, or return top.
Parameters
- wibox: The wibox
Return value:
The wibox position. - new (arg, args)
-
Create a new wibox and attach it to a screen edge.
Parameters
- arg:
- args: A table with standard arguments to wibox() creator. 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, 1 is assumed.
Return value:
The wibox created.See also:
- rounded_corners (wibox, corner_size)
-
Add rounded corners to a wibox
Parameters
- wibox: The wibox.
- corner_size: The size in pixel of the rounded corners.
- set_position (wibox, position, screen)
-
Put a wibox on a screen at this position.
Parameters
- wibox: The wibox to attach.
- position: The position: top, bottom left or right.
- screen: If the wibox it not attached to a screen, specified on which screen the position should be set.
- stretch (wibox, screen)
-
Stretch a wibox so it takes all screen width or height.
Parameters
- wibox: The wibox.
- screen: The screen to stretch on, or the wibox screen.