awesome

• Index

Contents

• Constructors
• Object properties
• Object methods
• Signals

Widget containers

• awful.widget.only_on_screen
• naughty.widget.background
• wibox.container.arcchart
• wibox.container.background
• wibox.container.border
• wibox.container.constraint
• wibox.container.margin
• wibox.container.mirror
• wibox.container.place
• wibox.container.radialprogressbar
• wibox.container.rotate
• wibox.container.scroll
• wibox.container.tile

Core components

• awesome
• awful.keygrabber
• client and awful.client
• drawable
• gears.timer
• mousegrabber
• naughty.action
• naughty.notification
• root
• screen and awful.screen
• tag and awful.tag

Input handling

• awful.button
• awful.key
• awful.keyboard
• mouse

Declarative rules

• ruled.client
• ruled.notifications

Widgets

• awful.widget.button
• awful.widget.clienticon
• awful.widget.keyboardlayout
• awful.widget.launcher
• awful.widget.layoutbox
• awful.widget.layoutlist
• awful.widget.prompt
• awful.widget.taglist
• awful.widget.tasklist
• awful.widget.watch
• naughty.list.actions
• naughty.list.notifications
• naughty.widget.icon
• naughty.widget.message
• naughty.widget.title
• wibox.widget.calendar
• wibox.widget.checkbox
• wibox.widget.graph
• wibox.widget.imagebox
• wibox.widget.piechart
• wibox.widget.progressbar
• wibox.widget.separator
• wibox.widget.slider
• wibox.widget.systray
• wibox.widget.textbox
• wibox.widget.textclock

Widget layouts

• wibox.layout.align
• wibox.layout.fixed
• wibox.layout.flex
• wibox.layout.grid
• wibox.layout.manual
• wibox.layout.ratio
• wibox.layout.stack

Popups and bars

• awful.hotkeys_popup.widget
• awful.menu
• awful.popup
• awful.titlebar
• awful.tooltip
• awful.wallpaper
• awful.wibar
• awful.widget.calendar_popup
• menubar
• naughty.layout.box
• naughty.layout.legacy
• wibox

Utility libraries

• gears.debug
• gears.filesystem
• gears.geometry
• gears.math
• gears.object
• gears.protected_call
• gears.sort
• gears.string
• gears.table
• gears.wallpaper

Theme related libraries

• beautiful
• gears.color
• gears.shape

Libraries

• awful.completion
• awful.hotkeys_popup
• awful.layout
• awful.permissions
• awful.placement
• awful.prompt
• awful.rules
• awful.spawn
• awful.util
• dbus
• gears.matcher
• gears.surface
• menubar.menu_gen
• menubar.utils
• naughty
• selection
• wibox.widget

Sample files

• rc.lua
• theme.lua

Classes

• awful.screenshot
• awful.widget.common
• gears.cache
• gears.matrix
• menubar.icon_theme
• menubar.index_theme
• wibox.hierarchy
• wibox.widget.base
• xproperties

Documentation

• Authors
• Readme
• Contributing
• The Widget system
• Creating new widget
• Default configuration file documentation
• Change Awesome appearance
• My first Awesome
• The AwesomeWM client layout system
• Startup options
• Building and Testing
• Using Cairo and LGI
• Tips for upgrading your configuration
• NEWS
• FAQ

Module: wibox.container.tile

Replicate the content of the widget over and over.

This contained is intended to be used for wallpapers. It currently doesn't support mouse input in the replicated tiles.

Constructors

Object properties

Object methods

Signals

Constructors

🔗 wibox.container.tile {[args]}

Create a new tile container.

Parameters:

Note: This constructors uses named parameters calling convention. It means you call it with {} and omit the parantheses. For example, calling this will all default argument would be wibox.container.tile{}. This is a Lua shortcut syntax equivalent to wibox.container.tile({}). args is only a placeholder name for the "lone table argument" used in named parameters calls.

Name		Type(s)	Description
args		table
widget		wibox.widget	The widget to be placed.
halign		string	Either left, right or center.
valign		string	Either top, bottom or center.
horizontal_spacing		number	The horizontal spacing between the tiled.
vertical_spacing		number	The vertical spacing between the tiled.
horizontal_crop		boolean	Avoid painting incomplete horizontal tiles.
vertical_crop		boolean	Avoid painting incomplete vertical tiles.
tiled		boolean	Enable or disable the tiling.
widget		wibox.widget	The widget to be placed.
fill_vertical		boolean	Fill the vertical space.
fill_horizontal		boolean	Fill the horizontal space.
content_fill_vertical		boolean	Stretch the contained widget so it takes all the vertical space.
content_fill_horizontal		boolean	Stretch the contained widget so it takes all the horizontal space.

Object properties

🔗 horizontal_spacing number · 1 signal

The horizontal spacing between the tiled.

Constraints:

Default value	: 0
Unit	: pixel
Negative allowed	: false

See also:

vertical_spacing	The vertical spacing between the tiled.	object properties

Usage:

for _, i in ipairs {0, 2, 5, 10} do
    local w = wibox.widget {
        {
            image         = beautiful.awesome_icon,
            forced_height = 30,
            forced_width  = 30,
            widget        = wibox.widget.imagebox
        },
        valign             = "top",
        halign             = "left",
        horizontal_spacing = i,
        widget             = wibox.container.tile
    }
end

Click to display more

Emit signals:

• property::horizontal_spacing When the horizontal_spacing value changes.
• self wibox.container.tile The object which changed (useful when connecting many object to the same callback).
• new_value horizontal_spacing The new value affected to the property.

🔗 vertical_spacing number · 1 signal

The vertical spacing between the tiled.

Constraints:

Default value	: 0
Unit	: pixel
Negative allowed	: false

See also:

horizontal_spacing	The horizontal spacing between the tiled.	object properties

Usage:

for _, i in ipairs {0, 2, 5, 10} do
    local w = wibox.widget {
        {
            image         = beautiful.awesome_icon,
            forced_height = 30,
            forced_width  = 30,
            widget        = wibox.widget.imagebox
        },
        valign             = "top",
        halign             = "left",
        vertical_spacing   = i,
        widget             = wibox.container.tile
    }
end

Click to display more

Emit signals:

• property::vertical_spacing When the vertical_spacing value changes.
• self wibox.container.tile The object which changed (useful when connecting many object to the same callback).
• new_value vertical_spacing The new value affected to the property.

🔗 horizontal_crop boolean

Avoid painting incomplete horizontal tiles.

Constraints:

Default value	: false
Valid values	: true or false.

See also:

vertical_crop	Avoid painting incomplete vertical tiles.	object properties

Usage:

for _, i in ipairs {true, false} do
    local w = wibox.widget {
        {
            {
                image         = beautiful.awesome_icon,
                forced_height = 30,
                forced_width  = 30,
                widget        = wibox.widget.imagebox
            },
            horizontal_crop = i,
            widget          = wibox.container.tile
        },
        bg     = beautiful.bg_normal,
        widget = wibox.container.background
    }
end

🔗 vertical_crop boolean

Avoid painting incomplete vertical tiles.

Constraints:

Default value	: false
Valid values	: true or false.

See also:

horizontal_crop	Avoid painting incomplete horizontal tiles.	object properties

Usage:

for _, i in ipairs {true, false} do
    local w = wibox.widget {
        {
            {
                image         = beautiful.awesome_icon,
                forced_height = 30,
                forced_width  = 30,
                widget        = wibox.widget.imagebox
            },
            vertical_crop  = i,
            widget         = wibox.container.tile
        },
        bg     = beautiful.bg_normal,
        widget = wibox.container.background
    }
end

🔗 tiled boolean

Enable or disable the tiling.

When set to false, this container behaves exactly like wibox.container.place.

Constraints:

Default value	: true
Valid values	: true or false.

Usage:

for _, i in ipairs {true, false} do
    local w = wibox.widget {
        {
            image         = beautiful.awesome_icon,
            forced_height = 30,
            forced_width  = 30,
            widget        = wibox.widget.imagebox
        },
        tiled  = i,
        widget = wibox.container.tile
    }
end

🔗 widget widget or nil · Inherited from wibox.container.place

The widget to be placed.

Constraints:

Default value	: nil

🔗 valign string · Inherited from wibox.container.place · 1 signal

The vertical alignment.

Constraints:

Default value	: "center"
Valid values:
"top"
"center"
"bottom"

Usage:

for _, i in ipairs {"top", "center", "bottom"} do
    local w = wibox.widget {
        {
            {
                image         = beautiful.awesome_icon,
                forced_height = 30,
                forced_width  = 30,
                widget        = wibox.widget.imagebox
            },
            valign = i,
            widget = wibox.container.place
        },
        bg     = beautiful.bg_normal,
        widget = wibox.container.background
    }
end

Click to display more

Emit signals:

• property::valign When the valign value changes.
• self wibox.container.place The object which changed (useful when connecting many object to the same callback).
• new_value valign The new value affected to the property.

🔗 halign string · Inherited from wibox.container.place · 1 signal

The horizontal alignment.

Constraints:

Default value	: "center"
Valid values:
"left"
"center"
"right"

Usage:

for _, i in ipairs {"left", "center", "right"} do
    local w = wibox.widget {
        {
            {
                image         = beautiful.awesome_icon,
                forced_height = 30,
                forced_width  = 30,
                widget        = wibox.widget.imagebox
            },
            halign = i,
            widget = wibox.container.place
        },
        bg     = beautiful.bg_normal,
        widget = wibox.container.background
    }
end

Click to display more

Emit signals:

• property::halign When the halign value changes.
• self wibox.container.place The object which changed (useful when connecting many object to the same callback).
• new_value halign The new value affected to the property.

🔗 fill_vertical boolean · Inherited from wibox.container.place · 1 signal

Fill the vertical space.

Constraints:

Default value	: false
Valid values	: true or false.

Click to display more

Emit signals:

• property::fill_vertical When the fill_vertical value changes.
• self wibox.container.place The object which changed (useful when connecting many object to the same callback).
• new_value fill_vertical The new value affected to the property.

🔗 fill_horizontal boolean · Inherited from wibox.container.place · 1 signal

Fill the horizontal space.

Constraints:

Default value	: false
Valid values	: true or false.

Click to display more

Emit signals:

• property::fill_horizontal When the fill_horizontal value changes.
• self wibox.container.place The object which changed (useful when connecting many object to the same callback).
• new_value fill_horizontal The new value affected to the property.

🔗 content_fill_vertical boolean · Inherited from wibox.container.place · 1 signal

Stretch the contained widget so it takes all the vertical space.

Constraints:

Default value	: false
Valid values	: true or false.

Usage:

for _, i in ipairs {true, false} do
    local w = wibox.widget {
        {
            {
                image         = beautiful.awesome_icon,
                forced_height = 30,
                forced_width  = 30,
                widget        = wibox.widget.imagebox
            },
            bg     = "#ff0000",
            widget = wibox.container.background
        },
        content_fill_vertical = i,
        widget = wibox.container.place
    }
end

Click to display more

Emit signals:

• property::content_fill_vertical When the content_fill_vertical value changes.
• self wibox.container.place The object which changed (useful when connecting many object to the same callback).
• new_value content_fill_vertical The new value affected to the property.

🔗 content_fill_horizontal boolean · Inherited from wibox.container.place · 1 signal

Stretch the contained widget so it takes all the horizontal space.

Constraints:

Default value	: false
Valid values	: true or false.

Usage:

for _, i in ipairs {true, false} do
    local w = wibox.widget {
        {
            {
                image         = beautiful.awesome_icon,
                forced_height = 30,
                forced_width  = 30,
                widget        = wibox.widget.imagebox
            },
            bg     = "#ff0000",
            widget = wibox.container.background
        },
        content_fill_horizontal = i,
        widget = wibox.container.place
    }
end

Click to display more

Emit signals:

• property::content_fill_horizontal When the content_fill_horizontal value changes.
• self wibox.container.place The object which changed (useful when connecting many object to the same callback).
• new_value content_fill_horizontal The new value affected to the property.

🔗 children table · Inherited from wibox.widget.base

Get or set the children elements.

Constraints:

Default value	: {}
Table content	: A list of wibox.widget.

See also:

wibox.widget.base.all_children

🔗 all_children table · Inherited from wibox.widget.base

Get all direct and indirect children widgets. This will scan all containers recursively to find widgets Warning: This method it prone to stack overflow if there is a loop in the widgets hierarchy. A hierarchy loop is when a widget, or any of its children, contain (directly or indirectly) itself.

Constraints:

Default value	: {}
Table content	: A list of wibox.widget.

See also:

wibox.widget.base.children

🔗 forced_height number or nil · Inherited from wibox.widget.base

Force a widget height.

Constraints:

Default value	: nil
Type description:
nil	: Let the layout decide the height. Usually using the widget native height.
number	: Enforce a number of pixels.
Unit	: pixel
Negative allowed	: false

See also:

wibox.widget.base.forced_width

🔗 forced_width number or nil · Inherited from wibox.widget.base

Force a widget width.

Constraints:

Default value	: nil
Type description:
nil	: Let the layout decide the width. Usually using the widget native width.
number	: Enforce a number of pixels.
Unit	: pixel
Negative allowed	: false

See also:

wibox.widget.base.forced_height

🔗 opacity number · Inherited from wibox.widget.base

The widget opacity (transparency).

Constraints:

Default value	: 1.0
Unit	: A gradient between transparent (0.0) and opaque (1.0).
Minimum value	: 0.0
Maximum value	: 1.0

See also:

wibox.widget.base.visible

🔗 visible boolean · Inherited from wibox.widget.base

The widget visibility.

Constraints:

Default value	: true
Valid values	: true or false.

See also:

wibox.widget.base.opacity

🔗 buttons table · Inherited from wibox.widget.base

The widget buttons.

The table contains a list of awful.button objects.

Constraints:

Default value	: {}
Table content	: A list of awful.button.

See also:

awful.button	Create easily new buttons objects ignoring certain modifiers.	module

Object methods

🔗 :reset () · Inherited from wibox.container.place

Reset this layout. The widget will be removed and the rotation reset.

🔗 :add_button (button) · Inherited from wibox.widget.base

Add a new awful.button to this widget.

Parameters:

Name		Type(s)	Description
button		awful.button	The button to add.

🔗 :emit_signal_recursive (signal_name, ...) · Inherited from wibox.widget.base

Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.

This is useful to track signals when there is a dynamic set of containers and layouts wrapping the widget.

Note that this function has some flaws:

1. The signal is only forwarded once the widget tree has been built. This happens after all currently scheduled functions have been executed. Therefore, it will not start to work right away.
2. In case the widget is present multiple times in a single widget tree, this function will also forward the signal multiple times (once per upward tree path).
3. If the widget is removed from the widget tree, the signal is still forwarded for some time, similar to the first case.

Parameters:

Name		Type(s)	Description
signal_name		string
...			Other arguments

🔗 :index (widget, recursive, ...) -> (number, widget, table) · Inherited from wibox.widget.base

Get the index of a widget.

Parameters:

Name		Type(s)	Description
widget		widget	The widget to look for.
recursive	Optional	boolean	Recursively check accross the sub-widgets hierarchy.
...	Optional	widget	Additional widgets to add at the end of the sub-widgets hierarchy "path".

Returns:

1. number The widget index.
2. widget The parent widget.
3. table The hierarchy path between "self" and "widget".

🔗 :connect_signal (name, func) · Inherited from gears.object

Connect to a signal.

Usage example output:

In slot [obj]   nil nil nil
In slot [obj]   foo bar 42

Parameters:

Name		Type(s)	Description
name		string	The name of the signal.
func		function	The callback to call when the signal is emitted.

Usage:

local o = gears.object{}
-- Function can be attached to signals
local function slot(obj, a, b, c)
    print("In slot", obj, a, b, c)
end
o:connect_signal("my_signal", slot)
-- Emitting can be done without arguments. In that case, the object will be
-- implicitly added as an argument.
o:emit_signal "my_signal"
-- It is also possible to add as many random arguments are required.
o:emit_signal("my_signal", "foo", "bar", 42)
-- Finally, to allow the object to be garbage collected (the memory freed), it
-- is necessary to disconnect the signal or use weak_connect_signal
o:disconnect_signal("my_signal", slot)
-- This time, the slot wont be called as it is no longer connected.
o:emit_signal "my_signal"

🔗 :weak_connect_signal (name, func) · Inherited from gears.object

Connect to a signal weakly.

This allows the callback function to be garbage collected and automatically disconnects the signal when that happens. Warning: Only use this function if you really, really, really know what you are doing.

Parameters:

Name		Type(s)	Description
name		string	The name of the signal.
func		function	The callback to call when the signal is emitted.

🔗 :disconnect_signal (name, func) · Inherited from gears.object

Disconnect from a signal.

Parameters:

Name		Type(s)	Description
name		string	The name of the signal.
func		function	The callback that should be disconnected.

🔗 :emit_signal (name, ...) · Inherited from gears.object

Emit a signal.

Parameters:

Name		Type(s)	Description
name		string	The name of the signal
...			Extra arguments for the callback functions. Each connected function receives the object as first argument and then any extra arguments that are given to emit_signal()

Signals

🔗 widget::layout_changed · Inherited from wibox.widget.base

When the layout (size) change. This signal is emitted when the previous results of :layout() and :fit() are no longer valid. Unless this signal is emitted, :layout() and :fit() must return the same result when called with the same arguments.

See also:

widget::redraw_needed	When the widget content changed.	signals

🔗 widget::redraw_needed · Inherited from wibox.widget.base

When the widget content changed. This signal is emitted when the content of the widget changes. The widget will be redrawn, it is not re-layouted. Put differently, it is assumed that :layout() and :fit() would still return the same results as before.

See also:

widget::layout_changed	When the layout (size) change.	signals

🔗 button::press · Inherited from wibox.widget.base

When a mouse button is pressed over the widget.

Arguments:

Name		Type(s)	Description
self		table	The current object instance itself.
lx		number	The horizontal position relative to the (0,0) position in the widget.
ly		number	The vertical position relative to the (0,0) position in the widget.
button		number	The button number.
mods		table	The modifiers (mod4, mod1 (alt), Control, Shift)
find_widgets_result		table	The entry from the result of wibox:find_widgets for the position that the mouse hit.
drawable		wibox.drawable	The drawable containing the widget.
widget		widget	The widget being displayed.
hierarchy		wibox.hierarchy	The hierarchy managing the widget's geometry.
x		number	An approximation of the X position that the widget is visible at on the surface.
y		number	An approximation of the Y position that the widget is visible at on the surface.
width		number	An approximation of the width that the widget is visible at on the surface.
height		number	An approximation of the height that the widget is visible at on the surface.
widget_width		number	The exact width of the widget in its local coordinate system.
widget_height		number	The exact height of the widget in its local coordinate system.

See also:

mouse	Manipulate and inspect the mouse cursor.	module

🔗 button::release · Inherited from wibox.widget.base

When a mouse button is released over the widget.

Arguments:

Name		Type(s)	Description
self		table	The current object instance itself.
lx		number	The horizontal position relative to the (0,0) position in the widget.
ly		number	The vertical position relative to the (0,0) position in the widget.
button		number	The button number.
mods		table	The modifiers (mod4, mod1 (alt), Control, Shift)
find_widgets_result		table	The entry from the result of wibox:find_widgets for the position that the mouse hit.
drawable		wibox.drawable	The drawable containing the widget.
widget		widget	The widget being displayed.
hierarchy		wibox.hierarchy	The hierarchy managing the widget's geometry.
x		number	An approximation of the X position that the widget is visible at on the surface.
y		number	An approximation of the Y position that the widget is visible at on the surface.
width		number	An approximation of the width that the widget is visible at on the surface.
height		number	An approximation of the height that the widget is visible at on the surface.
widget_width		number	The exact width of the widget in its local coordinate system.
widget_height		number	The exact height of the widget in its local coordinate system.

See also:

mouse	Manipulate and inspect the mouse cursor.	module

🔗 mouse::enter · Inherited from wibox.widget.base

When the mouse enter a widget.

Arguments:

Name		Type(s)	Description
self		table	The current object instance itself.
find_widgets_result		table	The entry from the result of wibox:find_widgets for the position that the mouse hit.
drawable		wibox.drawable	The drawable containing the widget.
widget		widget	The widget being displayed.
hierarchy		wibox.hierarchy	The hierarchy managing the widget's geometry.
x		number	An approximation of the X position that the widget is visible at on the surface.
y		number	An approximation of the Y position that the widget is visible at on the surface.
width		number	An approximation of the width that the widget is visible at on the surface.
height		number	An approximation of the height that the widget is visible at on the surface.
widget_width		number	The exact width of the widget in its local coordinate system.
widget_height		number	The exact height of the widget in its local coordinate system.

See also:

mouse	Manipulate and inspect the mouse cursor.	module

🔗 mouse::leave · Inherited from wibox.widget.base

When the mouse leave a widget.

Arguments:

Name		Type(s)	Description
self		table	The current object instance itself.
find_widgets_result		table	The entry from the result of wibox:find_widgets for the position that the mouse hit.
drawable		wibox.drawable	The drawable containing the widget.
widget		widget	The widget being displayed.
hierarchy		wibox.hierarchy	The hierarchy managing the widget's geometry.
x		number	An approximation of the X position that the widget is visible at on the surface.
y		number	An approximation of the Y position that the widget is visible at on the surface.
width		number	An approximation of the width that the widget is visible at on the surface.
height		number	An approximation of the height that the widget is visible at on the surface.
widget_width		number	The exact width of the widget in its local coordinate system.
widget_height		number	The exact height of the widget in its local coordinate system.

See also:

mouse	Manipulate and inspect the mouse cursor.	module