<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Rumai::Client</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="../../css/reset.css" type="text/css" media="screen" />
<link rel="stylesheet" href="../../css/main.css" type="text/css" media="screen" />
<script src="../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
<script src="../../js/main.js" type="text/javascript" charset="utf-8"></script>
</head>
<body>
<div class="banner">
<h1>
<span class="type">Class</span>
Rumai::Client
<span class="parent"><
WidgetNode
</span>
</h1>
<ul class="files">
<li><a href="../../files/lib/rumai/wm_rb.html">lib/rumai/wm.rb</a></li>
</ul>
</div>
<div id="bodyContent">
<div id="content">
<div class="description">
<p>
A graphical program that is running in your current X Windows session.
</p>
</div>
<div class="sectiontitle">Methods</div>
<dl class="methods">
<dt>A</dt>
<dd>
<ul>
<li><a href="#M000040">area</a></li>
</ul>
</dd>
<dt>C</dt>
<dd>
<ul>
<li><a href="#M000024">chain</a>,</li>
<li><a href="#M000023">curr</a></li>
</ul>
</dd>
<dt>F</dt>
<dd>
<ul>
<li><a href="#M000025">focus</a>,</li>
<li><a href="#M000031">fullscreen</a>,</li>
<li><a href="#M000033">fullscreen!</a>,</li>
<li><a href="#M000034">fullscreen?</a></li>
</ul>
</dd>
<dt>G</dt>
<dd>
<ul>
<li><a href="#M000050">group</a>,</li>
<li><a href="#M000054">group!</a>,</li>
<li><a href="#M000049">group?</a></li>
</ul>
</dd>
<dt>K</dt>
<dd>
<ul>
<li><a href="#M000029">kill</a></li>
</ul>
</dd>
<dt>M</dt>
<dd>
<ul>
<li><a href="#M000027">move</a></li>
</ul>
</dd>
<dt>N</dt>
<dd>
<ul>
<li><a href="#M000021">new</a></li>
</ul>
</dd>
<dt>S</dt>
<dd>
<ul>
<li><a href="#M000026">send</a>,</li>
<li><a href="#M000030">slay</a>,</li>
<li><a href="#M000037">stick</a>,</li>
<li><a href="#M000039">stick!</a>,</li>
<li><a href="#M000036">stick?</a>,</li>
<li><a href="#M000028">swap</a></li>
</ul>
</dd>
<dt>T</dt>
<dd>
<ul>
<li><a href="#M000046">tag</a>,</li>
<li><a href="#M000042">tags</a>,</li>
<li><a href="#M000043">tags=</a></li>
</ul>
</dd>
<dt>U</dt>
<dd>
<ul>
<li><a href="#M000032">unfullscreen</a>,</li>
<li><a href="#M000051">ungroup</a>,</li>
<li><a href="#M000038">unstick</a>,</li>
<li><a href="#M000047">untag</a></li>
</ul>
</dd>
<dt>V</dt>
<dd>
<ul>
<li><a href="#M000041">views</a></li>
</ul>
</dd>
<dt>W</dt>
<dd>
<ul>
<li><a href="#M000044">with_tags</a></li>
</ul>
</dd>
</dl>
<div class="sectiontitle">Included Modules</div>
<ul>
<li>
<a href="IXP/Struct/Field/CounterField.html">Rumai::IXP::Struct::Field::CounterField</a>
START:includes
</li>
</ul>
<div class="sectiontitle">Constants</div>
<table border='0' cellpadding='5'>
<tr valign='top'>
<td class="attr-name">TAG_DELIMITER</td>
<td>=</td>
<td class="attr-value">'+'.freeze</td>
</tr>
<tr valign='top'>
<td> </td>
<td colspan="2" class="attr-desc"><p>
tag manipulations
</p>
</td>
</tr>
</table>
<div class="sectiontitle">Class Public methods</div>
<div class="method">
<div class="title" id="M000023">
<a name="M000023"></a><b>curr</b>()
</div>
<div class="description">
<p>
Returns the currently focused client.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000023_source')" id="l_M000023_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L114" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000023_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 114</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">curr</span>
<span class="ruby-identifier">new</span> <span class="ruby-constant">FOCUSED_WIDGET_ID</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000021">
<a name="M000021"></a><b>new</b>(client_id)
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000021_source')" id="l_M000021_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L107" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000021_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 107</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">client_id</span>
<span class="ruby-keyword kw">super</span> <span class="ruby-identifier">client_id</span>, <span class="ruby-value str">'/client'</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="sectiontitle">Instance Public methods</div>
<div class="method">
<div class="title" id="M000040">
<a name="M000040"></a><b>area</b>(view = View.curr)
</div>
<div class="description">
<p>
Returns the area that contains this client within the given view.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000040_source')" id="l_M000040_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L256" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000040_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 256</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">area</span> <span class="ruby-identifier">view</span> = <span class="ruby-constant">View</span>.<span class="ruby-identifier">curr</span>
<span class="ruby-identifier">view</span>.<span class="ruby-identifier">area_of_client</span> <span class="ruby-keyword kw">self</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000024">
<a name="M000024"></a><b>chain</b>()
</div>
<div class="description">
<p>
Returns a list of all clients in the current view.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000024_source')" id="l_M000024_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L123" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000024_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 123</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">chain</span>
<span class="ruby-constant">View</span>.<span class="ruby-identifier">curr</span>.<span class="ruby-identifier">clients</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000025">
<a name="M000025"></a><b>focus</b>(view = nil)
</div>
<div class="description">
<p>
Focuses this client within the given view.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000025_source')" id="l_M000025_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L132" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000025_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 132</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">focus</span> <span class="ruby-identifier">view</span> = <span class="ruby-keyword kw">nil</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">exist?</span> <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">focus?</span>
(<span class="ruby-identifier">view</span> <span class="ruby-value">? </span>[<span class="ruby-identifier">view</span>] <span class="ruby-operator">:</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">views</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">a</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">area</span>(<span class="ruby-identifier">v</span>) <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">exist?</span>
<span class="ruby-identifier">v</span>.<span class="ruby-identifier">focus</span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">focus</span>
<span class="ruby-comment cmt"># slide focus from the current client onto this client</span>
<span class="ruby-identifier">arr</span> = <span class="ruby-identifier">a</span>.<span class="ruby-identifier">client_ids</span>
<span class="ruby-identifier">src</span> = <span class="ruby-identifier">arr</span>.<span class="ruby-identifier">index</span> <span class="ruby-constant">Client</span>.<span class="ruby-identifier">curr</span>.<span class="ruby-identifier">id</span>
<span class="ruby-identifier">dst</span> = <span class="ruby-identifier">arr</span>.<span class="ruby-identifier">index</span> <span class="ruby-ivar">@id</span>
<span class="ruby-identifier">distance</span> = (<span class="ruby-identifier">src</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">dst</span>).<span class="ruby-identifier">abs</span>
<span class="ruby-identifier">direction</span> = <span class="ruby-identifier">src</span> <span class="ruby-operator"><</span> <span class="ruby-identifier">dst</span> <span class="ruby-value">? </span><span class="ruby-operator">:</span><span class="ruby-identifier">down</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">:up</span>
<span class="ruby-identifier">distance</span>.<span class="ruby-identifier">times</span> { <span class="ruby-identifier">v</span>.<span class="ruby-identifier">move_focus</span> <span class="ruby-identifier">direction</span> }
<span class="ruby-keyword kw">break</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000031">
<a name="M000031"></a><b>fullscreen</b>()
</div>
<div class="description">
<p>
Maximizes this client to occupy the entire screen on the current view.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000031_source')" id="l_M000031_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L190" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000031_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 190</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fullscreen</span>
<span class="ruby-identifier">ctl</span>.<span class="ruby-identifier">write</span> <span class="ruby-value str">'Fullscreen on'</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000033">
<a name="M000033"></a><b>fullscreen!</b>()
</div>
<div class="description">
<p>
Toggles the fullscreen status of this client on the current view.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000033_source')" id="l_M000033_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L204" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000033_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 204</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fullscreen!</span>
<span class="ruby-identifier">ctl</span>.<span class="ruby-identifier">write</span> <span class="ruby-value str">'Fullscreen toggle'</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000034">
<a name="M000034"></a><b>fullscreen?</b>()
</div>
<div class="description">
<p>
Checks if this client is currently fullscreen on the current view.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000034_source')" id="l_M000034_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L211" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000034_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 211</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fullscreen?</span>
<span class="ruby-comment cmt">#</span>
<span class="ruby-comment cmt"># If the client's dimensions match those of the</span>
<span class="ruby-comment cmt"># floating area, then we know it is fullscreen.</span>
<span class="ruby-comment cmt">#</span>
<span class="ruby-constant">View</span>.<span class="ruby-identifier">curr</span>.<span class="ruby-identifier">manifest</span> <span class="ruby-operator">=~</span> <span class="ruby-node">/^# #{FLOATING_AREA_ID} (\d+) (\d+)\n.*^#{FLOATING_AREA_ID} #{@id} \d+ \d+ \1 \2 /</span><span class="ruby-identifier">m</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000050">
<a name="M000050"></a><b>group</b>()
</div>
<div class="description">
<p>
Adds this client to the current grouping.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000050_source')" id="l_M000050_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L328" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000050_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 328</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">group</span>
<span class="ruby-identifier">with_tags</span> <span class="ruby-keyword kw">do</span>
<span class="ruby-identifier">push</span> <span class="ruby-constant">CLIENT_GROUPING_TAG</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000054">
<a name="M000054"></a><b>group!</b>()
</div>
<div class="description">
<p>
Toggles the presence of this client in the current grouping.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000054_source')" id="l_M000054_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L344" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000054_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 344</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">group!</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">group?</span>
<span class="ruby-identifier">ungroup</span>
<span class="ruby-keyword kw">else</span>
<span class="ruby-identifier">group</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000049">
<a name="M000049"></a><b>group?</b>()
</div>
<div class="description">
<p>
Checks if this client is included in the current grouping.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000049_source')" id="l_M000049_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L321" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000049_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 321</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">group?</span>
<span class="ruby-identifier">tags</span>.<span class="ruby-identifier">include?</span> <span class="ruby-constant">CLIENT_GROUPING_TAG</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000029">
<a name="M000029"></a><b>kill</b>()
</div>
<div class="description">
<p>
Terminates this client nicely (requests this window to be closed).
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000029_source')" id="l_M000029_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L176" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000029_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 176</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">kill</span>
<span class="ruby-identifier">ctl</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">:kill</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000027">
<a name="M000027"></a><b>move</b>(area_or_id, view = View.curr)
</div>
<div class="description">
<p>
Alias for <a href="Client.html#M000026">send</a>
</p>
</div>
</div>
<div class="method">
<div class="title" id="M000026">
<a name="M000026"></a><b>send</b>(area_or_id, view = View.curr)
</div>
<div class="description">
<p>
Sends this client to the given destination within the given view.
</p>
</div>
<div class="aka">
This method is also aliased as
<a href="Client.html#M000027">move</a>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000026_source')" id="l_M000026_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L158" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000026_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 158</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send</span> <span class="ruby-identifier">area_or_id</span>, <span class="ruby-identifier">view</span> = <span class="ruby-constant">View</span>.<span class="ruby-identifier">curr</span>
<span class="ruby-identifier">dst</span> = <span class="ruby-identifier">area_to_id</span>(<span class="ruby-identifier">area_or_id</span>)
<span class="ruby-identifier">view</span>.<span class="ruby-identifier">ctl</span>.<span class="ruby-identifier">write</span> <span class="ruby-node">"send #{@id} #{dst}"</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000030">
<a name="M000030"></a><b>slay</b>()
</div>
<div class="description">
<p>
Terminates this client forcefully.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000030_source')" id="l_M000030_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L183" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000030_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 183</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">slay</span>
<span class="ruby-identifier">ctl</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">:slay</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000037">
<a name="M000037"></a><b>stick</b>()
</div>
<div class="description">
<p>
Makes this client sticky (appears in all views).
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000037_source')" id="l_M000037_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L229" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000037_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 229</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stick</span>
<span class="ruby-identifier">tag</span> <span class="ruby-constant">CLIENT_STICKY_TAG</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000039">
<a name="M000039"></a><b>stick!</b>()
</div>
<div class="description">
<p>
Toggles the stickyness of this client.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000039_source')" id="l_M000039_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L243" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000039_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 243</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stick!</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">stick?</span>
<span class="ruby-identifier">unstick</span>
<span class="ruby-keyword kw">else</span>
<span class="ruby-identifier">stick</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000036">
<a name="M000036"></a><b>stick?</b>()
</div>
<div class="description">
<p>
Checks if this client is sticky (appears in all views).
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000036_source')" id="l_M000036_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L222" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000036_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 222</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stick?</span>
<span class="ruby-identifier">tags</span>.<span class="ruby-identifier">include?</span> <span class="ruby-constant">CLIENT_STICKY_TAG</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000028">
<a name="M000028"></a><b>swap</b>(area_or_id, view = View.curr)
</div>
<div class="description">
<p>
Swaps this client with the given destination within the given view.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000028_source')" id="l_M000028_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L168" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000028_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 168</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">swap</span> <span class="ruby-identifier">area_or_id</span>, <span class="ruby-identifier">view</span> = <span class="ruby-constant">View</span>.<span class="ruby-identifier">curr</span>
<span class="ruby-identifier">dst</span> = <span class="ruby-identifier">area_to_id</span>(<span class="ruby-identifier">area_or_id</span>)
<span class="ruby-identifier">view</span>.<span class="ruby-identifier">ctl</span>.<span class="ruby-identifier">write</span> <span class="ruby-node">"swap #{@id} #{dst}"</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000046">
<a name="M000046"></a><b>tag</b>(*tags)
</div>
<div class="description">
<p>
Adds the given tags to this client.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000046_source')" id="l_M000046_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L299" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000046_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 299</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tag</span> <span class="ruby-operator">*</span><span class="ruby-identifier">tags</span>
<span class="ruby-identifier">with_tags</span> <span class="ruby-keyword kw">do</span>
<span class="ruby-identifier">concat</span> <span class="ruby-identifier">tags</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000042">
<a name="M000042"></a><b>tags</b>()
</div>
<div class="description">
<p>
Returns the tags associated with this client.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000042_source')" id="l_M000042_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L274" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000042_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 274</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tags</span>
<span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">:tags</span>].<span class="ruby-identifier">read</span>.<span class="ruby-identifier">split</span> <span class="ruby-constant">TAG_DELIMITER</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000043">
<a name="M000043"></a><b>tags=</b>(*tags)
</div>
<div class="description">
<p>
Modifies the tags associated with this client.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000043_source')" id="l_M000043_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L281" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000043_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 281</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tags=</span> <span class="ruby-operator">*</span><span class="ruby-identifier">tags</span>
<span class="ruby-identifier">arr</span> = <span class="ruby-identifier">tags</span>.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">uniq</span>
<span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">:tags</span>].<span class="ruby-identifier">write</span> <span class="ruby-identifier">arr</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">TAG_DELIMITER</span>)
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000032">
<a name="M000032"></a><b>unfullscreen</b>()
</div>
<div class="description">
<p>
Restores this client back to its original size on the current view.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000032_source')" id="l_M000032_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L197" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000032_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 197</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unfullscreen</span>
<span class="ruby-identifier">ctl</span>.<span class="ruby-identifier">write</span> <span class="ruby-value str">'Fullscreen off'</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000051">
<a name="M000051"></a><b>ungroup</b>()
</div>
<div class="description">
<p>
Removes this client to the current grouping.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000051_source')" id="l_M000051_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L337" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000051_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 337</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ungroup</span>
<span class="ruby-identifier">untag</span> <span class="ruby-constant">CLIENT_GROUPING_TAG</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000038">
<a name="M000038"></a><b>unstick</b>()
</div>
<div class="description">
<p>
Makes this client unsticky (does not appear in all views).
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000038_source')" id="l_M000038_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L236" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000038_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 236</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unstick</span>
<span class="ruby-identifier">untag</span> <span class="ruby-constant">CLIENT_STICKY_TAG</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000047">
<a name="M000047"></a><b>untag</b>(*tags)
</div>
<div class="description">
<p>
Removes the given tags from this client.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000047_source')" id="l_M000047_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L308" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000047_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 308</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">untag</span> <span class="ruby-operator">*</span><span class="ruby-identifier">tags</span>
<span class="ruby-identifier">with_tags</span> <span class="ruby-keyword kw">do</span>
<span class="ruby-identifier">tags</span>.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">tag</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">delete</span> <span class="ruby-identifier">tag</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000041">
<a name="M000041"></a><b>views</b>()
</div>
<div class="description">
<p>
Returns the views that contain this client.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000041_source')" id="l_M000041_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L263" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000041_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 263</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">views</span>
<span class="ruby-identifier">tags</span>.<span class="ruby-identifier">map!</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span> <span class="ruby-constant">View</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">t</span> }
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000044">
<a name="M000044"></a><b>with_tags</b>(&block)
</div>
<div class="description">
<p>
Evaluates the given block within the context of this client’s list of
tags.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000044_source')" id="l_M000044_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/7df1e5ba1e98a3810c3730a1a28ab64c33ccc355/lib/rumai/wm.rb#L290" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000044_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/wm.rb, line 290</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">with_tags</span> <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>
<span class="ruby-identifier">arr</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">tags</span>
<span class="ruby-identifier">arr</span>.<span class="ruby-identifier">instance_eval</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">tags</span> = <span class="ruby-identifier">arr</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>