<!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><strong>client</strong></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>client</code></h1>
<p>awesome client 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="#add_signal">add_signal</a> (name, func)</td>
<td class="summary">Add a signal.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#buttons">buttons</a> (buttons_table)</td>
<td class="summary">Get or set mouse buttons bindings for a client.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#emit_signal">emit_signal</a> (name, ...)</td>
<td class="summary">Emit a signal.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#geometry">geometry</a> (arg1)</td>
<td class="summary">Return client geometry.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#get">get</a> (screen)</td>
<td class="summary">Get all clients into a table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#isvisible">isvisible</a> ()</td>
<td class="summary">Check if a client is visible on its screen.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#keys">keys</a> (keys_table)</td>
<td class="summary">Get or set keys bindings for a client.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#kill">kill</a> ()</td>
<td class="summary">Kill a client.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#lower">lower</a> ()</td>
<td class="summary">Lower a client on bottom of others which are on the same layer.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#raise">raise</a> ()</td>
<td class="summary">Raise a client on top of others which are on the same layer.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#redraw">redraw</a> ()</td>
<td class="summary">Redraw a client by unmapping and mapping it quickly.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#remove_signal">remove_signal</a> (name, func)</td>
<td class="summary">Remove a signal.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#struts">struts</a> (struts)</td>
<td class="summary">Return client struts (reserved space at the edge of the screen).</td>
</tr>
<tr>
<td class="name" nowrap><a href="#swap">swap</a> (c)</td>
<td class="summary">Swap a client with another one in global client list.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#tags">tags</a> (tags_table)</td>
<td class="summary">Access or set the client tags.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#unmanage">unmanage</a> ()</td>
<td class="summary">Stop managing a client.</td>
</tr>
</table>
<h2>Tables</h2>
<table class="table_list">
<tr>
<td class="name" nowrap><a href="#client">client</a></td>
<td class="summary">Client object.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="add_signal"></a><strong>add_signal</strong> (name, func)</dt>
<dd>
Add a signal.
<h3>Parameters</h3>
<ul>
<li>
name: A signal name.
</li>
<li>
func: A function to call when the signal is emitted.
</li>
</ul>
</dd>
<dt><a name="buttons"></a><strong>buttons</strong> (buttons_table)</dt>
<dd>
Get or set mouse buttons bindings for a client.
<h3>Parameters</h3>
<ul>
<li>
buttons_table: An array of mouse button bindings objects, or nothing.
</li>
</ul>
<h3>Return value:</h3>
A table with all buttons.
</dd>
<dt><a name="emit_signal"></a><strong>emit_signal</strong> (name, ...)</dt>
<dd>
Emit a signal.
<h3>Parameters</h3>
<ul>
<li>
name: A signal name.
</li>
<li>
...: Various arguments, optional.
</li>
</ul>
</dd>
<dt><a name="geometry"></a><strong>geometry</strong> (arg1)</dt>
<dd>
Return client geometry.
<h3>Parameters</h3>
<ul>
<li>
arg1: A table with new coordinates, or none.
</li>
</ul>
<h3>Return value:</h3>
A table with client coordinates.
</dd>
<dt><a name="get"></a><strong>get</strong> (screen)</dt>
<dd>
Get all clients into a table.
<h3>Parameters</h3>
<ul>
<li>
screen: An optional screen number.
</li>
</ul>
<h3>Return value:</h3>
A table with all clients.
</dd>
<dt><a name="isvisible"></a><strong>isvisible</strong> ()</dt>
<dd>
Check if a client is visible on its screen.
<h3>Return value:</h3>
A boolean value, true if the client is visible, false otherwise.
</dd>
<dt><a name="keys"></a><strong>keys</strong> (keys_table)</dt>
<dd>
Get or set keys bindings for a client.
<h3>Parameters</h3>
<ul>
<li>
keys_table: An array of key bindings objects, or nothing.
</li>
</ul>
<h3>Return value:</h3>
A table with all keys.
</dd>
<dt><a name="kill"></a><strong>kill</strong> ()</dt>
<dd>
Kill a client.
</dd>
<dt><a name="lower"></a><strong>lower</strong> ()</dt>
<dd>
Lower a client on bottom of others which are on the same layer.
</dd>
<dt><a name="raise"></a><strong>raise</strong> ()</dt>
<dd>
Raise a client on top of others which are on the same layer.
</dd>
<dt><a name="redraw"></a><strong>redraw</strong> ()</dt>
<dd>
Redraw a client by unmapping and mapping it quickly.
</dd>
<dt><a name="remove_signal"></a><strong>remove_signal</strong> (name, func)</dt>
<dd>
Remove a signal.
<h3>Parameters</h3>
<ul>
<li>
name: A signal name.
</li>
<li>
func: A function to remove.
</li>
</ul>
</dd>
<dt><a name="struts"></a><strong>struts</strong> (struts)</dt>
<dd>
Return client struts (reserved space at the edge of the screen).
<h3>Parameters</h3>
<ul>
<li>
struts: A table with new strut values, or none.
</li>
</ul>
<h3>Return value:</h3>
A table with strut values.
</dd>
<dt><a name="swap"></a><strong>swap</strong> (c)</dt>
<dd>
Swap a client with another one in global client list.
<h3>Parameters</h3>
<ul>
<li>
c: A client to swap with.
</li>
</ul>
</dd>
<dt><a name="tags"></a><strong>tags</strong> (tags_table)</dt>
<dd>
Access or set the client tags.
<h3>Parameters</h3>
<ul>
<li>
tags_table: A table with tags to set, or none to get the current tags table.
</li>
</ul>
<h3>Return value:</h3>
A table with all tags.
</dd>
<dt><a name="unmanage"></a><strong>unmanage</strong> ()</dt>
<dd>
Stop managing a client.
</dd>
</dl>
<h2><a name="tables"></a>Tables</h2>
<dl class="table">
<dt><a name="client"></a><strong>client</strong></dt>
<dd>Client object.
<em>Fields</em>
<ul>
<li>
window: The X window id.
</li>
<li>
name: The client title.
</li>
<li>
skip_taskbar: True if the client does not want to be in taskbar.
</li>
<li>
type: The window type (desktop, normal, dock, …).
</li>
<li>
class: The client class.
</li>
<li>
instance: The client instance.
</li>
<li>
pid: The client PID, if available.
</li>
<li>
role: The window role, if available.
</li>
<li>
machine: The machine client is running on.
</li>
<li>
icon_name: The client name when iconified.
</li>
<li>
icon: The client icon.
</li>
<li>
screen: Client screen.
</li>
<li>
hidden: Define if the client must be hidden, i.e. never mapped, invisible in taskbar.
</li>
<li>
minimized: Define it the client must be iconify, i.e. only visible in taskbar.
</li>
<li>
size_hints_honor: Honor size hints, i.e. respect size ratio.
</li>
<li>
border_width: The client border width.
</li>
<li>
border_color: The client border color.
</li>
<li>
titlebar: The client titlebar.
</li>
<li>
urgent: The client urgent state.
</li>
<li>
content: An image representing the client window content (screenshot).
</li>
<li>
focus: The focused client.
</li>
<li>
opacity: The client opacity between 0 and 1.
</li>
<li>
ontop: The client is on top of every other windows.
</li>
<li>
above: The client is above normal windows.
</li>
<li>
below: The client is below normal windows.
</li>
<li>
fullscreen: The client is fullscreen or not.
</li>
<li>
maximized_horizontal: The client is maximized horizontally or not.
</li>
<li>
maximized_vertical: The client is maximized vertically or not.
</li>
<li>
transient_for: The client the window is transient for.
</li>
<li>
group_window: Window identification unique to a group of windows.
</li>
<li>
leader_id: Identification unique to windows spawned by the same command.
</li>
<li>
size_hints: A table with size hints of the client: user_position, user_size, program_position, program_size, etc.
</li>
<li>
sticky: Set the client sticky, i.e. available on all tags.
</li>
<li>
modal: Indicate if the client is modal.
</li>
<li>
focusable: True if the client can receive the input focus.
</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>
