--- a/src/eric7/Documentation/Source/eric7.Cooperation.CooperationClient.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Cooperation.CooperationClient.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Cooperation.CooperationClient</h1>
-
<p>
Module implementing the client of the cooperation package.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#CooperationClient">CooperationClient</a></td>
<td>Class implementing the client of the cooperation package.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="CooperationClient" ID="CooperationClient"></a>
<h2>CooperationClient</h2>
-
<p>
Class implementing the client of the cooperation package.
</p>
+
<h3>Signals</h3>
<dl>
@@ -73,19 +72,17 @@
<h3>Derived from</h3>
QObject
<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="#CooperationClient.__init__">CooperationClient</a></td>
<td>Constructor</td>
@@ -187,19 +184,20 @@
<td>Public method to start listening for new connections.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="CooperationClient.__init__" ID="CooperationClient.__init__"></a>
<h4>CooperationClient (Constructor)</h4>
<b>CooperationClient</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QObject)</dt>
@@ -210,10 +208,10 @@
<a NAME="CooperationClient.__connectionError" ID="CooperationClient.__connectionError"></a>
<h4>CooperationClient.__connectionError</h4>
<b>__connectionError</b>(<i>socketError, connection</i>)
-
<p>
Private slot to handle a connection error.
</p>
+
<dl>
<dt><i>socketError</i> (QAbstractSocket.SocketError)</dt>
@@ -228,10 +226,10 @@
<a NAME="CooperationClient.__connectionRejected" ID="CooperationClient.__connectionRejected"></a>
<h4>CooperationClient.__connectionRejected</h4>
<b>__connectionRejected</b>(<i>msg</i>)
-
<p>
Private slot to handle the rejection of a connection.
</p>
+
<dl>
<dt><i>msg</i> (str)</dt>
@@ -242,10 +240,10 @@
<a NAME="CooperationClient.__disconnected" ID="CooperationClient.__disconnected"></a>
<h4>CooperationClient.__disconnected</h4>
<b>__disconnected</b>(<i>connection</i>)
-
<p>
Private slot to handle the disconnection of a chat client.
</p>
+
<dl>
<dt><i>connection</i> (Connection)</dt>
@@ -256,10 +254,10 @@
<a NAME="CooperationClient.__findConnections" ID="CooperationClient.__findConnections"></a>
<h4>CooperationClient.__findConnections</h4>
<b>__findConnections</b>(<i>nick</i>)
-
<p>
Private method to get a list of connection given a nick name.
</p>
+
<dl>
<dt><i>nick</i> (str)</dt>
@@ -282,10 +280,10 @@
<a NAME="CooperationClient.__getParticipants" ID="CooperationClient.__getParticipants"></a>
<h4>CooperationClient.__getParticipants</h4>
<b>__getParticipants</b>(<i>reqConnection</i>)
-
<p>
Private slot to handle the request for a list of participants.
</p>
+
<dl>
<dt><i>reqConnection</i> (Connection)</dt>
@@ -297,10 +295,10 @@
<a NAME="CooperationClient.__newConnection" ID="CooperationClient.__newConnection"></a>
<h4>CooperationClient.__newConnection</h4>
<b>__newConnection</b>(<i>connection</i>)
-
<p>
Private slot to handle a new connection.
</p>
+
<dl>
<dt><i>connection</i> (Connection)</dt>
@@ -311,10 +309,10 @@
<a NAME="CooperationClient.__processParticipants" ID="CooperationClient.__processParticipants"></a>
<h4>CooperationClient.__processParticipants</h4>
<b>__processParticipants</b>(<i>participants</i>)
-
<p>
Private slot to handle the receipt of a list of participants.
</p>
+
<dl>
<dt><i>participants</i> (list of str)</dt>
@@ -325,10 +323,10 @@
<a NAME="CooperationClient.__readyForUse" ID="CooperationClient.__readyForUse"></a>
<h4>CooperationClient.__readyForUse</h4>
<b>__readyForUse</b>(<i>connection</i>)
-
<p>
Private slot to handle a connection getting ready for use.
</p>
+
<dl>
<dt><i>connection</i> (Connection)</dt>
@@ -339,10 +337,10 @@
<a NAME="CooperationClient.banKickUser" ID="CooperationClient.banKickUser"></a>
<h4>CooperationClient.banKickUser</h4>
<b>banKickUser</b>(<i>nick</i>)
-
<p>
Public method to ban and kick a user by its nick name.
</p>
+
<dl>
<dt><i>nick</i> (str)</dt>
@@ -353,10 +351,10 @@
<a NAME="CooperationClient.banUser" ID="CooperationClient.banUser"></a>
<h4>CooperationClient.banUser</h4>
<b>banUser</b>(<i>nick</i>)
-
<p>
Public method to ban a user by its nick name.
</p>
+
<dl>
<dt><i>nick</i> (str)</dt>
@@ -367,10 +365,10 @@
<a NAME="CooperationClient.chatWidget" ID="CooperationClient.chatWidget"></a>
<h4>CooperationClient.chatWidget</h4>
<b>chatWidget</b>(<i></i>)
-
<p>
Public method to get a reference to the chat widget.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -386,17 +384,17 @@
<a NAME="CooperationClient.close" ID="CooperationClient.close"></a>
<h4>CooperationClient.close</h4>
<b>close</b>(<i></i>)
-
<p>
Public method to close all connections and stop listening.
</p>
+
<a NAME="CooperationClient.connectToHost" ID="CooperationClient.connectToHost"></a>
<h4>CooperationClient.connectToHost</h4>
<b>connectToHost</b>(<i>host, port</i>)
-
<p>
Public method to connect to a host.
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -411,18 +409,18 @@
<a NAME="CooperationClient.disconnectConnections" ID="CooperationClient.disconnectConnections"></a>
<h4>CooperationClient.disconnectConnections</h4>
<b>disconnectConnections</b>(<i></i>)
-
<p>
Public slot to disconnect from the chat network.
</p>
+
<a NAME="CooperationClient.errorString" ID="CooperationClient.errorString"></a>
<h4>CooperationClient.errorString</h4>
<b>errorString</b>(<i></i>)
-
<p>
Public method to get a human readable error message about the last
server error.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -438,10 +436,10 @@
<a NAME="CooperationClient.hasConnection" ID="CooperationClient.hasConnection"></a>
<h4>CooperationClient.hasConnection</h4>
<b>hasConnection</b>(<i>senderIp, senderPort=-1</i>)
-
<p>
Public method to check for an existing connection.
</p>
+
<dl>
<dt><i>senderIp</i> (QHostAddress)</dt>
@@ -468,10 +466,10 @@
<a NAME="CooperationClient.hasConnections" ID="CooperationClient.hasConnections"></a>
<h4>CooperationClient.hasConnections</h4>
<b>hasConnections</b>(<i></i>)
-
<p>
Public method to check, if there are any connections established.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -487,10 +485,10 @@
<a NAME="CooperationClient.isListening" ID="CooperationClient.isListening"></a>
<h4>CooperationClient.isListening</h4>
<b>isListening</b>(<i></i>)
-
<p>
Public method to check, if the client is listening for connections.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -506,10 +504,10 @@
<a NAME="CooperationClient.kickUser" ID="CooperationClient.kickUser"></a>
<h4>CooperationClient.kickUser</h4>
<b>kickUser</b>(<i>nick</i>)
-
<p>
Public method to kick a user by its nick name.
</p>
+
<dl>
<dt><i>nick</i> (str)</dt>
@@ -520,10 +518,10 @@
<a NAME="CooperationClient.nickName" ID="CooperationClient.nickName"></a>
<h4>CooperationClient.nickName</h4>
<b>nickName</b>(<i></i>)
-
<p>
Public method to get the nick name.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -539,10 +537,10 @@
<a NAME="CooperationClient.removeConnection" ID="CooperationClient.removeConnection"></a>
<h4>CooperationClient.removeConnection</h4>
<b>removeConnection</b>(<i>connection</i>)
-
<p>
Public method to remove a connection.
</p>
+
<dl>
<dt><i>connection</i> (Connection)</dt>
@@ -553,10 +551,10 @@
<a NAME="CooperationClient.sendEditorCommand" ID="CooperationClient.sendEditorCommand"></a>
<h4>CooperationClient.sendEditorCommand</h4>
<b>sendEditorCommand</b>(<i>projectHash, filename, message</i>)
-
<p>
Public method to send an editor command.
</p>
+
<dl>
<dt><i>projectHash</i> (str)</dt>
@@ -576,10 +574,10 @@
<a NAME="CooperationClient.sendMessage" ID="CooperationClient.sendMessage"></a>
<h4>CooperationClient.sendMessage</h4>
<b>sendMessage</b>(<i>message</i>)
-
<p>
Public method to send a message.
</p>
+
<dl>
<dt><i>message</i> (str)</dt>
@@ -590,10 +588,10 @@
<a NAME="CooperationClient.startListening" ID="CooperationClient.startListening"></a>
<h4>CooperationClient.startListening</h4>
<b>startListening</b>(<i>port=-1</i>)
-
<p>
Public method to start listening for new connections.
</p>
+
<dl>
<dt><i>port</i> (int)</dt>
@@ -616,4 +614,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
