<!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><strong>awful.tooltip</strong></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>
<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.tooltip</code></h1>
<p>Tooltip module for awesome objects. A tooltip is a small hint displayed when the mouse cursor hovers a specific item. In awesome, a tooltip can be linked with almost any object having a <code>add_signal()</code> method and receiving <code>mouse::enter</code> and <code>mouse::leave</code> signals. <p>How to create a tooltip?<br/> <code> myclock = awful.widget.textclock({}, "%T", 1)<br/> myclock_t = awful.tooltip({<br/> objects = { myclock },<br/> timer_function = function()<br/> return os.date("Today is %A %B %d %Y\nThe time is %T")<br/> end,<br/> })<br/> </code> </p> <p>How to add the same tooltip to several objects?<br/> <code> myclock_t:add_to_object(obj1)<br/> myclock_t:add_to_object(obj2)<br/> </code> Now the same tooltip is attached to <code>myclock</code>, <code>obj1</code>, <code>obj2</code>.<br/> </p> <p>How to remove tooltip from many objects?<br/> <code> myclock_t:remove_from_object(obj1)<br/> myclock_t:remove_from_object(obj2)<br/> </code> Now the same tooltip is only attached to <code>myclock</code>.<br/> </p></p>
<p><b>Author:</b>
<table class="authors_list">
<tr><td class="name">Sébastien Gross <seb•ɱɩɲʋʃ•awesome•ɑƬ•chezwam•ɖɵʈ•org></td></tr>
</table>
</p>
<p>Copyright© 2009 Sébastien Gross</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="#add_to_object">add_to_object</a> (self, object)</td>
<td class="summary">Add tooltip to an object.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#new">new</a> (args)</td>
<td class="summary">Create a new tooltip and link it to a widget.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#remove_from_object">remove_from_object</a> (self, object)</td>
<td class="summary">Remove tooltip from an object.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_text">set_text</a> (self, text)</td>
<td class="summary">Change displayed text.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_timeout">set_timeout</a> (self, timeout)</td>
<td class="summary">Change the tooltip's update interval.</td>
</tr>
</table>
<h2>Tables</h2>
<table class="table_list">
<tr>
<td class="name" nowrap><a href="#tooltip">tooltip</a></td>
<td class="summary">Tooltip object definition.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="add_to_object"></a><strong>add_to_object</strong> (self, object)</dt>
<dd>
Add tooltip to an object.
<h3>Parameters</h3>
<ul>
<li>
self: The tooltip.
</li>
<li>
object: An object.
</li>
</ul>
</dd>
<dt><a name="new"></a><strong>new</strong> (args)</dt>
<dd>
Create a new tooltip and link it to a widget.
<h3>Parameters</h3>
<ul>
<li>
args: Arguments for tooltip creation may containt:<br/> <code>timeout</code>: The timeout value for update_func.<br/> <code>timer_function</code>: A function to dynamicaly change the tooltip text.<br/> <code>objects</code>: A list of objects linked to the tooltip.<br/>
</li>
</ul>
<h3>Return value:</h3>
The created tooltip.
<h3>See also:</h3>
<ul>
<li><a href="../modules/awful.tooltip.html#add_to_object">
add_to_object
</a>
<li><a href="../modules/awful.tooltip.html#set_timeout">
set_timeout
</a>
<li><a href="../modules/awful.tooltip.html#set_text">
set_text
</a>
</ul>
</dd>
<dt><a name="remove_from_object"></a><strong>remove_from_object</strong> (self, object)</dt>
<dd>
Remove tooltip from an object.
<h3>Parameters</h3>
<ul>
<li>
self: The tooltip.
</li>
<li>
object: An object.
</li>
</ul>
</dd>
<dt><a name="set_text"></a><strong>set_text</strong> (self, text)</dt>
<dd>
Change displayed text.
<h3>Parameters</h3>
<ul>
<li>
self: The tooltip object.
</li>
<li>
text: New tooltip text.
</li>
</ul>
</dd>
<dt><a name="set_timeout"></a><strong>set_timeout</strong> (self, timeout)</dt>
<dd>
Change the tooltip's update interval.
<h3>Parameters</h3>
<ul>
<li>
self: A tooltip object.
</li>
<li>
timeout: The timeout value.
</li>
</ul>
</dd>
</dl>
<h2><a name="tables"></a>Tables</h2>
<dl class="table">
<dt><a name="tooltip"></a><strong>tooltip</strong></dt>
<dd>Tooltip object definition.
<em>Fields</em>
<ul>
<li>
wibox: The wibox displaying the tooltip.
</li>
<li>
visible: True if tooltip is visible.
</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>
