<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Reference</title>
<link rel="stylesheet" href="../luadoc.css" type="text/css" />
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<div id="navigation">
<h1>LuaDoc</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<!-- Module list -->
<h1>Modules</h1>
<ul>
<li>
<a href="../modules/awesome.html">awesome</a>
</li>
<li>
<a href="../modules/awful.html">awful</a>
</li>
<li>
<a href="../modules/awful.autofocus.html">awful.autofocus</a>
</li>
<li>
<a href="../modules/awful.button.html">awful.button</a>
</li>
<li>
<a href="../modules/awful.client.html">awful.client</a>
</li>
<li>
<a href="../modules/awful.completion.html">awful.completion</a>
</li>
<li>
<a href="../modules/awful.dbus.html">awful.dbus</a>
</li>
<li>
<a href="../modules/awful.hooks.html">awful.hooks</a>
</li>
<li>
<a href="../modules/awful.key.html">awful.key</a>
</li>
<li>
<a href="../modules/awful.layout.html">awful.layout</a>
</li>
<li>
<a href="../modules/awful.layout.suit.html">awful.layout.suit</a>
</li>
<li>
<a href="../modules/awful.layout.suit.fair.html">awful.layout.suit.fair</a>
</li>
<li>
<a href="../modules/awful.layout.suit.floating.html">awful.layout.suit.floating</a>
</li>
<li>
<a href="../modules/awful.layout.suit.magnifier.html">awful.layout.suit.magnifier</a>
</li>
<li>
<a href="../modules/awful.layout.suit.max.html">awful.layout.suit.max</a>
</li>
<li>
<a href="../modules/awful.layout.suit.spiral.html">awful.layout.suit.spiral</a>
</li>
<li>
<a href="../modules/awful.layout.suit.tile.html">awful.layout.suit.tile</a>
</li>
<li>
<a href="../modules/awful.menu.html">awful.menu</a>
</li>
<li>
<a href="../modules/awful.mouse.html">awful.mouse</a>
</li>
<li>
<a href="../modules/awful.mouse.finder.html">awful.mouse.finder</a>
</li>
<li>
<a href="../modules/awful.placement.html">awful.placement</a>
</li>
<li>
<a href="../modules/awful.prompt.html">awful.prompt</a>
</li>
<li>
<a href="../modules/awful.remote.html">awful.remote</a>
</li>
<li>
<a href="../modules/awful.rules.html">awful.rules</a>
</li>
<li>
<a href="../modules/awful.screen.html">awful.screen</a>
</li>
<li>
<a href="../modules/awful.startup_notification.html">awful.startup_notification</a>
</li>
<li>
<a href="../modules/awful.tag.html">awful.tag</a>
</li>
<li>
<a href="../modules/awful.titlebar.html">awful.titlebar</a>
</li>
<li>
<a href="../modules/awful.tooltip.html">awful.tooltip</a>
</li>
<li>
<a href="../modules/awful.util.html">awful.util</a>
</li>
<li><strong>awful.wibox</strong></li>
<li>
<a href="../modules/awful.widget.html">awful.widget</a>
</li>
<li>
<a href="../modules/awful.widget.button.html">awful.widget.button</a>
</li>
<li>
<a href="../modules/awful.widget.common.html">awful.widget.common</a>
</li>
<li>
<a href="../modules/awful.widget.graph.html">awful.widget.graph</a>
</li>
<li>
<a href="../modules/awful.widget.launcher.html">awful.widget.launcher</a>
</li>
<li>
<a href="../modules/awful.widget.layout.html">awful.widget.layout</a>
</li>
<li>
<a href="../modules/awful.widget.layout.default.html">awful.widget.layout.default</a>
</li>
<li>
<a href="../modules/awful.widget.layout.horizontal.html">awful.widget.layout.horizontal</a>
</li>
<li>
<a href="../modules/awful.widget.layout.vertical.html">awful.widget.layout.vertical</a>
</li>
<li>
<a href="../modules/awful.widget.layoutbox.html">awful.widget.layoutbox</a>
</li>
<li>
<a href="../modules/awful.widget.progressbar.html">awful.widget.progressbar</a>
</li>
<li>
<a href="../modules/awful.widget.prompt.html">awful.widget.prompt</a>
</li>
<li>
<a href="../modules/awful.widget.taglist.html">awful.widget.taglist</a>
</li>
<li>
<a href="../modules/awful.widget.tasklist.html">awful.widget.tasklist</a>
</li>
<li>
<a href="../modules/awful.widget.textclock.html">awful.widget.textclock</a>
</li>
<li>
<a href="../modules/beautiful.html">beautiful</a>
</li>
<li>
<a href="../modules/button.html">button</a>
</li>
<li>
<a href="../modules/client.html">client</a>
</li>
<li>
<a href="../modules/dbus.html">dbus</a>
</li>
<li>
<a href="../modules/image.html">image</a>
</li>
<li>
<a href="../modules/key.html">key</a>
</li>
<li>
<a href="../modules/keygrabber.html">keygrabber</a>
</li>
<li>
<a href="../modules/mouse.html">mouse</a>
</li>
<li>
<a href="../modules/mousegrabber.html">mousegrabber</a>
</li>
<li>
<a href="../modules/naughty.html">naughty</a>
</li>
<li>
<a href="../modules/root.html">root</a>
</li>
<li>
<a href="../modules/screen.html">screen</a>
</li>
<li>
<a href="../modules/selection.html">selection</a>
</li>
<li>
<a href="../modules/tag.html">tag</a>
</li>
<li>
<a href="../modules/timer.html">timer</a>
</li>
<li>
<a href="../modules/wibox.html">wibox</a>
</li>
<li>
<a href="../modules/widget.html">widget</a>
</li>
</ul>
<!-- File list -->
</div><!-- id="navigation" -->
<div id="content">
<h1>Module <code>awful.wibox</code></h1>
<p>Wibox module for awful. This module allows you to easily create wibox and attach them to the edge of a screen.</p>
<p><b>Author:</b>
<table class="authors_list">
<tr><td class="name">Julien Danjou <julien@danjou.info></td></tr>
</table>
</p>
<p>Copyright© 2009 Julien Danjou</p>
<p><small><b>Release:</b> v3.4.9 </small></p>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#align">align</a> (wibox, align, screen)</td>
<td class="summary">Align a wibox.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#attach">attach</a> (wibox, position)</td>
<td class="summary">Attach a wibox to a screen.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#get_position">get_position</a> (wibox)</td>
<td class="summary">Get a wibox position if it has been set, or return top.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#new">new</a> (arg, args)</td>
<td class="summary">Create a new wibox and attach it to a screen edge.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#rounded_corners">rounded_corners</a> (wibox, corner_size)</td>
<td class="summary">Add rounded corners to a wibox </td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_position">set_position</a> (wibox, position, screen)</td>
<td class="summary">Put a wibox on a screen at this position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#stretch">stretch</a> (wibox, screen)</td>
<td class="summary">Stretch a wibox so it takes all screen width or height.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="align"></a><strong>align</strong> (wibox, align, screen)</dt>
<dd>
Align a wibox.
<h3>Parameters</h3>
<ul>
<li>
wibox: The wibox.
</li>
<li>
align: The alignment: left, right or center.
</li>
<li>
screen: If the wibox is not attached to any screen, you can specify the screen where to align. Otherwise 1 is assumed.
</li>
</ul>
</dd>
<dt><a name="attach"></a><strong>attach</strong> (wibox, position)</dt>
<dd>
Attach a wibox to a screen. If a wibox is attached, it will be automatically be moved when other wiboxes will be attached.
<h3>Parameters</h3>
<ul>
<li>
wibox: The wibox to attach.
</li>
<li>
position: The position of the wibox: top, bottom, left or right.
</li>
</ul>
</dd>
<dt><a name="get_position"></a><strong>get_position</strong> (wibox)</dt>
<dd>
Get a wibox position if it has been set, or return top.
<h3>Parameters</h3>
<ul>
<li>
wibox: The wibox
</li>
</ul>
<h3>Return value:</h3>
The wibox position.
</dd>
<dt><a name="new"></a><strong>new</strong> (arg, args)</dt>
<dd>
Create a new wibox and attach it to a screen edge.
<h3>Parameters</h3>
<ul>
<li>
arg:
</li>
<li>
args: A table with standard arguments to wibox() creator. You can add also position key with value top, bottom, left or right. You can also use width or height in % and set align to center, right or left. You can also set the screen key with a screen number to attach the wibox. If not specified, 1 is assumed.
</li>
</ul>
<h3>Return value:</h3>
The wibox created.
<h3>See also:</h3>
<ul>
<li><a href="">
capi.wibox
</a>
</ul>
</dd>
<dt><a name="rounded_corners"></a><strong>rounded_corners</strong> (wibox, corner_size)</dt>
<dd>
Add rounded corners to a wibox
<h3>Parameters</h3>
<ul>
<li>
wibox: The wibox.
</li>
<li>
corner_size: The size in pixel of the rounded corners.
</li>
</ul>
</dd>
<dt><a name="set_position"></a><strong>set_position</strong> (wibox, position, screen)</dt>
<dd>
Put a wibox on a screen at this position.
<h3>Parameters</h3>
<ul>
<li>
wibox: The wibox to attach.
</li>
<li>
position: The position: top, bottom left or right.
</li>
<li>
screen: If the wibox it not attached to a screen, specified on which screen the position should be set.
</li>
</ul>
</dd>
<dt><a name="stretch"></a><strong>stretch</strong> (wibox, screen)</dt>
<dd>
Stretch a wibox so it takes all screen width or height.
<h3>Parameters</h3>
<ul>
<li>
wibox: The wibox.
</li>
<li>
screen: The screen to stretch on, or the wibox screen.
</li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
