awesome

• Index

Contents

• Functions
• Theme variables
• Client layouts
• Tables
• Fields

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

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

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

Module awful.layout

Layout module for awful

Info:

• Copyright: 2008 Julien Danjou
• Author: Julien Danjou <[email protected]>

Functions

get_tag_layout_index (t)	Return the tag layout index (from awful.layout.layouts).
get (screen)	Get the current layout.
inc (i, s[, layouts])	Change the layout of the current tag.
set (_layout[, t=mouse.screen.selected_tag])	Set the layout function of the current tag.
parameters ([t[, screen]])	Get the layout parameters used for the screen This should give the same result as “arrange”, but without the “geometries” parameter, as this is computed during arranging.
arrange (screen)	Arrange a screen using its current layout.
getname (_layout)	Get the current layout name.
move_handler (c, context, hints)	Default handler for request::geometry signals for tiled clients with the “mouse.move” context.

Theme variables

beautiful.layout_cornernw	The cornernw layout layoutbox icon.
beautiful.layout_cornerne	The cornerne layout layoutbox icon.
beautiful.layout_cornersw	The cornersw layout layoutbox icon.
beautiful.layout_cornerse	The cornerse layout layoutbox icon.
beautiful.layout_fairh	The fairh layout layoutbox icon.
beautiful.layout_fairv	The fairv layout layoutbox icon.
beautiful.layout_floating	The floating layout layoutbox icon.
beautiful.layout_magnifier	The magnifier layout layoutbox icon.
beautiful.layout_max	The max layout layoutbox icon.
beautiful.layout_fullscreen	The fullscreen layout layoutbox icon.
beautiful.layout_spiral	The spiral layout layoutbox icon.
beautiful.layout_dwindle	The dwindle layout layoutbox icon.
beautiful.layout_tile	The tile layout layoutbox icon.
beautiful.layout_tiletop	The tile top layout layoutbox icon.
beautiful.layout_tilebottom	The tile bottom layout layoutbox icon.
beautiful.layout_tileleft	The tile left layout layoutbox icon.

Client layouts

awful.layout.suit.corner.nw	Corner layout.
awful.layout.suit.corner.ne	Corner layout.
awful.layout.suit.corner.sw	Corner layout.
awful.layout.suit.corner.se	Corner layout.
awful.layout.suit.	The floating layout.
awful.layout.suit.magnifier	The magnifier layout.
awful.layout.suit.max.name	Maximized layout.
awful.layout.suit.max.fullscreen	Fullscreen layout.
awful.layout.suit.spiral.dwindle	Dwindle layout.
awful.layout.suit.spiral.name	Spiral layout.
awful.layout.suit.tile.right	The main tile algo, on the right.
awful.layout.suit.tile.left	The main tile algo, on the left.
awful.layout.suit.tile.bottom	The main tile algo, on the bottom.
awful.layout.suit.tile.top	The main tile algo, on the top.

Tables

fair.horizontal

Horizontal fair layout.

Fields

layouts	The default list of layouts.
fair.name	Vertical fair layout.
floating.resize_jump_to_corner	Jump mouse cursor to the client’s corner when resizing it.
tile.resize_jump_to_corner	Jump mouse cursor to the client’s corner when resizing it.

Functions

Methods

get_tag_layout_index (t)

Return the tag layout index (from awful.layout.layouts).

If the layout isn’t part of awful.layout.layouts, this function returns nil.

• t tag The tag.

Returns:

nil or number The layout index.

get (screen)

Get the current layout.

• screen The screen.

Returns:

The layout function.

inc (i, s[, layouts])

Change the layout of the current tag.

• i Relative index.
• s The screen.
• layouts A table of layouts. (optional)

set (_layout[, t=mouse.screen.selected_tag])

Set the layout function of the current tag.

• _layout Layout name.
• t tag The tag to modify. (default mouse.screen.selected_tag)

parameters ([t[, screen]])

Get the layout parameters used for the screen

This should give the same result as “arrange”, but without the “geometries” parameter, as this is computed during arranging.

If t is given, screen is ignored, if none are given, the mouse screen is used.

• t tag The tag to query (optional)
• screen The screen (optional)

Returns:

table A table with the workarea (x, y, width, height), the screen geometry (x, y, width, height), the clients, the screen and sometime, a “geometries” table with client as keys and geometry as value

arrange (screen)

Arrange a screen using its current layout.

• screen The screen to arrange.

getname (_layout)

Get the current layout name.

• _layout The layout.

Returns:

The layout name.

move_handler (c, context, hints)

Default handler for request::geometry signals for tiled clients with the “mouse.move” context.

• c client The client
• context string The context
• hints table Additional hints

Theme variables

beautiful.layout_cornernw

The cornernw layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_cornerne

The cornerne layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_cornersw

The cornersw layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_cornerse

The cornerse layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_fairh

The fairh layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_fairv

The fairv layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_floating

The floating layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_magnifier

The magnifier layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_max

The max layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_fullscreen

The fullscreen layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_spiral

The spiral layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_dwindle

The dwindle layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_tile

The tile layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_tiletop

The tile top layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_tilebottom

The tile bottom layout layoutbox icon.

Type:

• surface

See also:

gears.surface

beautiful.layout_tileleft

The tile left layout layoutbox icon.

Type:

• surface

See also:

gears.surface

Client layouts

awful.layout.suit.corner.nw

Corner layout. Display master client in a corner of the screen, and slaves in one column and one row around the master.

awful.layout.suit.corner.ne

Corner layout. Display master client in a corner of the screen, and slaves in one column and one row around the master.

awful.layout.suit.corner.sw

Corner layout. Display master client in a corner of the screen, and slaves in one column and one row around the master.

awful.layout.suit.corner.se

Corner layout. Display master client in a corner of the screen, and slaves in one column and one row around the master.

awful.layout.suit.

The floating layout.

awful.layout.suit.magnifier

The magnifier layout.

awful.layout.suit.max.name

Maximized layout.

awful.layout.suit.max.fullscreen

Fullscreen layout.

awful.layout.suit.spiral.dwindle

Dwindle layout.

awful.layout.suit.spiral.name

Spiral layout.

awful.layout.suit.tile.right

The main tile algo, on the right.

param:

• screen The screen number to tile.

awful.layout.suit.tile.left

The main tile algo, on the left.

param:

• screen The screen number to tile.

awful.layout.suit.tile.bottom

The main tile algo, on the bottom.

param:

• screen The screen number to tile.

awful.layout.suit.tile.top

The main tile algo, on the top.

param:

• screen The screen number to tile.

Tables

fair.horizontal

Horizontal fair layout.

Fields:

• screen The screen to arrange.

Fields

layouts

The default list of layouts.

The default value is:

awful.layout.suit.floating,
awful.layout.suit.tile,
awful.layout.suit.tile.left,
awful.layout.suit.tile.bottom,
awful.layout.suit.tile.top,
awful.layout.suit.fair,
awful.layout.suit.fair.horizontal,
awful.layout.suit.spiral,
awful.layout.suit.spiral.dwindle,
awful.layout.suit.max,
awful.layout.suit.max.fullscreen,
awful.layout.suit.magnifier,
awful.layout.suit.corner.nw,
awful.layout.suit.corner.ne,
awful.layout.suit.corner.sw,
awful.layout.suit.corner.se,

fair.name

Vertical fair layout.

• screen The screen to arrange.

floating.resize_jump_to_corner

Jump mouse cursor to the client’s corner when resizing it.

tile.resize_jump_to_corner

Jump mouse cursor to the client’s corner when resizing it.