Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Network.IRC.IrcWidget.html
src/eric7/Documentation/Source/eric7.Network.IRC.IrcWidget.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Network.IRC.IrcWidget</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Network.IRC.IrcWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the IRC window. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#IrcWidget">IrcWidget</a></td> | |
| 25 <td>Class implementing the IRC window.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="IrcWidget" ID="IrcWidget"></a> | |
| 36 <h2>IrcWidget</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the IRC window. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>autoConnected()</dt> | |
| 45 <dd> | |
| 46 emitted after an automatic connection was initiated | |
| 47 </dd> | |
| 48 </dl> | |
| 49 <h3>Derived from</h3> | |
| 50 QWidget, Ui_IrcWidget | |
| 51 <h3>Class Attributes</h3> | |
| 52 | |
| 53 <table> | |
| 54 <tr><td>ServerConnected</td></tr><tr><td>ServerConnecting</td></tr><tr><td>ServerDisconnected</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 | |
| 65 <tr> | |
| 66 <td><a href="#IrcWidget.__init__">IrcWidget</a></td> | |
| 67 <td>Constructor</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#IrcWidget.__autoJoinChannels">__autoJoinChannels</a></td> | |
| 71 <td>Private slot to join channels automatically once a server got connected.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#IrcWidget.__away">__away</a></td> | |
| 75 <td>Private slot handling the change of the away state.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#IrcWidget.__changeNick">__changeNick</a></td> | |
| 79 <td>Private slot to use a new nick name.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#IrcWidget.__closeAllChannels">__closeAllChannels</a></td> | |
| 83 <td>Private method to close all channels.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#IrcWidget.__closeChannel">__closeChannel</a></td> | |
| 87 <td>Private slot handling the closing of a channel.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#IrcWidget.__connectNetwork">__connectNetwork</a></td> | |
| 91 <td>Private slot to connect to or disconnect from the given network.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#IrcWidget.__editNetwork">__editNetwork</a></td> | |
| 95 <td>Private slot to edit the network configuration.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#IrcWidget.__handleCtcp">__handleCtcp</a></td> | |
| 99 <td>Private method to handle a CTCP command.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#IrcWidget.__handleCtcpReply">__handleCtcpReply</a></td> | |
| 103 <td>Private method to handle a server message containing a CTCP reply.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#IrcWidget.__handleNamedMessage">__handleNamedMessage</a></td> | |
| 107 <td>Private method to handle a server message containing a message name.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#IrcWidget.__handleNickInUse">__handleNickInUse</a></td> | |
| 111 <td>Private method to handle a 443 server error.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#IrcWidget.__handleNickInUseLogin">__handleNickInUseLogin</a></td> | |
| 115 <td>Private method to handle a 443 server error at login.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#IrcWidget.__handleNumericMessage">__handleNumericMessage</a></td> | |
| 119 <td>Private method to handle a server message containing a numeric code.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#IrcWidget.__handleServerError">__handleServerError</a></td> | |
| 123 <td>Private slot to handle a server error reply.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#IrcWidget.__handleServerReply">__handleServerReply</a></td> | |
| 127 <td>Private slot to handle a server reply.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#IrcWidget.__hostConnected">__hostConnected</a></td> | |
| 131 <td>Private slot to log in to the server after the connection was established.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#IrcWidget.__hostDisconnected">__hostDisconnected</a></td> | |
| 135 <td>Private slot to indicate the host was disconnected.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#IrcWidget.__hostFound">__hostFound</a></td> | |
| 139 <td>Private slot to indicate the host was found.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#IrcWidget.__leaveAllChannels">__leaveAllChannels</a></td> | |
| 143 <td>Private slot to leave all channels and close their tabs.</td> | |
| 144 </tr> | |
| 145 <tr> | |
| 146 <td><a href="#IrcWidget.__leaveChannel">__leaveChannel</a></td> | |
| 147 <td>Private slot to leave a channel and close the associated tab.</td> | |
| 148 </tr> | |
| 149 <tr> | |
| 150 <td><a href="#IrcWidget.__leaveChannels">__leaveChannels</a></td> | |
| 151 <td>Private slot to leave a list of channels and close their associated tabs.</td> | |
| 152 </tr> | |
| 153 <tr> | |
| 154 <td><a href="#IrcWidget.__networkDataChanged">__networkDataChanged</a></td> | |
| 155 <td>Private slot handling changes of the network and identity definitions.</td> | |
| 156 </tr> | |
| 157 <tr> | |
| 158 <td><a href="#IrcWidget.__openPrivate">__openPrivate</a></td> | |
| 159 <td>Private slot to open a private chat with the given user.</td> | |
| 160 </tr> | |
| 161 <tr> | |
| 162 <td><a href="#IrcWidget.__ping">__ping</a></td> | |
| 163 <td>Private method to handle a PING message.</td> | |
| 164 </tr> | |
| 165 <tr> | |
| 166 <td><a href="#IrcWidget.__query">__query</a></td> | |
| 167 <td>Private method to handle a new private connection.</td> | |
| 168 </tr> | |
| 169 <tr> | |
| 170 <td><a href="#IrcWidget.__readyRead">__readyRead</a></td> | |
| 171 <td>Private slot to read data from the socket.</td> | |
| 172 </tr> | |
| 173 <tr> | |
| 174 <td><a href="#IrcWidget.__registerWithServices">__registerWithServices</a></td> | |
| 175 <td>Private method to register to services.</td> | |
| 176 </tr> | |
| 177 <tr> | |
| 178 <td><a href="#IrcWidget.__send">__send</a></td> | |
| 179 <td>Private slot to send data to the IRC server.</td> | |
| 180 </tr> | |
| 181 <tr> | |
| 182 <td><a href="#IrcWidget.__sendCtcpReply">__sendCtcpReply</a></td> | |
| 183 <td>Private slot to send a CTCP reply.</td> | |
| 184 </tr> | |
| 185 <tr> | |
| 186 <td><a href="#IrcWidget.__sendCtcpRequest">__sendCtcpRequest</a></td> | |
| 187 <td>Private slot to send a CTCP request.</td> | |
| 188 </tr> | |
| 189 <tr> | |
| 190 <td><a href="#IrcWidget.__setChannelTypePrefixes">__setChannelTypePrefixes</a></td> | |
| 191 <td>Private method to set the channel type prefixes.</td> | |
| 192 </tr> | |
| 193 <tr> | |
| 194 <td><a href="#IrcWidget.__setUserPrivilegePrefix">__setUserPrivilegePrefix</a></td> | |
| 195 <td>Private method to set the user privilege prefix.</td> | |
| 196 </tr> | |
| 197 <tr> | |
| 198 <td><a href="#IrcWidget.__sslErrors">__sslErrors</a></td> | |
| 199 <td>Private slot to handle SSL errors.</td> | |
| 200 </tr> | |
| 201 <tr> | |
| 202 <td><a href="#IrcWidget.__tcpError">__tcpError</a></td> | |
| 203 <td>Private slot to handle errors reported by the TCP socket.</td> | |
| 204 </tr> | |
| 205 <tr> | |
| 206 <td><a href="#IrcWidget.__updateUsersCount">__updateUsersCount</a></td> | |
| 207 <td>Private method to update the users count on the channel tabs.</td> | |
| 208 </tr> | |
| 209 <tr> | |
| 210 <td><a href="#IrcWidget.autoConnect">autoConnect</a></td> | |
| 211 <td>Public method to initiate the IRC auto connection.</td> | |
| 212 </tr> | |
| 213 <tr> | |
| 214 <td><a href="#IrcWidget.isChannelName">isChannelName</a></td> | |
| 215 <td>Public method to check, if the given name is a channel name.</td> | |
| 216 </tr> | |
| 217 <tr> | |
| 218 <td><a href="#IrcWidget.joinChannel">joinChannel</a></td> | |
| 219 <td>Public slot to join a channel.</td> | |
| 220 </tr> | |
| 221 <tr> | |
| 222 <td><a href="#IrcWidget.on_channelsWidget_tabCloseRequested">on_channelsWidget_tabCloseRequested</a></td> | |
| 223 <td>Private slot to close a channel by pressing the close button of the channels widget.</td> | |
| 224 </tr> | |
| 225 <tr> | |
| 226 <td><a href="#IrcWidget.shutdown">shutdown</a></td> | |
| 227 <td>Public method to shut down the widget.</td> | |
| 228 </tr> | |
| 229 </table> | |
| 230 <h3>Static Methods</h3> | |
| 231 | |
| 232 <table> | |
| 233 <tr><td>None</td></tr> | |
| 234 </table> | |
| 235 | |
| 236 <a NAME="IrcWidget.__init__" ID="IrcWidget.__init__"></a> | |
| 237 <h4>IrcWidget (Constructor)</h4> | |
| 238 <b>IrcWidget</b>(<i>parent=None</i>) | |
| 239 | |
| 240 <p> | |
| 241 Constructor | |
| 242 </p> | |
| 243 <dl> | |
| 244 | |
| 245 <dt><i>parent</i></dt> | |
| 246 <dd> | |
| 247 reference to the parent widget (QWidget) | |
| 248 </dd> | |
| 249 </dl> | |
| 250 <a NAME="IrcWidget.__autoJoinChannels" ID="IrcWidget.__autoJoinChannels"></a> | |
| 251 <h4>IrcWidget.__autoJoinChannels</h4> | |
| 252 <b>__autoJoinChannels</b>(<i></i>) | |
| 253 | |
| 254 <p> | |
| 255 Private slot to join channels automatically once a server got | |
| 256 connected. | |
| 257 </p> | |
| 258 <a NAME="IrcWidget.__away" ID="IrcWidget.__away"></a> | |
| 259 <h4>IrcWidget.__away</h4> | |
| 260 <b>__away</b>(<i>isAway</i>) | |
| 261 | |
| 262 <p> | |
| 263 Private slot handling the change of the away state. | |
| 264 </p> | |
| 265 <dl> | |
| 266 | |
| 267 <dt><i>isAway</i></dt> | |
| 268 <dd> | |
| 269 flag indicating the current away state (boolean) | |
| 270 </dd> | |
| 271 </dl> | |
| 272 <a NAME="IrcWidget.__changeNick" ID="IrcWidget.__changeNick"></a> | |
| 273 <h4>IrcWidget.__changeNick</h4> | |
| 274 <b>__changeNick</b>(<i>nick</i>) | |
| 275 | |
| 276 <p> | |
| 277 Private slot to use a new nick name. | |
| 278 </p> | |
| 279 <dl> | |
| 280 | |
| 281 <dt><i>nick</i></dt> | |
| 282 <dd> | |
| 283 nick name to use (str) | |
| 284 </dd> | |
| 285 </dl> | |
| 286 <a NAME="IrcWidget.__closeAllChannels" ID="IrcWidget.__closeAllChannels"></a> | |
| 287 <h4>IrcWidget.__closeAllChannels</h4> | |
| 288 <b>__closeAllChannels</b>(<i></i>) | |
| 289 | |
| 290 <p> | |
| 291 Private method to close all channels. | |
| 292 </p> | |
| 293 <a NAME="IrcWidget.__closeChannel" ID="IrcWidget.__closeChannel"></a> | |
| 294 <h4>IrcWidget.__closeChannel</h4> | |
| 295 <b>__closeChannel</b>(<i>name</i>) | |
| 296 | |
| 297 <p> | |
| 298 Private slot handling the closing of a channel. | |
| 299 </p> | |
| 300 <dl> | |
| 301 | |
| 302 <dt><i>name</i></dt> | |
| 303 <dd> | |
| 304 name of the closed channel (string) | |
| 305 </dd> | |
| 306 </dl> | |
| 307 <a NAME="IrcWidget.__connectNetwork" ID="IrcWidget.__connectNetwork"></a> | |
| 308 <h4>IrcWidget.__connectNetwork</h4> | |
| 309 <b>__connectNetwork</b>(<i>name, connect, silent</i>) | |
| 310 | |
| 311 <p> | |
| 312 Private slot to connect to or disconnect from the given network. | |
| 313 </p> | |
| 314 <dl> | |
| 315 | |
| 316 <dt><i>name</i></dt> | |
| 317 <dd> | |
| 318 name of the network to connect to (string) | |
| 319 </dd> | |
| 320 <dt><i>connect</i></dt> | |
| 321 <dd> | |
| 322 flag indicating to connect (boolean) | |
| 323 </dd> | |
| 324 <dt><i>silent</i></dt> | |
| 325 <dd> | |
| 326 flag indicating a silent connect/disconnect (boolean) | |
| 327 </dd> | |
| 328 </dl> | |
| 329 <a NAME="IrcWidget.__editNetwork" ID="IrcWidget.__editNetwork"></a> | |
| 330 <h4>IrcWidget.__editNetwork</h4> | |
| 331 <b>__editNetwork</b>(<i>name</i>) | |
| 332 | |
| 333 <p> | |
| 334 Private slot to edit the network configuration. | |
| 335 </p> | |
| 336 <dl> | |
| 337 | |
| 338 <dt><i>name</i></dt> | |
| 339 <dd> | |
| 340 name of the network to edit (string) | |
| 341 </dd> | |
| 342 </dl> | |
| 343 <a NAME="IrcWidget.__handleCtcp" ID="IrcWidget.__handleCtcp"></a> | |
| 344 <h4>IrcWidget.__handleCtcp</h4> | |
| 345 <b>__handleCtcp</b>(<i>match</i>) | |
| 346 | |
| 347 <p> | |
| 348 Private method to handle a CTCP command. | |
| 349 </p> | |
| 350 <dl> | |
| 351 | |
| 352 <dt><i>match</i></dt> | |
| 353 <dd> | |
| 354 reference to the match object | |
| 355 </dd> | |
| 356 </dl> | |
| 357 <dl> | |
| 358 <dt>Return:</dt> | |
| 359 <dd> | |
| 360 flag indicating, if the message was handled (boolean) | |
| 361 </dd> | |
| 362 </dl> | |
| 363 <a NAME="IrcWidget.__handleCtcpReply" ID="IrcWidget.__handleCtcpReply"></a> | |
| 364 <h4>IrcWidget.__handleCtcpReply</h4> | |
| 365 <b>__handleCtcpReply</b>(<i>match</i>) | |
| 366 | |
| 367 <p> | |
| 368 Private method to handle a server message containing a CTCP reply. | |
| 369 </p> | |
| 370 <dl> | |
| 371 | |
| 372 <dt><i>match</i></dt> | |
| 373 <dd> | |
| 374 reference to the match object | |
| 375 </dd> | |
| 376 </dl> | |
| 377 <a NAME="IrcWidget.__handleNamedMessage" ID="IrcWidget.__handleNamedMessage"></a> | |
| 378 <h4>IrcWidget.__handleNamedMessage</h4> | |
| 379 <b>__handleNamedMessage</b>(<i>match</i>) | |
| 380 | |
| 381 <p> | |
| 382 Private method to handle a server message containing a message name. | |
| 383 </p> | |
| 384 <dl> | |
| 385 | |
| 386 <dt><i>match</i></dt> | |
| 387 <dd> | |
| 388 reference to the match object | |
| 389 </dd> | |
| 390 </dl> | |
| 391 <dl> | |
| 392 <dt>Return:</dt> | |
| 393 <dd> | |
| 394 flag indicating, if the message was handled (boolean) | |
| 395 </dd> | |
| 396 </dl> | |
| 397 <a NAME="IrcWidget.__handleNickInUse" ID="IrcWidget.__handleNickInUse"></a> | |
| 398 <h4>IrcWidget.__handleNickInUse</h4> | |
| 399 <b>__handleNickInUse</b>(<i></i>) | |
| 400 | |
| 401 <p> | |
| 402 Private method to handle a 443 server error. | |
| 403 </p> | |
| 404 <a NAME="IrcWidget.__handleNickInUseLogin" ID="IrcWidget.__handleNickInUseLogin"></a> | |
| 405 <h4>IrcWidget.__handleNickInUseLogin</h4> | |
| 406 <b>__handleNickInUseLogin</b>(<i></i>) | |
| 407 | |
| 408 <p> | |
| 409 Private method to handle a 443 server error at login. | |
| 410 </p> | |
| 411 <a NAME="IrcWidget.__handleNumericMessage" ID="IrcWidget.__handleNumericMessage"></a> | |
| 412 <h4>IrcWidget.__handleNumericMessage</h4> | |
| 413 <b>__handleNumericMessage</b>(<i>match</i>) | |
| 414 | |
| 415 <p> | |
| 416 Private method to handle a server message containing a numeric code. | |
| 417 </p> | |
| 418 <dl> | |
| 419 | |
| 420 <dt><i>match</i></dt> | |
| 421 <dd> | |
| 422 reference to the match object | |
| 423 </dd> | |
| 424 </dl> | |
| 425 <dl> | |
| 426 <dt>Return:</dt> | |
| 427 <dd> | |
| 428 flag indicating, if the message was handled (boolean) | |
| 429 </dd> | |
| 430 </dl> | |
| 431 <a NAME="IrcWidget.__handleServerError" ID="IrcWidget.__handleServerError"></a> | |
| 432 <h4>IrcWidget.__handleServerError</h4> | |
| 433 <b>__handleServerError</b>(<i>code, server, message</i>) | |
| 434 | |
| 435 <p> | |
| 436 Private slot to handle a server error reply. | |
| 437 </p> | |
| 438 <dl> | |
| 439 | |
| 440 <dt><i>code</i></dt> | |
| 441 <dd> | |
| 442 numerical code sent by the server (integer) | |
| 443 </dd> | |
| 444 <dt><i>server</i></dt> | |
| 445 <dd> | |
| 446 name of the server (string) | |
| 447 </dd> | |
| 448 <dt><i>message</i></dt> | |
| 449 <dd> | |
| 450 message sent by the server (string) | |
| 451 </dd> | |
| 452 </dl> | |
| 453 <dl> | |
| 454 <dt>Return:</dt> | |
| 455 <dd> | |
| 456 flag indicating, if the message was handled (boolean) | |
| 457 </dd> | |
| 458 </dl> | |
| 459 <a NAME="IrcWidget.__handleServerReply" ID="IrcWidget.__handleServerReply"></a> | |
| 460 <h4>IrcWidget.__handleServerReply</h4> | |
| 461 <b>__handleServerReply</b>(<i>code, server, message</i>) | |
| 462 | |
| 463 <p> | |
| 464 Private slot to handle a server reply. | |
| 465 </p> | |
| 466 <dl> | |
| 467 | |
| 468 <dt><i>code</i></dt> | |
| 469 <dd> | |
| 470 numerical code sent by the server (integer) | |
| 471 </dd> | |
| 472 <dt><i>server</i></dt> | |
| 473 <dd> | |
| 474 name of the server (string) | |
| 475 </dd> | |
| 476 <dt><i>message</i></dt> | |
| 477 <dd> | |
| 478 message sent by the server (string) | |
| 479 </dd> | |
| 480 </dl> | |
| 481 <dl> | |
| 482 <dt>Return:</dt> | |
| 483 <dd> | |
| 484 flag indicating, if the message was handled (boolean) | |
| 485 </dd> | |
| 486 </dl> | |
| 487 <a NAME="IrcWidget.__hostConnected" ID="IrcWidget.__hostConnected"></a> | |
| 488 <h4>IrcWidget.__hostConnected</h4> | |
| 489 <b>__hostConnected</b>(<i></i>) | |
| 490 | |
| 491 <p> | |
| 492 Private slot to log in to the server after the connection was | |
| 493 established. | |
| 494 </p> | |
| 495 <a NAME="IrcWidget.__hostDisconnected" ID="IrcWidget.__hostDisconnected"></a> | |
| 496 <h4>IrcWidget.__hostDisconnected</h4> | |
| 497 <b>__hostDisconnected</b>(<i></i>) | |
| 498 | |
| 499 <p> | |
| 500 Private slot to indicate the host was disconnected. | |
| 501 </p> | |
| 502 <a NAME="IrcWidget.__hostFound" ID="IrcWidget.__hostFound"></a> | |
| 503 <h4>IrcWidget.__hostFound</h4> | |
| 504 <b>__hostFound</b>(<i></i>) | |
| 505 | |
| 506 <p> | |
| 507 Private slot to indicate the host was found. | |
| 508 </p> | |
| 509 <a NAME="IrcWidget.__leaveAllChannels" ID="IrcWidget.__leaveAllChannels"></a> | |
| 510 <h4>IrcWidget.__leaveAllChannels</h4> | |
| 511 <b>__leaveAllChannels</b>(<i></i>) | |
| 512 | |
| 513 <p> | |
| 514 Private slot to leave all channels and close their tabs. | |
| 515 </p> | |
| 516 <a NAME="IrcWidget.__leaveChannel" ID="IrcWidget.__leaveChannel"></a> | |
| 517 <h4>IrcWidget.__leaveChannel</h4> | |
| 518 <b>__leaveChannel</b>(<i></i>) | |
| 519 | |
| 520 <p> | |
| 521 Private slot to leave a channel and close the associated tab. | |
| 522 </p> | |
| 523 <a NAME="IrcWidget.__leaveChannels" ID="IrcWidget.__leaveChannels"></a> | |
| 524 <h4>IrcWidget.__leaveChannels</h4> | |
| 525 <b>__leaveChannels</b>(<i>channelNames</i>) | |
| 526 | |
| 527 <p> | |
| 528 Private slot to leave a list of channels and close their associated | |
| 529 tabs. | |
| 530 </p> | |
| 531 <dl> | |
| 532 | |
| 533 <dt><i>channelNames</i> (list of str)</dt> | |
| 534 <dd> | |
| 535 list of channels to leave | |
| 536 </dd> | |
| 537 </dl> | |
| 538 <a NAME="IrcWidget.__networkDataChanged" ID="IrcWidget.__networkDataChanged"></a> | |
| 539 <h4>IrcWidget.__networkDataChanged</h4> | |
| 540 <b>__networkDataChanged</b>(<i></i>) | |
| 541 | |
| 542 <p> | |
| 543 Private slot handling changes of the network and identity definitions. | |
| 544 </p> | |
| 545 <a NAME="IrcWidget.__openPrivate" ID="IrcWidget.__openPrivate"></a> | |
| 546 <h4>IrcWidget.__openPrivate</h4> | |
| 547 <b>__openPrivate</b>(<i>name</i>) | |
| 548 | |
| 549 <p> | |
| 550 Private slot to open a private chat with the given user. | |
| 551 </p> | |
| 552 <dl> | |
| 553 | |
| 554 <dt><i>name</i></dt> | |
| 555 <dd> | |
| 556 name of the user (string) | |
| 557 </dd> | |
| 558 </dl> | |
| 559 <a NAME="IrcWidget.__ping" ID="IrcWidget.__ping"></a> | |
| 560 <h4>IrcWidget.__ping</h4> | |
| 561 <b>__ping</b>(<i>match</i>) | |
| 562 | |
| 563 <p> | |
| 564 Private method to handle a PING message. | |
| 565 </p> | |
| 566 <dl> | |
| 567 | |
| 568 <dt><i>match</i></dt> | |
| 569 <dd> | |
| 570 reference to the match object | |
| 571 </dd> | |
| 572 </dl> | |
| 573 <dl> | |
| 574 <dt>Return:</dt> | |
| 575 <dd> | |
| 576 flag indicating, if the message was handled (boolean) | |
| 577 </dd> | |
| 578 </dl> | |
| 579 <a NAME="IrcWidget.__query" ID="IrcWidget.__query"></a> | |
| 580 <h4>IrcWidget.__query</h4> | |
| 581 <b>__query</b>(<i>match</i>) | |
| 582 | |
| 583 <p> | |
| 584 Private method to handle a new private connection. | |
| 585 </p> | |
| 586 <dl> | |
| 587 | |
| 588 <dt><i>match</i></dt> | |
| 589 <dd> | |
| 590 reference to the match object | |
| 591 </dd> | |
| 592 </dl> | |
| 593 <dl> | |
| 594 <dt>Return:</dt> | |
| 595 <dd> | |
| 596 flag indicating, if the message was handled (boolean) | |
| 597 </dd> | |
| 598 </dl> | |
| 599 <a NAME="IrcWidget.__readyRead" ID="IrcWidget.__readyRead"></a> | |
| 600 <h4>IrcWidget.__readyRead</h4> | |
| 601 <b>__readyRead</b>(<i></i>) | |
| 602 | |
| 603 <p> | |
| 604 Private slot to read data from the socket. | |
| 605 </p> | |
| 606 <a NAME="IrcWidget.__registerWithServices" ID="IrcWidget.__registerWithServices"></a> | |
| 607 <h4>IrcWidget.__registerWithServices</h4> | |
| 608 <b>__registerWithServices</b>(<i></i>) | |
| 609 | |
| 610 <p> | |
| 611 Private method to register to services. | |
| 612 </p> | |
| 613 <a NAME="IrcWidget.__send" ID="IrcWidget.__send"></a> | |
| 614 <h4>IrcWidget.__send</h4> | |
| 615 <b>__send</b>(<i>data</i>) | |
| 616 | |
| 617 <p> | |
| 618 Private slot to send data to the IRC server. | |
| 619 </p> | |
| 620 <dl> | |
| 621 | |
| 622 <dt><i>data</i></dt> | |
| 623 <dd> | |
| 624 data to be sent (string) | |
| 625 </dd> | |
| 626 </dl> | |
| 627 <a NAME="IrcWidget.__sendCtcpReply" ID="IrcWidget.__sendCtcpReply"></a> | |
| 628 <h4>IrcWidget.__sendCtcpReply</h4> | |
| 629 <b>__sendCtcpReply</b>(<i>receiver, text</i>) | |
| 630 | |
| 631 <p> | |
| 632 Private slot to send a CTCP reply. | |
| 633 </p> | |
| 634 <dl> | |
| 635 | |
| 636 <dt><i>receiver</i> (str)</dt> | |
| 637 <dd> | |
| 638 nick name of the receiver | |
| 639 </dd> | |
| 640 <dt><i>text</i> (str)</dt> | |
| 641 <dd> | |
| 642 text to be sent | |
| 643 </dd> | |
| 644 </dl> | |
| 645 <a NAME="IrcWidget.__sendCtcpRequest" ID="IrcWidget.__sendCtcpRequest"></a> | |
| 646 <h4>IrcWidget.__sendCtcpRequest</h4> | |
| 647 <b>__sendCtcpRequest</b>(<i>receiver, request, arguments</i>) | |
| 648 | |
| 649 <p> | |
| 650 Private slot to send a CTCP request. | |
| 651 </p> | |
| 652 <dl> | |
| 653 | |
| 654 <dt><i>receiver</i> (str)</dt> | |
| 655 <dd> | |
| 656 nick name of the receiver | |
| 657 </dd> | |
| 658 <dt><i>request</i> (str)</dt> | |
| 659 <dd> | |
| 660 CTCP request to be sent | |
| 661 </dd> | |
| 662 <dt><i>arguments</i> (str)</dt> | |
| 663 <dd> | |
| 664 arguments to be sent | |
| 665 </dd> | |
| 666 </dl> | |
| 667 <a NAME="IrcWidget.__setChannelTypePrefixes" ID="IrcWidget.__setChannelTypePrefixes"></a> | |
| 668 <h4>IrcWidget.__setChannelTypePrefixes</h4> | |
| 669 <b>__setChannelTypePrefixes</b>(<i>prefixes</i>) | |
| 670 | |
| 671 <p> | |
| 672 Private method to set the channel type prefixes. | |
| 673 </p> | |
| 674 <dl> | |
| 675 | |
| 676 <dt><i>prefixes</i></dt> | |
| 677 <dd> | |
| 678 channel prefix characters (string) | |
| 679 </dd> | |
| 680 </dl> | |
| 681 <a NAME="IrcWidget.__setUserPrivilegePrefix" ID="IrcWidget.__setUserPrivilegePrefix"></a> | |
| 682 <h4>IrcWidget.__setUserPrivilegePrefix</h4> | |
| 683 <b>__setUserPrivilegePrefix</b>(<i>prefix1, prefix2</i>) | |
| 684 | |
| 685 <p> | |
| 686 Private method to set the user privilege prefix. | |
| 687 </p> | |
| 688 <dl> | |
| 689 | |
| 690 <dt><i>prefix1</i></dt> | |
| 691 <dd> | |
| 692 first part of the prefix (string) | |
| 693 </dd> | |
| 694 <dt><i>prefix2</i></dt> | |
| 695 <dd> | |
| 696 indictors the first part gets mapped to (string) | |
| 697 </dd> | |
| 698 </dl> | |
| 699 <a NAME="IrcWidget.__sslErrors" ID="IrcWidget.__sslErrors"></a> | |
| 700 <h4>IrcWidget.__sslErrors</h4> | |
| 701 <b>__sslErrors</b>(<i>errors</i>) | |
| 702 | |
| 703 <p> | |
| 704 Private slot to handle SSL errors. | |
| 705 </p> | |
| 706 <dl> | |
| 707 | |
| 708 <dt><i>errors</i></dt> | |
| 709 <dd> | |
| 710 list of SSL errors (list of QSslError) | |
| 711 </dd> | |
| 712 </dl> | |
| 713 <a NAME="IrcWidget.__tcpError" ID="IrcWidget.__tcpError"></a> | |
| 714 <h4>IrcWidget.__tcpError</h4> | |
| 715 <b>__tcpError</b>(<i>error</i>) | |
| 716 | |
| 717 <p> | |
| 718 Private slot to handle errors reported by the TCP socket. | |
| 719 </p> | |
| 720 <dl> | |
| 721 | |
| 722 <dt><i>error</i></dt> | |
| 723 <dd> | |
| 724 error code reported by the socket | |
| 725 (QAbstractSocket.SocketError) | |
| 726 </dd> | |
| 727 </dl> | |
| 728 <a NAME="IrcWidget.__updateUsersCount" ID="IrcWidget.__updateUsersCount"></a> | |
| 729 <h4>IrcWidget.__updateUsersCount</h4> | |
| 730 <b>__updateUsersCount</b>(<i></i>) | |
| 731 | |
| 732 <p> | |
| 733 Private method to update the users count on the channel tabs. | |
| 734 </p> | |
| 735 <a NAME="IrcWidget.autoConnect" ID="IrcWidget.autoConnect"></a> | |
| 736 <h4>IrcWidget.autoConnect</h4> | |
| 737 <b>autoConnect</b>(<i></i>) | |
| 738 | |
| 739 <p> | |
| 740 Public method to initiate the IRC auto connection. | |
| 741 </p> | |
| 742 <a NAME="IrcWidget.isChannelName" ID="IrcWidget.isChannelName"></a> | |
| 743 <h4>IrcWidget.isChannelName</h4> | |
| 744 <b>isChannelName</b>(<i>name</i>) | |
| 745 | |
| 746 <p> | |
| 747 Public method to check, if the given name is a channel name. | |
| 748 </p> | |
| 749 <dl> | |
| 750 | |
| 751 <dt><i>name</i></dt> | |
| 752 <dd> | |
| 753 name to check (string) | |
| 754 </dd> | |
| 755 </dl> | |
| 756 <dl> | |
| 757 <dt>Return:</dt> | |
| 758 <dd> | |
| 759 flag indicating a channel name (boolean) | |
| 760 </dd> | |
| 761 </dl> | |
| 762 <a NAME="IrcWidget.joinChannel" ID="IrcWidget.joinChannel"></a> | |
| 763 <h4>IrcWidget.joinChannel</h4> | |
| 764 <b>joinChannel</b>(<i>name, key=""</i>) | |
| 765 | |
| 766 <p> | |
| 767 Public slot to join a channel. | |
| 768 </p> | |
| 769 <dl> | |
| 770 | |
| 771 <dt><i>name</i></dt> | |
| 772 <dd> | |
| 773 name of the channel (string) | |
| 774 </dd> | |
| 775 <dt><i>key</i></dt> | |
| 776 <dd> | |
| 777 key of the channel (string) | |
| 778 </dd> | |
| 779 </dl> | |
| 780 <a NAME="IrcWidget.on_channelsWidget_tabCloseRequested" ID="IrcWidget.on_channelsWidget_tabCloseRequested"></a> | |
| 781 <h4>IrcWidget.on_channelsWidget_tabCloseRequested</h4> | |
| 782 <b>on_channelsWidget_tabCloseRequested</b>(<i>index</i>) | |
| 783 | |
| 784 <p> | |
| 785 Private slot to close a channel by pressing the close button of | |
| 786 the channels widget. | |
| 787 </p> | |
| 788 <dl> | |
| 789 | |
| 790 <dt><i>index</i></dt> | |
| 791 <dd> | |
| 792 index of the tab to be closed (integer) | |
| 793 </dd> | |
| 794 </dl> | |
| 795 <a NAME="IrcWidget.shutdown" ID="IrcWidget.shutdown"></a> | |
| 796 <h4>IrcWidget.shutdown</h4> | |
| 797 <b>shutdown</b>(<i></i>) | |
| 798 | |
| 799 <p> | |
| 800 Public method to shut down the widget. | |
| 801 </p> | |
| 802 <dl> | |
| 803 <dt>Return:</dt> | |
| 804 <dd> | |
| 805 flag indicating successful shutdown (boolean) | |
| 806 </dd> | |
| 807 </dl> | |
| 808 <div align="right"><a href="#top">Up</a></div> | |
| 809 <hr /> | |
| 810 </body></html> |
