twisted.conch.insults.client.InsultsClient.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.conch.insults.client.InsultsClient</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.conch.html">Package conch</a> ::
<a href="twisted.conch.insults.html">Package insults</a> ::
<a href="twisted.conch.insults.client.html">Module client</a> ::
Class InsultsClient
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.conch.insults.client.InsultsClient.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class InsultsClient</h2>
<pre class="base-tree">
<a href="twisted.internet.protocol.BaseProtocol.html"><code>BaseProtocol</code></a> --+
|
<a href="twisted.internet.protocol.Protocol.html"><code>Protocol</code></a> --+
|
<b>InsultsClient</b>
</pre><br />
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.insults.client.InsultsClient.html#clearScreen" class="summary-sig-name"><code>clearScreen</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Clear the screen, and return the cursor to 0, 0.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.insults.client.InsultsClient.html#dataReceived" class="summary-sig-name"><code>dataReceived</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Called whenever data is received.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="endEscape"></a><span class="summary-sig"><span class="summary-sig-name">endEscape</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.insults.client.InsultsClient.html#eraseToLine" class="summary-sig-name"><code>eraseToLine</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Erase from the current position to the end of the line.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.insults.client.InsultsClient.html#eraseToScreen" class="summary-sig-name"><code>eraseToScreen</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Erase from the current position to the end of the screen.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.insults.client.InsultsClient.html#gotoXY" class="summary-sig-name"><code>gotoXY</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>x</span>,
<span class=summary-sig-arg>y</span>)</span></code>
<br />
Go to a position on the screen.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="initScreen"></a><span class="summary-sig"><span class="summary-sig-name">initScreen</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.insults.client.InsultsClient.html#keyReceived" class="summary-sig-name"><code>keyReceived</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>key</span>)</span></code>
<br />
Called when the user hits a key.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.insults.client.InsultsClient.html#refresh" class="summary-sig-name"><code>refresh</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Redraw the screen.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.insults.client.InsultsClient.html#setAttributes" class="summary-sig-name"><code>setAttributes</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*attrs</span>)</span></code>
<br />
Set the attributes for drawing on the screen.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="setSize"></a><span class="summary-sig"><span class="summary-sig-name">setSize</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>width</span>,
<span class=summary-sig-arg>height</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.insults.client.InsultsClient.html#windowSizeChanged" class="summary-sig-name"><code>windowSizeChanged</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called when the size of the window changes.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.insults.client.InsultsClient.html#writeCh" class="summary-sig-name"><code>writeCh</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>ch</span>)</span></code>
<br />
Write a character to the screen.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.insults.client.InsultsClient.html#writeStr" class="summary-sig-name"><code>writeStr</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>s</span>)</span></code>
<br />
Write a string to the screen.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Protocol</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.Protocol.html#connectionFailed" class="summary-sig-name"><code>connectionFailed</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
(Deprecated)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.Protocol.html#connectionLost" class="summary-sig-name"><code>connectionLost</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reason</span>)</span></code>
<br />
Called when the connection is shut down.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from BaseProtocol</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.BaseProtocol.html#connectionMade" class="summary-sig-name"><code>connectionMade</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called when a connection is made.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.BaseProtocol.html#makeConnection" class="summary-sig-name"><code>makeConnection</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>transport</span>)</span></code>
<br />
Make a connection to a transport and a server.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>float</code></font></td>
<td><b><a href="twisted.conch.insults.client.InsultsClient.html#escapeTimeout"><code>escapeTimeout</code></a></b> = <span title="0.20000000000000001">0.20000000000000001 </span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Protocol</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.internet.protocol.Protocol.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.internet.interfaces.IProtocol at 0x8278f0c>,)"><code>(<class twisted.internet.interfaces.IPr<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from BaseProtocol</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.protocol.BaseProtocol.html#connected"><code>connected</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.internet.protocol.BaseProtocol.html#transport"><code>transport</code></a></b> = <span title="None">None </span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="clearScreen"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">clearScreen</span>(<span class=sig-arg>self</span>)</span>
</h3>
Clear the screen, and return the cursor to 0, 0.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="dataReceived"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">dataReceived</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>Called whenever data is received.</p>
Use this method to translate to a higher-level message. Usually,
some callback will be made upon the receipt of each complete protocol
message.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>data</b></code> -
a string of indeterminate length. Please keep in mind that you
will probably need to buffer some data, as partial (or multiple)
protocol messages may be received! I recommend that unit tests
for protocols call through to this method with differing chunk
sizes, down to one byte at a time.
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.internet.protocol.Protocol.html#dataReceived"><code>twisted.internet.protocol.Protocol.dataReceived</code></a> <i>(inherited documentation)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="eraseToLine"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">eraseToLine</span>(<span class=sig-arg>self</span>)</span>
</h3>
Erase from the current position to the end of the line.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="eraseToScreen"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">eraseToScreen</span>(<span class=sig-arg>self</span>)</span>
</h3>
Erase from the current position to the end of the screen.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="gotoXY"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">gotoXY</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>x</span>,
<span class=sig-arg>y</span>)</span>
</h3>
Go to a position on the screen.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="keyReceived"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">keyReceived</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>key</span>)</span>
</h3>
Called when the user hits a key.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="refresh"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">refresh</span>(<span class=sig-arg>self</span>)</span>
</h3>
Redraw the screen.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setAttributes"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setAttributes</span>(<span class=sig-arg>self</span>,
<span class="sig-vararg">*attrs</span>)</span>
</h3>
Set the attributes for drawing on the screen.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="windowSizeChanged"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">windowSizeChanged</span>(<span class=sig-arg>self</span>)</span>
</h3>
Called when the size of the window changes. Might want to redraw the
screen here, or something.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="writeCh"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">writeCh</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>ch</span>)</span>
</h3>
Write a character to the screen. If we're at the end of the row,
ignore the write.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="writeStr"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">writeStr</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>s</span>)</span>
</h3>
Write a string to the screen. This does not wrap a the edge of the
screen, and stops at \r and \n.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="escapeTimeout"></a>
<h3>escapeTimeout</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>float</code>
</dd>
<span title="0.20000000000000001"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0.20000000000000001 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:44 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>