Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Network.IRC.IrcChannelWidget.html
eric6/Documentation/Source/eric6.Network.IRC.IrcChannelWidget.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Network.IRC.IrcChannelWidget</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Network.IRC.IrcChannelWidget</h1> | |
| 23 <p> | |
| 24 Module implementing the IRC channel widget. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#IrcChannelWidget">IrcChannelWidget</a></td> | |
| 34 <td>Class implementing the IRC channel widget.</td> | |
| 35 </tr><tr> | |
| 36 <td><a href="#IrcUserItem">IrcUserItem</a></td> | |
| 37 <td>Class implementing a list widget item containing an IRC channel user.</td> | |
| 38 </tr> | |
| 39 </table> | |
| 40 <h3>Functions</h3> | |
| 41 <table> | |
| 42 <tr><td>None</td></tr> | |
| 43 </table> | |
| 44 <hr /><hr /> | |
| 45 <a NAME="IrcChannelWidget" ID="IrcChannelWidget"></a> | |
| 46 <h2>IrcChannelWidget</h2> | |
| 47 <p> | |
| 48 Class implementing the IRC channel widget. | |
| 49 </p><h3>Signals</h3> | |
| 50 <dl> | |
| 51 <dt>awayCommand(str)</dt> | |
| 52 <dd> | |
| 53 emitted to set the away status via the /away | |
| 54 command | |
| 55 </dd><dt>channelClosed(str)</dt> | |
| 56 <dd> | |
| 57 emitted after the user has left the channel | |
| 58 </dd><dt>leaveAllChannels()</dt> | |
| 59 <dd> | |
| 60 emitted to leave all channels | |
| 61 </dd><dt>leaveChannels(list)</dt> | |
| 62 <dd> | |
| 63 emitted to leave a list of channels | |
| 64 </dd><dt>openPrivateChat(str)</dt> | |
| 65 <dd> | |
| 66 emitted to open a "channel" for private | |
| 67 messages | |
| 68 </dd><dt>sendCtcpReply(str, str)</dt> | |
| 69 <dd> | |
| 70 emitted to send a CTCP reply | |
| 71 </dd><dt>sendCtcpRequest(str, str, str)</dt> | |
| 72 <dd> | |
| 73 emitted to send a CTCP request | |
| 74 </dd><dt>sendData(str)</dt> | |
| 75 <dd> | |
| 76 emitted to send a message to the channel | |
| 77 </dd> | |
| 78 </dl> | |
| 79 <h3>Derived from</h3> | |
| 80 QWidget, Ui_IrcChannelWidget | |
| 81 <h3>Class Attributes</h3> | |
| 82 <table> | |
| 83 <tr><td>JoinIndicator</td></tr><tr><td>LeaveIndicator</td></tr><tr><td>MessageIndicator</td></tr><tr><td>UrlRe</td></tr> | |
| 84 </table> | |
| 85 <h3>Class Methods</h3> | |
| 86 <table> | |
| 87 <tr><td>None</td></tr> | |
| 88 </table> | |
| 89 <h3>Methods</h3> | |
| 90 <table> | |
| 91 <tr> | |
| 92 <td><a href="#IrcChannelWidget.__init__">IrcChannelWidget</a></td> | |
| 93 <td>Constructor</td> | |
| 94 </tr><tr> | |
| 95 <td><a href="#IrcChannelWidget.__addManagementMessage">__addManagementMessage</a></td> | |
| 96 <td>Private method to add a channel management message to the list.</td> | |
| 97 </tr><tr> | |
| 98 <td><a href="#IrcChannelWidget.__appendMessage">__appendMessage</a></td> | |
| 99 <td>Private slot to append a message.</td> | |
| 100 </tr><tr> | |
| 101 <td><a href="#IrcChannelWidget.__autoWhoEntry">__autoWhoEntry</a></td> | |
| 102 <td>Private method to handle a WHO entry returned by the server as requested automatically.</td> | |
| 103 </tr><tr> | |
| 104 <td><a href="#IrcChannelWidget.__channelCreated">__channelCreated</a></td> | |
| 105 <td>Private method to handle a channel created message.</td> | |
| 106 </tr><tr> | |
| 107 <td><a href="#IrcChannelWidget.__channelModes">__channelModes</a></td> | |
| 108 <td>Private method to handle a message reporting the channel modes.</td> | |
| 109 </tr><tr> | |
| 110 <td><a href="#IrcChannelWidget.__channelUrl">__channelUrl</a></td> | |
| 111 <td>Private method to handle a channel URL message.</td> | |
| 112 </tr><tr> | |
| 113 <td><a href="#IrcChannelWidget.__clearMessages">__clearMessages</a></td> | |
| 114 <td>Private slot to clear the contents of the messages display.</td> | |
| 115 </tr><tr> | |
| 116 <td><a href="#IrcChannelWidget.__copyAllMessages">__copyAllMessages</a></td> | |
| 117 <td>Private slot to copy the contents of the messages display to the clipboard.</td> | |
| 118 </tr><tr> | |
| 119 <td><a href="#IrcChannelWidget.__copyMessages">__copyMessages</a></td> | |
| 120 <td>Private slot to copy the selection of the messages display to the clipboard.</td> | |
| 121 </tr><tr> | |
| 122 <td><a href="#IrcChannelWidget.__cutAllMessages">__cutAllMessages</a></td> | |
| 123 <td>Private slot to cut the contents of the messages display to the clipboard.</td> | |
| 124 </tr><tr> | |
| 125 <td><a href="#IrcChannelWidget.__extractPrivilege">__extractPrivilege</a></td> | |
| 126 <td>Private method to extract the user privileges out of the name.</td> | |
| 127 </tr><tr> | |
| 128 <td><a href="#IrcChannelWidget.__findUser">__findUser</a></td> | |
| 129 <td>Private method to find the user in the list of users.</td> | |
| 130 </tr><tr> | |
| 131 <td><a href="#IrcChannelWidget.__handleCtcp">__handleCtcp</a></td> | |
| 132 <td>Private method to handle a CTCP channel command.</td> | |
| 133 </tr><tr> | |
| 134 <td><a href="#IrcChannelWidget.__help">__help</a></td> | |
| 135 <td>Private method to handle a help message.</td> | |
| 136 </tr><tr> | |
| 137 <td><a href="#IrcChannelWidget.__ignore">__ignore</a></td> | |
| 138 <td>Private method to handle a channel message we are not interested in.</td> | |
| 139 </tr><tr> | |
| 140 <td><a href="#IrcChannelWidget.__ignoreUser">__ignoreUser</a></td> | |
| 141 <td>Private slot to ignore a specific user.</td> | |
| 142 </tr><tr> | |
| 143 <td><a href="#IrcChannelWidget.__initMessagesMenu">__initMessagesMenu</a></td> | |
| 144 <td>Private slot to initialize the context menu of the messages pane.</td> | |
| 145 </tr><tr> | |
| 146 <td><a href="#IrcChannelWidget.__initUsersMenu">__initUsersMenu</a></td> | |
| 147 <td>Private slot to initialize the users list context menu.</td> | |
| 148 </tr><tr> | |
| 149 <td><a href="#IrcChannelWidget.__message">__message</a></td> | |
| 150 <td>Private method to handle messages to the channel.</td> | |
| 151 </tr><tr> | |
| 152 <td><a href="#IrcChannelWidget.__openPrivateChat">__openPrivateChat</a></td> | |
| 153 <td>Private slot to open a chat with the selected user.</td> | |
| 154 </tr><tr> | |
| 155 <td><a href="#IrcChannelWidget.__pingUser">__pingUser</a></td> | |
| 156 <td>Private slot to send a ping to a specific user.</td> | |
| 157 </tr><tr> | |
| 158 <td><a href="#IrcChannelWidget.__processUserMessage">__processUserMessage</a></td> | |
| 159 <td>Private method to process a message entered by the user or via the user list context menu.</td> | |
| 160 </tr><tr> | |
| 161 <td><a href="#IrcChannelWidget.__saveMessages">__saveMessages</a></td> | |
| 162 <td>Private slot to save the contents of the messages display.</td> | |
| 163 </tr><tr> | |
| 164 <td><a href="#IrcChannelWidget.__sendAutoWhoCommand">__sendAutoWhoCommand</a></td> | |
| 165 <td>Private slot to send the WHO command to update the users list.</td> | |
| 166 </tr><tr> | |
| 167 <td><a href="#IrcChannelWidget.__sendUserMessage">__sendUserMessage</a></td> | |
| 168 <td>Private slot to send a private message to a specific user.</td> | |
| 169 </tr><tr> | |
| 170 <td><a href="#IrcChannelWidget.__sendUserNotice">__sendUserNotice</a></td> | |
| 171 <td>Private slot to send a notice message to a specific user.</td> | |
| 172 </tr><tr> | |
| 173 <td><a href="#IrcChannelWidget.__sendUserQuery">__sendUserQuery</a></td> | |
| 174 <td>Private slot to send a query message to a specific user.</td> | |
| 175 </tr><tr> | |
| 176 <td><a href="#IrcChannelWidget.__setEditTopicButton">__setEditTopicButton</a></td> | |
| 177 <td>Private method to set the visibility of the Edit Topic button.</td> | |
| 178 </tr><tr> | |
| 179 <td><a href="#IrcChannelWidget.__setTopic">__setTopic</a></td> | |
| 180 <td>Private method to handle a topic change of the channel.</td> | |
| 181 </tr><tr> | |
| 182 <td><a href="#IrcChannelWidget.__setUserPrivilege">__setUserPrivilege</a></td> | |
| 183 <td>Private method to handle a change of user privileges for the channel.</td> | |
| 184 </tr><tr> | |
| 185 <td><a href="#IrcChannelWidget.__topicCreated">__topicCreated</a></td> | |
| 186 <td>Private method to handle a topic created message.</td> | |
| 187 </tr><tr> | |
| 188 <td><a href="#IrcChannelWidget.__updateChannelModes">__updateChannelModes</a></td> | |
| 189 <td>Private method to handle a message reporting the channel modes.</td> | |
| 190 </tr><tr> | |
| 191 <td><a href="#IrcChannelWidget.__userAway">__userAway</a></td> | |
| 192 <td>Private method to handle a topic change of the channel.</td> | |
| 193 </tr><tr> | |
| 194 <td><a href="#IrcChannelWidget.__userJoin">__userJoin</a></td> | |
| 195 <td>Private method to handle a user joining the channel.</td> | |
| 196 </tr><tr> | |
| 197 <td><a href="#IrcChannelWidget.__userList">__userList</a></td> | |
| 198 <td>Private method to handle the receipt of a list of users of the channel.</td> | |
| 199 </tr><tr> | |
| 200 <td><a href="#IrcChannelWidget.__userNickChange">__userNickChange</a></td> | |
| 201 <td>Private method to handle a nickname change of a user.</td> | |
| 202 </tr><tr> | |
| 203 <td><a href="#IrcChannelWidget.__userPart">__userPart</a></td> | |
| 204 <td>Private method to handle a user leaving the channel.</td> | |
| 205 </tr><tr> | |
| 206 <td><a href="#IrcChannelWidget.__userQuit">__userQuit</a></td> | |
| 207 <td>Private method to handle a user logging off the server.</td> | |
| 208 </tr><tr> | |
| 209 <td><a href="#IrcChannelWidget.__whoEnd">__whoEnd</a></td> | |
| 210 <td>Private method to handle the end of the WHO list.</td> | |
| 211 </tr><tr> | |
| 212 <td><a href="#IrcChannelWidget.__whoEntry">__whoEntry</a></td> | |
| 213 <td>Private method to handle a WHO entry returned by the server as requested manually.</td> | |
| 214 </tr><tr> | |
| 215 <td><a href="#IrcChannelWidget.__whoIs">__whoIs</a></td> | |
| 216 <td>Private slot to get information about the selected user.</td> | |
| 217 </tr><tr> | |
| 218 <td><a href="#IrcChannelWidget.__whoIsAccount">__whoIsAccount</a></td> | |
| 219 <td>Private method to handle the WHOIS account reply.</td> | |
| 220 </tr><tr> | |
| 221 <td><a href="#IrcChannelWidget.__whoIsActually">__whoIsActually</a></td> | |
| 222 <td>Private method to handle the WHOIS actually reply.</td> | |
| 223 </tr><tr> | |
| 224 <td><a href="#IrcChannelWidget.__whoIsChannels">__whoIsChannels</a></td> | |
| 225 <td>Private method to handle the WHOIS channels reply.</td> | |
| 226 </tr><tr> | |
| 227 <td><a href="#IrcChannelWidget.__whoIsConnection">__whoIsConnection</a></td> | |
| 228 <td>Private method to handle the WHOIS connection reply.</td> | |
| 229 </tr><tr> | |
| 230 <td><a href="#IrcChannelWidget.__whoIsEnd">__whoIsEnd</a></td> | |
| 231 <td>Private method to handle the end of WHOIS reply.</td> | |
| 232 </tr><tr> | |
| 233 <td><a href="#IrcChannelWidget.__whoIsHelper">__whoIsHelper</a></td> | |
| 234 <td>Private method to handle the WHOIS helper reply.</td> | |
| 235 </tr><tr> | |
| 236 <td><a href="#IrcChannelWidget.__whoIsIdentify">__whoIsIdentify</a></td> | |
| 237 <td>Private method to handle the WHOIS identify and identified replies.</td> | |
| 238 </tr><tr> | |
| 239 <td><a href="#IrcChannelWidget.__whoIsIdle">__whoIsIdle</a></td> | |
| 240 <td>Private method to handle the WHOIS idle reply.</td> | |
| 241 </tr><tr> | |
| 242 <td><a href="#IrcChannelWidget.__whoIsOperator">__whoIsOperator</a></td> | |
| 243 <td>Private method to handle the WHOIS operator reply.</td> | |
| 244 </tr><tr> | |
| 245 <td><a href="#IrcChannelWidget.__whoIsSecure">__whoIsSecure</a></td> | |
| 246 <td>Private method to handle the WHOIS secure reply.</td> | |
| 247 </tr><tr> | |
| 248 <td><a href="#IrcChannelWidget.__whoIsServer">__whoIsServer</a></td> | |
| 249 <td>Private method to handle the WHOIS server reply.</td> | |
| 250 </tr><tr> | |
| 251 <td><a href="#IrcChannelWidget.__whoIsUser">__whoIsUser</a></td> | |
| 252 <td>Private method to handle the WHOIS user reply.</td> | |
| 253 </tr><tr> | |
| 254 <td><a href="#IrcChannelWidget.addMessage">addMessage</a></td> | |
| 255 <td>Public method to add a message from external.</td> | |
| 256 </tr><tr> | |
| 257 <td><a href="#IrcChannelWidget.addUsers">addUsers</a></td> | |
| 258 <td>Public method to add users to the channel.</td> | |
| 259 </tr><tr> | |
| 260 <td><a href="#IrcChannelWidget.getUsersCount">getUsersCount</a></td> | |
| 261 <td>Public method to get the users count of the channel.</td> | |
| 262 </tr><tr> | |
| 263 <td><a href="#IrcChannelWidget.handleMessage">handleMessage</a></td> | |
| 264 <td>Public method to handle the message sent by the server.</td> | |
| 265 </tr><tr> | |
| 266 <td><a href="#IrcChannelWidget.hideEvent">hideEvent</a></td> | |
| 267 <td>Protected method handling hide events.</td> | |
| 268 </tr><tr> | |
| 269 <td><a href="#IrcChannelWidget.initAutoWho">initAutoWho</a></td> | |
| 270 <td>Public method to initialize the Auto Who system.</td> | |
| 271 </tr><tr> | |
| 272 <td><a href="#IrcChannelWidget.leaveChannel">leaveChannel</a></td> | |
| 273 <td>Public slot to leave the channel.</td> | |
| 274 </tr><tr> | |
| 275 <td><a href="#IrcChannelWidget.name">name</a></td> | |
| 276 <td>Public method to get the name of the channel.</td> | |
| 277 </tr><tr> | |
| 278 <td><a href="#IrcChannelWidget.on_editTopicButton_clicked">on_editTopicButton_clicked</a></td> | |
| 279 <td>Private slot to change the topic of the channel.</td> | |
| 280 </tr><tr> | |
| 281 <td><a href="#IrcChannelWidget.on_messageEdit_returnPressed">on_messageEdit_returnPressed</a></td> | |
| 282 <td>Private slot to send a message to the channel.</td> | |
| 283 </tr><tr> | |
| 284 <td><a href="#IrcChannelWidget.on_messages_anchorClicked">on_messages_anchorClicked</a></td> | |
| 285 <td>Private slot to open links in the default browser.</td> | |
| 286 </tr><tr> | |
| 287 <td><a href="#IrcChannelWidget.on_messages_copyAvailable">on_messages_copyAvailable</a></td> | |
| 288 <td>Private slot to react to text selection/deselection of the messages edit.</td> | |
| 289 </tr><tr> | |
| 290 <td><a href="#IrcChannelWidget.on_messages_customContextMenuRequested">on_messages_customContextMenuRequested</a></td> | |
| 291 <td>Private slot to show the context menu of the messages pane.</td> | |
| 292 </tr><tr> | |
| 293 <td><a href="#IrcChannelWidget.on_usersList_customContextMenuRequested">on_usersList_customContextMenuRequested</a></td> | |
| 294 <td>Private slot to show the context menu of the users list.</td> | |
| 295 </tr><tr> | |
| 296 <td><a href="#IrcChannelWidget.partMessage">partMessage</a></td> | |
| 297 <td>Public method to get the part message.</td> | |
| 298 </tr><tr> | |
| 299 <td><a href="#IrcChannelWidget.requestLeave">requestLeave</a></td> | |
| 300 <td>Public method to leave the channel.</td> | |
| 301 </tr><tr> | |
| 302 <td><a href="#IrcChannelWidget.setMarkerLine">setMarkerLine</a></td> | |
| 303 <td>Public method to draw a line to mark the current position.</td> | |
| 304 </tr><tr> | |
| 305 <td><a href="#IrcChannelWidget.setName">setName</a></td> | |
| 306 <td>Public method to set the name of the channel.</td> | |
| 307 </tr><tr> | |
| 308 <td><a href="#IrcChannelWidget.setPartMessage">setPartMessage</a></td> | |
| 309 <td>Public method to set the part message.</td> | |
| 310 </tr><tr> | |
| 311 <td><a href="#IrcChannelWidget.setPrivate">setPrivate</a></td> | |
| 312 <td>Public method to set the private chat mode.</td> | |
| 313 </tr><tr> | |
| 314 <td><a href="#IrcChannelWidget.setPrivateInfo">setPrivateInfo</a></td> | |
| 315 <td>Public method to set some info text for private chat mode.</td> | |
| 316 </tr><tr> | |
| 317 <td><a href="#IrcChannelWidget.setUserName">setUserName</a></td> | |
| 318 <td>Public method to set the user name for the channel.</td> | |
| 319 </tr><tr> | |
| 320 <td><a href="#IrcChannelWidget.setUserPrivilegePrefix">setUserPrivilegePrefix</a></td> | |
| 321 <td>Public method to set the user privilege to prefix mapping.</td> | |
| 322 </tr><tr> | |
| 323 <td><a href="#IrcChannelWidget.showEvent">showEvent</a></td> | |
| 324 <td>Protected method handling show events.</td> | |
| 325 </tr><tr> | |
| 326 <td><a href="#IrcChannelWidget.unsetMarkerLine">unsetMarkerLine</a></td> | |
| 327 <td>Public method to remove the marker line.</td> | |
| 328 </tr><tr> | |
| 329 <td><a href="#IrcChannelWidget.userName">userName</a></td> | |
| 330 <td>Public method to get the nick name of the user.</td> | |
| 331 </tr> | |
| 332 </table> | |
| 333 <h3>Static Methods</h3> | |
| 334 <table> | |
| 335 <tr><td>None</td></tr> | |
| 336 </table> | |
| 337 <a NAME="IrcChannelWidget.__init__" ID="IrcChannelWidget.__init__"></a> | |
| 338 <h4>IrcChannelWidget (Constructor)</h4> | |
| 339 <b>IrcChannelWidget</b>(<i>parent=None</i>) | |
| 340 <p> | |
| 341 Constructor | |
| 342 </p><dl> | |
| 343 <dt><i>parent</i></dt> | |
| 344 <dd> | |
| 345 reference to the parent widget (QWidget) | |
| 346 </dd> | |
| 347 </dl><a NAME="IrcChannelWidget.__addManagementMessage" ID="IrcChannelWidget.__addManagementMessage"></a> | |
| 348 <h4>IrcChannelWidget.__addManagementMessage</h4> | |
| 349 <b>__addManagementMessage</b>(<i>indicator, message</i>) | |
| 350 <p> | |
| 351 Private method to add a channel management message to the list. | |
| 352 </p><dl> | |
| 353 <dt><i>indicator</i></dt> | |
| 354 <dd> | |
| 355 indicator to be shown (string) | |
| 356 </dd><dt><i>message</i></dt> | |
| 357 <dd> | |
| 358 message to be shown (string) | |
| 359 </dd> | |
| 360 </dl><a NAME="IrcChannelWidget.__appendMessage" ID="IrcChannelWidget.__appendMessage"></a> | |
| 361 <h4>IrcChannelWidget.__appendMessage</h4> | |
| 362 <b>__appendMessage</b>(<i>message</i>) | |
| 363 <p> | |
| 364 Private slot to append a message. | |
| 365 </p><dl> | |
| 366 <dt><i>message</i></dt> | |
| 367 <dd> | |
| 368 message to be appended (string) | |
| 369 </dd> | |
| 370 </dl><a NAME="IrcChannelWidget.__autoWhoEntry" ID="IrcChannelWidget.__autoWhoEntry"></a> | |
| 371 <h4>IrcChannelWidget.__autoWhoEntry</h4> | |
| 372 <b>__autoWhoEntry</b>(<i>match</i>) | |
| 373 <p> | |
| 374 Private method to handle a WHO entry returned by the server as | |
| 375 requested automatically. | |
| 376 </p><dl> | |
| 377 <dt><i>match</i></dt> | |
| 378 <dd> | |
| 379 match object that matched the pattern | |
| 380 </dd> | |
| 381 </dl><dl> | |
| 382 <dt>Returns:</dt> | |
| 383 <dd> | |
| 384 flag indicating whether the message was handled (boolean) | |
| 385 </dd> | |
| 386 </dl><a NAME="IrcChannelWidget.__channelCreated" ID="IrcChannelWidget.__channelCreated"></a> | |
| 387 <h4>IrcChannelWidget.__channelCreated</h4> | |
| 388 <b>__channelCreated</b>(<i>match</i>) | |
| 389 <p> | |
| 390 Private method to handle a channel created message. | |
| 391 </p><dl> | |
| 392 <dt><i>match</i></dt> | |
| 393 <dd> | |
| 394 match object that matched the pattern | |
| 395 </dd> | |
| 396 </dl><dl> | |
| 397 <dt>Returns:</dt> | |
| 398 <dd> | |
| 399 flag indicating whether the message was handled (boolean) | |
| 400 </dd> | |
| 401 </dl><a NAME="IrcChannelWidget.__channelModes" ID="IrcChannelWidget.__channelModes"></a> | |
| 402 <h4>IrcChannelWidget.__channelModes</h4> | |
| 403 <b>__channelModes</b>(<i>match</i>) | |
| 404 <p> | |
| 405 Private method to handle a message reporting the channel modes. | |
| 406 </p><dl> | |
| 407 <dt><i>match</i></dt> | |
| 408 <dd> | |
| 409 match object that matched the pattern | |
| 410 </dd> | |
| 411 </dl><dl> | |
| 412 <dt>Returns:</dt> | |
| 413 <dd> | |
| 414 flag indicating whether the message was handled (boolean) | |
| 415 </dd> | |
| 416 </dl><a NAME="IrcChannelWidget.__channelUrl" ID="IrcChannelWidget.__channelUrl"></a> | |
| 417 <h4>IrcChannelWidget.__channelUrl</h4> | |
| 418 <b>__channelUrl</b>(<i>match</i>) | |
| 419 <p> | |
| 420 Private method to handle a channel URL message. | |
| 421 </p><dl> | |
| 422 <dt><i>match</i></dt> | |
| 423 <dd> | |
| 424 match object that matched the pattern | |
| 425 </dd> | |
| 426 </dl><dl> | |
| 427 <dt>Returns:</dt> | |
| 428 <dd> | |
| 429 flag indicating whether the message was handled (boolean) | |
| 430 </dd> | |
| 431 </dl><a NAME="IrcChannelWidget.__clearMessages" ID="IrcChannelWidget.__clearMessages"></a> | |
| 432 <h4>IrcChannelWidget.__clearMessages</h4> | |
| 433 <b>__clearMessages</b>(<i></i>) | |
| 434 <p> | |
| 435 Private slot to clear the contents of the messages display. | |
| 436 </p><a NAME="IrcChannelWidget.__copyAllMessages" ID="IrcChannelWidget.__copyAllMessages"></a> | |
| 437 <h4>IrcChannelWidget.__copyAllMessages</h4> | |
| 438 <b>__copyAllMessages</b>(<i></i>) | |
| 439 <p> | |
| 440 Private slot to copy the contents of the messages display to the | |
| 441 clipboard. | |
| 442 </p><a NAME="IrcChannelWidget.__copyMessages" ID="IrcChannelWidget.__copyMessages"></a> | |
| 443 <h4>IrcChannelWidget.__copyMessages</h4> | |
| 444 <b>__copyMessages</b>(<i></i>) | |
| 445 <p> | |
| 446 Private slot to copy the selection of the messages display to the | |
| 447 clipboard. | |
| 448 </p><a NAME="IrcChannelWidget.__cutAllMessages" ID="IrcChannelWidget.__cutAllMessages"></a> | |
| 449 <h4>IrcChannelWidget.__cutAllMessages</h4> | |
| 450 <b>__cutAllMessages</b>(<i></i>) | |
| 451 <p> | |
| 452 Private slot to cut the contents of the messages display to the | |
| 453 clipboard. | |
| 454 </p><a NAME="IrcChannelWidget.__extractPrivilege" ID="IrcChannelWidget.__extractPrivilege"></a> | |
| 455 <h4>IrcChannelWidget.__extractPrivilege</h4> | |
| 456 <b>__extractPrivilege</b>(<i>name</i>) | |
| 457 <p> | |
| 458 Private method to extract the user privileges out of the name. | |
| 459 </p><dl> | |
| 460 <dt><i>name</i></dt> | |
| 461 <dd> | |
| 462 user name and prefixes (string) | |
| 463 </dd> | |
| 464 </dl><dl> | |
| 465 <dt>Returns:</dt> | |
| 466 <dd> | |
| 467 list of privileges and user name (list of string, string) | |
| 468 </dd> | |
| 469 </dl><a NAME="IrcChannelWidget.__findUser" ID="IrcChannelWidget.__findUser"></a> | |
| 470 <h4>IrcChannelWidget.__findUser</h4> | |
| 471 <b>__findUser</b>(<i>name</i>) | |
| 472 <p> | |
| 473 Private method to find the user in the list of users. | |
| 474 </p><dl> | |
| 475 <dt><i>name</i></dt> | |
| 476 <dd> | |
| 477 user name to search for (string) | |
| 478 </dd> | |
| 479 </dl><dl> | |
| 480 <dt>Returns:</dt> | |
| 481 <dd> | |
| 482 reference to the list entry (QListWidgetItem) | |
| 483 </dd> | |
| 484 </dl><a NAME="IrcChannelWidget.__handleCtcp" ID="IrcChannelWidget.__handleCtcp"></a> | |
| 485 <h4>IrcChannelWidget.__handleCtcp</h4> | |
| 486 <b>__handleCtcp</b>(<i>match</i>) | |
| 487 <p> | |
| 488 Private method to handle a CTCP channel command. | |
| 489 </p><dl> | |
| 490 <dt><i>match</i></dt> | |
| 491 <dd> | |
| 492 reference to the match object | |
| 493 </dd> | |
| 494 </dl><dl> | |
| 495 <dt>Returns:</dt> | |
| 496 <dd> | |
| 497 flag indicating, if the message was handled (boolean) | |
| 498 </dd> | |
| 499 </dl><a NAME="IrcChannelWidget.__help" ID="IrcChannelWidget.__help"></a> | |
| 500 <h4>IrcChannelWidget.__help</h4> | |
| 501 <b>__help</b>(<i>match</i>) | |
| 502 <p> | |
| 503 Private method to handle a help message. | |
| 504 </p><dl> | |
| 505 <dt><i>match</i></dt> | |
| 506 <dd> | |
| 507 match object that matched the pattern | |
| 508 </dd> | |
| 509 </dl><dl> | |
| 510 <dt>Returns:</dt> | |
| 511 <dd> | |
| 512 flag indicating whether the message was handled (boolean) | |
| 513 </dd> | |
| 514 </dl><a NAME="IrcChannelWidget.__ignore" ID="IrcChannelWidget.__ignore"></a> | |
| 515 <h4>IrcChannelWidget.__ignore</h4> | |
| 516 <b>__ignore</b>(<i>match</i>) | |
| 517 <p> | |
| 518 Private method to handle a channel message we are not interested in. | |
| 519 </p><dl> | |
| 520 <dt><i>match</i></dt> | |
| 521 <dd> | |
| 522 match object that matched the pattern | |
| 523 </dd> | |
| 524 </dl><dl> | |
| 525 <dt>Returns:</dt> | |
| 526 <dd> | |
| 527 flag indicating whether the message was handled (boolean) | |
| 528 </dd> | |
| 529 </dl><a NAME="IrcChannelWidget.__ignoreUser" ID="IrcChannelWidget.__ignoreUser"></a> | |
| 530 <h4>IrcChannelWidget.__ignoreUser</h4> | |
| 531 <b>__ignoreUser</b>(<i></i>) | |
| 532 <p> | |
| 533 Private slot to ignore a specific user. | |
| 534 </p><a NAME="IrcChannelWidget.__initMessagesMenu" ID="IrcChannelWidget.__initMessagesMenu"></a> | |
| 535 <h4>IrcChannelWidget.__initMessagesMenu</h4> | |
| 536 <b>__initMessagesMenu</b>(<i></i>) | |
| 537 <p> | |
| 538 Private slot to initialize the context menu of the messages pane. | |
| 539 </p><a NAME="IrcChannelWidget.__initUsersMenu" ID="IrcChannelWidget.__initUsersMenu"></a> | |
| 540 <h4>IrcChannelWidget.__initUsersMenu</h4> | |
| 541 <b>__initUsersMenu</b>(<i></i>) | |
| 542 <p> | |
| 543 Private slot to initialize the users list context menu. | |
| 544 </p><a NAME="IrcChannelWidget.__message" ID="IrcChannelWidget.__message"></a> | |
| 545 <h4>IrcChannelWidget.__message</h4> | |
| 546 <b>__message</b>(<i>match</i>) | |
| 547 <p> | |
| 548 Private method to handle messages to the channel. | |
| 549 </p><dl> | |
| 550 <dt><i>match</i></dt> | |
| 551 <dd> | |
| 552 match object that matched the pattern | |
| 553 </dd> | |
| 554 </dl><dl> | |
| 555 <dt>Returns:</dt> | |
| 556 <dd> | |
| 557 flag indicating whether the message was handled (boolean) | |
| 558 </dd> | |
| 559 </dl><a NAME="IrcChannelWidget.__openPrivateChat" ID="IrcChannelWidget.__openPrivateChat"></a> | |
| 560 <h4>IrcChannelWidget.__openPrivateChat</h4> | |
| 561 <b>__openPrivateChat</b>(<i></i>) | |
| 562 <p> | |
| 563 Private slot to open a chat with the selected user. | |
| 564 </p><a NAME="IrcChannelWidget.__pingUser" ID="IrcChannelWidget.__pingUser"></a> | |
| 565 <h4>IrcChannelWidget.__pingUser</h4> | |
| 566 <b>__pingUser</b>(<i></i>) | |
| 567 <p> | |
| 568 Private slot to send a ping to a specific user. | |
| 569 </p><a NAME="IrcChannelWidget.__processUserMessage" ID="IrcChannelWidget.__processUserMessage"></a> | |
| 570 <h4>IrcChannelWidget.__processUserMessage</h4> | |
| 571 <b>__processUserMessage</b>(<i>msg</i>) | |
| 572 <p> | |
| 573 Private method to process a message entered by the user or via the | |
| 574 user list context menu. | |
| 575 </p><dl> | |
| 576 <dt><i>msg</i> (str)</dt> | |
| 577 <dd> | |
| 578 message to be processed | |
| 579 </dd> | |
| 580 </dl><a NAME="IrcChannelWidget.__saveMessages" ID="IrcChannelWidget.__saveMessages"></a> | |
| 581 <h4>IrcChannelWidget.__saveMessages</h4> | |
| 582 <b>__saveMessages</b>(<i></i>) | |
| 583 <p> | |
| 584 Private slot to save the contents of the messages display. | |
| 585 </p><a NAME="IrcChannelWidget.__sendAutoWhoCommand" ID="IrcChannelWidget.__sendAutoWhoCommand"></a> | |
| 586 <h4>IrcChannelWidget.__sendAutoWhoCommand</h4> | |
| 587 <b>__sendAutoWhoCommand</b>(<i></i>) | |
| 588 <p> | |
| 589 Private slot to send the WHO command to update the users list. | |
| 590 </p><a NAME="IrcChannelWidget.__sendUserMessage" ID="IrcChannelWidget.__sendUserMessage"></a> | |
| 591 <h4>IrcChannelWidget.__sendUserMessage</h4> | |
| 592 <b>__sendUserMessage</b>(<i></i>) | |
| 593 <p> | |
| 594 Private slot to send a private message to a specific user. | |
| 595 </p><a NAME="IrcChannelWidget.__sendUserNotice" ID="IrcChannelWidget.__sendUserNotice"></a> | |
| 596 <h4>IrcChannelWidget.__sendUserNotice</h4> | |
| 597 <b>__sendUserNotice</b>(<i></i>) | |
| 598 <p> | |
| 599 Private slot to send a notice message to a specific user. | |
| 600 </p><a NAME="IrcChannelWidget.__sendUserQuery" ID="IrcChannelWidget.__sendUserQuery"></a> | |
| 601 <h4>IrcChannelWidget.__sendUserQuery</h4> | |
| 602 <b>__sendUserQuery</b>(<i></i>) | |
| 603 <p> | |
| 604 Private slot to send a query message to a specific user. | |
| 605 </p><a NAME="IrcChannelWidget.__setEditTopicButton" ID="IrcChannelWidget.__setEditTopicButton"></a> | |
| 606 <h4>IrcChannelWidget.__setEditTopicButton</h4> | |
| 607 <b>__setEditTopicButton</b>(<i></i>) | |
| 608 <p> | |
| 609 Private method to set the visibility of the Edit Topic button. | |
| 610 </p><a NAME="IrcChannelWidget.__setTopic" ID="IrcChannelWidget.__setTopic"></a> | |
| 611 <h4>IrcChannelWidget.__setTopic</h4> | |
| 612 <b>__setTopic</b>(<i>match</i>) | |
| 613 <p> | |
| 614 Private method to handle a topic change of the channel. | |
| 615 </p><dl> | |
| 616 <dt><i>match</i></dt> | |
| 617 <dd> | |
| 618 match object that matched the pattern | |
| 619 </dd> | |
| 620 </dl><dl> | |
| 621 <dt>Returns:</dt> | |
| 622 <dd> | |
| 623 flag indicating whether the message was handled (boolean) | |
| 624 </dd> | |
| 625 </dl><a NAME="IrcChannelWidget.__setUserPrivilege" ID="IrcChannelWidget.__setUserPrivilege"></a> | |
| 626 <h4>IrcChannelWidget.__setUserPrivilege</h4> | |
| 627 <b>__setUserPrivilege</b>(<i>match</i>) | |
| 628 <p> | |
| 629 Private method to handle a change of user privileges for the channel. | |
| 630 </p><dl> | |
| 631 <dt><i>match</i></dt> | |
| 632 <dd> | |
| 633 match object that matched the pattern | |
| 634 </dd> | |
| 635 </dl><dl> | |
| 636 <dt>Returns:</dt> | |
| 637 <dd> | |
| 638 flag indicating whether the message was handled (boolean) | |
| 639 </dd> | |
| 640 </dl><a NAME="IrcChannelWidget.__topicCreated" ID="IrcChannelWidget.__topicCreated"></a> | |
| 641 <h4>IrcChannelWidget.__topicCreated</h4> | |
| 642 <b>__topicCreated</b>(<i>match</i>) | |
| 643 <p> | |
| 644 Private method to handle a topic created message. | |
| 645 </p><dl> | |
| 646 <dt><i>match</i></dt> | |
| 647 <dd> | |
| 648 match object that matched the pattern | |
| 649 </dd> | |
| 650 </dl><dl> | |
| 651 <dt>Returns:</dt> | |
| 652 <dd> | |
| 653 flag indicating whether the message was handled (boolean) | |
| 654 </dd> | |
| 655 </dl><a NAME="IrcChannelWidget.__updateChannelModes" ID="IrcChannelWidget.__updateChannelModes"></a> | |
| 656 <h4>IrcChannelWidget.__updateChannelModes</h4> | |
| 657 <b>__updateChannelModes</b>(<i>match</i>) | |
| 658 <p> | |
| 659 Private method to handle a message reporting the channel modes. | |
| 660 </p><dl> | |
| 661 <dt><i>match</i></dt> | |
| 662 <dd> | |
| 663 match object that matched the pattern | |
| 664 </dd> | |
| 665 </dl><dl> | |
| 666 <dt>Returns:</dt> | |
| 667 <dd> | |
| 668 flag indicating whether the message was handled (boolean) | |
| 669 </dd> | |
| 670 </dl><a NAME="IrcChannelWidget.__userAway" ID="IrcChannelWidget.__userAway"></a> | |
| 671 <h4>IrcChannelWidget.__userAway</h4> | |
| 672 <b>__userAway</b>(<i>match</i>) | |
| 673 <p> | |
| 674 Private method to handle a topic change of the channel. | |
| 675 </p><dl> | |
| 676 <dt><i>match</i></dt> | |
| 677 <dd> | |
| 678 match object that matched the pattern | |
| 679 </dd> | |
| 680 </dl><dl> | |
| 681 <dt>Returns:</dt> | |
| 682 <dd> | |
| 683 flag indicating whether the message was handled (boolean) | |
| 684 </dd> | |
| 685 </dl><a NAME="IrcChannelWidget.__userJoin" ID="IrcChannelWidget.__userJoin"></a> | |
| 686 <h4>IrcChannelWidget.__userJoin</h4> | |
| 687 <b>__userJoin</b>(<i>match</i>) | |
| 688 <p> | |
| 689 Private method to handle a user joining the channel. | |
| 690 </p><dl> | |
| 691 <dt><i>match</i></dt> | |
| 692 <dd> | |
| 693 match object that matched the pattern | |
| 694 </dd> | |
| 695 </dl><dl> | |
| 696 <dt>Returns:</dt> | |
| 697 <dd> | |
| 698 flag indicating whether the message was handled (boolean) | |
| 699 </dd> | |
| 700 </dl><a NAME="IrcChannelWidget.__userList" ID="IrcChannelWidget.__userList"></a> | |
| 701 <h4>IrcChannelWidget.__userList</h4> | |
| 702 <b>__userList</b>(<i>match</i>) | |
| 703 <p> | |
| 704 Private method to handle the receipt of a list of users of the channel. | |
| 705 </p><dl> | |
| 706 <dt><i>match</i></dt> | |
| 707 <dd> | |
| 708 match object that matched the pattern | |
| 709 </dd> | |
| 710 </dl><dl> | |
| 711 <dt>Returns:</dt> | |
| 712 <dd> | |
| 713 flag indicating whether the message was handled (boolean) | |
| 714 </dd> | |
| 715 </dl><a NAME="IrcChannelWidget.__userNickChange" ID="IrcChannelWidget.__userNickChange"></a> | |
| 716 <h4>IrcChannelWidget.__userNickChange</h4> | |
| 717 <b>__userNickChange</b>(<i>match</i>) | |
| 718 <p> | |
| 719 Private method to handle a nickname change of a user. | |
| 720 </p><dl> | |
| 721 <dt><i>match</i></dt> | |
| 722 <dd> | |
| 723 match object that matched the pattern | |
| 724 </dd> | |
| 725 </dl><dl> | |
| 726 <dt>Returns:</dt> | |
| 727 <dd> | |
| 728 flag indicating whether the message was handled (boolean) | |
| 729 </dd> | |
| 730 </dl><a NAME="IrcChannelWidget.__userPart" ID="IrcChannelWidget.__userPart"></a> | |
| 731 <h4>IrcChannelWidget.__userPart</h4> | |
| 732 <b>__userPart</b>(<i>match</i>) | |
| 733 <p> | |
| 734 Private method to handle a user leaving the channel. | |
| 735 </p><dl> | |
| 736 <dt><i>match</i></dt> | |
| 737 <dd> | |
| 738 match object that matched the pattern | |
| 739 </dd> | |
| 740 </dl><dl> | |
| 741 <dt>Returns:</dt> | |
| 742 <dd> | |
| 743 flag indicating whether the message was handled (boolean) | |
| 744 </dd> | |
| 745 </dl><a NAME="IrcChannelWidget.__userQuit" ID="IrcChannelWidget.__userQuit"></a> | |
| 746 <h4>IrcChannelWidget.__userQuit</h4> | |
| 747 <b>__userQuit</b>(<i>match</i>) | |
| 748 <p> | |
| 749 Private method to handle a user logging off the server. | |
| 750 </p><dl> | |
| 751 <dt><i>match</i></dt> | |
| 752 <dd> | |
| 753 match object that matched the pattern | |
| 754 </dd> | |
| 755 </dl><dl> | |
| 756 <dt>Returns:</dt> | |
| 757 <dd> | |
| 758 flag indicating whether the message was handled (boolean) | |
| 759 </dd> | |
| 760 </dl><a NAME="IrcChannelWidget.__whoEnd" ID="IrcChannelWidget.__whoEnd"></a> | |
| 761 <h4>IrcChannelWidget.__whoEnd</h4> | |
| 762 <b>__whoEnd</b>(<i>match</i>) | |
| 763 <p> | |
| 764 Private method to handle the end of the WHO list. | |
| 765 </p><dl> | |
| 766 <dt><i>match</i></dt> | |
| 767 <dd> | |
| 768 match object that matched the pattern | |
| 769 </dd> | |
| 770 </dl><dl> | |
| 771 <dt>Returns:</dt> | |
| 772 <dd> | |
| 773 flag indicating whether the message was handled (boolean) | |
| 774 </dd> | |
| 775 </dl><a NAME="IrcChannelWidget.__whoEntry" ID="IrcChannelWidget.__whoEntry"></a> | |
| 776 <h4>IrcChannelWidget.__whoEntry</h4> | |
| 777 <b>__whoEntry</b>(<i>match</i>) | |
| 778 <p> | |
| 779 Private method to handle a WHO entry returned by the server as | |
| 780 requested manually. | |
| 781 </p><dl> | |
| 782 <dt><i>match</i></dt> | |
| 783 <dd> | |
| 784 match object that matched the pattern | |
| 785 </dd> | |
| 786 </dl><dl> | |
| 787 <dt>Returns:</dt> | |
| 788 <dd> | |
| 789 flag indicating whether the message was handled (boolean) | |
| 790 </dd> | |
| 791 </dl><a NAME="IrcChannelWidget.__whoIs" ID="IrcChannelWidget.__whoIs"></a> | |
| 792 <h4>IrcChannelWidget.__whoIs</h4> | |
| 793 <b>__whoIs</b>(<i></i>) | |
| 794 <p> | |
| 795 Private slot to get information about the selected user. | |
| 796 </p><a NAME="IrcChannelWidget.__whoIsAccount" ID="IrcChannelWidget.__whoIsAccount"></a> | |
| 797 <h4>IrcChannelWidget.__whoIsAccount</h4> | |
| 798 <b>__whoIsAccount</b>(<i>match</i>) | |
| 799 <p> | |
| 800 Private method to handle the WHOIS account reply. | |
| 801 </p><dl> | |
| 802 <dt><i>match</i></dt> | |
| 803 <dd> | |
| 804 match object that matched the pattern | |
| 805 </dd> | |
| 806 </dl><dl> | |
| 807 <dt>Returns:</dt> | |
| 808 <dd> | |
| 809 flag indicating whether the message was handled (boolean) | |
| 810 </dd> | |
| 811 </dl><a NAME="IrcChannelWidget.__whoIsActually" ID="IrcChannelWidget.__whoIsActually"></a> | |
| 812 <h4>IrcChannelWidget.__whoIsActually</h4> | |
| 813 <b>__whoIsActually</b>(<i>match</i>) | |
| 814 <p> | |
| 815 Private method to handle the WHOIS actually reply. | |
| 816 </p><dl> | |
| 817 <dt><i>match</i></dt> | |
| 818 <dd> | |
| 819 match object that matched the pattern | |
| 820 </dd> | |
| 821 </dl><dl> | |
| 822 <dt>Returns:</dt> | |
| 823 <dd> | |
| 824 flag indicating whether the message was handled (boolean) | |
| 825 </dd> | |
| 826 </dl><a NAME="IrcChannelWidget.__whoIsChannels" ID="IrcChannelWidget.__whoIsChannels"></a> | |
| 827 <h4>IrcChannelWidget.__whoIsChannels</h4> | |
| 828 <b>__whoIsChannels</b>(<i>match</i>) | |
| 829 <p> | |
| 830 Private method to handle the WHOIS channels reply. | |
| 831 </p><dl> | |
| 832 <dt><i>match</i></dt> | |
| 833 <dd> | |
| 834 match object that matched the pattern | |
| 835 </dd> | |
| 836 </dl><dl> | |
| 837 <dt>Returns:</dt> | |
| 838 <dd> | |
| 839 flag indicating whether the message was handled (boolean) | |
| 840 </dd> | |
| 841 </dl><a NAME="IrcChannelWidget.__whoIsConnection" ID="IrcChannelWidget.__whoIsConnection"></a> | |
| 842 <h4>IrcChannelWidget.__whoIsConnection</h4> | |
| 843 <b>__whoIsConnection</b>(<i>match</i>) | |
| 844 <p> | |
| 845 Private method to handle the WHOIS connection reply. | |
| 846 </p><dl> | |
| 847 <dt><i>match</i></dt> | |
| 848 <dd> | |
| 849 match object that matched the pattern | |
| 850 </dd> | |
| 851 </dl><dl> | |
| 852 <dt>Returns:</dt> | |
| 853 <dd> | |
| 854 flag indicating whether the message was handled (boolean) | |
| 855 </dd> | |
| 856 </dl><a NAME="IrcChannelWidget.__whoIsEnd" ID="IrcChannelWidget.__whoIsEnd"></a> | |
| 857 <h4>IrcChannelWidget.__whoIsEnd</h4> | |
| 858 <b>__whoIsEnd</b>(<i>match</i>) | |
| 859 <p> | |
| 860 Private method to handle the end of WHOIS reply. | |
| 861 </p><dl> | |
| 862 <dt><i>match</i></dt> | |
| 863 <dd> | |
| 864 match object that matched the pattern | |
| 865 </dd> | |
| 866 </dl><dl> | |
| 867 <dt>Returns:</dt> | |
| 868 <dd> | |
| 869 flag indicating whether the message was handled (boolean) | |
| 870 </dd> | |
| 871 </dl><a NAME="IrcChannelWidget.__whoIsHelper" ID="IrcChannelWidget.__whoIsHelper"></a> | |
| 872 <h4>IrcChannelWidget.__whoIsHelper</h4> | |
| 873 <b>__whoIsHelper</b>(<i>match</i>) | |
| 874 <p> | |
| 875 Private method to handle the WHOIS helper reply. | |
| 876 </p><dl> | |
| 877 <dt><i>match</i></dt> | |
| 878 <dd> | |
| 879 match object that matched the pattern | |
| 880 </dd> | |
| 881 </dl><dl> | |
| 882 <dt>Returns:</dt> | |
| 883 <dd> | |
| 884 flag indicating whether the message was handled (boolean) | |
| 885 </dd> | |
| 886 </dl><a NAME="IrcChannelWidget.__whoIsIdentify" ID="IrcChannelWidget.__whoIsIdentify"></a> | |
| 887 <h4>IrcChannelWidget.__whoIsIdentify</h4> | |
| 888 <b>__whoIsIdentify</b>(<i>match</i>) | |
| 889 <p> | |
| 890 Private method to handle the WHOIS identify and identified replies. | |
| 891 </p><dl> | |
| 892 <dt><i>match</i></dt> | |
| 893 <dd> | |
| 894 match object that matched the pattern | |
| 895 </dd> | |
| 896 </dl><dl> | |
| 897 <dt>Returns:</dt> | |
| 898 <dd> | |
| 899 flag indicating whether the message was handled (boolean) | |
| 900 </dd> | |
| 901 </dl><a NAME="IrcChannelWidget.__whoIsIdle" ID="IrcChannelWidget.__whoIsIdle"></a> | |
| 902 <h4>IrcChannelWidget.__whoIsIdle</h4> | |
| 903 <b>__whoIsIdle</b>(<i>match</i>) | |
| 904 <p> | |
| 905 Private method to handle the WHOIS idle reply. | |
| 906 </p><dl> | |
| 907 <dt><i>match</i></dt> | |
| 908 <dd> | |
| 909 match object that matched the pattern | |
| 910 </dd> | |
| 911 </dl><dl> | |
| 912 <dt>Returns:</dt> | |
| 913 <dd> | |
| 914 flag indicating whether the message was handled (boolean) | |
| 915 </dd> | |
| 916 </dl><a NAME="IrcChannelWidget.__whoIsOperator" ID="IrcChannelWidget.__whoIsOperator"></a> | |
| 917 <h4>IrcChannelWidget.__whoIsOperator</h4> | |
| 918 <b>__whoIsOperator</b>(<i>match</i>) | |
| 919 <p> | |
| 920 Private method to handle the WHOIS operator reply. | |
| 921 </p><dl> | |
| 922 <dt><i>match</i></dt> | |
| 923 <dd> | |
| 924 match object that matched the pattern | |
| 925 </dd> | |
| 926 </dl><dl> | |
| 927 <dt>Returns:</dt> | |
| 928 <dd> | |
| 929 flag indicating whether the message was handled (boolean) | |
| 930 </dd> | |
| 931 </dl><a NAME="IrcChannelWidget.__whoIsSecure" ID="IrcChannelWidget.__whoIsSecure"></a> | |
| 932 <h4>IrcChannelWidget.__whoIsSecure</h4> | |
| 933 <b>__whoIsSecure</b>(<i>match</i>) | |
| 934 <p> | |
| 935 Private method to handle the WHOIS secure reply. | |
| 936 </p><dl> | |
| 937 <dt><i>match</i></dt> | |
| 938 <dd> | |
| 939 match object that matched the pattern | |
| 940 </dd> | |
| 941 </dl><dl> | |
| 942 <dt>Returns:</dt> | |
| 943 <dd> | |
| 944 flag indicating whether the message was handled (boolean) | |
| 945 </dd> | |
| 946 </dl><a NAME="IrcChannelWidget.__whoIsServer" ID="IrcChannelWidget.__whoIsServer"></a> | |
| 947 <h4>IrcChannelWidget.__whoIsServer</h4> | |
| 948 <b>__whoIsServer</b>(<i>match</i>) | |
| 949 <p> | |
| 950 Private method to handle the WHOIS server reply. | |
| 951 </p><dl> | |
| 952 <dt><i>match</i></dt> | |
| 953 <dd> | |
| 954 match object that matched the pattern | |
| 955 </dd> | |
| 956 </dl><dl> | |
| 957 <dt>Returns:</dt> | |
| 958 <dd> | |
| 959 flag indicating whether the message was handled (boolean) | |
| 960 </dd> | |
| 961 </dl><a NAME="IrcChannelWidget.__whoIsUser" ID="IrcChannelWidget.__whoIsUser"></a> | |
| 962 <h4>IrcChannelWidget.__whoIsUser</h4> | |
| 963 <b>__whoIsUser</b>(<i>match</i>) | |
| 964 <p> | |
| 965 Private method to handle the WHOIS user reply. | |
| 966 </p><dl> | |
| 967 <dt><i>match</i></dt> | |
| 968 <dd> | |
| 969 match object that matched the pattern | |
| 970 </dd> | |
| 971 </dl><dl> | |
| 972 <dt>Returns:</dt> | |
| 973 <dd> | |
| 974 flag indicating whether the message was handled (boolean) | |
| 975 </dd> | |
| 976 </dl><a NAME="IrcChannelWidget.addMessage" ID="IrcChannelWidget.addMessage"></a> | |
| 977 <h4>IrcChannelWidget.addMessage</h4> | |
| 978 <b>addMessage</b>(<i>sender, msg</i>) | |
| 979 <p> | |
| 980 Public method to add a message from external. | |
| 981 </p><dl> | |
| 982 <dt><i>sender</i></dt> | |
| 983 <dd> | |
| 984 nick name of the sender (string) | |
| 985 </dd><dt><i>msg</i></dt> | |
| 986 <dd> | |
| 987 message received from sender (string) | |
| 988 </dd> | |
| 989 </dl><a NAME="IrcChannelWidget.addUsers" ID="IrcChannelWidget.addUsers"></a> | |
| 990 <h4>IrcChannelWidget.addUsers</h4> | |
| 991 <b>addUsers</b>(<i>users</i>) | |
| 992 <p> | |
| 993 Public method to add users to the channel. | |
| 994 </p><dl> | |
| 995 <dt><i>users</i></dt> | |
| 996 <dd> | |
| 997 list of user names to add (list of string) | |
| 998 </dd> | |
| 999 </dl><a NAME="IrcChannelWidget.getUsersCount" ID="IrcChannelWidget.getUsersCount"></a> | |
| 1000 <h4>IrcChannelWidget.getUsersCount</h4> | |
| 1001 <b>getUsersCount</b>(<i></i>) | |
| 1002 <p> | |
| 1003 Public method to get the users count of the channel. | |
| 1004 </p><dl> | |
| 1005 <dt>Returns:</dt> | |
| 1006 <dd> | |
| 1007 users count of the channel (integer) | |
| 1008 </dd> | |
| 1009 </dl><a NAME="IrcChannelWidget.handleMessage" ID="IrcChannelWidget.handleMessage"></a> | |
| 1010 <h4>IrcChannelWidget.handleMessage</h4> | |
| 1011 <b>handleMessage</b>(<i>line</i>) | |
| 1012 <p> | |
| 1013 Public method to handle the message sent by the server. | |
| 1014 </p><dl> | |
| 1015 <dt><i>line</i></dt> | |
| 1016 <dd> | |
| 1017 server message (string) | |
| 1018 </dd> | |
| 1019 </dl><dl> | |
| 1020 <dt>Returns:</dt> | |
| 1021 <dd> | |
| 1022 flag indicating, if the message was handled (boolean) | |
| 1023 </dd> | |
| 1024 </dl><a NAME="IrcChannelWidget.hideEvent" ID="IrcChannelWidget.hideEvent"></a> | |
| 1025 <h4>IrcChannelWidget.hideEvent</h4> | |
| 1026 <b>hideEvent</b>(<i>evt</i>) | |
| 1027 <p> | |
| 1028 Protected method handling hide events. | |
| 1029 </p><dl> | |
| 1030 <dt><i>evt</i></dt> | |
| 1031 <dd> | |
| 1032 reference to the hide event (QHideEvent) | |
| 1033 </dd> | |
| 1034 </dl><a NAME="IrcChannelWidget.initAutoWho" ID="IrcChannelWidget.initAutoWho"></a> | |
| 1035 <h4>IrcChannelWidget.initAutoWho</h4> | |
| 1036 <b>initAutoWho</b>(<i></i>) | |
| 1037 <p> | |
| 1038 Public method to initialize the Auto Who system. | |
| 1039 </p><a NAME="IrcChannelWidget.leaveChannel" ID="IrcChannelWidget.leaveChannel"></a> | |
| 1040 <h4>IrcChannelWidget.leaveChannel</h4> | |
| 1041 <b>leaveChannel</b>(<i></i>) | |
| 1042 <p> | |
| 1043 Public slot to leave the channel. | |
| 1044 </p><a NAME="IrcChannelWidget.name" ID="IrcChannelWidget.name"></a> | |
| 1045 <h4>IrcChannelWidget.name</h4> | |
| 1046 <b>name</b>(<i></i>) | |
| 1047 <p> | |
| 1048 Public method to get the name of the channel. | |
| 1049 </p><dl> | |
| 1050 <dt>Returns:</dt> | |
| 1051 <dd> | |
| 1052 name of the channel (string) | |
| 1053 </dd> | |
| 1054 </dl><a NAME="IrcChannelWidget.on_editTopicButton_clicked" ID="IrcChannelWidget.on_editTopicButton_clicked"></a> | |
| 1055 <h4>IrcChannelWidget.on_editTopicButton_clicked</h4> | |
| 1056 <b>on_editTopicButton_clicked</b>(<i></i>) | |
| 1057 <p> | |
| 1058 Private slot to change the topic of the channel. | |
| 1059 </p><a NAME="IrcChannelWidget.on_messageEdit_returnPressed" ID="IrcChannelWidget.on_messageEdit_returnPressed"></a> | |
| 1060 <h4>IrcChannelWidget.on_messageEdit_returnPressed</h4> | |
| 1061 <b>on_messageEdit_returnPressed</b>(<i></i>) | |
| 1062 <p> | |
| 1063 Private slot to send a message to the channel. | |
| 1064 </p><a NAME="IrcChannelWidget.on_messages_anchorClicked" ID="IrcChannelWidget.on_messages_anchorClicked"></a> | |
| 1065 <h4>IrcChannelWidget.on_messages_anchorClicked</h4> | |
| 1066 <b>on_messages_anchorClicked</b>(<i>url</i>) | |
| 1067 <p> | |
| 1068 Private slot to open links in the default browser. | |
| 1069 </p><dl> | |
| 1070 <dt><i>url</i></dt> | |
| 1071 <dd> | |
| 1072 URL to be opened (QUrl) | |
| 1073 </dd> | |
| 1074 </dl><a NAME="IrcChannelWidget.on_messages_copyAvailable" ID="IrcChannelWidget.on_messages_copyAvailable"></a> | |
| 1075 <h4>IrcChannelWidget.on_messages_copyAvailable</h4> | |
| 1076 <b>on_messages_copyAvailable</b>(<i>yes</i>) | |
| 1077 <p> | |
| 1078 Private slot to react to text selection/deselection of the messages | |
| 1079 edit. | |
| 1080 </p><dl> | |
| 1081 <dt><i>yes</i></dt> | |
| 1082 <dd> | |
| 1083 flag signaling the availability of selected text (boolean) | |
| 1084 </dd> | |
| 1085 </dl><a NAME="IrcChannelWidget.on_messages_customContextMenuRequested" ID="IrcChannelWidget.on_messages_customContextMenuRequested"></a> | |
| 1086 <h4>IrcChannelWidget.on_messages_customContextMenuRequested</h4> | |
| 1087 <b>on_messages_customContextMenuRequested</b>(<i>pos</i>) | |
| 1088 <p> | |
| 1089 Private slot to show the context menu of the messages pane. | |
| 1090 </p><dl> | |
| 1091 <dt><i>pos</i></dt> | |
| 1092 <dd> | |
| 1093 the position of the mouse pointer (QPoint) | |
| 1094 </dd> | |
| 1095 </dl><a NAME="IrcChannelWidget.on_usersList_customContextMenuRequested" ID="IrcChannelWidget.on_usersList_customContextMenuRequested"></a> | |
| 1096 <h4>IrcChannelWidget.on_usersList_customContextMenuRequested</h4> | |
| 1097 <b>on_usersList_customContextMenuRequested</b>(<i>pos</i>) | |
| 1098 <p> | |
| 1099 Private slot to show the context menu of the users list. | |
| 1100 </p><dl> | |
| 1101 <dt><i>pos</i></dt> | |
| 1102 <dd> | |
| 1103 the position of the mouse pointer (QPoint) | |
| 1104 </dd> | |
| 1105 </dl><a NAME="IrcChannelWidget.partMessage" ID="IrcChannelWidget.partMessage"></a> | |
| 1106 <h4>IrcChannelWidget.partMessage</h4> | |
| 1107 <b>partMessage</b>(<i></i>) | |
| 1108 <p> | |
| 1109 Public method to get the part message. | |
| 1110 </p><dl> | |
| 1111 <dt>Returns:</dt> | |
| 1112 <dd> | |
| 1113 part message (string) | |
| 1114 </dd> | |
| 1115 </dl><a NAME="IrcChannelWidget.requestLeave" ID="IrcChannelWidget.requestLeave"></a> | |
| 1116 <h4>IrcChannelWidget.requestLeave</h4> | |
| 1117 <b>requestLeave</b>(<i></i>) | |
| 1118 <p> | |
| 1119 Public method to leave the channel. | |
| 1120 </p><a NAME="IrcChannelWidget.setMarkerLine" ID="IrcChannelWidget.setMarkerLine"></a> | |
| 1121 <h4>IrcChannelWidget.setMarkerLine</h4> | |
| 1122 <b>setMarkerLine</b>(<i></i>) | |
| 1123 <p> | |
| 1124 Public method to draw a line to mark the current position. | |
| 1125 </p><a NAME="IrcChannelWidget.setName" ID="IrcChannelWidget.setName"></a> | |
| 1126 <h4>IrcChannelWidget.setName</h4> | |
| 1127 <b>setName</b>(<i>name</i>) | |
| 1128 <p> | |
| 1129 Public method to set the name of the channel. | |
| 1130 </p><dl> | |
| 1131 <dt><i>name</i></dt> | |
| 1132 <dd> | |
| 1133 of the channel (string) | |
| 1134 </dd> | |
| 1135 </dl><a NAME="IrcChannelWidget.setPartMessage" ID="IrcChannelWidget.setPartMessage"></a> | |
| 1136 <h4>IrcChannelWidget.setPartMessage</h4> | |
| 1137 <b>setPartMessage</b>(<i>message</i>) | |
| 1138 <p> | |
| 1139 Public method to set the part message. | |
| 1140 </p><dl> | |
| 1141 <dt><i>message</i></dt> | |
| 1142 <dd> | |
| 1143 message to be used for PART messages (string) | |
| 1144 </dd> | |
| 1145 </dl><a NAME="IrcChannelWidget.setPrivate" ID="IrcChannelWidget.setPrivate"></a> | |
| 1146 <h4>IrcChannelWidget.setPrivate</h4> | |
| 1147 <b>setPrivate</b>(<i>private, partner=""</i>) | |
| 1148 <p> | |
| 1149 Public method to set the private chat mode. | |
| 1150 </p><dl> | |
| 1151 <dt><i>private</i></dt> | |
| 1152 <dd> | |
| 1153 flag indicating private chat mode (boolean) | |
| 1154 </dd><dt><i>partner</i></dt> | |
| 1155 <dd> | |
| 1156 name of the partner user (string) | |
| 1157 </dd> | |
| 1158 </dl><a NAME="IrcChannelWidget.setPrivateInfo" ID="IrcChannelWidget.setPrivateInfo"></a> | |
| 1159 <h4>IrcChannelWidget.setPrivateInfo</h4> | |
| 1160 <b>setPrivateInfo</b>(<i>infoText</i>) | |
| 1161 <p> | |
| 1162 Public method to set some info text for private chat mode. | |
| 1163 </p><dl> | |
| 1164 <dt><i>infoText</i></dt> | |
| 1165 <dd> | |
| 1166 info text to be shown (string) | |
| 1167 </dd> | |
| 1168 </dl><a NAME="IrcChannelWidget.setUserName" ID="IrcChannelWidget.setUserName"></a> | |
| 1169 <h4>IrcChannelWidget.setUserName</h4> | |
| 1170 <b>setUserName</b>(<i>name</i>) | |
| 1171 <p> | |
| 1172 Public method to set the user name for the channel. | |
| 1173 </p><dl> | |
| 1174 <dt><i>name</i></dt> | |
| 1175 <dd> | |
| 1176 user name for the channel (string) | |
| 1177 </dd> | |
| 1178 </dl><a NAME="IrcChannelWidget.setUserPrivilegePrefix" ID="IrcChannelWidget.setUserPrivilegePrefix"></a> | |
| 1179 <h4>IrcChannelWidget.setUserPrivilegePrefix</h4> | |
| 1180 <b>setUserPrivilegePrefix</b>(<i>prefixes</i>) | |
| 1181 <p> | |
| 1182 Public method to set the user privilege to prefix mapping. | |
| 1183 </p><dl> | |
| 1184 <dt><i>prefixes</i></dt> | |
| 1185 <dd> | |
| 1186 dictionary with privilege as key and prefix as value | |
| 1187 </dd> | |
| 1188 </dl><a NAME="IrcChannelWidget.showEvent" ID="IrcChannelWidget.showEvent"></a> | |
| 1189 <h4>IrcChannelWidget.showEvent</h4> | |
| 1190 <b>showEvent</b>(<i>evt</i>) | |
| 1191 <p> | |
| 1192 Protected method handling show events. | |
| 1193 </p><dl> | |
| 1194 <dt><i>evt</i></dt> | |
| 1195 <dd> | |
| 1196 reference to the show event (QShowEvent) | |
| 1197 </dd> | |
| 1198 </dl><a NAME="IrcChannelWidget.unsetMarkerLine" ID="IrcChannelWidget.unsetMarkerLine"></a> | |
| 1199 <h4>IrcChannelWidget.unsetMarkerLine</h4> | |
| 1200 <b>unsetMarkerLine</b>(<i></i>) | |
| 1201 <p> | |
| 1202 Public method to remove the marker line. | |
| 1203 </p><a NAME="IrcChannelWidget.userName" ID="IrcChannelWidget.userName"></a> | |
| 1204 <h4>IrcChannelWidget.userName</h4> | |
| 1205 <b>userName</b>(<i></i>) | |
| 1206 <p> | |
| 1207 Public method to get the nick name of the user. | |
| 1208 </p><dl> | |
| 1209 <dt>Returns:</dt> | |
| 1210 <dd> | |
| 1211 nick name of the user (string) | |
| 1212 </dd> | |
| 1213 </dl> | |
| 1214 <div align="right"><a href="#top">Up</a></div> | |
| 1215 <hr /><hr /> | |
| 1216 <a NAME="IrcUserItem" ID="IrcUserItem"></a> | |
| 1217 <h2>IrcUserItem</h2> | |
| 1218 <p> | |
| 1219 Class implementing a list widget item containing an IRC channel user. | |
| 1220 </p> | |
| 1221 <h3>Derived from</h3> | |
| 1222 QListWidgetItem | |
| 1223 <h3>Class Attributes</h3> | |
| 1224 <table> | |
| 1225 <tr><td>Admin</td></tr><tr><td>Away</td></tr><tr><td>Halfop</td></tr><tr><td>Normal</td></tr><tr><td>Operator</td></tr><tr><td>Owner</td></tr><tr><td>PrivilegeMapping</td></tr><tr><td>Voice</td></tr> | |
| 1226 </table> | |
| 1227 <h3>Class Methods</h3> | |
| 1228 <table> | |
| 1229 <tr><td>None</td></tr> | |
| 1230 </table> | |
| 1231 <h3>Methods</h3> | |
| 1232 <table> | |
| 1233 <tr> | |
| 1234 <td><a href="#IrcUserItem.__init__">IrcUserItem</a></td> | |
| 1235 <td>Constructor</td> | |
| 1236 </tr><tr> | |
| 1237 <td><a href="#IrcUserItem.__awayIcon">__awayIcon</a></td> | |
| 1238 <td>Private method to convert an icon to an away icon.</td> | |
| 1239 </tr><tr> | |
| 1240 <td><a href="#IrcUserItem.__setIcon">__setIcon</a></td> | |
| 1241 <td>Private method to set the icon dependent on user privileges.</td> | |
| 1242 </tr><tr> | |
| 1243 <td><a href="#IrcUserItem.__setText">__setText</a></td> | |
| 1244 <td>Private method to set the user item text.</td> | |
| 1245 </tr><tr> | |
| 1246 <td><a href="#IrcUserItem.canChangeTopic">canChangeTopic</a></td> | |
| 1247 <td>Public method to check, if the user is allowed to change the topic.</td> | |
| 1248 </tr><tr> | |
| 1249 <td><a href="#IrcUserItem.changePrivilege">changePrivilege</a></td> | |
| 1250 <td>Public method to set or unset a user privilege.</td> | |
| 1251 </tr><tr> | |
| 1252 <td><a href="#IrcUserItem.clearPrivileges">clearPrivileges</a></td> | |
| 1253 <td>Public method to clear the user privileges.</td> | |
| 1254 </tr><tr> | |
| 1255 <td><a href="#IrcUserItem.isIgnored">isIgnored</a></td> | |
| 1256 <td>Public method to check, if this user is ignored.</td> | |
| 1257 </tr><tr> | |
| 1258 <td><a href="#IrcUserItem.name">name</a></td> | |
| 1259 <td>Public method to get the user name.</td> | |
| 1260 </tr><tr> | |
| 1261 <td><a href="#IrcUserItem.parseWhoFlags">parseWhoFlags</a></td> | |
| 1262 <td>Public method to parse the user flags reported by a WHO command.</td> | |
| 1263 </tr><tr> | |
| 1264 <td><a href="#IrcUserItem.setIgnored">setIgnored</a></td> | |
| 1265 <td>Public method to set the user status to ignored.</td> | |
| 1266 </tr><tr> | |
| 1267 <td><a href="#IrcUserItem.setName">setName</a></td> | |
| 1268 <td>Public method to set a new nick name.</td> | |
| 1269 </tr> | |
| 1270 </table> | |
| 1271 <h3>Static Methods</h3> | |
| 1272 <table> | |
| 1273 <tr><td>None</td></tr> | |
| 1274 </table> | |
| 1275 <a NAME="IrcUserItem.__init__" ID="IrcUserItem.__init__"></a> | |
| 1276 <h4>IrcUserItem (Constructor)</h4> | |
| 1277 <b>IrcUserItem</b>(<i>name, parent=None</i>) | |
| 1278 <p> | |
| 1279 Constructor | |
| 1280 </p><dl> | |
| 1281 <dt><i>name</i></dt> | |
| 1282 <dd> | |
| 1283 string with user name and privilege prefix (string) | |
| 1284 </dd><dt><i>parent</i></dt> | |
| 1285 <dd> | |
| 1286 reference to the parent widget (QListWidget or | |
| 1287 QListWidgetItem) | |
| 1288 </dd> | |
| 1289 </dl><a NAME="IrcUserItem.__awayIcon" ID="IrcUserItem.__awayIcon"></a> | |
| 1290 <h4>IrcUserItem.__awayIcon</h4> | |
| 1291 <b>__awayIcon</b>(<i>icon</i>) | |
| 1292 <p> | |
| 1293 Private method to convert an icon to an away icon. | |
| 1294 </p><dl> | |
| 1295 <dt><i>icon</i></dt> | |
| 1296 <dd> | |
| 1297 icon to be converted (QIcon) | |
| 1298 </dd> | |
| 1299 </dl><dl> | |
| 1300 <dt>Returns:</dt> | |
| 1301 <dd> | |
| 1302 away icon (QIcon) | |
| 1303 </dd> | |
| 1304 </dl><a NAME="IrcUserItem.__setIcon" ID="IrcUserItem.__setIcon"></a> | |
| 1305 <h4>IrcUserItem.__setIcon</h4> | |
| 1306 <b>__setIcon</b>(<i></i>) | |
| 1307 <p> | |
| 1308 Private method to set the icon dependent on user privileges. | |
| 1309 </p><a NAME="IrcUserItem.__setText" ID="IrcUserItem.__setText"></a> | |
| 1310 <h4>IrcUserItem.__setText</h4> | |
| 1311 <b>__setText</b>(<i></i>) | |
| 1312 <p> | |
| 1313 Private method to set the user item text. | |
| 1314 </p><a NAME="IrcUserItem.canChangeTopic" ID="IrcUserItem.canChangeTopic"></a> | |
| 1315 <h4>IrcUserItem.canChangeTopic</h4> | |
| 1316 <b>canChangeTopic</b>(<i></i>) | |
| 1317 <p> | |
| 1318 Public method to check, if the user is allowed to change the topic. | |
| 1319 </p><dl> | |
| 1320 <dt>Returns:</dt> | |
| 1321 <dd> | |
| 1322 flag indicating that the topic can be changed (boolean) | |
| 1323 </dd> | |
| 1324 </dl><a NAME="IrcUserItem.changePrivilege" ID="IrcUserItem.changePrivilege"></a> | |
| 1325 <h4>IrcUserItem.changePrivilege</h4> | |
| 1326 <b>changePrivilege</b>(<i>privilege</i>) | |
| 1327 <p> | |
| 1328 Public method to set or unset a user privilege. | |
| 1329 </p><dl> | |
| 1330 <dt><i>privilege</i></dt> | |
| 1331 <dd> | |
| 1332 privilege to set or unset (string) | |
| 1333 </dd> | |
| 1334 </dl><a NAME="IrcUserItem.clearPrivileges" ID="IrcUserItem.clearPrivileges"></a> | |
| 1335 <h4>IrcUserItem.clearPrivileges</h4> | |
| 1336 <b>clearPrivileges</b>(<i></i>) | |
| 1337 <p> | |
| 1338 Public method to clear the user privileges. | |
| 1339 </p><a NAME="IrcUserItem.isIgnored" ID="IrcUserItem.isIgnored"></a> | |
| 1340 <h4>IrcUserItem.isIgnored</h4> | |
| 1341 <b>isIgnored</b>(<i></i>) | |
| 1342 <p> | |
| 1343 Public method to check, if this user is ignored. | |
| 1344 </p><dl> | |
| 1345 <dt>Returns:</dt> | |
| 1346 <dd> | |
| 1347 flag indicating the ignored status | |
| 1348 </dd> | |
| 1349 </dl><dl> | |
| 1350 <dt>Return Type:</dt> | |
| 1351 <dd> | |
| 1352 bool | |
| 1353 </dd> | |
| 1354 </dl><a NAME="IrcUserItem.name" ID="IrcUserItem.name"></a> | |
| 1355 <h4>IrcUserItem.name</h4> | |
| 1356 <b>name</b>(<i></i>) | |
| 1357 <p> | |
| 1358 Public method to get the user name. | |
| 1359 </p><dl> | |
| 1360 <dt>Returns:</dt> | |
| 1361 <dd> | |
| 1362 user name (string) | |
| 1363 </dd> | |
| 1364 </dl><a NAME="IrcUserItem.parseWhoFlags" ID="IrcUserItem.parseWhoFlags"></a> | |
| 1365 <h4>IrcUserItem.parseWhoFlags</h4> | |
| 1366 <b>parseWhoFlags</b>(<i>flags</i>) | |
| 1367 <p> | |
| 1368 Public method to parse the user flags reported by a WHO command. | |
| 1369 </p><dl> | |
| 1370 <dt><i>flags</i></dt> | |
| 1371 <dd> | |
| 1372 user flags as reported by WHO (string) | |
| 1373 </dd> | |
| 1374 </dl><a NAME="IrcUserItem.setIgnored" ID="IrcUserItem.setIgnored"></a> | |
| 1375 <h4>IrcUserItem.setIgnored</h4> | |
| 1376 <b>setIgnored</b>(<i>ignored</i>) | |
| 1377 <p> | |
| 1378 Public method to set the user status to ignored. | |
| 1379 </p><dl> | |
| 1380 <dt><i>ignored</i> (bool)</dt> | |
| 1381 <dd> | |
| 1382 flag indicating the new ignored status | |
| 1383 </dd> | |
| 1384 </dl><a NAME="IrcUserItem.setName" ID="IrcUserItem.setName"></a> | |
| 1385 <h4>IrcUserItem.setName</h4> | |
| 1386 <b>setName</b>(<i>name</i>) | |
| 1387 <p> | |
| 1388 Public method to set a new nick name. | |
| 1389 </p><dl> | |
| 1390 <dt><i>name</i></dt> | |
| 1391 <dd> | |
| 1392 new nick name for the user (string) | |
| 1393 </dd> | |
| 1394 </dl> | |
| 1395 <div align="right"><a href="#top">Up</a></div> | |
| 1396 <hr /> | |
| 1397 </body></html> |
