--- a/src/eric7/Documentation/Source/eric7.Toolbox.SingleApplication.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Toolbox.SingleApplication.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Toolbox.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>
@@ -29,35 +27,34 @@
<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>
None
<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>
@@ -83,19 +80,20 @@
<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> (str)</dt>
@@ -106,10 +104,10 @@
<a NAME="SingleApplicationClient.connect" ID="SingleApplicationClient.connect"></a>
<h4>SingleApplicationClient.connect</h4>
<b>connect</b>(<i>timeout=10000</i>)
-
<p>
Public method to connect the single application client to its server.
</p>
+
<dl>
<dt><i>timeout</i> (int)</dt>
@@ -136,17 +134,17 @@
<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>Return:</dt>
<dd>
@@ -162,13 +160,13 @@
<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 arguments passed to the UI.
</p>
<p>
<b>Note</b>: This method must be overridden by subclasses.
</p>
+
<dl>
<dt><i>args</i> (argparse.Namespace)</dt>
@@ -187,10 +185,10 @@
<a NAME="SingleApplicationClient.sendCommand" ID="SingleApplicationClient.sendCommand"></a>
<h4>SingleApplicationClient.sendCommand</h4>
<b>sendCommand</b>(<i>command, arguments</i>)
-
<p>
Public method to send the command to the application server.
</p>
+
<dl>
<dt><i>command</i> (str)</dt>
@@ -207,26 +205,24 @@
<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>
@@ -252,19 +248,20 @@
<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> (str)</dt>
@@ -275,34 +272,34 @@
<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.__receiveJson" ID="SingleApplicationServer.__receiveJson"></a>
<h4>SingleApplicationServer.__receiveJson</h4>
<b>__receiveJson</b>(<i></i>)
-
<p>
Private method to receive the data from the client.
</p>
+
<a NAME="SingleApplicationServer.handleCommand" ID="SingleApplicationServer.handleCommand"></a>
<h4>SingleApplicationServer.handleCommand</h4>
<b>handleCommand</b>(<i>command, arguments</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>command</i> (str)</dt>
@@ -325,10 +322,10 @@
<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
+</body></html>
