awesome

• Index

Contents

• Static module functions
• Object methods
• Signals

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

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

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: drawable

awesome drawable API.

Furthermore to the classes described here, one can also use signals as described in signals.

Static module functions

drawable.drawable (surface)	Drawable object.
drawable.instances () -> ()	Get the number of instances.
drawable.set_index_miss_handler (cb)	Set a __index metamethod for all drawable instances.
drawable.set_newindex_miss_handler (cb)	Set a __newindex metamethod for all drawable instances.

Object methods

:refresh ()	Refresh a drawable's content.
:geometry () -> table	Get drawable geometry.

Signals

button::press
button::release
mouse::enter
mouse::leave
mouse::move
property::geometry
property::height
property::width
property::x
property::y
property::surface

Static module functions

drawable.drawable (surface)

Drawable object.

Parameters:

• surface The drawable's cairo surface.

drawable.instances () -> ()

Get the number of instances.

Returns:

The number of drawable objects alive.

drawable.set_index_miss_handler (cb)

Set a __index metamethod for all drawable instances.

Parameters:

• cb function The meta-method

drawable.set_newindex_miss_handler (cb)

Set a __newindex metamethod for all drawable instances.

Parameters:

• cb function The meta-method

Object methods

:refresh ()

Refresh a drawable's content. This has to be called whenever some drawing to the drawable's surface has been done and should become visible.

:geometry () -> table

Get drawable geometry. The geometry consists of x, y, width and height.

Returns:

table A table with drawable coordinates and geometry.

Signals

button::press

button::release

mouse::enter

mouse::leave

mouse::move

property::geometry

property::height

property::width

property::x

property::y

property::surface