awesome API documentation

## API documentation for awesome, a highly configurable X window manager (version v4.0).

## Libraries

awesome | awesome core API
awful.client | This module documentation has been merged with the client module.
awful.completion | Completion module.
awful.ewmh | Implements EWMH requests handling.
awful.hotkeys_popup | Popup widget which shows current hotkeys and their descriptions.
awful.hotkeys_popup.keys | Additional hotkeys for awful.hotkeys_widget
awful.hotkeys_popup.keys.vim | VIM hotkeys for awful.hotkeys_widget
awful.hotkeys_popup.widget | Popup widget which shows current hotkeys and their descriptions.
awful.key | Create easily new key objects ignoring certain modifiers.
awful.keygrabber | Keygrabber Stack
awful.layout | Layout module for awful
awful.menu | A menu for awful
awful.mouse | This module documentation has been merged with the mouse module.
awful.placement | Algorithms used to place various drawables.
awful.prompt | Prompt module for awful.
awful.rules | Apply rules to clients at startup.
awful.screen | This module documentation has been merged with the screen module.
awful.spawn | Spawning of programs.
awful.tag | This module documentation has been merged with the tag module.
awful.titlebar | Titlebars for awful.
awful.util | Utility module for awful
awful.wibox | This module is deprecated and has been renamed awful.wibar
beautiful | Theme library.
beautiful.xresources | Library for getting xrdb data.
dbus | awesome D-Bus API
gears.color |
gears.debug |
gears.geometry | Helper functions used to compute geometries.
gears.object.properties | An helper module to map userdata __index and __newindex entries to lua classes.
gears.protected_call |
gears.shape | Module dedicated to gather common shape painters.
gears.surface |
gears.wallpaper |
keygrabber | awesome keygrabber API
menubar | Menubar module, which aims to provide a freedesktop menu alternative
menubar.menu_gen | Menu generation module for menubar
menubar.utils | Utility module for menubar
mouse | awesome mouse API.
mousegrabber | awesome mousegrabber API
naughty | Notification library
naughty.dbus | DBUS/Notification support Notify
objects.button | Mouse buttons bindings
objects.client | client_t type
objects.drawable | drawable type
objects.drawin | Drawin type
objects.key | Key modifier
objects.screen | Is this screen still valid and may be used?
objects.tag | Tag type
objects.window | Windows type
root | awesome root window API
selection | awesome selection (clipboard) API
wibox.hierarchy | Management of widget hierarchies.

## Classes

awful.button | Create easily new buttons objects ignoring certain modifiers.
awful.tooltip | Tooltip module for awesome objects.
awful.wibar | Wibox module for awful.
awful.widget.button | A simple button widget.
awful.widget.common |
awful.widget.graph | This module has been moved to wibox.widget.graph
awful.widget.launcher |
awful.widget.layoutbox | Layoutbox widget.
awful.widget.progressbar | This module has been moved to wibox.widget.progressbar
awful.widget.prompt |
awful.widget.taglist | Taglist widget module for awful
awful.widget.tasklist | Tasklist widget module for awful.
awful.widget.textclock | This widget has moved to wibox.widget.textclock
awful.widget.watch | Watch widget.
button | awesome button API Furthermore to the classes described here, one can also use signals as described in signals.
client | A process window.
drawable | awesome drawable API
gears.cache |
gears.matrix | An implementation of matrices for describing and working with affine transformations.
gears.object | The object oriented programming base class used by various Awesome widgets and components.
gears.timer | Timer objects and functions.
key | awesome key API Furthermore to the classes described here, one can also use signals as described in signals.
menubar.icon_theme | Class module for icon lookup for menubar
menubar.index_theme | Class module for parsing an index.theme file
screen | awesome screen API Screen objects can be added and removed over time.
signals | Handling of signals.
tag | awesome tag API Furthermore to the classes described here, one can also use signals as described in signals.
wibox |
wibox.container.arcchart | A circular chart (arc chart).
wibox.container.background | A container capable of changing the background color, foreground color widget shape.
wibox.container.constraint |
wibox.container.margin |
wibox.container.mirror |
wibox.container.radialprogressbar | A circular progressbar wrapper.
wibox.container.rotate | A container rotating the conained widget by 90 degrees.
wibox.container.scroll |
wibox.drawable | Handling of drawables.
wibox.layout.align |
wibox.layout.constraint | This class has been moved to `wibox.container.`
wibox.layout.fixed |
wibox.layout.flex |
wibox.layout.margin | This class has been moved to wibox.container.margin
wibox.layout.mirror | This class has been moved to wibox.container.mirror
wibox.layout.ratio | A layout filling all the available space.
wibox.layout.rotate | This class has been moved to wibox.container.rotate
wibox.layout.scroll | This class has been moved to wibox.container.scroll
wibox.layout.stack | A stacked layout.
wibox.widget.background | This class has been moved to wibox.container.background
wibox.widget.base |
wibox.widget.checkbox | A boolean display widget.
wibox.widget.graph | A graph widget.
wibox.widget.imagebox |
wibox.widget.keyboardlayout |
wibox.widget.piechart | Display percentage in a circle.
wibox.widget.progressbar | A progressbar widget.
wibox.widget.slider | An interactive mouse based slider widget.
wibox.widget.systray |
wibox.widget.textbox |
wibox.widget.textclock | Text clock widget.
xproperties | Handling of X properties.

## Documentation

00-authors.md |
01-readme.md |
02-contributing.md |
03-declarative-layout.md |
04-new-widgets.md |
05-awesomerc.md |
06-appearance.md |
16-using-cairo.md |
17-porting-tips.md |
89-NEWS.md |
90-FAQ.md |

generated by LDoc 1.4.6 Last updated 2017-01-19 17:31:36