eric: comparison src/eric7/Cooperation/ChatWidget.py

-:2fda68a9168d
+:5ac83a87954d
 def __init__(self, ui, port=-1, parent=None):
 """
 Constructor
-@param ui reference to the user interface object (UserInterface)
+@param ui reference to the user interface object
-@param port port to be used for the cooperation server (integer)
+@type UserInterface
-@param parent reference to the parent widget (QWidget)
+@param port port to be used for the cooperation server
+@type int
+@param parent reference to the parent widget
+@type QWidget
 """
 super().__init__(parent)
 self.setupUi(self)
 self.shareButton.setIcon(EricPixmapCache.getIcon("sharedEditDisconnected"))
 def __setHostsHistory(self, host):
 """
 Private method to remember the given host as the most recent entry.
-@param host host entry to remember (string)
+@param host host entry to remember
+@type str
 """
 if host in self.__recent:
 self.__recent.remove(host)
 self.__recent.insert(0, host)
 self.__saveHostsHistory()
 def __newParticipant(self, nick):
 """
 Private slot handling a new participant joining.
-@param nick nick name of the new participant (string)
+@param nick nick name of the new participant
+@type str
 """
 if nick == "":
 return
 color = self.chatEdit.textColor()
 def __participantLeft(self, nick):
 """
 Private slot handling a participant leaving the session.
-@param nick nick name of the participant (string)
+@param nick nick name of the participant
+@type str
 """
 if nick == "":
 return
 items = self.usersList.findItems(nick, Qt.MatchFlag.MatchExactly)
 def appendMessage(self, from_, message):
 """
 Public slot to append a message to the display.
-@param from_ originator of the message (string)
+@param from_ originator of the message
-@param message message to be appended (string)
+@type str
+@param message message to be appended
+@type str
 """
 if from_ == "" or message == "":
 return
 self.chatEdit.append(
 @pyqtSlot(str)
 def on_hostEdit_editTextChanged(self, host):
 """
 Private slot handling the entry of a host to connect to.
-@param host host to connect to (string)
+@param host host to connect to
+@type str
 """
 if not self.__connected:
 self.connectButton.setEnabled(host != "")
 def __getConnectionParameters(self):
 """
 Private method to determine the connection parameters.
-@return tuple with hostname and port (string, integer)
+@return tuple with hostname and port
+@rtype tuple of (str, int)
 """
 hostEntry = self.hostEdit.currentText()
 if "@" in hostEntry:
 host, port = hostEntry.split("@")
 try:
 def __setConnected(self, connected):
 """
 Private slot to set the connected state.
-@param connected new connected state (boolean)
+@param connected new connected state
+@type bool
 """
 if connected:
 self.connectButton.setText(self.tr("Disconnect"))
 self.connectButton.setEnabled(True)
 self.connectionLed.setColor(QColor(Qt.GlobalColor.green))
 def __showErrorMessage(self, message):
 """
 Private slot to show an error message.
-@param message error message to show (string)
+@param message error message to show
+@type str
 """
 color = self.chatEdit.textColor()
 self.chatEdit.setTextColor(Qt.GlobalColor.red)
 self.chatEdit.append(
 QDateTime.currentDateTime().toString(Qt.DateFormat.SystemLocaleLongDate)
 def getClient(self):
 """
 Public method to get a reference to the cooperation client.
-@return reference to the cooperation client (CooperationClient)
+@return reference to the cooperation client
+@rtype CooperationClient
 """
 return self.__client
 def __editorCommandMessage(self, hashStr, fileName, message):
 """
 Private slot to handle editor command messages from the client.
-@param hashStr hash of the project (string)
+@param hashStr hash of the project
-@param fileName project relative file name of the editor (string)
+@type str
-@param message command message (string)
+@param fileName project relative file name of the editor
+@type str
+@param message command message
+@type str
 """
 from eric7.QScintilla.Editor import Editor
 self.editorCommand.emit(hashStr, fileName, message)
 @pyqtSlot(bool)
 def on_shareButton_clicked(self, checked):
 """
 Private slot to share the current editor.
-@param checked flag indicating the button state (boolean)
+@param checked flag indicating the button state
+@type bool
 """
 if checked:
 self.shareButton.setIcon(EricPixmapCache.getIcon("sharedEditConnected"))
 else:
 self.shareButton.setIcon(EricPixmapCache.getIcon("sharedEditDisconnected"))
 @pyqtSlot(bool)
 def on_startEditButton_clicked(self, checked):
 """
 Private slot to start a shared edit session.
-@param checked flag indicating the button state (boolean)
+@param checked flag indicating the button state
+@type bool
 """
 if checked:
 self.sendEditButton.setEnabled(True)
 self.cancelEditButton.setEnabled(True)
 self.shareButton.setEnabled(False)
 def checkEditorActions(self, editor):
 """
 Public slot to set action according to an editor's state.
-@param editor reference to the editor (Editor)
+@param editor reference to the editor
+@type Editor
 """
 shareable, sharing, editing, remoteEditing = editor.getSharingStatus()
 self.shareButton.setChecked(sharing)
 if sharing:
 @pyqtSlot(bool)
 def on_chatEdit_copyAvailable(self, yes):
 """
 Private slot to react to text selection/deselection of the chat edit.
-@param yes flag signaling the availability of selected text (boolean)
+@param yes flag signaling the availability of selected text
+@type bool
 """
 self.__copyChatAct.setEnabled(yes)
 @pyqtSlot(QPoint)
 def on_chatEdit_customContextMenuRequested(self, pos):
 """
 Private slot to show the context menu for the chat.
-@param pos the position of the mouse pointer (QPoint)
+@param pos the position of the mouse pointer
+@type QPoint
 """
 enable = self.chatEdit.toPlainText() != ""
 self.__saveChatAct.setEnabled(enable)
 self.__copyAllChatAct.setEnabled(enable)
 self.__cutAllChatAct.setEnabled(enable)
 @pyqtSlot(QPoint)
 def on_usersList_customContextMenuRequested(self, pos):
 """
 Private slot to show the context menu for the users list.
-@param pos the position of the mouse pointer (QPoint)
+@param pos the position of the mouse pointer
+@type QPoint
 """
 itm = self.usersList.itemAt(pos)
 self.__kickUserAct.setEnabled(itm is not None)
 self.__banUserAct.setEnabled(itm is not None)
 self.__banKickUserAct.setEnabled(itm is not None)

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Cooperation/ChatWidget.py

src/eric7/Cooperation/ChatWidget.py