<!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>
<a href="../modules/awful.wibox.html">awful.wibox</a>
</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><strong>awful.widget.progressbar</strong></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.widget.progressbar</code></h1>
<p>A progressbar widget.</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.15 </small></p>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#new">new</a> (args)</td>
<td class="summary">Create a progressbar widget.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_background_color">set_background_color</a> (progressbar, color)</td>
<td class="summary">Set the progressbar background color.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_border_color">set_border_color</a> (progressbar, color)</td>
<td class="summary">Set the progressbar border color.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_color">set_color</a> (progressbar, color)</td>
<td class="summary">Set the progressbar foreground color.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_gradient_colors">set_gradient_colors</a> (progressbar, gradient_colors)</td>
<td class="summary">Set the progressbar foreground color as a gradient.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_height">set_height</a> (progressbar, height)</td>
<td class="summary">Set the progressbar height.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_max_value">set_max_value</a> (progressbar, value)</td>
<td class="summary">Set the maximum value the progressbar should handle.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_ticks">set_ticks</a> (progressbar, ticks)</td>
<td class="summary">Set the progressbar to draw ticks.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_ticks_gap">set_ticks_gap</a> (progressbar, value)</td>
<td class="summary">Set the progressbar ticks gap.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_ticks_size">set_ticks_size</a> (progressbar, value)</td>
<td class="summary">Set the progressbar ticks size.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_value">set_value</a> (pbar, value)</td>
<td class="summary">Set the progressbar value.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_vertical">set_vertical</a> (progressbar, vertical)</td>
<td class="summary">Set the progressbar to draw vertically.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_width">set_width</a> (progressbar, width)</td>
<td class="summary">Set the progressbar width.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="new"></a><strong>new</strong> (args)</dt>
<dd>
Create a progressbar widget.
<h3>Parameters</h3>
<ul>
<li>
args: Standard widget() arguments. You should add width and height key to set progressbar geometry.
</li>
</ul>
<h3>Return value:</h3>
A progressbar widget.
</dd>
<dt><a name="set_background_color"></a><strong>set_background_color</strong> (progressbar, color)</dt>
<dd>
Set the progressbar background color.
<h3>Parameters</h3>
<ul>
<li>
progressbar: The progressbar.
</li>
<li>
color: The progressbar background color.
</li>
</ul>
</dd>
<dt><a name="set_border_color"></a><strong>set_border_color</strong> (progressbar, color)</dt>
<dd>
Set the progressbar border color. If the value is nil, no border will be drawn.
<h3>Parameters</h3>
<ul>
<li>
progressbar: The progressbar.
</li>
<li>
color: The border color to set.
</li>
</ul>
</dd>
<dt><a name="set_color"></a><strong>set_color</strong> (progressbar, color)</dt>
<dd>
Set the progressbar foreground color.
<h3>Parameters</h3>
<ul>
<li>
progressbar: The progressbar.
</li>
<li>
color: The progressbar color.
</li>
</ul>
</dd>
<dt><a name="set_gradient_colors"></a><strong>set_gradient_colors</strong> (progressbar, gradient_colors)</dt>
<dd>
Set the progressbar foreground color as a gradient.
<h3>Parameters</h3>
<ul>
<li>
progressbar: The progressbar.
</li>
<li>
gradient_colors: A table with gradients colors. The distance between each color can also be specified. Example: { "red", "blue" } or { "red", "green", "blue", blue = 10 } to specify blue distance from other colors.
</li>
</ul>
</dd>
<dt><a name="set_height"></a><strong>set_height</strong> (progressbar, height)</dt>
<dd>
Set the progressbar height.
<h3>Parameters</h3>
<ul>
<li>
progressbar: The progressbar.
</li>
<li>
height: The height to set.
</li>
</ul>
</dd>
<dt><a name="set_max_value"></a><strong>set_max_value</strong> (progressbar, value)</dt>
<dd>
Set the maximum value the progressbar should handle.
<h3>Parameters</h3>
<ul>
<li>
progressbar: The progressbar.
</li>
<li>
value: The value.
</li>
</ul>
</dd>
<dt><a name="set_ticks"></a><strong>set_ticks</strong> (progressbar, ticks)</dt>
<dd>
Set the progressbar to draw ticks. Default is false.
<h3>Parameters</h3>
<ul>
<li>
progressbar: The progressbar.
</li>
<li>
ticks: A boolean value.
</li>
</ul>
</dd>
<dt><a name="set_ticks_gap"></a><strong>set_ticks_gap</strong> (progressbar, value)</dt>
<dd>
Set the progressbar ticks gap.
<h3>Parameters</h3>
<ul>
<li>
progressbar: The progressbar.
</li>
<li>
value: The value.
</li>
</ul>
</dd>
<dt><a name="set_ticks_size"></a><strong>set_ticks_size</strong> (progressbar, value)</dt>
<dd>
Set the progressbar ticks size.
<h3>Parameters</h3>
<ul>
<li>
progressbar: The progressbar.
</li>
<li>
value: The value.
</li>
</ul>
</dd>
<dt><a name="set_value"></a><strong>set_value</strong> (pbar, value)</dt>
<dd>
Set the progressbar value.
<h3>Parameters</h3>
<ul>
<li>
pbar: The progress bar.
</li>
<li>
value: The progress bar value between 0 and 1.
</li>
</ul>
</dd>
<dt><a name="set_vertical"></a><strong>set_vertical</strong> (progressbar, vertical)</dt>
<dd>
Set the progressbar to draw vertically. Default is false.
<h3>Parameters</h3>
<ul>
<li>
progressbar: The progressbar.
</li>
<li>
vertical: A boolean value.
</li>
</ul>
</dd>
<dt><a name="set_width"></a><strong>set_width</strong> (progressbar, width)</dt>
<dd>
Set the progressbar width.
<h3>Parameters</h3>
<ul>
<li>
progressbar: The progressbar.
</li>
<li>
width: The width to set.
</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>
