--- a/Documentation/Source/eric5.Utilities.SingleApplication.html Mon Oct 01 19:55:49 2012 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,240 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
-'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
-<html><head>
-<title>eric5.Utilities.SingleApplication</title>
-<style>
-body {
- background: #EDECE6;
- margin: 0em 1em 10em 1em;
- color: black;
-}
-
-h1 { color: white; background: #85774A; }
-h2 { color: white; background: #85774A; }
-h3 { color: white; background: #9D936E; }
-h4 { color: white; background: #9D936E; }
-
-a { color: #BA6D36; }
-
-</style>
-</head>
-<body><a NAME="top" ID="top"></a>
-<h1>eric5.Utilities.SingleApplication</h1>
-<p>
-Module implementing the single application server and client.
-</p>
-<h3>Global Attributes</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Classes</h3>
-<table>
-<tr>
-<td><a href="#SingleApplicationClient">SingleApplicationClient</a></td>
-<td>Class implementing the single application client base class.</td>
-</tr><tr>
-<td><a href="#SingleApplicationServer">SingleApplicationServer</a></td>
-<td>Class implementing the single application server base class.</td>
-</tr>
-</table>
-<h3>Functions</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<hr /><hr />
-<a NAME="SingleApplicationClient" ID="SingleApplicationClient"></a>
-<h2>SingleApplicationClient</h2>
-<p>
- Class implementing the single application client base class.
-</p>
-<h3>Derived from</h3>
-object
-<h3>Class Attributes</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Class Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Methods</h3>
-<table>
-<tr>
-<td><a href="#SingleApplicationClient.__init__">SingleApplicationClient</a></td>
-<td>Constructor</td>
-</tr><tr>
-<td><a href="#SingleApplicationClient.connect">connect</a></td>
-<td>Public method to connect the single application client to its server.</td>
-</tr><tr>
-<td><a href="#SingleApplicationClient.disconnect">disconnect</a></td>
-<td>Public method to disconnect from the Single Appliocation server.</td>
-</tr><tr>
-<td><a href="#SingleApplicationClient.errstr">errstr</a></td>
-<td>Public method to return a meaningful error string for the last error.</td>
-</tr><tr>
-<td><a href="#SingleApplicationClient.processArgs">processArgs</a></td>
-<td>Public method to process the command line args passed to the UI.</td>
-</tr><tr>
-<td><a href="#SingleApplicationClient.sendCommand">sendCommand</a></td>
-<td>Public method to send the command to the application server.</td>
-</tr>
-</table>
-<h3>Static Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<a NAME="SingleApplicationClient.__init__" ID="SingleApplicationClient.__init__"></a>
-<h4>SingleApplicationClient (Constructor)</h4>
-<b>SingleApplicationClient</b>(<i>name</i>)
-<p>
- Constructor
-</p><dl>
-<dt><i>name</i></dt>
-<dd>
-name of the local server to connect to (string)
-</dd>
-</dl><a NAME="SingleApplicationClient.connect" ID="SingleApplicationClient.connect"></a>
-<h4>SingleApplicationClient.connect</h4>
-<b>connect</b>(<i></i>)
-<p>
- Public method to connect the single application client to its server.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-value indicating success or an error number. Value is one of:
- <table>
- <tr><td>0</td><td>No application is running</td></tr>
- <tr><td>1</td><td>Application is already running</td></tr>
- </table>
-</dd>
-</dl><a NAME="SingleApplicationClient.disconnect" ID="SingleApplicationClient.disconnect"></a>
-<h4>SingleApplicationClient.disconnect</h4>
-<b>disconnect</b>(<i></i>)
-<p>
- Public method to disconnect from the Single Appliocation server.
-</p><a NAME="SingleApplicationClient.errstr" ID="SingleApplicationClient.errstr"></a>
-<h4>SingleApplicationClient.errstr</h4>
-<b>errstr</b>(<i></i>)
-<p>
- Public method to return a meaningful error string for the last error.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-error string for the last error (string)
-</dd>
-</dl><a NAME="SingleApplicationClient.processArgs" ID="SingleApplicationClient.processArgs"></a>
-<h4>SingleApplicationClient.processArgs</h4>
-<b>processArgs</b>(<i>args</i>)
-<p>
- Public method to process the command line args passed to the UI.
-</p><p>
- <b>Note</b>: This method must be overridden by subclasses.
-</p><dl>
-<dt><i>args</i></dt>
-<dd>
-command line args (list of strings)
-</dd>
-</dl><a NAME="SingleApplicationClient.sendCommand" ID="SingleApplicationClient.sendCommand"></a>
-<h4>SingleApplicationClient.sendCommand</h4>
-<b>sendCommand</b>(<i>cmd</i>)
-<p>
- Public method to send the command to the application server.
-</p><dl>
-<dt><i>cmd</i></dt>
-<dd>
-command to be sent (string)
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
-<a NAME="SingleApplicationServer" ID="SingleApplicationServer"></a>
-<h2>SingleApplicationServer</h2>
-<p>
- Class implementing the single application server base class.
-</p>
-<h3>Derived from</h3>
-QLocalServer
-<h3>Class Attributes</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Class Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Methods</h3>
-<table>
-<tr>
-<td><a href="#SingleApplicationServer.__init__">SingleApplicationServer</a></td>
-<td>Constructor</td>
-</tr><tr>
-<td><a href="#SingleApplicationServer.__disconnected">__disconnected</a></td>
-<td>Private method to handle the closure of the socket.</td>
-</tr><tr>
-<td><a href="#SingleApplicationServer.__newConnection">__newConnection</a></td>
-<td>Private slot to handle a new connection.</td>
-</tr><tr>
-<td><a href="#SingleApplicationServer.__parseLine">__parseLine</a></td>
-<td>Private method to handle data from the client.</td>
-</tr><tr>
-<td><a href="#SingleApplicationServer.handleCommand">handleCommand</a></td>
-<td>Public slot to handle the command sent by the client.</td>
-</tr><tr>
-<td><a href="#SingleApplicationServer.shutdown">shutdown</a></td>
-<td>Public method used to shut down the server.</td>
-</tr>
-</table>
-<h3>Static Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<a NAME="SingleApplicationServer.__init__" ID="SingleApplicationServer.__init__"></a>
-<h4>SingleApplicationServer (Constructor)</h4>
-<b>SingleApplicationServer</b>(<i>name</i>)
-<p>
- Constructor
-</p><dl>
-<dt><i>name</i></dt>
-<dd>
-name this server is listening to (string)
-</dd>
-</dl><a NAME="SingleApplicationServer.__disconnected" ID="SingleApplicationServer.__disconnected"></a>
-<h4>SingleApplicationServer.__disconnected</h4>
-<b>__disconnected</b>(<i></i>)
-<p>
- Private method to handle the closure of the socket.
-</p><a NAME="SingleApplicationServer.__newConnection" ID="SingleApplicationServer.__newConnection"></a>
-<h4>SingleApplicationServer.__newConnection</h4>
-<b>__newConnection</b>(<i></i>)
-<p>
- Private slot to handle a new connection.
-</p><a NAME="SingleApplicationServer.__parseLine" ID="SingleApplicationServer.__parseLine"></a>
-<h4>SingleApplicationServer.__parseLine</h4>
-<b>__parseLine</b>(<i></i>)
-<p>
- Private method to handle data from the client.
-</p><a NAME="SingleApplicationServer.handleCommand" ID="SingleApplicationServer.handleCommand"></a>
-<h4>SingleApplicationServer.handleCommand</h4>
-<b>handleCommand</b>(<i>cmd, params</i>)
-<p>
- Public slot to handle the command sent by the client.
-</p><p>
- <b>Note</b>: This method must be overridden by subclasses.
-</p><dl>
-<dt><i>cmd</i></dt>
-<dd>
-commandstring (string)
-</dd><dt><i>params</i></dt>
-<dd>
-parameterstring (string)
-</dd>
-</dl><a NAME="SingleApplicationServer.shutdown" ID="SingleApplicationServer.shutdown"></a>
-<h4>SingleApplicationServer.shutdown</h4>
-<b>shutdown</b>(<i></i>)
-<p>
- Public method used to shut down the server.
-</p>
-<div align="right"><a href="#top">Up</a></div>
-<hr />
-</body></html>
\ No newline at end of file
