eric: comparison src/eric7/Network/IRC/IrcNetworkWidget.py

-:3733e2b23cf7
+:a071d4065202
 def __init__(self, parent=None):
 """
 Constructor
-@param parent reference to the parent widget (QWidget)
+@param parent reference to the parent widget
+@type QWidget
 """
 super().__init__(parent)
 self.setupUi(self)
 self.connectButton.setIcon(EricPixmapCache.getIcon("ircConnect"))
 def initialize(self, manager):
 """
 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
 self.networkCombo.addItems(self.__manager.getNetworkNames())
 @pyqtSlot(str)
 def on_channelCombo_editTextChanged(self, txt):
 """
 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)
 @pyqtSlot()
 def getNetworkChannels(self):
 """
 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)
 return network.getChannels()
 def on_nickCombo_currentIndexChanged(self, nick=0):
 """
 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())
 def getNickname(self):
 """
 Public method to get the currently selected nick name.
-@return selected nick name (string)
+@return selected nick name
+@rtype str
 """
 return self.nickCombo.currentText()
 def setNickName(self, nick):
 """
 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)
 self.nickCombo.blockSignals(False)
 def addMessage(self, msg):
 """
 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
 )
 self.messages.append(s)
 def addServerMessage(self, msgType, msg, filterMsg=True):
 """
 Public method to add a server message.
-@param msgType txpe of the message (string)
+@param msgType txpe of the message
-@param msg message to be added (string)
+@type str
-@param filterMsg flag indicating to filter the message (boolean)
+@param msg message to be added
+@type str
+@param filterMsg flag indicating to filter the message
+@type bool
 """
 if filterMsg:
 msg = ircFilter(msg)
 s = '<font color="{0}">{1} <b>[</b>{2}<b>]</b> {3}</font>'.format(
 Preferences.getIrc("ServerMessageColour"), ircTimestamp(), msgType, msg
 def addErrorMessage(self, msgType, msg):
 """
 Public method to add an error message.
-@param msgType txpe of the message (string)
+@param msgType txpe of the message
-@param msg message to be added (string)
+@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
 )
 self.messages.append(s)
 def setConnected(self, connected):
 """
 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:
 self.connectButton.setIcon(EricPixmapCache.getIcon("ircDisconnect"))
 self.connectButton.setToolTip(
 def isConnected(self):
 """
 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
 def setRegistered(self, registered):
 """
 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
 self.joinButton.setEnabled(on)
 self.nickCombo.setEnabled(registered)
 def on_messages_copyAvailable(self, yes):
 """
 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)
 @pyqtSlot(QPoint)
 def on_messages_customContextMenuRequested(self, pos):
 """
 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)
 self.__copyAllMessagesAct.setEnabled(enable)
 self.__saveMessagesAct.setEnabled(enable)
 @pyqtSlot(QUrl)
 def on_messages_anchorClicked(self, url):
 """
 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)

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Network/IRC/IrcNetworkWidget.py

src/eric7/Network/IRC/IrcNetworkWidget.py