<!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><strong>awful.menu</strong></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>
<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.menu</code></h1>
<p>Creation of menus.</p>
<p><b>Authors:</b>
<table class="authors_list">
<tr><td class="name">Damien Leone <damien.leone@gmail.com></td></tr>
<tr><td class="name">Julien Danjou <julien@danjou.info></td></tr>
</table>
</p>
<p>Copyright© 2008 Damien Leone, 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="#clients">clients</a> (menu, args, args.keygrabber)</td>
<td class="summary">Build a popup menu with running clients and shows it.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#hide">hide</a> (menu)</td>
<td class="summary">Hide a menu popup.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#new">new</a> (menu, parent, num)</td>
<td class="summary">Open a menu popup.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#show">show</a> (menu, args, args.keygrabber, args.coords)</td>
<td class="summary">Show a menu.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#toggle">toggle</a> (menu, args, args.keygrabber, args.coords)</td>
<td class="summary">Toggle menu visibility.</td>
</tr>
</table>
<h2>Tables</h2>
<table class="table_list">
<tr>
<td class="name" nowrap><a href="#menu_keys">menu_keys</a></td>
<td class="summary">Key bindings for menu navigation.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="clients"></a><strong>clients</strong> (menu, args, args.keygrabber)</dt>
<dd>
Build a popup menu with running clients and shows it.
<h3>Parameters</h3>
<ul>
<li>
menu: Menu table, see new() function for more informations
</li>
<li>
args:
</li>
<li>
args.keygrabber: A boolean enabling or not the keyboard navigation.
</li>
</ul>
<h3>Return value:</h3>
The menu.
</dd>
<dt><a name="hide"></a><strong>hide</strong> (menu)</dt>
<dd>
Hide a menu popup.
<h3>Parameters</h3>
<ul>
<li>
menu: The menu to hide.
</li>
</ul>
</dd>
<dt><a name="new"></a><strong>new</strong> (menu, parent, num)</dt>
<dd>
Open a menu popup.
<h3>Parameters</h3>
<ul>
<li>
menu: Table containing the menu informations.<br/> <ul> <li> Key items: Table containing the displayed items. Each element is a table containing: item name, triggered action, submenu table or function, item icon (optional). </li> <li> Keys [fg|bg]_[focus|normal], border, border_width, submenu_icon, height and width override the default display for your menu, each of them are optional. </li> <li> Key auto_expand controls the submenu auto expand behaviour by setting it to true (default) or false. </li> </ul>
</li>
<li>
parent: Specify the parent menu if we want to open a submenu, this value should never be set by the user.
</li>
<li>
num: Specify the parent's clicked item number if we want to open a submenu, this value should never be set by the user.
</li>
</ul>
<h3>Usage:</h3>
The following function builds, and shows a menu of clients that match a particular rule. Bound to a key, it can for example be used to select from dozens of terminals open on several tags. With the use of <code>match_any</code> instead of <code>match</code>, menu of clients with different classes can also be build. <p><code> function terminal_menu () <br/> terms = {} <br/> for i, c in pairs(client.get()) do <br/> if awful.rules.match(c, {class = "URxvt"}) then <br/> terms[i] = <br/> {c.name, <br/> function() <br/> awful.tag.viewonly(c:tags()[1]) <br/> client.focus = c <br/> end, <br/> c.icon <br/> } <br/> end <br/> end <br/> m = awful.menu({items = terms}) <br/> m:show({keygrabber=true}) <br/> return m <br/> end <br/> </code></p>
</dd>
<dt><a name="show"></a><strong>show</strong> (menu, args, args.keygrabber, args.coords)</dt>
<dd>
Show a menu.
<h3>Parameters</h3>
<ul>
<li>
menu: The menu to show.
</li>
<li>
args:
</li>
<li>
args.keygrabber: A boolean enabling or not the keyboard navigation.
</li>
<li>
args.coords: Menu position defaulting to mouse.coords()
</li>
</ul>
</dd>
<dt><a name="toggle"></a><strong>toggle</strong> (menu, args, args.keygrabber, args.coords)</dt>
<dd>
Toggle menu visibility.
<h3>Parameters</h3>
<ul>
<li>
menu: The menu to show if it's hidden, or to hide if it's shown.
</li>
<li>
args:
</li>
<li>
args.keygrabber: A boolean enabling or not the keyboard navigation.
</li>
<li>
args.coords: Menu position {x,y}
</li>
</ul>
</dd>
</dl>
<h2><a name="tables"></a>Tables</h2>
<dl class="table">
<dt><a name="menu_keys"></a><strong>menu_keys</strong></dt>
<dd>Key bindings for menu navigation. Keys are: up, down, exec, back, close. Value are table with a list of valid keys for the action, i.e. menu_keys.up = { "j", "k" } will bind 'j' and 'k' key to up action. This is common to all created menu.
</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>
