awesome

• Index

Contents

• 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.drawable

Handling of drawables.

A drawable is something that can be drawn to.

Methods

:find_widgets (x, y)	Find a widget by a point.
:set_widget (widget)	Set the widget that the drawable displays
:set_bg (c)	Set the background of the drawable
:set_bgimage (image)	Set the background image of the drawable If image is a function, it will be called with (context, cr, width, height) as arguments.
:set_fg (c)	Set the foreground of the drawable

Methods

:find_widgets (x, y)

Find a widget by a point. The drawable must have drawn itself at least once for this to work.

Parameters:

• x X coordinate of the point
• y Y coordinate of the point

Returns:

table A table containing a description of all the widgets that contain the given point. Each entry is a table containing this drawable as its .drawable entry, the widget under .widget and the instance of wibox.hierarchy describing the size and position of the widget under .hierarchy. For convenience, .x, .y, .width and .height contain an approximation of the widget's extents on the surface. widget_width and widget_height contain the exact size of the widget in its own, local coordinate system (which may e.g. be rotated and scaled).

:set_widget (widget)

Set the widget that the drawable displays

Parameters:

• widget

:set_bg (c)

Set the background of the drawable

Parameters:

• c The background to use. This must either be a cairo pattern object, nil or a string that gears.color() understands.

See also:

gears.color

:set_bgimage (image)

Set the background image of the drawable If image is a function, it will be called with (context, cr, width, height) as arguments. Any other arguments passed to this method will be appended.

Parameters:

• image A background image or a function

:set_fg (c)

Set the foreground of the drawable

Parameters:

• c The foreground to use. This must either be a cairo pattern object, nil or a string that gears.color() understands.

See also:

gears.color