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