<!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><strong>awful.client</strong></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>
<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.client</code></h1>
<p>Useful client manipulation functions.</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 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="#cycle">cycle</a> (filter, start, s)</td>
<td class="summary">Returns an iterator to cycle through, starting from the client in focus or the given index, all clients that match a given criteria.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cycle">cycle</a> (filter, start, s)</td>
<td class="summary">Returns an iterator to cycle through, starting from the client in focus or the given index, all clients that match a given criteria.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#dockable.get">dockable.get</a> (c)</td>
<td class="summary">Get a client dockable state.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#dockable.set">dockable.set</a> (c, value)</td>
<td class="summary">Set a client dockable state, overriding auto-detection.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#floating.delete">floating.delete</a> (c)</td>
<td class="summary">Remove the floating information on a client.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#floating.get">floating.get</a> (c)</td>
<td class="summary">Get a client floating state.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#floating.set">floating.set</a> (c, s)</td>
<td class="summary">Set a client floating state, overriding auto-detection.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#floating.toggle">floating.toggle</a> (c)</td>
<td class="summary">Toggle the floating state of a client between 'auto' and 'true'.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#focus.bydirection">focus.bydirection</a> (dir, c)</td>
<td class="summary">Focus a client by the given direction.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#focus.byidx">focus.byidx</a> (i, c)</td>
<td class="summary">Focus a client by its relative index.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#focus.filter">focus.filter</a> (c)</td>
<td class="summary">Filter out window that we do not want handled by focus.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#focus.history.add">focus.history.add</a> (c)</td>
<td class="summary">Update client focus history.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#focus.history.delete">focus.history.delete</a> (c)</td>
<td class="summary">Remove a client from the focus history </td>
</tr>
<tr>
<td class="name" nowrap><a href="#focus.history.get">focus.history.get</a> (screen, idx)</td>
<td class="summary">Get the latest focused client for a screen in history.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#focus.history.previous">focus.history.previous</a> ()</td>
<td class="summary">Focus the previous client in history.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#getmarked">getmarked</a> ()</td>
<td class="summary">Return the marked clients and empty the marked table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#getmaster">getmaster</a> (screen)</td>
<td class="summary">Get the master window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#idx">idx</a> (c)</td>
<td class="summary">Calculate a client's column number, index in that column, and number of visible clients in this column.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#incwfact">incwfact</a> (add, c)</td>
<td class="summary">Increment a client's window factor </td>
</tr>
<tr>
<td class="name" nowrap><a href="#isfixed">isfixed</a> (c)</td>
<td class="summary">Return if a client has a fixe size or not.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ismarked">ismarked</a> (c)</td>
<td class="summary">Check if a client is marked.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#mark">mark</a> (c)</td>
<td class="summary">Mark a client, and then call 'marked' hook.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#moveresize">moveresize</a> (x, y, w, h, c)</td>
<td class="summary">Move/resize a client relative to current coordinates.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#movetoscreen">movetoscreen</a> (c, s)</td>
<td class="summary">Move a client to a screen.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#movetotag">movetotag</a> (target, c)</td>
<td class="summary">Move a client to a tag.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#next">next</a> (i, c)</td>
<td class="summary">Get a client by its relative index to the focused window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#property.get">property.get</a> (c, prop)</td>
<td class="summary">Get a client property.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#property.set">property.set</a> (c, prop, value)</td>
<td class="summary">Set a client property.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#restore">restore</a> (s)</td>
<td class="summary">Restore (=unminimize) a random client.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#setslave">setslave</a> (c)</td>
<td class="summary">Set the client as slave: put it at the end of other windows.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#setwfact">setwfact</a> (wfact, c)</td>
<td class="summary">Set the window factor of a client </td>
</tr>
<tr>
<td class="name" nowrap><a href="#swap.bydirection">swap.bydirection</a> (dir, c)</td>
<td class="summary">Swap a client with another client in the given direction </td>
</tr>
<tr>
<td class="name" nowrap><a href="#swap.byidx">swap.byidx</a> (i, c)</td>
<td class="summary">Swap a client by its relative index.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#tiled">tiled</a> (screen)</td>
<td class="summary">Get visible and tiled clients </td>
</tr>
<tr>
<td class="name" nowrap><a href="#togglemarked">togglemarked</a> (c)</td>
<td class="summary">Toggle a client as marked.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#toggletag">toggletag</a> (target, c)</td>
<td class="summary">Toggle a tag on a client.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#unmark">unmark</a> (c)</td>
<td class="summary">Unmark a client and then call 'unmarked' hook.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#urgent.add">urgent.add</a> (c, prop)</td>
<td class="summary">Adds client to urgent stack.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#urgent.delete">urgent.delete</a> (c)</td>
<td class="summary">Remove client from urgent stack.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#urgent.get">urgent.get</a> ()</td>
<td class="summary">Get the first client that got the urgent hint.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#urgent.jumpto">urgent.jumpto</a> (merge)</td>
<td class="summary">Jump to the client that received the urgent hint first.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#visible">visible</a> (screen)</td>
<td class="summary">Get visible clients from a screen.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="cycle"></a><strong>cycle</strong> (filter, start, s)</dt>
<dd>
Returns an iterator to cycle through, starting from the client in focus or the given index, all clients that match a given criteria.
<h3>Parameters</h3>
<ul>
<li>
filter: a function that returns true to indicate a positive match
</li>
<li>
start: what index to start iterating from. Defaults to using the index of the currently focused client.
</li>
<li>
s: which screen to use. nil means all screens.
</li>
</ul>
<h3>Usage:</h3>
e.g.: un-minimize all urxvt instances <p><code> local urxvt = function (c) <br/> return awful.rules.match(c, {class = "URxvt"}) <br/> end <br/> </br> for c in awful.client.cycle(urxvt) do <br/> c.minimized = false <br/> end <br/> </code></p>
</dd>
<dt><a name="cycle"></a><strong>cycle</strong> (filter, start, s)</dt>
<dd>
Returns an iterator to cycle through, starting from the client in focus or the given index, all clients that match a given criteria.
<h3>Parameters</h3>
<ul>
<li>
filter: a function that returns true to indicate a positive match
</li>
<li>
start: what index to start iterating from. Defaults to using the index of the currently focused client.
</li>
<li>
s: which screen to use. nil means all screens.
</li>
</ul>
<h3>Usage:</h3>
e.g.: un-minimize all urxvt instances <p><code> local urxvt = function (c) <br/> return awful.rules.match(c, {class = "URxvt"}) <br/> end <br/> </br> for c in awful.client.cycle(urxvt) do <br/> c.minimized = false <br/> end <br/> </code></p>
</dd>
<dt><a name="dockable.get"></a><strong>dockable.get</strong> (c)</dt>
<dd>
Get a client dockable state.
<h3>Parameters</h3>
<ul>
<li>
c: A client.
</li>
</ul>
<h3>Return value:</h3>
True or false. Note that some windows might be dockable even if you did not set them manually. For example, windows with a type "utility", "toolbar" or "dock"
</dd>
<dt><a name="dockable.set"></a><strong>dockable.set</strong> (c, value)</dt>
<dd>
Set a client dockable state, overriding auto-detection. With this enabled you can dock windows by moving them from the center to the edge of the workarea.
<h3>Parameters</h3>
<ul>
<li>
c: A client.
</li>
<li>
value: True or false.
</li>
</ul>
</dd>
<dt><a name="floating.delete"></a><strong>floating.delete</strong> (c)</dt>
<dd>
Remove the floating information on a client.
<h3>Parameters</h3>
<ul>
<li>
c: The client.
</li>
</ul>
</dd>
<dt><a name="floating.get"></a><strong>floating.get</strong> (c)</dt>
<dd>
Get a client floating state.
<h3>Parameters</h3>
<ul>
<li>
c: A client.
</li>
</ul>
<h3>Return value:</h3>
True or false. Note that some windows might be floating even if you did not set them manually. For example, windows with a type different than normal.
</dd>
<dt><a name="floating.set"></a><strong>floating.set</strong> (c, s)</dt>
<dd>
Set a client floating state, overriding auto-detection. Floating client are not handled by tiling layouts.
<h3>Parameters</h3>
<ul>
<li>
c: A client.
</li>
<li>
s: True or false.
</li>
</ul>
</dd>
<dt><a name="floating.toggle"></a><strong>floating.toggle</strong> (c)</dt>
<dd>
Toggle the floating state of a client between 'auto' and 'true'.
<h3>Parameters</h3>
<ul>
<li>
c: A client.
</li>
</ul>
</dd>
<dt><a name="focus.bydirection"></a><strong>focus.bydirection</strong> (dir, c)</dt>
<dd>
Focus a client by the given direction.
<h3>Parameters</h3>
<ul>
<li>
dir: The direction, can be either "up", "down", "left" or "right".
</li>
<li>
c: Optional client.
</li>
</ul>
</dd>
<dt><a name="focus.byidx"></a><strong>focus.byidx</strong> (i, c)</dt>
<dd>
Focus a client by its relative index.
<h3>Parameters</h3>
<ul>
<li>
i: The index.
</li>
<li>
c: Optional client.
</li>
</ul>
</dd>
<dt><a name="focus.filter"></a><strong>focus.filter</strong> (c)</dt>
<dd>
Filter out window that we do not want handled by focus. This usually means that desktop, dock and splash windows are not registered and cannot get focus.
<h3>Parameters</h3>
<ul>
<li>
c: A client.
</li>
</ul>
<h3>Return value:</h3>
The same client if it's ok, nil otherwise.
</dd>
<dt><a name="focus.history.add"></a><strong>focus.history.add</strong> (c)</dt>
<dd>
Update client focus history.
<h3>Parameters</h3>
<ul>
<li>
c: The client that has been focused.
</li>
</ul>
</dd>
<dt><a name="focus.history.delete"></a><strong>focus.history.delete</strong> (c)</dt>
<dd>
Remove a client from the focus history
<h3>Parameters</h3>
<ul>
<li>
c: The client that must be removed.
</li>
</ul>
</dd>
<dt><a name="focus.history.get"></a><strong>focus.history.get</strong> (screen, idx)</dt>
<dd>
Get the latest focused client for a screen in history.
<h3>Parameters</h3>
<ul>
<li>
screen: The screen number to look for.
</li>
<li>
idx: The index: 0 will return first candidate, 1 will return second, etc.
</li>
</ul>
<h3>Return value:</h3>
A client.
</dd>
<dt><a name="focus.history.previous"></a><strong>focus.history.previous</strong> ()</dt>
<dd>
Focus the previous client in history.
</dd>
<dt><a name="getmarked"></a><strong>getmarked</strong> ()</dt>
<dd>
Return the marked clients and empty the marked table.
<h3>Return value:</h3>
A table with all marked clients.
</dd>
<dt><a name="getmaster"></a><strong>getmaster</strong> (screen)</dt>
<dd>
Get the master window.
<h3>Parameters</h3>
<ul>
<li>
screen: Optional screen number, otherwise screen mouse is used.
</li>
</ul>
<h3>Return value:</h3>
The master window.
</dd>
<dt><a name="idx"></a><strong>idx</strong> (c)</dt>
<dd>
Calculate a client's column number, index in that column, and number of visible clients in this column.
<h3>Parameters</h3>
<ul>
<li>
c: the client
</li>
</ul>
<h3>Return values:</h3>
<ol>
<li>col the column number
<li>idx index of the client in the column
<li>num the number of visible clients in the column
</ol>
</dd>
<dt><a name="incwfact"></a><strong>incwfact</strong> (add, c)</dt>
<dd>
Increment a client's window factor
<h3>Parameters</h3>
<ul>
<li>
add: amount to increase the client's window
</li>
<li>
c: the client
</li>
</ul>
</dd>
<dt><a name="isfixed"></a><strong>isfixed</strong> (c)</dt>
<dd>
Return if a client has a fixe size or not.
<h3>Parameters</h3>
<ul>
<li>
c: The client.
</li>
</ul>
</dd>
<dt><a name="ismarked"></a><strong>ismarked</strong> (c)</dt>
<dd>
Check if a client is marked.
<h3>Parameters</h3>
<ul>
<li>
c: The client to check, or the focused one otherwise.
</li>
</ul>
</dd>
<dt><a name="mark"></a><strong>mark</strong> (c)</dt>
<dd>
Mark a client, and then call 'marked' hook.
<h3>Parameters</h3>
<ul>
<li>
c: The client to mark, the focused one if not specified.
</li>
</ul>
<h3>Return value:</h3>
True if the client has been marked. False if the client was already marked.
</dd>
<dt><a name="moveresize"></a><strong>moveresize</strong> (x, y, w, h, c)</dt>
<dd>
Move/resize a client relative to current coordinates.
<h3>Parameters</h3>
<ul>
<li>
x: The relative x coordinate.
</li>
<li>
y: The relative y coordinate.
</li>
<li>
w: The relative width.
</li>
<li>
h: The relative height.
</li>
<li>
c: The optional client, otherwise focused one is used.
</li>
</ul>
</dd>
<dt><a name="movetoscreen"></a><strong>movetoscreen</strong> (c, s)</dt>
<dd>
Move a client to a screen. Default is next screen, cycling.
<h3>Parameters</h3>
<ul>
<li>
c: The client to move.
</li>
<li>
s: The screen number, default to current + 1.
</li>
</ul>
</dd>
<dt><a name="movetotag"></a><strong>movetotag</strong> (target, c)</dt>
<dd>
Move a client to a tag.
<h3>Parameters</h3>
<ul>
<li>
target: The tag to move the client to.
</li>
<li>
c: Optional client to move, otherwise the focused one is used.
</li>
</ul>
</dd>
<dt><a name="next"></a><strong>next</strong> (i, c)</dt>
<dd>
Get a client by its relative index to the focused window.
<h3>Parameters</h3>
<ul>
<li>
i: The index.
</li>
<li>
c: Optional client.
</li>
</ul>
<h3>Usage:</h3>
Set i to 1 to get next, -1 to get previous.
<h3>Return value:</h3>
A client, or nil if no client is available.
</dd>
<dt><a name="property.get"></a><strong>property.get</strong> (c, prop)</dt>
<dd>
Get a client property.
<h3>Parameters</h3>
<ul>
<li>
c: The client.
</li>
<li>
prop: The property name.
</li>
</ul>
<h3>Return value:</h3>
The property.
</dd>
<dt><a name="property.set"></a><strong>property.set</strong> (c, prop, value)</dt>
<dd>
Set a client property. This properties are internal to awful. Some are used to move clients, etc.
<h3>Parameters</h3>
<ul>
<li>
c: The client.
</li>
<li>
prop: The property name.
</li>
<li>
value: The value.
</li>
</ul>
</dd>
<dt><a name="restore"></a><strong>restore</strong> (s)</dt>
<dd>
Restore (=unminimize) a random client.
<h3>Parameters</h3>
<ul>
<li>
s: The screen to use.
</li>
</ul>
<h3>Return value:</h3>
True if some client was restored.
</dd>
<dt><a name="setslave"></a><strong>setslave</strong> (c)</dt>
<dd>
Set the client as slave: put it at the end of other windows.
<h3>Parameters</h3>
<ul>
<li>
c: The window to set as slave.
</li>
</ul>
</dd>
<dt><a name="setwfact"></a><strong>setwfact</strong> (wfact, c)</dt>
<dd>
Set the window factor of a client
<h3>Parameters</h3>
<ul>
<li>
wfact: the window factor value
</li>
<li>
c: the client
</li>
</ul>
</dd>
<dt><a name="swap.bydirection"></a><strong>swap.bydirection</strong> (dir, c)</dt>
<dd>
Swap a client with another client in the given direction
<h3>Parameters</h3>
<ul>
<li>
dir: The direction, can be either "up", "down", "left" or "right".
</li>
<li>
c: Optional client.
</li>
</ul>
</dd>
<dt><a name="swap.byidx"></a><strong>swap.byidx</strong> (i, c)</dt>
<dd>
Swap a client by its relative index.
<h3>Parameters</h3>
<ul>
<li>
i: The index.
</li>
<li>
c: Optional client, otherwise focused one is used.
</li>
</ul>
</dd>
<dt><a name="tiled"></a><strong>tiled</strong> (screen)</dt>
<dd>
Get visible and tiled clients
<h3>Parameters</h3>
<ul>
<li>
screen: The screen number, or nil for all screens.
</li>
</ul>
<h3>Return value:</h3>
A tabl with all visible and tiled clients.
</dd>
<dt><a name="togglemarked"></a><strong>togglemarked</strong> (c)</dt>
<dd>
Toggle a client as marked.
<h3>Parameters</h3>
<ul>
<li>
c: The client to toggle mark.
</li>
</ul>
</dd>
<dt><a name="toggletag"></a><strong>toggletag</strong> (target, c)</dt>
<dd>
Toggle a tag on a client.
<h3>Parameters</h3>
<ul>
<li>
target: The tag to toggle.
</li>
<li>
c: Optional client to toggle, otherwise the focused one is used.
</li>
</ul>
</dd>
<dt><a name="unmark"></a><strong>unmark</strong> (c)</dt>
<dd>
Unmark a client and then call 'unmarked' hook.
<h3>Parameters</h3>
<ul>
<li>
c: The client to unmark, or the focused one if not specified.
</li>
</ul>
<h3>Return value:</h3>
True if the client has been unmarked. False if the client was not marked.
</dd>
<dt><a name="urgent.add"></a><strong>urgent.add</strong> (c, prop)</dt>
<dd>
Adds client to urgent stack.
<h3>Parameters</h3>
<ul>
<li>
c: The client object.
</li>
<li>
prop: The property which is updated.
</li>
</ul>
</dd>
<dt><a name="urgent.delete"></a><strong>urgent.delete</strong> (c)</dt>
<dd>
Remove client from urgent stack.
<h3>Parameters</h3>
<ul>
<li>
c: The client object.
</li>
</ul>
</dd>
<dt><a name="urgent.get"></a><strong>urgent.get</strong> ()</dt>
<dd>
Get the first client that got the urgent hint.
<h3>Return value:</h3>
The first urgent client.
</dd>
<dt><a name="urgent.jumpto"></a><strong>urgent.jumpto</strong> (merge)</dt>
<dd>
Jump to the client that received the urgent hint first.
<h3>Parameters</h3>
<ul>
<li>
merge: If true then merge tags when clients are not visible.
</li>
</ul>
</dd>
<dt><a name="visible"></a><strong>visible</strong> (screen)</dt>
<dd>
Get visible clients from a screen.
<h3>Parameters</h3>
<ul>
<li>
screen: The screen number, or nil for all screens.
</li>
</ul>
<h3>Return value:</h3>
A table with all visible clients.
</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>
