src/eric7/Network/IRC/IrcNetworkWidget.py

branch
eric7
changeset 10428
a071d4065202
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
--- a/src/eric7/Network/IRC/IrcNetworkWidget.py	Wed Dec 20 11:06:38 2023 +0100
+++ b/src/eric7/Network/IRC/IrcNetworkWidget.py	Wed Dec 20 14:58:58 2023 +0100
@@ -49,7 +49,8 @@
         """
         Constructor
 
-        @param parent reference to the parent widget (QWidget)
+        @param parent reference to the parent widget
+        @type QWidget
         """
         super().__init__(parent)
         self.setupUi(self)
@@ -81,7 +82,8 @@
         """
         Public method to initialize the widget.
 
-        @param manager reference to the network manager (IrcNetworkManager)
+        @param manager reference to the network manager
+        @type IrcNetworkManager
         """
         self.__manager = manager
 
@@ -212,7 +214,8 @@
         """
         Private slot to react upon changes of the channel.
 
-        @param txt current text of the channel combo (string)
+        @param txt current text of the channel combo
+        @type str
         """
         on = bool(txt) and self.__registered
         self.joinButton.setEnabled(on)
@@ -252,7 +255,8 @@
         Public method to get the list of channels associated with the
         selected network.
 
-        @return associated channels (list of IrcChannel)
+        @return associated channels
+        @rtype list of IrcChannel
         """
         networkName = self.networkCombo.currentText()
         network = self.__manager.getNetwork(networkName)
@@ -265,6 +269,7 @@
         Private slot to use another nick name.
 
         @param nick index of the selected nick name (unused)
+        @type int
         """
         if self.__connected:
             self.nickChanged.emit(self.nickCombo.currentText())
@@ -273,7 +278,8 @@
         """
         Public method to get the currently selected nick name.
 
-        @return selected nick name (string)
+        @return selected nick name
+        @rtype str
         """
         return self.nickCombo.currentText()
 
@@ -281,7 +287,8 @@
         """
         Public slot to set the nick name in use.
 
-        @param nick nick name in use (string)
+        @param nick nick name in use
+        @type str
         """
         self.nickCombo.blockSignals(True)
         self.nickCombo.setEditText(nick)
@@ -291,7 +298,8 @@
         """
         Public method to add a message.
 
-        @param msg message to be added (string)
+        @param msg message to be added
+        @type str
         """
         s = '<font color="{0}">{1} {2}</font>'.format(
             Preferences.getIrc("NetworkMessageColour"), ircTimestamp(), msg
@@ -302,9 +310,12 @@
         """
         Public method to add a server message.
 
-        @param msgType txpe of the message (string)
-        @param msg message to be added (string)
-        @param filterMsg flag indicating to filter the message (boolean)
+        @param msgType txpe of the message
+        @type str
+        @param msg message to be added
+        @type str
+        @param filterMsg flag indicating to filter the message
+        @type bool
         """
         if filterMsg:
             msg = ircFilter(msg)
@@ -317,8 +328,10 @@
         """
         Public method to add an error message.
 
-        @param msgType txpe of the message (string)
-        @param msg message to be added (string)
+        @param msgType txpe of the message
+        @type str
+        @param msg message to be added
+        @type str
         """
         s = '<font color="{0}">{1} <b>[</b>{2}<b>]</b> {3}</font>'.format(
             Preferences.getIrc("ErrorMessageColour"), ircTimestamp(), msgType, msg
@@ -329,7 +342,8 @@
         """
         Public slot to set the connection state.
 
-        @param connected flag indicating the connection state (boolean)
+        @param connected flag indicating the connection state
+        @type bool
         """
         self.__connected = connected
         if self.__connected:
@@ -347,7 +361,8 @@
         """
         Public method to check, if the network is connected.
 
-        @return flag indicating a connected network (boolean)
+        @return flag indicating a connected network
+        @rtype bool
         """
         return self.__connected
 
@@ -355,7 +370,8 @@
         """
         Public slot to set the registered state.
 
-        @param registered flag indicating the registration state (boolean)
+        @param registered flag indicating the registration state
+        @type bool
         """
         self.__registered = registered
         on = bool(self.channelCombo.currentText()) and self.__registered
@@ -495,7 +511,8 @@
         Private slot to react to text selection/deselection of the
         messages edit.
 
-        @param yes flag signaling the availability of selected text (boolean)
+        @param yes flag signaling the availability of selected text
+        @type bool
         """
         self.__copyMessagesAct.setEnabled(yes)
 
@@ -504,7 +521,8 @@
         """
         Private slot to show the context menu of the messages pane.
 
-        @param pos position the menu should be opened at (QPoint)
+        @param pos position the menu should be opened at
+        @type QPoint
         """
         enable = not self.messages.document().isEmpty()
         self.__cutAllMessagesAct.setEnabled(enable)
@@ -517,6 +535,7 @@
         """
         Private slot to open links in the default browser.
 
-        @param url URL to be opened (QUrl)
+        @param url URL to be opened
+        @type QUrl
         """
         QDesktopServices.openUrl(url)

eric ide

mercurial