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

-:3733e2b23cf7
+:a071d4065202
 def __init__(self, name, parent=None):
 """
 Constructor
-@param name string with user name and privilege prefix (string)
+@param name string with user name and privilege prefix
-@param parent reference to the parent widget (QListWidget or
+@type str
-QListWidgetItem)
+@param parent reference to the parent widget
+@type QListWidget or QListWidgetItem
 """
 super().__init__(name, parent)
 self.__privilege = IrcUserItem.Normal
 self.__name = name
 def name(self):
 """
 Public method to get the user name.
-@return user name (string)
+@return user name
+@rtype str
 """
 return self.__name
 def setName(self, name):
 """
 Public method to set a new nick name.
-@param name new nick name for the user (string)
+@param name new nick name for the user
+@type str
 """
 self.__name = name
 self.__setText()
 def changePrivilege(self, privilege):
 """
 Public method to set or unset a user privilege.
-@param privilege privilege to set or unset (string)
+@param privilege privilege to set or unset
+@type str
 """
 oper = privilege[0]
 priv = privilege[1]
 if priv in IrcUserItem.PrivilegeMapping:
 if oper == "+":
 def __awayIcon(self, icon):
 """
 Private method to convert an icon to an away icon.
-@param icon icon to be converted (QIcon)
+@param icon icon to be converted
-@return away icon (QIcon)
+@type QIcon
+@return away icon
+@rtype QIcon
 """
 pix1 = icon.pixmap(16, 16)
 pix2 = EricPixmapCache.getPixmap("ircAway")
 painter = QPainter(pix1)
 painter.drawPixmap(0, 0, pix2)
 def parseWhoFlags(self, flags):
 """
 Public method to parse the user flags reported by a WHO command.
-@param flags user flags as reported by WHO (string)
+@param flags user flags as reported by WHO
+@type str
 """
 # H The user is not away.
 # G The user is set away.
 # * The user is an IRC operator.
 # @ The user is a channel op in the channel listed in the first field.
 def canChangeTopic(self):
 """
 Public method to check, if the user is allowed to change the topic.
-@return flag indicating that the topic can be changed (boolean)
+@return flag indicating that the topic can be changed
+@rtype bool
 """
 return (
 bool(self.__privilege & IrcUserItem.Operator)
 or bool(self.__privilege & IrcUserItem.Admin)
 or bool(self.__privilege & IrcUserItem.Owner)
 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.__ui = ericApp().getObject("UserInterface")
 def name(self):
 """
 Public method to get the name of the channel.
-@return name of the channel (string)
+@return name of the channel
+@rtype str
 """
 return self.__name
 def setName(self, name):
 """
 Public method to set the name of the channel.
-@param name of the channel (string)
+@param name of the channel
+@type str
 """
 self.__name = name
 def getUsersCount(self):
 """
 Public method to get the users count of the channel.
-@return users count of the channel (integer)
+@return users count of the channel
+@rtype int
 """
 return self.usersList.count()
 def userName(self):
 """
 Public method to get the nick name of the user.
-@return nick name of the user (string)
+@return nick name of the user
+@rtype str
 """
 return self.__userName
 def setUserName(self, name):
 """
 Public method to set the user name for the channel.
-@param name user name for the channel (string)
+@param name user name for the channel
+@type str
 """
 self.__userName = name
 def partMessage(self):
 """
 Public method to get the part message.
-@return part message (string)
+@return part message
+@rtype str
 """
 return self.__partMessage
 def setPartMessage(self, message):
 """
 Public method to set the part message.
-@param message message to be used for PART messages (string)
+@param message message to be used for PART messages
+@type str
 """
 self.__partMessage = message
 def setPrivate(self, private, partner=""):
 """
 Public method to set the private chat mode.
-@param private flag indicating private chat mode (boolean)
+@param private flag indicating private chat mode
-@param partner name of the partner user (string)
+@type bool
+@param partner name of the partner user
+@type str
 """
 self.__private = private
 self.__privatePartner = partner
 self.editTopicButton.setEnabled(private)
 def setPrivateInfo(self, infoText):
 """
 Public method to set some info text for private chat mode.
-@param infoText info text to be shown (string)
+@param infoText info text to be shown
+@type str
 """
 if self.__private:
 self.topicLabel.setText(infoText)
 def handleMessage(self, line):
 """
 Public method to handle the message sent by the server.
-@param line server message (string)
+@param line server message
-@return flag indicating, if the message was handled (boolean)
+@type str
+@return flag indicating, if the message was handled
+@rtype bool
 """
 for patternRe, patternFunc in self.__patterns:
 match = patternRe.match(line)
 if match is not None and patternFunc(match):
 return True
 def __message(self, match):
 """
 Private method to handle messages to the channel.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   sender user name
 # group(2)   sender user@host
 # group(3)   target nick
 # group(4)   message
 def addMessage(self, sender, msg):
 """
 Public method to add a message from external.
-@param sender nick name of the sender (string)
+@param sender nick name of the sender
-@param msg message received from sender (string)
+@type str
+@param msg message received from sender
+@type str
 """
 self.__appendMessage(
 '<font color="{0}">{2} <b>&lt;</b><font color="{1}">{3}</font>'
 "<b>&gt;</b> {4}</font>".format(
 Preferences.getIrc("ChannelMessageColour"),
 def addUsers(self, users):
 """
 Public method to add users to the channel.
-@param users list of user names to add (list of string)
+@param users list of user names to add
+@type list of str
 """
 for user in users:
 itm = self.__findUser(user)
 if itm is None:
 IrcUserItem(user, self.usersList)
 def __userJoin(self, match):
 """
 Private method to handle a user joining the channel.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 if match.group(3).lower() == self.__name.lower():
 if self.__userName != match.group(1):
 IrcUserItem(match.group(1), self.usersList)
 msg = self.tr("{0} has joined the channel {1} ({2}).").format(
 def __userPart(self, match):
 """
 Private method to handle a user leaving the channel.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 if match.group(2).lower() == self.__name.lower():
 itm = self.__findUser(match.group(1))
 self.usersList.takeItem(self.usersList.row(itm))
 del itm
 def __userQuit(self, match):
 """
 Private method to handle a user logging off the server.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 itm = self.__findUser(match.group(1))
 if itm:
 self.usersList.takeItem(self.usersList.row(itm))
 del itm
 def __userNickChange(self, match):
 """
 Private method to handle a nickname change of a user.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 itm = self.__findUser(match.group(1))
 if itm:
 itm.setName(match.group(2))
 if match.group(1) == self.__userName:
 def __userList(self, match):
 """
 Private method to handle the receipt of a list of users of the channel.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 if match.group(1).lower() == self.__name.lower():
 users = match.group(2).split()
 for user in users:
 userPrivileges, userName = self.__extractPrivilege(user)
 def __userAway(self, match):
 """
 Private method to handle a topic change of the channel.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 if match.group(1).lower() == self.__name.lower():
 self.__addManagementMessage(
 self.tr("Away"),
 self.tr("{0} is away: {1}").format(match.group(2), match.group(3)),
 def __setTopic(self, match):
 """
 Private method to handle a topic change of the channel.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 if match.group(1).lower() == self.__name.lower():
 self.topicLabel.setText(match.group(2))
 self.__addManagementMessage(
 IrcChannelWidget.MessageIndicator,
 def __topicCreated(self, match):
 """
 Private method to handle a topic created message.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 if match.group(1).lower() == self.__name.lower():
 self.__addManagementMessage(
 IrcChannelWidget.MessageIndicator,
 self.tr("The topic was set by {0} on {1}.").format(
 def __channelUrl(self, match):
 """
 Private method to handle a channel URL message.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 if match.group(1).lower() == self.__name.lower():
 self.__addManagementMessage(
 IrcChannelWidget.MessageIndicator,
 ircFilter(self.tr("Channel URL: {0}").format(match.group(2))),
 def __channelModes(self, match):
 """
 Private method to handle a message reporting the channel modes.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 if match.group(1).lower() == self.__name.lower():
 modesDict = getChannelModesDict()
 modesParameters = match.group(2).split()
 modeString = modesParameters.pop(0)
 def __channelCreated(self, match):
 """
 Private method to handle a channel created message.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 if match.group(1).lower() == self.__name.lower():
 self.__addManagementMessage(
 IrcChannelWidget.MessageIndicator,
 self.tr("This channel was created on {0}.").format(
 def __updateChannelModes(self, match):
 """
 Private method to handle a message reporting the channel modes.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)  user or server
 # group(2)  channel
 # group(3)  modes and parameter list
 if match.group(2).lower() == self.__name.lower():
 def __setUserPrivilege(self, match):
 """
 Private method to handle a change of user privileges for the channel.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 if match.group(2).lower() == self.__name.lower():
 itm = self.__findUser(match.group(4))
 if itm:
 itm.changePrivilege(match.group(3))
 def __ignore(self, match):
 """
 Private method to handle a channel message we are not interested in.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 if match.group(1).lower() == self.__name.lower():
 return True
 return False
 def __help(self, match):
 """
 Private method to handle a help message.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 self.__addManagementMessage(
 self.tr("Help"), "{0} {1}".format(match.group(1), ircFilter(match.group(2)))
 )
 return True
 def __handleCtcp(self, match):
 """
 Private method to handle a CTCP channel command.
 @param match reference to the match object
-@return flag indicating, if the message was handled (boolean)
+@type re.Match
+@return flag indicating, if the message was handled
+@rtype bool
 """
 # group(1)   sender user name
 # group(2)   sender user@host
 # group(3)   target nick
 # group(4)   message
 def setUserPrivilegePrefix(self, prefixes):
 """
 Public method to set the user privilege to prefix mapping.
 @param prefixes dictionary with privilege as key and prefix as value
+@type dict
 """
 self.__prefixToPrivilege = {}
 for privilege, prefix in prefixes.items():
 if prefix:
 self.__prefixToPrivilege[prefix] = privilege
 def __findUser(self, name):
 """
 Private method to find the user in the list of users.
-@param name user name to search for (string)
+@param name user name to search for
-@return reference to the list entry (QListWidgetItem)
+@type str
+@return reference to the list entry
+@rtype QListWidgetItem
 """
 for row in range(self.usersList.count()):
 itm = self.usersList.item(row)
 if itm.name() == name:
 return itm
 def __extractPrivilege(self, name):
 """
 Private method to extract the user privileges out of the name.
-@param name user name and prefixes (string)
+@param name user name and prefixes
-@return list of privileges and user name (list of string, string)
+@type str
+@return tuple containing a list of privileges and user name
+@rtype tuple of (list of str, str)
 """
 privileges = []
 while name[0] in self.__prefixToPrivilege:
 prefix = name[0]
 privileges.append(self.__prefixToPrivilege[prefix])
 def __addManagementMessage(self, indicator, message):
 """
 Private method to add a channel management message to the list.
-@param indicator indicator to be shown (string)
+@param indicator indicator to be shown
-@param message message to be shown (string)
+@type str
+@param message message to be shown
+@type str
 """
 if indicator == self.JoinIndicator:
 color = Preferences.getIrc("JoinChannelColour")
 elif indicator == self.LeaveIndicator:
 color = Preferences.getIrc("LeaveChannelColour")
 def __appendMessage(self, message):
 """
 Private slot to append a message.
-@param message message to be appended (string)
+@param message message to be appended
+@type str
 """
 if (
 self.__hidden
 and self.__markerLine == ""
 and Preferences.getIrc("MarkPositionWhenHidden")
 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 the position of the mouse pointer (QPoint)
+@param pos the position of the mouse pointer
+@type QPoint
 """
 enable = not self.messages.document().isEmpty()
 self.__cutAllMessagesAct.setEnabled(enable)
 self.__copyAllMessagesAct.setEnabled(enable)
 self.__saveMessagesAct.setEnabled(enable)
 @pyqtSlot(QPoint)
 def on_usersList_customContextMenuRequested(self, pos):
 """
 Private slot to show the context menu of the users list.
-@param pos the position of the mouse pointer (QPoint)
+@param pos the position of the mouse pointer
+@type QPoint
 """
 enable = len(self.usersList.selectedItems()) > 0
 enablePrivate = enable and not self.__private
 itm = self.usersList.itemAt(pos)
 if itm and enablePrivate:
 def hideEvent(self, evt):
 """
 Protected method handling hide events.
-@param evt reference to the hide event (QHideEvent)
+@param evt reference to the hide event
+@type QHideEvent
 """
 self.__hidden = True
 def showEvent(self, evt):
 """
 Protected method handling show events.
-@param evt reference to the show event (QShowEvent)
+@param evt reference to the show event
+@type QShowEvent
 """
 self.__hidden = False
 def initAutoWho(self):
 """
 """
 Private method to handle a WHO entry returned by the server as
 requested automatically.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)  nick
 # group(2)  user flags
 if self.__autoWhoRequested:
 itm = self.__findUser(match.group(1))
 def __whoEnd(self, match):
 """
 Private method to handle the end of the WHO list.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 if match.group(1).lower() == self.__name.lower():
 if self.__autoWhoRequested:
 self.__autoWhoRequested = False
 self.initAutoWho()
 """
 Private method to handle a WHO entry returned by the server as
 requested manually.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)  channel
 # group(2)  user
 # group(3)  host
 # group(4)  nick
 def __whoIsUser(self, match):
 """
 Private method to handle the WHOIS user reply.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   nick
 # group(2)   user
 # group(3)   host
 # group(4)   real name
 def __whoIsChannels(self, match):
 """
 Private method to handle the WHOIS channels reply.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   nick
 # group(2)   channels
 if match.group(1) == self.__whoIsNick:
 userChannels = []
 def __whoIsServer(self, match):
 """
 Private method to handle the WHOIS server reply.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   nick
 # group(2)   server
 # group(3)   server info
 if match.group(1) == self.__whoIsNick:
 def __whoIsOperator(self, match):
 """
 Private method to handle the WHOIS operator reply.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   nick
 # group(2)   message
 if match.group(1) == self.__whoIsNick:
 if match.group(2).lower().startswith("is an irc operator"):
 def __whoIsIdle(self, match):
 """
 Private method to handle the WHOIS idle reply.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   nick
 # group(2)   idle seconds
 # group(3)   signon time
 if match.group(1) == self.__whoIsNick:
 def __whoIsEnd(self, match):
 """
 Private method to handle the end of WHOIS reply.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   nick
 # group(2)   end message
 if match.group(1) == self.__whoIsNick:
 self.__whoIsNick = ""
 def __whoIsIdentify(self, match):
 """
 Private method to handle the WHOIS identify and identified replies.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   nick
 # group(2)   identified message
 if match.group(1) == self.__whoIsNick:
 self.__addManagementMessage(
 def __whoIsHelper(self, match):
 """
 Private method to handle the WHOIS helper reply.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   nick
 # group(2)   helper message
 if match.group(1) == self.__whoIsNick:
 self.__addManagementMessage(
 def __whoIsAccount(self, match):
 """
 Private method to handle the WHOIS account reply.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   nick
 # group(2)   login name
 if match.group(1) == self.__whoIsNick:
 self.__addManagementMessage(
 def __whoIsActually(self, match):
 """
 Private method to handle the WHOIS actually reply.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   nick
 # group(2)   actual user@host
 # group(3)   actual IP
 if match.group(1) == self.__whoIsNick:
 def __whoIsSecure(self, match):
 """
 Private method to handle the WHOIS secure reply.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   nick
 if match.group(1) == self.__whoIsNick:
 self.__addManagementMessage(
 self.tr("Whois"),
 def __whoIsConnection(self, match):
 """
 Private method to handle the WHOIS connection reply.
 @param match match object that matched the pattern
-@return flag indicating whether the message was handled (boolean)
+@type re.Match
+@return flag indicating whether the message was handled
+@rtype bool
 """
 # group(1)   nick
 # group(2)   host name
 # group(3)   IP
 if match.group(1) == self.__whoIsNick:
 @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/IrcChannelWidget.py

src/eric7/Network/IRC/IrcChannelWidget.py