awesome

• Index

Contents

• Functions
• Object properties
• Object methods
• Signals
• Methods

Classes

• awful.widget.common
• gears.cache
• gears.connection
• gears.history
• gears.matrix
• gears.reactive
• gears.watcher
• menubar.icon_theme
• menubar.index_theme
• signals
• wibox.container.conditional
• wibox.container.scale
• wibox.container.template
• wibox.drawable
• wibox.hierarchy
• wibox.widget.base
• wibox.widget.status
• xproperties

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.clipboard
• ruled.notifications
• ruled.screen
• ruled.tag

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 containers

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

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

Client tiling

• dynamite
• dynamite.layout.conditional
• dynamite.layout.ratio
• dynamite.layout.stack
• dynamite.layout.tabbed
• dynamite.utils
• dynamite.widget.placeholder

Libraries

• awful.completion
• awful.hotkeys_popup
• awful.layout
• awful.permissions
• awful.placement
• awful.prompt
• awful.spawn
• awful.util
• dbus
• dynamite.widget.pager
• dynamite.widget.spawn
• gears.matcher
• gears.surface
• lib.lain.layout.centerwork
• menubar.menu_gen
• menubar.utils
• naughty
• selection
• wibox.widget

Sample files

• rc.lua
• theme.lua

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.scale

Resize the content widget by a factor, offset or DPI differential.

This container can be used to shrink or grow its content.

Functions

wibox.container.scale ([widget[, reflection]])

Returns a new scale container.

Object properties

widget	widget	The widget to be reflected.
factor	table	Set the scaling factor of this scale container.
factor	table	Set the scaling of this scale container (by points/pixels).
factor	table	Set the scaling percentage of this scale container.
children	table	Get or set the children elements.	Inherited from wibox.widget
all_children	table	Get all direct and indirect children widgets.	Inherited from wibox.widget
forced_height	number or nil	Force a widget height.	Inherited from wibox.widget
forced_width	number or nil	Force a widget width.	Inherited from wibox.widget
opacity	number	The widget opacity (transparency).	Inherited from wibox.widget
visible	boolean	The widget visibility.	Inherited from wibox.widget
buttons	table	The widget buttons.	Inherited from wibox.widget

Object methods

:setup {[args]}	Set a declarative widget hierarchy description.	Inherited from wibox.widget
:add_button (button)	Add a new awful.button to this widget.	Inherited from wibox.widget
:emit_signal_recursive (signal_name, ...)	Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.	Inherited from wibox.widget
:emit_signal (name, ...)	Emit a signal.	Inherited from gears.object
:connect_signal (name, func)	Connect to a signal.	Inherited from gears.object
:weak_connect_signal (name, func)	Connect to a signal weakly.	Inherited from gears.object

Signals

widget::layout_changed	When the layout (size) change.	Inherited from wibox.widget
widget::redraw_needed	When the widget content changed.	Inherited from wibox.widget
button::press	When a mouse button is pressed over the widget.	Inherited from wibox.widget
button::release	When a mouse button is released over the widget.	Inherited from wibox.widget
mouse::enter	When the mouse enter a widget.	Inherited from wibox.widget
mouse::leave	When the mouse leave a widget.	Inherited from wibox.widget

Methods

:get_children ()	Get the number of children element
:set_children (children)	Replace the layout children This layout only accept one children, all others will be ignored
:reset ()	Reset this layout.

Functions

Methods

wibox.container.scale ([widget[, reflection]])

Returns a new scale container.

horizontal and vertical are by default false which doesn't change anything.

Parameters:

• widget The widget to display. (optional)
• reflection A table describing the reflection to apply. (optional)

Returns:

table A new scale container

Object properties

widget widget

The widget to be reflected.

Type constraints:

• widget widget The widget

factor table

Set the scaling factor of this scale container.

Type constraints:

• factor A table of booleans with the keys "horizontal", "vertical".
  • horizontal boolean
  • vertical boolean

factor table

Set the scaling of this scale container (by points/pixels).

Type constraints:

• factor A table of booleans with the keys "horizontal", "vertical".
  • horizontal boolean
  • vertical boolean

factor table

Set the scaling percentage of this scale container.

Type constraints:

• factor A table of booleans with the keys "horizontal", "vertical".
  • horizontal boolean
  • vertical boolean

children table · Inherited from wibox.widget

Get or set the children elements.

Type constraints:

• children table The children.

all_children table · Inherited from wibox.widget

Get all direct and indirect children widgets. This will scan all containers recursively to find widgets Warning: This method it prone to stack overflow id the widget, or any of its children, contain (directly or indirectly) itself.

Type constraints:

• children table The children.

forced_height number or nil · Inherited from wibox.widget

Force a widget height.

Type constraints:

• height number or nil The height (nil for automatic)

forced_width number or nil · Inherited from wibox.widget

Force a widget width.

Type constraints:

• width number or nil The width (nil for automatic)

opacity number · Inherited from wibox.widget

The widget opacity (transparency).

Type constraints:

• opacity number The opacity (between 0 and 1) (default 1)

visible boolean · Inherited from wibox.widget

The widget visibility.

buttons table · Inherited from wibox.widget

The widget buttons.

The table contains a list of awful.button objects.

See also:

awful.button

Object methods

:setup {[args]} · Inherited from wibox.widget

Set a declarative widget hierarchy description. See The declarative layout system

Parameters:

• args An array containing the widgets disposition

:add_button (button) · Inherited from wibox.widget

Add a new awful.button to this widget.

Parameters:

• button awful.button The button to add.

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

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.

Parameters:

• signal_name string
• ... Other arguments

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

Emit a signal.

Parameters:

• 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().

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

Connect to a signal.

Parameters:

• name string The name of the signal.
• func function The callback to call when the signal is emitted.

: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 string The name of the signal.
• func function The callback to call when the signal is emitted.

Signals

widget::layout_changed · Inherited from wibox.widget

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

widget::redraw_needed · Inherited from wibox.widget

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

button::press · Inherited from wibox.widget

When a mouse button is pressed over the widget.

Arguments:

• 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 The entry from the result of wibox.drawable: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

button::release · Inherited from wibox.widget

When a mouse button is released over the widget.

Arguments:

• 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 The entry from the result of wibox.drawable: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

mouse::enter · Inherited from wibox.widget

When the mouse enter a widget.

Arguments:

• self table The current object instance itself.
• find_widgets_result The entry from the result of wibox.drawable: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

mouse::leave · Inherited from wibox.widget

When the mouse leave a widget.

Arguments:

• self table The current object instance itself.
• find_widgets_result The entry from the result of wibox.drawable: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

Methods

:get_children ()

Get the number of children element

Returns:

table The children

:set_children (children)

Replace the layout children This layout only accept one children, all others will be ignored

Parameters:

• children table A table composed of valid widgets

:reset ()

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