<!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> <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><strong>root</strong></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>root</code></h1> <p>awesome root window API</p> <p><b>Author:</b> <table class="authors_list"> <tr><td class="name">Julien Danjou <julien@danjou.info></td></tr> </table> </p> <p>Copyright© 2008-2009 Julien Danjou</p> <h2>Functions</h2> <table class="function_list"> <tr> <td class="name" nowrap><a href="#buttons">buttons</a> (button_table)</td> <td class="summary">Get or set global mouse bindings.</td> </tr> <tr> <td class="name" nowrap><a href="#cursor">cursor</a> (cursor_name)</td> <td class="summary">Set the root cursor.</td> </tr> <tr> <td class="name" nowrap><a href="#fake_input">fake_input</a> (event_type, detail, x, y, screen)</td> <td class="summary">Send fake events.</td> </tr> <tr> <td class="name" nowrap><a href="#keys">keys</a> (keys_array)</td> <td class="summary">Get or set global key bindings.</td> </tr> <tr> <td class="name" nowrap><a href="#wiboxes">wiboxes</a> ()</td> <td class="summary">Get the wiboxes attached to a screen.</td> </tr> </table> <br/> <br/> <h2><a name="functions"></a>Functions</h2> <dl class="function"> <dt><a name="buttons"></a><strong>buttons</strong> (button_table)</dt> <dd> Get or set global mouse bindings. This binding will be available when you'll click on root window. <h3>Parameters</h3> <ul> <li> button_table: An array of mouse button bindings objects, or nothing. </li> </ul> <h3>Return value:</h3> The array of mouse button bindings objects. </dd> <dt><a name="cursor"></a><strong>cursor</strong> (cursor_name)</dt> <dd> Set the root cursor. <h3>Parameters</h3> <ul> <li> cursor_name: A X cursor name. </li> </ul> </dd> <dt><a name="fake_input"></a><strong>fake_input</strong> (event_type, detail, x, y, screen)</dt> <dd> Send fake events. Usually the current focused client will get it. <h3>Parameters</h3> <ul> <li> event_type: The event type: key_press, key_release, button_press, button_release or motion_notify. </li> <li> detail: The detail: in case of a key event, this is the keycode to send, in case of a button event this is the number of the button. In case of a motion event, this is a boolean value which if true make the coordinates relatives. </li> <li> x: In case of a motion event, this is the X coordinate. </li> <li> y: In case of a motion event, this is the Y coordinate. </li> <li> screen: In case of a motion event, this is the screen number to move on. If not specified, the current one is used. </li> </ul> </dd> <dt><a name="keys"></a><strong>keys</strong> (keys_array)</dt> <dd> Get or set global key bindings. This binding will be available when you'll press keys on root window. <h3>Parameters</h3> <ul> <li> keys_array: An array of key bindings objects, or nothing. </li> </ul> <h3>Return value:</h3> The array of key bindings objects of this client. </dd> <dt><a name="wiboxes"></a><strong>wiboxes</strong> ()</dt> <dd> Get the wiboxes attached to a screen. <h3>Return value:</h3> A table with all wiboxes. </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>