awesome

• Index

Contents

• Functions
• Object properties
• Signals
• Methods

Classes

• awful.button
• awful.keygrabber
• awful.popup
• awful.titlebar
• awful.tooltip
• awful.wibar
• awful.widget.button
• awful.widget.calendar_popup
• awful.widget.clienticon
• awful.widget.common
• awful.widget.keyboardlayout
• awful.widget.launcher
• awful.widget.layoutbox
• awful.widget.layoutlist
• awful.widget.only_on_screen
• awful.widget.prompt
• awful.widget.taglist
• awful.widget.tasklist
• awful.widget.textclock
• awful.widget.watch
• button
• client
• drawable
• gears.cache
• gears.matrix
• gears.object
• gears.timer
• key
• menubar.icon_theme
• menubar.index_theme
• screen
• signals
• tag
• wibox
• 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.drawable
• wibox.layout.align
• wibox.layout.fixed
• wibox.layout.flex
• wibox.layout.grid
• wibox.layout.manual
• wibox.layout.ratio
• wibox.layout.stack
• wibox.widget
• wibox.widget.base
• 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
• xproperties

Libraries

• awesome
• awful.client
• awful.completion
• awful.ewmh
• awful.hotkeys_popup
• awful.hotkeys_popup.widget
• awful.key
• awful.layout
• awful.menu
• awful.mouse
• awful.placement
• awful.prompt
• awful.rules
• awful.screen
• awful.spawn
• awful.tag
• awful.util
• awful.wibox
• beautiful
• beautiful.gtk
• dbus
• gears.color
• gears.debug
• gears.filesystem
• gears.geometry
• gears.math
• gears.protected_call
• gears.shape
• gears.sort
• gears.string
• gears.surface
• gears.table
• gears.wallpaper
• menubar
• menubar.menu_gen
• menubar.utils
• mouse
• mousegrabber
• naughty
• naughty.dbus
• root
• selection
• wibox.hierarchy

Sample files

• rc.lua
• theme.lua

Documentation

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

Class wibox.container.mirror

Info:

• Copyright: 2012 dodo
• Author: dodo

Functions

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

Returns a new mirror container.

Object properties

widget	The widget to be reflected.
reflection	Get the reflection of this mirror layout.
forced_height	Force a widget height.
forced_width	Force a widget width.
opacity	The widget opacity (transparency).
visible	The widget visibility.

Signals

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

Methods

wibox.container.mirror:get_children ()	Get the number of children element
wibox.container.mirror:set_children (children)	Replace the layout children This layout only accept one children, all others will be ignored
wibox.container.mirror:reset ()	Reset this layout.
wibox.container.mirror:get_all_children ()	Get all direct and indirect children widgets.
wibox.container.mirror:setup (args)	Set a declarative widget hierarchy description.
wibox.container.mirror:buttons (_buttons)	Set/get a widget’s buttons.
wibox.container.mirror:emit_signal_recursive (signal_name, ...)	Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.
wibox.container.mirror:emit_signal (name, ...)	Emit a signal.
wibox.container.mirror:connect_signal (name, func)	Connect to a signal.
wibox.container.mirror:weak_connect_signal (name, func)	Connect to a signal weakly.

Functions

Methods

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

Returns a new mirror container. A mirror container mirrors a given widget. Use :set_widget() to set the widget and :set_horizontal() and :set_vertical() for the direction. horizontal and vertical are by default false which doesn’t change anything.

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

Returns:

table A new mirror container

Object properties

widget

The widget to be reflected.

Type:

• widget widget The widget

reflection

Get the reflection of this mirror layout.

Type:

• reflection A table of booleans with the keys “horizontal”, “vertical”.
  • horizontal boolean
  • vertical boolean

forced_height

Force a widget height.

Type:

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

forced_width

Force a widget width.

Type:

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

opacity

The widget opacity (transparency).

Type:

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

visible

The widget visibility.

Type:

• boolean

Signals

widget::layout_changed

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

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

When a mouse button is pressed over the widget.

Arguments:

• 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

When a mouse button is released over the widget.

Arguments:

• 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

When the mouse enter a widget.

Arguments:

• 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

When the mouse leave a widget.

Arguments:

• 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

wibox.container.mirror:get_children ()

Get the number of children element

Returns:

table The children

wibox.container.mirror:set_children (children)

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

• children table A table composed of valid widgets

wibox.container.mirror:reset ()

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

wibox.container.mirror:get_all_children ()

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.

Returns:

table The children

wibox.container.mirror:setup (args)

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

• args An array containing the widgets disposition

wibox.container.mirror:buttons (_buttons)

Set/get a widget’s buttons.

• _buttons The table of buttons that should bind to the widget.

wibox.container.mirror:emit_signal_recursive (signal_name, ...)

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.

• signal_name string
• ... Other arguments

wibox.container.mirror:emit_signal (name, ...)

Emit a signal.

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

wibox.container.mirror:connect_signal (name, func)

Connect to a signal.

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

wibox.container.mirror:weak_connect_signal (name, func)

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.

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