Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Cooperation.ChatWidget.html	Tue Dec 19 11:04:03 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Cooperation.ChatWidget.html	Tue Dec 19 19:57:08 2023 +0100
@@ -256,17 +256,17 @@
 </p>
 <dl>
 
-<dt><i>ui</i></dt>
+<dt><i>ui</i> (UserInterface)</dt>
 <dd>
-reference to the user interface object (UserInterface)
+reference to the user interface object
 </dd>
-<dt><i>port</i></dt>
+<dt><i>port</i> (int)</dt>
 <dd>
-port to be used for the cooperation server (integer)
+port to be used for the cooperation server
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
 </dl>
 <a NAME="ChatWidget.__banKickUser" ID="ChatWidget.__banKickUser"></a>
@@ -327,17 +327,17 @@
 </p>
 <dl>
 
-<dt><i>hashStr</i></dt>
+<dt><i>hashStr</i> (str)</dt>
 <dd>
-hash of the project (string)
+hash of the project
 </dd>
-<dt><i>fileName</i></dt>
+<dt><i>fileName</i> (str)</dt>
 <dd>
-project relative file name of the editor (string)
+project relative file name of the editor
 </dd>
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
 <dd>
-command message (string)
+command message
 </dd>
 </dl>
 <a NAME="ChatWidget.__getConnectionParameters" ID="ChatWidget.__getConnectionParameters"></a>
@@ -350,7 +350,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple with hostname and port (string, integer)
+tuple with hostname and port
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, int)
 </dd>
 </dl>
 <a NAME="ChatWidget.__handleMessage" ID="ChatWidget.__handleMessage"></a>
@@ -404,9 +410,9 @@
 </p>
 <dl>
 
-<dt><i>nick</i></dt>
+<dt><i>nick</i> (str)</dt>
 <dd>
-nick name of the new participant (string)
+nick name of the new participant
 </dd>
 </dl>
 <a NAME="ChatWidget.__participantLeft" ID="ChatWidget.__participantLeft"></a>
@@ -418,9 +424,9 @@
 </p>
 <dl>
 
-<dt><i>nick</i></dt>
+<dt><i>nick</i> (str)</dt>
 <dd>
-nick name of the participant (string)
+nick name of the participant
 </dd>
 </dl>
 <a NAME="ChatWidget.__saveChat" ID="ChatWidget.__saveChat"></a>
@@ -446,9 +452,9 @@
 </p>
 <dl>
 
-<dt><i>connected</i></dt>
+<dt><i>connected</i> (bool)</dt>
 <dd>
-new connected state (boolean)
+new connected state
 </dd>
 </dl>
 <a NAME="ChatWidget.__setHostsHistory" ID="ChatWidget.__setHostsHistory"></a>
@@ -460,9 +466,9 @@
 </p>
 <dl>
 
-<dt><i>host</i></dt>
+<dt><i>host</i> (str)</dt>
 <dd>
-host entry to remember (string)
+host entry to remember
 </dd>
 </dl>
 <a NAME="ChatWidget.__showErrorMessage" ID="ChatWidget.__showErrorMessage"></a>
@@ -474,9 +480,9 @@
 </p>
 <dl>
 
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
 <dd>
-error message to show (string)
+error message to show
 </dd>
 </dl>
 <a NAME="ChatWidget.appendMessage" ID="ChatWidget.appendMessage"></a>
@@ -488,13 +494,13 @@
 </p>
 <dl>
 
-<dt><i>from_</i></dt>
+<dt><i>from_</i> (str)</dt>
 <dd>
-originator of the message (string)
+originator of the message
 </dd>
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
 <dd>
-message to be appended (string)
+message to be appended
 </dd>
 </dl>
 <a NAME="ChatWidget.checkEditorActions" ID="ChatWidget.checkEditorActions"></a>
@@ -506,9 +512,9 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-reference to the editor (Editor)
+reference to the editor
 </dd>
 </dl>
 <a NAME="ChatWidget.getClient" ID="ChatWidget.getClient"></a>
@@ -521,7 +527,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the cooperation client (CooperationClient)
+reference to the cooperation client
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+CooperationClient
 </dd>
 </dl>
 <a NAME="ChatWidget.on_cancelEditButton_clicked" ID="ChatWidget.on_cancelEditButton_clicked"></a>
@@ -540,9 +552,9 @@
 </p>
 <dl>
 
-<dt><i>yes</i></dt>
+<dt><i>yes</i> (bool)</dt>
 <dd>
-flag signaling the availability of selected text (boolean)
+flag signaling the availability of selected text
 </dd>
 </dl>
 <a NAME="ChatWidget.on_chatEdit_customContextMenuRequested" ID="ChatWidget.on_chatEdit_customContextMenuRequested"></a>
@@ -554,9 +566,9 @@
 </p>
 <dl>
 
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (QPoint)</dt>
 <dd>
-the position of the mouse pointer (QPoint)
+the position of the mouse pointer
 </dd>
 </dl>
 <a NAME="ChatWidget.on_clearHostsButton_clicked" ID="ChatWidget.on_clearHostsButton_clicked"></a>
@@ -582,9 +594,9 @@
 </p>
 <dl>
 
-<dt><i>host</i></dt>
+<dt><i>host</i> (str)</dt>
 <dd>
-host to connect to (string)
+host to connect to
 </dd>
 </dl>
 <a NAME="ChatWidget.on_sendEditButton_clicked" ID="ChatWidget.on_sendEditButton_clicked"></a>
@@ -610,9 +622,9 @@
 </p>
 <dl>
 
-<dt><i>checked</i></dt>
+<dt><i>checked</i> (bool)</dt>
 <dd>
-flag indicating the button state (boolean)
+flag indicating the button state
 </dd>
 </dl>
 <a NAME="ChatWidget.on_startEditButton_clicked" ID="ChatWidget.on_startEditButton_clicked"></a>
@@ -624,9 +636,9 @@
 </p>
 <dl>
 
-<dt><i>checked</i></dt>
+<dt><i>checked</i> (bool)</dt>
 <dd>
-flag indicating the button state (boolean)
+flag indicating the button state
 </dd>
 </dl>
 <a NAME="ChatWidget.on_usersList_customContextMenuRequested" ID="ChatWidget.on_usersList_customContextMenuRequested"></a>
@@ -638,9 +650,9 @@
 </p>
 <dl>
 
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (QPoint)</dt>
 <dd>
-the position of the mouse pointer (QPoint)
+the position of the mouse pointer
 </dd>
 </dl>
 <a NAME="ChatWidget.preferencesChanged" ID="ChatWidget.preferencesChanged"></a>