Mercurial Repositories > IRC client / file comparison
comparison: ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcNetworkManager.html
ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcNetworkManager.html
- changeset 3
- 51c2c37bde76
equal
deleted
inserted
replaced
| 2:5b635dc8895f | 3:51c2c37bde76 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Extension_Irc.ExtensionIrc.IrcNetworkManager</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.IrcNetworkManager</h1> | |
| 10 <p> | |
| 11 Module implementing the IRC data structures and their manager. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>None</td></tr> | |
| 17 </table> | |
| 18 | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#IrcChannel">IrcChannel</a></td> | |
| 23 <td>Class implementing the IRC channel object.</td> | |
| 24 </tr> | |
| 25 <tr> | |
| 26 <td><a href="#IrcIdentity">IrcIdentity</a></td> | |
| 27 <td>Class implementing the IRC identity object.</td> | |
| 28 </tr> | |
| 29 <tr> | |
| 30 <td><a href="#IrcNetwork">IrcNetwork</a></td> | |
| 31 <td>Class implementing the IRC network object.</td> | |
| 32 </tr> | |
| 33 <tr> | |
| 34 <td><a href="#IrcNetworkManager">IrcNetworkManager</a></td> | |
| 35 <td>Class implementing the IRC identity object.</td> | |
| 36 </tr> | |
| 37 <tr> | |
| 38 <td><a href="#IrcServer">IrcServer</a></td> | |
| 39 <td>Class implementing the IRC identity object.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 | |
| 43 <h3>Functions</h3> | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 | |
| 48 <hr /> | |
| 49 <hr /> | |
| 50 <a NAME="IrcChannel" ID="IrcChannel"></a> | |
| 51 <h2>IrcChannel</h2> | |
| 52 <p> | |
| 53 Class implementing the IRC channel object. | |
| 54 </p> | |
| 55 | |
| 56 <h3>Derived from</h3> | |
| 57 None | |
| 58 <h3>Class Attributes</h3> | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 | |
| 63 <h3>Class Methods</h3> | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 | |
| 68 <h3>Methods</h3> | |
| 69 <table> | |
| 70 <tr> | |
| 71 <td><a href="#IrcChannel.__init__">IrcChannel</a></td> | |
| 72 <td>Constructor</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#IrcChannel.autoJoin">autoJoin</a></td> | |
| 76 <td>Public method to check the auto join status.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#IrcChannel.getKey">getKey</a></td> | |
| 80 <td>Public method to get the channel key.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#IrcChannel.getName">getName</a></td> | |
| 84 <td>Public method to get the channel name.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#IrcChannel.load">load</a></td> | |
| 88 <td>Public method to load the network data.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#IrcChannel.save">save</a></td> | |
| 92 <td>Public method to save the channel data.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#IrcChannel.setAutoJoin">setAutoJoin</a></td> | |
| 96 <td>Public method to set the auto join status of the channel.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#IrcChannel.setKey">setKey</a></td> | |
| 100 <td>Public method to set a new channel key.</td> | |
| 101 </tr> | |
| 102 </table> | |
| 103 | |
| 104 <h3>Static Methods</h3> | |
| 105 <table> | |
| 106 <tr><td>None</td></tr> | |
| 107 </table> | |
| 108 | |
| 109 | |
| 110 <a NAME="IrcChannel.__init__" ID="IrcChannel.__init__"></a> | |
| 111 <h4>IrcChannel (Constructor)</h4> | |
| 112 <b>IrcChannel</b>(<i>name</i>) | |
| 113 <p> | |
| 114 Constructor | |
| 115 </p> | |
| 116 | |
| 117 <dl> | |
| 118 | |
| 119 <dt><i>name</i> (str)</dt> | |
| 120 <dd> | |
| 121 name of the network | |
| 122 </dd> | |
| 123 </dl> | |
| 124 <a NAME="IrcChannel.autoJoin" ID="IrcChannel.autoJoin"></a> | |
| 125 <h4>IrcChannel.autoJoin</h4> | |
| 126 <b>autoJoin</b>(<i></i>) | |
| 127 <p> | |
| 128 Public method to check the auto join status. | |
| 129 </p> | |
| 130 | |
| 131 <dl> | |
| 132 <dt>Return:</dt> | |
| 133 <dd> | |
| 134 flag indicating if the channel should be | |
| 135 joined automatically | |
| 136 </dd> | |
| 137 </dl> | |
| 138 <dl> | |
| 139 <dt>Return Type:</dt> | |
| 140 <dd> | |
| 141 bool | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <a NAME="IrcChannel.getKey" ID="IrcChannel.getKey"></a> | |
| 145 <h4>IrcChannel.getKey</h4> | |
| 146 <b>getKey</b>(<i></i>) | |
| 147 <p> | |
| 148 Public method to get the channel key. | |
| 149 </p> | |
| 150 | |
| 151 <dl> | |
| 152 <dt>Return:</dt> | |
| 153 <dd> | |
| 154 channel key | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <dl> | |
| 158 <dt>Return Type:</dt> | |
| 159 <dd> | |
| 160 str | |
| 161 </dd> | |
| 162 </dl> | |
| 163 <a NAME="IrcChannel.getName" ID="IrcChannel.getName"></a> | |
| 164 <h4>IrcChannel.getName</h4> | |
| 165 <b>getName</b>(<i></i>) | |
| 166 <p> | |
| 167 Public method to get the channel name. | |
| 168 </p> | |
| 169 | |
| 170 <dl> | |
| 171 <dt>Return:</dt> | |
| 172 <dd> | |
| 173 channel name | |
| 174 </dd> | |
| 175 </dl> | |
| 176 <dl> | |
| 177 <dt>Return Type:</dt> | |
| 178 <dd> | |
| 179 str | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <a NAME="IrcChannel.load" ID="IrcChannel.load"></a> | |
| 183 <h4>IrcChannel.load</h4> | |
| 184 <b>load</b>(<i>settings</i>) | |
| 185 <p> | |
| 186 Public method to load the network data. | |
| 187 </p> | |
| 188 | |
| 189 <dl> | |
| 190 | |
| 191 <dt><i>settings</i> (QSettings)</dt> | |
| 192 <dd> | |
| 193 reference to the settings object | |
| 194 </dd> | |
| 195 </dl> | |
| 196 <a NAME="IrcChannel.save" ID="IrcChannel.save"></a> | |
| 197 <h4>IrcChannel.save</h4> | |
| 198 <b>save</b>(<i>settings</i>) | |
| 199 <p> | |
| 200 Public method to save the channel data. | |
| 201 </p> | |
| 202 | |
| 203 <dl> | |
| 204 | |
| 205 <dt><i>settings</i> (QSettings)</dt> | |
| 206 <dd> | |
| 207 reference to the settings object | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <a NAME="IrcChannel.setAutoJoin" ID="IrcChannel.setAutoJoin"></a> | |
| 211 <h4>IrcChannel.setAutoJoin</h4> | |
| 212 <b>setAutoJoin</b>(<i>enable</i>) | |
| 213 <p> | |
| 214 Public method to set the auto join status of the channel. | |
| 215 </p> | |
| 216 | |
| 217 <dl> | |
| 218 | |
| 219 <dt><i>enable</i> (bool)</dt> | |
| 220 <dd> | |
| 221 flag indicating if the channel should be | |
| 222 joined automatically | |
| 223 </dd> | |
| 224 </dl> | |
| 225 <a NAME="IrcChannel.setKey" ID="IrcChannel.setKey"></a> | |
| 226 <h4>IrcChannel.setKey</h4> | |
| 227 <b>setKey</b>(<i>key</i>) | |
| 228 <p> | |
| 229 Public method to set a new channel key. | |
| 230 </p> | |
| 231 | |
| 232 <dl> | |
| 233 | |
| 234 <dt><i>key</i> (str)</dt> | |
| 235 <dd> | |
| 236 channel key to set | |
| 237 </dd> | |
| 238 </dl> | |
| 239 <div align="right"><a href="#top">Up</a></div> | |
| 240 <hr /> | |
| 241 <hr /> | |
| 242 <a NAME="IrcIdentity" ID="IrcIdentity"></a> | |
| 243 <h2>IrcIdentity</h2> | |
| 244 <p> | |
| 245 Class implementing the IRC identity object. | |
| 246 </p> | |
| 247 | |
| 248 <h3>Derived from</h3> | |
| 249 None | |
| 250 <h3>Class Attributes</h3> | |
| 251 <table> | |
| 252 <tr><td>DefaultAwayMessage</td></tr> | |
| 253 <tr><td>DefaultIdentityDisplay</td></tr> | |
| 254 <tr><td>DefaultIdentityName</td></tr> | |
| 255 <tr><td>DefaultPartMessage</td></tr> | |
| 256 <tr><td>DefaultQuitMessage</td></tr> | |
| 257 </table> | |
| 258 | |
| 259 <h3>Class Methods</h3> | |
| 260 <table> | |
| 261 <tr> | |
| 262 <td><a href="#IrcIdentity.createDefaultIdentity">createDefaultIdentity</a></td> | |
| 263 <td>Class method to create the default identity.</td> | |
| 264 </tr> | |
| 265 </table> | |
| 266 | |
| 267 <h3>Methods</h3> | |
| 268 <table> | |
| 269 <tr> | |
| 270 <td><a href="#IrcIdentity.__init__">IrcIdentity</a></td> | |
| 271 <td>Constructor</td> | |
| 272 </tr> | |
| 273 <tr> | |
| 274 <td><a href="#IrcIdentity.getAwayMessage">getAwayMessage</a></td> | |
| 275 <td>Public method to get the AWAY message.</td> | |
| 276 </tr> | |
| 277 <tr> | |
| 278 <td><a href="#IrcIdentity.getIdent">getIdent</a></td> | |
| 279 <td>Public method to get the real identity name.</td> | |
| 280 </tr> | |
| 281 <tr> | |
| 282 <td><a href="#IrcIdentity.getName">getName</a></td> | |
| 283 <td>Public method to get the identity name.</td> | |
| 284 </tr> | |
| 285 <tr> | |
| 286 <td><a href="#IrcIdentity.getNickNames">getNickNames</a></td> | |
| 287 <td>Public method to get the nick names.</td> | |
| 288 </tr> | |
| 289 <tr> | |
| 290 <td><a href="#IrcIdentity.getPartMessage">getPartMessage</a></td> | |
| 291 <td>Public method to get the PART message.</td> | |
| 292 </tr> | |
| 293 <tr> | |
| 294 <td><a href="#IrcIdentity.getPassword">getPassword</a></td> | |
| 295 <td>Public method to get the password.</td> | |
| 296 </tr> | |
| 297 <tr> | |
| 298 <td><a href="#IrcIdentity.getQuitMessage">getQuitMessage</a></td> | |
| 299 <td>Public method to get the QUIT message.</td> | |
| 300 </tr> | |
| 301 <tr> | |
| 302 <td><a href="#IrcIdentity.getRealName">getRealName</a></td> | |
| 303 <td>Public method to get the real name.</td> | |
| 304 </tr> | |
| 305 <tr> | |
| 306 <td><a href="#IrcIdentity.getServiceName">getServiceName</a></td> | |
| 307 <td>Public method to get the service name of the identity used for identification.</td> | |
| 308 </tr> | |
| 309 <tr> | |
| 310 <td><a href="#IrcIdentity.load">load</a></td> | |
| 311 <td>Public method to load the identity data.</td> | |
| 312 </tr> | |
| 313 <tr> | |
| 314 <td><a href="#IrcIdentity.rememberAwayPosition">rememberAwayPosition</a></td> | |
| 315 <td>Public method to get a flag indicating to remember the chat position upon AWAY.</td> | |
| 316 </tr> | |
| 317 <tr> | |
| 318 <td><a href="#IrcIdentity.save">save</a></td> | |
| 319 <td>Public method to save the identity data.</td> | |
| 320 </tr> | |
| 321 <tr> | |
| 322 <td><a href="#IrcIdentity.setAwayMessage">setAwayMessage</a></td> | |
| 323 <td>Public method to set the AWAY message.</td> | |
| 324 </tr> | |
| 325 <tr> | |
| 326 <td><a href="#IrcIdentity.setIdent">setIdent</a></td> | |
| 327 <td>Public method to set the real identity name.</td> | |
| 328 </tr> | |
| 329 <tr> | |
| 330 <td><a href="#IrcIdentity.setName">setName</a></td> | |
| 331 <td>Public method to set the identity name.</td> | |
| 332 </tr> | |
| 333 <tr> | |
| 334 <td><a href="#IrcIdentity.setNickNames">setNickNames</a></td> | |
| 335 <td>Public method to set the nick names of the identity.</td> | |
| 336 </tr> | |
| 337 <tr> | |
| 338 <td><a href="#IrcIdentity.setPartMessage">setPartMessage</a></td> | |
| 339 <td>Public method to set the PART message.</td> | |
| 340 </tr> | |
| 341 <tr> | |
| 342 <td><a href="#IrcIdentity.setPassword">setPassword</a></td> | |
| 343 <td>Public method to set a new password.</td> | |
| 344 </tr> | |
| 345 <tr> | |
| 346 <td><a href="#IrcIdentity.setQuitMessage">setQuitMessage</a></td> | |
| 347 <td>Public method to set the QUIT message.</td> | |
| 348 </tr> | |
| 349 <tr> | |
| 350 <td><a href="#IrcIdentity.setRealName">setRealName</a></td> | |
| 351 <td>Public method to set the real name of the identity.</td> | |
| 352 </tr> | |
| 353 <tr> | |
| 354 <td><a href="#IrcIdentity.setRememberAwayPosition">setRememberAwayPosition</a></td> | |
| 355 <td>Public method to set to remember the chat position upon AWAY.</td> | |
| 356 </tr> | |
| 357 <tr> | |
| 358 <td><a href="#IrcIdentity.setServiceName">setServiceName</a></td> | |
| 359 <td>Public method to set the service name of the identity used for identification.</td> | |
| 360 </tr> | |
| 361 </table> | |
| 362 | |
| 363 <h3>Static Methods</h3> | |
| 364 <table> | |
| 365 <tr><td>None</td></tr> | |
| 366 </table> | |
| 367 | |
| 368 | |
| 369 <a NAME="IrcIdentity.createDefaultIdentity" ID="IrcIdentity.createDefaultIdentity"></a> | |
| 370 <h4>IrcIdentity.createDefaultIdentity (class method)</h4> | |
| 371 <b>createDefaultIdentity</b>(<i></i>) | |
| 372 <p> | |
| 373 Class method to create the default identity. | |
| 374 </p> | |
| 375 | |
| 376 <dl> | |
| 377 <dt>Return:</dt> | |
| 378 <dd> | |
| 379 default identity | |
| 380 </dd> | |
| 381 </dl> | |
| 382 <dl> | |
| 383 <dt>Return Type:</dt> | |
| 384 <dd> | |
| 385 IrcIdentity | |
| 386 </dd> | |
| 387 </dl> | |
| 388 <a NAME="IrcIdentity.__init__" ID="IrcIdentity.__init__"></a> | |
| 389 <h4>IrcIdentity (Constructor)</h4> | |
| 390 <b>IrcIdentity</b>(<i>name</i>) | |
| 391 <p> | |
| 392 Constructor | |
| 393 </p> | |
| 394 | |
| 395 <dl> | |
| 396 | |
| 397 <dt><i>name</i> (str)</dt> | |
| 398 <dd> | |
| 399 name of the identity | |
| 400 </dd> | |
| 401 </dl> | |
| 402 <a NAME="IrcIdentity.getAwayMessage" ID="IrcIdentity.getAwayMessage"></a> | |
| 403 <h4>IrcIdentity.getAwayMessage</h4> | |
| 404 <b>getAwayMessage</b>(<i></i>) | |
| 405 <p> | |
| 406 Public method to get the AWAY message. | |
| 407 </p> | |
| 408 | |
| 409 <dl> | |
| 410 <dt>Return:</dt> | |
| 411 <dd> | |
| 412 AWAY message | |
| 413 </dd> | |
| 414 </dl> | |
| 415 <dl> | |
| 416 <dt>Return Type:</dt> | |
| 417 <dd> | |
| 418 str | |
| 419 </dd> | |
| 420 </dl> | |
| 421 <a NAME="IrcIdentity.getIdent" ID="IrcIdentity.getIdent"></a> | |
| 422 <h4>IrcIdentity.getIdent</h4> | |
| 423 <b>getIdent</b>(<i></i>) | |
| 424 <p> | |
| 425 Public method to get the real identity name. | |
| 426 </p> | |
| 427 | |
| 428 <dl> | |
| 429 <dt>Return:</dt> | |
| 430 <dd> | |
| 431 real identity name | |
| 432 </dd> | |
| 433 </dl> | |
| 434 <dl> | |
| 435 <dt>Return Type:</dt> | |
| 436 <dd> | |
| 437 str | |
| 438 </dd> | |
| 439 </dl> | |
| 440 <a NAME="IrcIdentity.getName" ID="IrcIdentity.getName"></a> | |
| 441 <h4>IrcIdentity.getName</h4> | |
| 442 <b>getName</b>(<i></i>) | |
| 443 <p> | |
| 444 Public method to get the identity name. | |
| 445 </p> | |
| 446 | |
| 447 <dl> | |
| 448 <dt>Return:</dt> | |
| 449 <dd> | |
| 450 identity name | |
| 451 </dd> | |
| 452 </dl> | |
| 453 <dl> | |
| 454 <dt>Return Type:</dt> | |
| 455 <dd> | |
| 456 str | |
| 457 </dd> | |
| 458 </dl> | |
| 459 <a NAME="IrcIdentity.getNickNames" ID="IrcIdentity.getNickNames"></a> | |
| 460 <h4>IrcIdentity.getNickNames</h4> | |
| 461 <b>getNickNames</b>(<i></i>) | |
| 462 <p> | |
| 463 Public method to get the nick names. | |
| 464 </p> | |
| 465 | |
| 466 <dl> | |
| 467 <dt>Return:</dt> | |
| 468 <dd> | |
| 469 nick names | |
| 470 </dd> | |
| 471 </dl> | |
| 472 <dl> | |
| 473 <dt>Return Type:</dt> | |
| 474 <dd> | |
| 475 list of str | |
| 476 </dd> | |
| 477 </dl> | |
| 478 <a NAME="IrcIdentity.getPartMessage" ID="IrcIdentity.getPartMessage"></a> | |
| 479 <h4>IrcIdentity.getPartMessage</h4> | |
| 480 <b>getPartMessage</b>(<i></i>) | |
| 481 <p> | |
| 482 Public method to get the PART message. | |
| 483 </p> | |
| 484 | |
| 485 <dl> | |
| 486 <dt>Return:</dt> | |
| 487 <dd> | |
| 488 PART message | |
| 489 </dd> | |
| 490 </dl> | |
| 491 <dl> | |
| 492 <dt>Return Type:</dt> | |
| 493 <dd> | |
| 494 str | |
| 495 </dd> | |
| 496 </dl> | |
| 497 <a NAME="IrcIdentity.getPassword" ID="IrcIdentity.getPassword"></a> | |
| 498 <h4>IrcIdentity.getPassword</h4> | |
| 499 <b>getPassword</b>(<i></i>) | |
| 500 <p> | |
| 501 Public method to get the password. | |
| 502 </p> | |
| 503 | |
| 504 <dl> | |
| 505 <dt>Return:</dt> | |
| 506 <dd> | |
| 507 password | |
| 508 </dd> | |
| 509 </dl> | |
| 510 <dl> | |
| 511 <dt>Return Type:</dt> | |
| 512 <dd> | |
| 513 str | |
| 514 </dd> | |
| 515 </dl> | |
| 516 <a NAME="IrcIdentity.getQuitMessage" ID="IrcIdentity.getQuitMessage"></a> | |
| 517 <h4>IrcIdentity.getQuitMessage</h4> | |
| 518 <b>getQuitMessage</b>(<i></i>) | |
| 519 <p> | |
| 520 Public method to get the QUIT message. | |
| 521 </p> | |
| 522 | |
| 523 <dl> | |
| 524 <dt>Return:</dt> | |
| 525 <dd> | |
| 526 QUIT message | |
| 527 </dd> | |
| 528 </dl> | |
| 529 <dl> | |
| 530 <dt>Return Type:</dt> | |
| 531 <dd> | |
| 532 str | |
| 533 </dd> | |
| 534 </dl> | |
| 535 <a NAME="IrcIdentity.getRealName" ID="IrcIdentity.getRealName"></a> | |
| 536 <h4>IrcIdentity.getRealName</h4> | |
| 537 <b>getRealName</b>(<i></i>) | |
| 538 <p> | |
| 539 Public method to get the real name. | |
| 540 </p> | |
| 541 | |
| 542 <dl> | |
| 543 <dt>Return:</dt> | |
| 544 <dd> | |
| 545 real name | |
| 546 </dd> | |
| 547 </dl> | |
| 548 <dl> | |
| 549 <dt>Return Type:</dt> | |
| 550 <dd> | |
| 551 str | |
| 552 </dd> | |
| 553 </dl> | |
| 554 <a NAME="IrcIdentity.getServiceName" ID="IrcIdentity.getServiceName"></a> | |
| 555 <h4>IrcIdentity.getServiceName</h4> | |
| 556 <b>getServiceName</b>(<i></i>) | |
| 557 <p> | |
| 558 Public method to get the service name of the identity used for | |
| 559 identification. | |
| 560 </p> | |
| 561 | |
| 562 <dl> | |
| 563 <dt>Return:</dt> | |
| 564 <dd> | |
| 565 service name | |
| 566 </dd> | |
| 567 </dl> | |
| 568 <dl> | |
| 569 <dt>Return Type:</dt> | |
| 570 <dd> | |
| 571 str | |
| 572 </dd> | |
| 573 </dl> | |
| 574 <a NAME="IrcIdentity.load" ID="IrcIdentity.load"></a> | |
| 575 <h4>IrcIdentity.load</h4> | |
| 576 <b>load</b>(<i>settings</i>) | |
| 577 <p> | |
| 578 Public method to load the identity data. | |
| 579 </p> | |
| 580 | |
| 581 <dl> | |
| 582 | |
| 583 <dt><i>settings</i> (QSettings)</dt> | |
| 584 <dd> | |
| 585 reference to the settings object | |
| 586 </dd> | |
| 587 </dl> | |
| 588 <a NAME="IrcIdentity.rememberAwayPosition" ID="IrcIdentity.rememberAwayPosition"></a> | |
| 589 <h4>IrcIdentity.rememberAwayPosition</h4> | |
| 590 <b>rememberAwayPosition</b>(<i></i>) | |
| 591 <p> | |
| 592 Public method to get a flag indicating to remember the chat position | |
| 593 upon AWAY. | |
| 594 </p> | |
| 595 | |
| 596 <dl> | |
| 597 <dt>Return:</dt> | |
| 598 <dd> | |
| 599 flag indicating to remember the chat position | |
| 600 </dd> | |
| 601 </dl> | |
| 602 <dl> | |
| 603 <dt>Return Type:</dt> | |
| 604 <dd> | |
| 605 bool | |
| 606 </dd> | |
| 607 </dl> | |
| 608 <a NAME="IrcIdentity.save" ID="IrcIdentity.save"></a> | |
| 609 <h4>IrcIdentity.save</h4> | |
| 610 <b>save</b>(<i>settings</i>) | |
| 611 <p> | |
| 612 Public method to save the identity data. | |
| 613 </p> | |
| 614 | |
| 615 <dl> | |
| 616 | |
| 617 <dt><i>settings</i> (QSettings)</dt> | |
| 618 <dd> | |
| 619 reference to the settings object | |
| 620 </dd> | |
| 621 </dl> | |
| 622 <a NAME="IrcIdentity.setAwayMessage" ID="IrcIdentity.setAwayMessage"></a> | |
| 623 <h4>IrcIdentity.setAwayMessage</h4> | |
| 624 <b>setAwayMessage</b>(<i>message</i>) | |
| 625 <p> | |
| 626 Public method to set the AWAY message. | |
| 627 </p> | |
| 628 | |
| 629 <dl> | |
| 630 | |
| 631 <dt><i>message</i> (str)</dt> | |
| 632 <dd> | |
| 633 AWAY message | |
| 634 </dd> | |
| 635 </dl> | |
| 636 <a NAME="IrcIdentity.setIdent" ID="IrcIdentity.setIdent"></a> | |
| 637 <h4>IrcIdentity.setIdent</h4> | |
| 638 <b>setIdent</b>(<i>name</i>) | |
| 639 <p> | |
| 640 Public method to set the real identity name. | |
| 641 </p> | |
| 642 | |
| 643 <dl> | |
| 644 | |
| 645 <dt><i>name</i> (str)</dt> | |
| 646 <dd> | |
| 647 real identity name | |
| 648 </dd> | |
| 649 </dl> | |
| 650 <a NAME="IrcIdentity.setName" ID="IrcIdentity.setName"></a> | |
| 651 <h4>IrcIdentity.setName</h4> | |
| 652 <b>setName</b>(<i>name</i>) | |
| 653 <p> | |
| 654 Public method to set the identity name. | |
| 655 </p> | |
| 656 | |
| 657 <dl> | |
| 658 | |
| 659 <dt><i>name</i> (str)</dt> | |
| 660 <dd> | |
| 661 identity name | |
| 662 </dd> | |
| 663 </dl> | |
| 664 <a NAME="IrcIdentity.setNickNames" ID="IrcIdentity.setNickNames"></a> | |
| 665 <h4>IrcIdentity.setNickNames</h4> | |
| 666 <b>setNickNames</b>(<i>names</i>) | |
| 667 <p> | |
| 668 Public method to set the nick names of the identity. | |
| 669 </p> | |
| 670 | |
| 671 <dl> | |
| 672 | |
| 673 <dt><i>names</i> (list of str)</dt> | |
| 674 <dd> | |
| 675 nick names | |
| 676 </dd> | |
| 677 </dl> | |
| 678 <a NAME="IrcIdentity.setPartMessage" ID="IrcIdentity.setPartMessage"></a> | |
| 679 <h4>IrcIdentity.setPartMessage</h4> | |
| 680 <b>setPartMessage</b>(<i>message</i>) | |
| 681 <p> | |
| 682 Public method to set the PART message. | |
| 683 </p> | |
| 684 | |
| 685 <dl> | |
| 686 | |
| 687 <dt><i>message</i> (str)</dt> | |
| 688 <dd> | |
| 689 PART message | |
| 690 </dd> | |
| 691 </dl> | |
| 692 <a NAME="IrcIdentity.setPassword" ID="IrcIdentity.setPassword"></a> | |
| 693 <h4>IrcIdentity.setPassword</h4> | |
| 694 <b>setPassword</b>(<i>password</i>) | |
| 695 <p> | |
| 696 Public method to set a new password. | |
| 697 </p> | |
| 698 | |
| 699 <dl> | |
| 700 | |
| 701 <dt><i>password</i> (str)</dt> | |
| 702 <dd> | |
| 703 password to set | |
| 704 </dd> | |
| 705 </dl> | |
| 706 <a NAME="IrcIdentity.setQuitMessage" ID="IrcIdentity.setQuitMessage"></a> | |
| 707 <h4>IrcIdentity.setQuitMessage</h4> | |
| 708 <b>setQuitMessage</b>(<i>message</i>) | |
| 709 <p> | |
| 710 Public method to set the QUIT message. | |
| 711 </p> | |
| 712 | |
| 713 <dl> | |
| 714 | |
| 715 <dt><i>message</i> (str)</dt> | |
| 716 <dd> | |
| 717 QUIT message | |
| 718 </dd> | |
| 719 </dl> | |
| 720 <a NAME="IrcIdentity.setRealName" ID="IrcIdentity.setRealName"></a> | |
| 721 <h4>IrcIdentity.setRealName</h4> | |
| 722 <b>setRealName</b>(<i>name</i>) | |
| 723 <p> | |
| 724 Public method to set the real name of the identity. | |
| 725 </p> | |
| 726 | |
| 727 <dl> | |
| 728 | |
| 729 <dt><i>name</i> (str)</dt> | |
| 730 <dd> | |
| 731 real name | |
| 732 </dd> | |
| 733 </dl> | |
| 734 <a NAME="IrcIdentity.setRememberAwayPosition" ID="IrcIdentity.setRememberAwayPosition"></a> | |
| 735 <h4>IrcIdentity.setRememberAwayPosition</h4> | |
| 736 <b>setRememberAwayPosition</b>(<i>remember</i>) | |
| 737 <p> | |
| 738 Public method to set to remember the chat position upon AWAY. | |
| 739 </p> | |
| 740 | |
| 741 <dl> | |
| 742 | |
| 743 <dt><i>remember</i> (bool)</dt> | |
| 744 <dd> | |
| 745 flag indicating to remember the chat position | |
| 746 </dd> | |
| 747 </dl> | |
| 748 <a NAME="IrcIdentity.setServiceName" ID="IrcIdentity.setServiceName"></a> | |
| 749 <h4>IrcIdentity.setServiceName</h4> | |
| 750 <b>setServiceName</b>(<i>name</i>) | |
| 751 <p> | |
| 752 Public method to set the service name of the identity used for | |
| 753 identification. | |
| 754 </p> | |
| 755 | |
| 756 <dl> | |
| 757 | |
| 758 <dt><i>name</i> (str)</dt> | |
| 759 <dd> | |
| 760 service name | |
| 761 </dd> | |
| 762 </dl> | |
| 763 <div align="right"><a href="#top">Up</a></div> | |
| 764 <hr /> | |
| 765 <hr /> | |
| 766 <a NAME="IrcNetwork" ID="IrcNetwork"></a> | |
| 767 <h2>IrcNetwork</h2> | |
| 768 <p> | |
| 769 Class implementing the IRC network object. | |
| 770 </p> | |
| 771 | |
| 772 <h3>Derived from</h3> | |
| 773 None | |
| 774 <h3>Class Attributes</h3> | |
| 775 <table> | |
| 776 <tr><td>None</td></tr> | |
| 777 </table> | |
| 778 | |
| 779 <h3>Class Methods</h3> | |
| 780 <table> | |
| 781 <tr> | |
| 782 <td><a href="#IrcNetwork.createDefaultNetwork">createDefaultNetwork</a></td> | |
| 783 <td>Class method to create the default network.</td> | |
| 784 </tr> | |
| 785 </table> | |
| 786 | |
| 787 <h3>Methods</h3> | |
| 788 <table> | |
| 789 <tr> | |
| 790 <td><a href="#IrcNetwork.__init__">IrcNetwork</a></td> | |
| 791 <td>Constructor</td> | |
| 792 </tr> | |
| 793 <tr> | |
| 794 <td><a href="#IrcNetwork.addChannel">addChannel</a></td> | |
| 795 <td>Public method to add a channel.</td> | |
| 796 </tr> | |
| 797 <tr> | |
| 798 <td><a href="#IrcNetwork.autoConnect">autoConnect</a></td> | |
| 799 <td>Public method to check, if the network should be connected to at start-up.</td> | |
| 800 </tr> | |
| 801 <tr> | |
| 802 <td><a href="#IrcNetwork.deleteChannel">deleteChannel</a></td> | |
| 803 <td>Public method to delete the given channel.</td> | |
| 804 </tr> | |
| 805 <tr> | |
| 806 <td><a href="#IrcNetwork.getChannel">getChannel</a></td> | |
| 807 <td>Public method to get a channel.</td> | |
| 808 </tr> | |
| 809 <tr> | |
| 810 <td><a href="#IrcNetwork.getChannelNames">getChannelNames</a></td> | |
| 811 <td>Public method to get the list of channels.</td> | |
| 812 </tr> | |
| 813 <tr> | |
| 814 <td><a href="#IrcNetwork.getChannels">getChannels</a></td> | |
| 815 <td>Public method to get the channels.</td> | |
| 816 </tr> | |
| 817 <tr> | |
| 818 <td><a href="#IrcNetwork.getIdentityName">getIdentityName</a></td> | |
| 819 <td>Public method to get the name of the identity.</td> | |
| 820 </tr> | |
| 821 <tr> | |
| 822 <td><a href="#IrcNetwork.getName">getName</a></td> | |
| 823 <td>Public method to get the network name.</td> | |
| 824 </tr> | |
| 825 <tr> | |
| 826 <td><a href="#IrcNetwork.getServer">getServer</a></td> | |
| 827 <td>Public method to get the server object.</td> | |
| 828 </tr> | |
| 829 <tr> | |
| 830 <td><a href="#IrcNetwork.getServerName">getServerName</a></td> | |
| 831 <td>Public method to get the server name.</td> | |
| 832 </tr> | |
| 833 <tr> | |
| 834 <td><a href="#IrcNetwork.load">load</a></td> | |
| 835 <td>Public method to load the network data.</td> | |
| 836 </tr> | |
| 837 <tr> | |
| 838 <td><a href="#IrcNetwork.save">save</a></td> | |
| 839 <td>Public method to save the network data.</td> | |
| 840 </tr> | |
| 841 <tr> | |
| 842 <td><a href="#IrcNetwork.setAutoConnect">setAutoConnect</a></td> | |
| 843 <td>Public method to set the auto connect flag.</td> | |
| 844 </tr> | |
| 845 <tr> | |
| 846 <td><a href="#IrcNetwork.setChannel">setChannel</a></td> | |
| 847 <td>Public method to set a channel.</td> | |
| 848 </tr> | |
| 849 <tr> | |
| 850 <td><a href="#IrcNetwork.setChannels">setChannels</a></td> | |
| 851 <td>Public method to set the list of channels.</td> | |
| 852 </tr> | |
| 853 <tr> | |
| 854 <td><a href="#IrcNetwork.setIdentityName">setIdentityName</a></td> | |
| 855 <td>Public method to set the name of the identity.</td> | |
| 856 </tr> | |
| 857 <tr> | |
| 858 <td><a href="#IrcNetwork.setName">setName</a></td> | |
| 859 <td>Public method to set the network name.</td> | |
| 860 </tr> | |
| 861 <tr> | |
| 862 <td><a href="#IrcNetwork.setServer">setServer</a></td> | |
| 863 <td>Public method to set the server.</td> | |
| 864 </tr> | |
| 865 </table> | |
| 866 | |
| 867 <h3>Static Methods</h3> | |
| 868 <table> | |
| 869 <tr><td>None</td></tr> | |
| 870 </table> | |
| 871 | |
| 872 | |
| 873 <a NAME="IrcNetwork.createDefaultNetwork" ID="IrcNetwork.createDefaultNetwork"></a> | |
| 874 <h4>IrcNetwork.createDefaultNetwork (class method)</h4> | |
| 875 <b>createDefaultNetwork</b>(<i>ssl=False</i>) | |
| 876 <p> | |
| 877 Class method to create the default network. | |
| 878 </p> | |
| 879 | |
| 880 <dl> | |
| 881 | |
| 882 <dt><i>ssl</i> (bool)</dt> | |
| 883 <dd> | |
| 884 flag indicating to create a SSL network configuration | |
| 885 </dd> | |
| 886 </dl> | |
| 887 <dl> | |
| 888 <dt>Return:</dt> | |
| 889 <dd> | |
| 890 default network object | |
| 891 </dd> | |
| 892 </dl> | |
| 893 <dl> | |
| 894 <dt>Return Type:</dt> | |
| 895 <dd> | |
| 896 IrcNetwork | |
| 897 </dd> | |
| 898 </dl> | |
| 899 <a NAME="IrcNetwork.__init__" ID="IrcNetwork.__init__"></a> | |
| 900 <h4>IrcNetwork (Constructor)</h4> | |
| 901 <b>IrcNetwork</b>(<i>name</i>) | |
| 902 <p> | |
| 903 Constructor | |
| 904 </p> | |
| 905 | |
| 906 <dl> | |
| 907 | |
| 908 <dt><i>name</i> (str)</dt> | |
| 909 <dd> | |
| 910 name of the network | |
| 911 </dd> | |
| 912 </dl> | |
| 913 <a NAME="IrcNetwork.addChannel" ID="IrcNetwork.addChannel"></a> | |
| 914 <h4>IrcNetwork.addChannel</h4> | |
| 915 <b>addChannel</b>(<i>channel</i>) | |
| 916 <p> | |
| 917 Public method to add a channel. | |
| 918 </p> | |
| 919 | |
| 920 <dl> | |
| 921 | |
| 922 <dt><i>channel</i> (IrcChannel)</dt> | |
| 923 <dd> | |
| 924 channel object to add | |
| 925 </dd> | |
| 926 </dl> | |
| 927 <a NAME="IrcNetwork.autoConnect" ID="IrcNetwork.autoConnect"></a> | |
| 928 <h4>IrcNetwork.autoConnect</h4> | |
| 929 <b>autoConnect</b>(<i></i>) | |
| 930 <p> | |
| 931 Public method to check, if the network should be connected to at | |
| 932 start-up. | |
| 933 </p> | |
| 934 | |
| 935 <dl> | |
| 936 <dt>Return:</dt> | |
| 937 <dd> | |
| 938 flag indicating an auto connect | |
| 939 </dd> | |
| 940 </dl> | |
| 941 <dl> | |
| 942 <dt>Return Type:</dt> | |
| 943 <dd> | |
| 944 bool | |
| 945 </dd> | |
| 946 </dl> | |
| 947 <a NAME="IrcNetwork.deleteChannel" ID="IrcNetwork.deleteChannel"></a> | |
| 948 <h4>IrcNetwork.deleteChannel</h4> | |
| 949 <b>deleteChannel</b>(<i>channelName</i>) | |
| 950 <p> | |
| 951 Public method to delete the given channel. | |
| 952 </p> | |
| 953 | |
| 954 <dl> | |
| 955 | |
| 956 <dt><i>channelName</i> (str)</dt> | |
| 957 <dd> | |
| 958 name of the channel to be deleted | |
| 959 </dd> | |
| 960 </dl> | |
| 961 <a NAME="IrcNetwork.getChannel" ID="IrcNetwork.getChannel"></a> | |
| 962 <h4>IrcNetwork.getChannel</h4> | |
| 963 <b>getChannel</b>(<i>channelName</i>) | |
| 964 <p> | |
| 965 Public method to get a channel. | |
| 966 </p> | |
| 967 | |
| 968 <dl> | |
| 969 | |
| 970 <dt><i>channelName</i> (str)</dt> | |
| 971 <dd> | |
| 972 name of the channel to retrieve | |
| 973 </dd> | |
| 974 </dl> | |
| 975 <dl> | |
| 976 <dt>Return:</dt> | |
| 977 <dd> | |
| 978 reference to the channel | |
| 979 </dd> | |
| 980 </dl> | |
| 981 <dl> | |
| 982 <dt>Return Type:</dt> | |
| 983 <dd> | |
| 984 IrcChannel | |
| 985 </dd> | |
| 986 </dl> | |
| 987 <a NAME="IrcNetwork.getChannelNames" ID="IrcNetwork.getChannelNames"></a> | |
| 988 <h4>IrcNetwork.getChannelNames</h4> | |
| 989 <b>getChannelNames</b>(<i></i>) | |
| 990 <p> | |
| 991 Public method to get the list of channels. | |
| 992 </p> | |
| 993 | |
| 994 <dl> | |
| 995 <dt>Return:</dt> | |
| 996 <dd> | |
| 997 list of channel names | |
| 998 </dd> | |
| 999 </dl> | |
| 1000 <dl> | |
| 1001 <dt>Return Type:</dt> | |
| 1002 <dd> | |
| 1003 list of str | |
| 1004 </dd> | |
| 1005 </dl> | |
| 1006 <a NAME="IrcNetwork.getChannels" ID="IrcNetwork.getChannels"></a> | |
| 1007 <h4>IrcNetwork.getChannels</h4> | |
| 1008 <b>getChannels</b>(<i></i>) | |
| 1009 <p> | |
| 1010 Public method to get the channels. | |
| 1011 </p> | |
| 1012 | |
| 1013 <dl> | |
| 1014 <dt>Return:</dt> | |
| 1015 <dd> | |
| 1016 list of channels for the network | |
| 1017 </dd> | |
| 1018 </dl> | |
| 1019 <dl> | |
| 1020 <dt>Return Type:</dt> | |
| 1021 <dd> | |
| 1022 list of IrcChannel | |
| 1023 </dd> | |
| 1024 </dl> | |
| 1025 <a NAME="IrcNetwork.getIdentityName" ID="IrcNetwork.getIdentityName"></a> | |
| 1026 <h4>IrcNetwork.getIdentityName</h4> | |
| 1027 <b>getIdentityName</b>(<i></i>) | |
| 1028 <p> | |
| 1029 Public method to get the name of the identity. | |
| 1030 </p> | |
| 1031 | |
| 1032 <dl> | |
| 1033 <dt>Return:</dt> | |
| 1034 <dd> | |
| 1035 identity name | |
| 1036 </dd> | |
| 1037 </dl> | |
| 1038 <dl> | |
| 1039 <dt>Return Type:</dt> | |
| 1040 <dd> | |
| 1041 str | |
| 1042 </dd> | |
| 1043 </dl> | |
| 1044 <a NAME="IrcNetwork.getName" ID="IrcNetwork.getName"></a> | |
| 1045 <h4>IrcNetwork.getName</h4> | |
| 1046 <b>getName</b>(<i></i>) | |
| 1047 <p> | |
| 1048 Public method to get the network name. | |
| 1049 </p> | |
| 1050 | |
| 1051 <dl> | |
| 1052 <dt>Return:</dt> | |
| 1053 <dd> | |
| 1054 network name | |
| 1055 </dd> | |
| 1056 </dl> | |
| 1057 <dl> | |
| 1058 <dt>Return Type:</dt> | |
| 1059 <dd> | |
| 1060 str | |
| 1061 </dd> | |
| 1062 </dl> | |
| 1063 <a NAME="IrcNetwork.getServer" ID="IrcNetwork.getServer"></a> | |
| 1064 <h4>IrcNetwork.getServer</h4> | |
| 1065 <b>getServer</b>(<i></i>) | |
| 1066 <p> | |
| 1067 Public method to get the server object. | |
| 1068 </p> | |
| 1069 | |
| 1070 <dl> | |
| 1071 <dt>Return:</dt> | |
| 1072 <dd> | |
| 1073 reference to the server | |
| 1074 </dd> | |
| 1075 </dl> | |
| 1076 <dl> | |
| 1077 <dt>Return Type:</dt> | |
| 1078 <dd> | |
| 1079 IrcServer | |
| 1080 </dd> | |
| 1081 </dl> | |
| 1082 <a NAME="IrcNetwork.getServerName" ID="IrcNetwork.getServerName"></a> | |
| 1083 <h4>IrcNetwork.getServerName</h4> | |
| 1084 <b>getServerName</b>(<i></i>) | |
| 1085 <p> | |
| 1086 Public method to get the server name. | |
| 1087 </p> | |
| 1088 | |
| 1089 <dl> | |
| 1090 <dt>Return:</dt> | |
| 1091 <dd> | |
| 1092 server name | |
| 1093 </dd> | |
| 1094 </dl> | |
| 1095 <dl> | |
| 1096 <dt>Return Type:</dt> | |
| 1097 <dd> | |
| 1098 str | |
| 1099 </dd> | |
| 1100 </dl> | |
| 1101 <a NAME="IrcNetwork.load" ID="IrcNetwork.load"></a> | |
| 1102 <h4>IrcNetwork.load</h4> | |
| 1103 <b>load</b>(<i>settings</i>) | |
| 1104 <p> | |
| 1105 Public method to load the network data. | |
| 1106 </p> | |
| 1107 | |
| 1108 <dl> | |
| 1109 | |
| 1110 <dt><i>settings</i> (QSettings)</dt> | |
| 1111 <dd> | |
| 1112 reference to the settings object | |
| 1113 </dd> | |
| 1114 </dl> | |
| 1115 <a NAME="IrcNetwork.save" ID="IrcNetwork.save"></a> | |
| 1116 <h4>IrcNetwork.save</h4> | |
| 1117 <b>save</b>(<i>settings</i>) | |
| 1118 <p> | |
| 1119 Public method to save the network data. | |
| 1120 </p> | |
| 1121 | |
| 1122 <dl> | |
| 1123 | |
| 1124 <dt><i>settings</i> (QSettings)</dt> | |
| 1125 <dd> | |
| 1126 reference to the settings object | |
| 1127 </dd> | |
| 1128 </dl> | |
| 1129 <a NAME="IrcNetwork.setAutoConnect" ID="IrcNetwork.setAutoConnect"></a> | |
| 1130 <h4>IrcNetwork.setAutoConnect</h4> | |
| 1131 <b>setAutoConnect</b>(<i>enable</i>) | |
| 1132 <p> | |
| 1133 Public method to set the auto connect flag. | |
| 1134 </p> | |
| 1135 | |
| 1136 <dl> | |
| 1137 | |
| 1138 <dt><i>enable</i> (bool)</dt> | |
| 1139 <dd> | |
| 1140 flag indicate to connect to the network at start-up | |
| 1141 </dd> | |
| 1142 </dl> | |
| 1143 <a NAME="IrcNetwork.setChannel" ID="IrcNetwork.setChannel"></a> | |
| 1144 <h4>IrcNetwork.setChannel</h4> | |
| 1145 <b>setChannel</b>(<i>channel</i>) | |
| 1146 <p> | |
| 1147 Public method to set a channel. | |
| 1148 </p> | |
| 1149 | |
| 1150 <dl> | |
| 1151 | |
| 1152 <dt><i>channel</i> (IrcChannel)</dt> | |
| 1153 <dd> | |
| 1154 channel object to set | |
| 1155 </dd> | |
| 1156 </dl> | |
| 1157 <a NAME="IrcNetwork.setChannels" ID="IrcNetwork.setChannels"></a> | |
| 1158 <h4>IrcNetwork.setChannels</h4> | |
| 1159 <b>setChannels</b>(<i>channels</i>) | |
| 1160 <p> | |
| 1161 Public method to set the list of channels. | |
| 1162 </p> | |
| 1163 | |
| 1164 <dl> | |
| 1165 | |
| 1166 <dt><i>channels</i> (list of IrcChannel)</dt> | |
| 1167 <dd> | |
| 1168 list of channels for the network | |
| 1169 </dd> | |
| 1170 </dl> | |
| 1171 <a NAME="IrcNetwork.setIdentityName" ID="IrcNetwork.setIdentityName"></a> | |
| 1172 <h4>IrcNetwork.setIdentityName</h4> | |
| 1173 <b>setIdentityName</b>(<i>name</i>) | |
| 1174 <p> | |
| 1175 Public method to set the name of the identity. | |
| 1176 </p> | |
| 1177 | |
| 1178 <dl> | |
| 1179 | |
| 1180 <dt><i>name</i> (str)</dt> | |
| 1181 <dd> | |
| 1182 identity name | |
| 1183 </dd> | |
| 1184 </dl> | |
| 1185 <a NAME="IrcNetwork.setName" ID="IrcNetwork.setName"></a> | |
| 1186 <h4>IrcNetwork.setName</h4> | |
| 1187 <b>setName</b>(<i>name</i>) | |
| 1188 <p> | |
| 1189 Public method to set the network name. | |
| 1190 </p> | |
| 1191 | |
| 1192 <dl> | |
| 1193 | |
| 1194 <dt><i>name</i> (str)</dt> | |
| 1195 <dd> | |
| 1196 network name | |
| 1197 </dd> | |
| 1198 </dl> | |
| 1199 <a NAME="IrcNetwork.setServer" ID="IrcNetwork.setServer"></a> | |
| 1200 <h4>IrcNetwork.setServer</h4> | |
| 1201 <b>setServer</b>(<i>server</i>) | |
| 1202 <p> | |
| 1203 Public method to set the server. | |
| 1204 </p> | |
| 1205 | |
| 1206 <dl> | |
| 1207 | |
| 1208 <dt><i>server</i> (IrcServer)</dt> | |
| 1209 <dd> | |
| 1210 server object to set | |
| 1211 </dd> | |
| 1212 </dl> | |
| 1213 <div align="right"><a href="#top">Up</a></div> | |
| 1214 <hr /> | |
| 1215 <hr /> | |
| 1216 <a NAME="IrcNetworkManager" ID="IrcNetworkManager"></a> | |
| 1217 <h2>IrcNetworkManager</h2> | |
| 1218 <p> | |
| 1219 Class implementing the IRC identity object. | |
| 1220 </p> | |
| 1221 | |
| 1222 <h3>Signals</h3> | |
| 1223 <dl> | |
| 1224 | |
| 1225 <dt>dataChanged()</dt> | |
| 1226 <dd> | |
| 1227 emitted after some data has changed | |
| 1228 </dd> | |
| 1229 <dt>identitiesChanged()</dt> | |
| 1230 <dd> | |
| 1231 emitted after an identity object has changed | |
| 1232 </dd> | |
| 1233 <dt>networksChanged()</dt> | |
| 1234 <dd> | |
| 1235 emitted after a network object has changed | |
| 1236 </dd> | |
| 1237 </dl> | |
| 1238 <h3>Derived from</h3> | |
| 1239 QObject | |
| 1240 <h3>Class Attributes</h3> | |
| 1241 <table> | |
| 1242 <tr><td>None</td></tr> | |
| 1243 </table> | |
| 1244 | |
| 1245 <h3>Class Methods</h3> | |
| 1246 <table> | |
| 1247 <tr><td>None</td></tr> | |
| 1248 </table> | |
| 1249 | |
| 1250 <h3>Methods</h3> | |
| 1251 <table> | |
| 1252 <tr> | |
| 1253 <td><a href="#IrcNetworkManager.__init__">IrcNetworkManager</a></td> | |
| 1254 <td>Constructor</td> | |
| 1255 </tr> | |
| 1256 <tr> | |
| 1257 <td><a href="#IrcNetworkManager.__load">__load</a></td> | |
| 1258 <td>Private slot to load the IRC data.</td> | |
| 1259 </tr> | |
| 1260 <tr> | |
| 1261 <td><a href="#IrcNetworkManager.__loadDefaults">__loadDefaults</a></td> | |
| 1262 <td>Private method to load default values.</td> | |
| 1263 </tr> | |
| 1264 <tr> | |
| 1265 <td><a href="#IrcNetworkManager.addIdentity">addIdentity</a></td> | |
| 1266 <td>Public method to add a new identity.</td> | |
| 1267 </tr> | |
| 1268 <tr> | |
| 1269 <td><a href="#IrcNetworkManager.addNetwork">addNetwork</a></td> | |
| 1270 <td>Public method to add a network.</td> | |
| 1271 </tr> | |
| 1272 <tr> | |
| 1273 <td><a href="#IrcNetworkManager.close">close</a></td> | |
| 1274 <td>Public method to close the open search engines manager.</td> | |
| 1275 </tr> | |
| 1276 <tr> | |
| 1277 <td><a href="#IrcNetworkManager.deleteIdentity">deleteIdentity</a></td> | |
| 1278 <td>Public method to delete the given identity.</td> | |
| 1279 </tr> | |
| 1280 <tr> | |
| 1281 <td><a href="#IrcNetworkManager.deleteNetwork">deleteNetwork</a></td> | |
| 1282 <td>Public method to delete the given network.</td> | |
| 1283 </tr> | |
| 1284 <tr> | |
| 1285 <td><a href="#IrcNetworkManager.getIdentities">getIdentities</a></td> | |
| 1286 <td>Public method to get a copy of all identities.</td> | |
| 1287 </tr> | |
| 1288 <tr> | |
| 1289 <td><a href="#IrcNetworkManager.getIdentity">getIdentity</a></td> | |
| 1290 <td>Public method to get an identity object.</td> | |
| 1291 </tr> | |
| 1292 <tr> | |
| 1293 <td><a href="#IrcNetworkManager.getIdentityNames">getIdentityNames</a></td> | |
| 1294 <td>Public method to get the names of all identities.</td> | |
| 1295 </tr> | |
| 1296 <tr> | |
| 1297 <td><a href="#IrcNetworkManager.getNetwork">getNetwork</a></td> | |
| 1298 <td>Public method to get a network object.</td> | |
| 1299 </tr> | |
| 1300 <tr> | |
| 1301 <td><a href="#IrcNetworkManager.getNetworkNames">getNetworkNames</a></td> | |
| 1302 <td>Public method to get a list of all known network names.</td> | |
| 1303 </tr> | |
| 1304 <tr> | |
| 1305 <td><a href="#IrcNetworkManager.identityChanged">identityChanged</a></td> | |
| 1306 <td>Public method to indicate a change of an identity object.</td> | |
| 1307 </tr> | |
| 1308 <tr> | |
| 1309 <td><a href="#IrcNetworkManager.networkChanged">networkChanged</a></td> | |
| 1310 <td>Public method to indicate a change of a network object.</td> | |
| 1311 </tr> | |
| 1312 <tr> | |
| 1313 <td><a href="#IrcNetworkManager.renameIdentity">renameIdentity</a></td> | |
| 1314 <td>Public method to rename an identity.</td> | |
| 1315 </tr> | |
| 1316 <tr> | |
| 1317 <td><a href="#IrcNetworkManager.save">save</a></td> | |
| 1318 <td>Public slot to save the IRC data.</td> | |
| 1319 </tr> | |
| 1320 <tr> | |
| 1321 <td><a href="#IrcNetworkManager.setIdentities">setIdentities</a></td> | |
| 1322 <td>Public method to set the identities.</td> | |
| 1323 </tr> | |
| 1324 <tr> | |
| 1325 <td><a href="#IrcNetworkManager.setNetwork">setNetwork</a></td> | |
| 1326 <td>Public method to set a network.</td> | |
| 1327 </tr> | |
| 1328 </table> | |
| 1329 | |
| 1330 <h3>Static Methods</h3> | |
| 1331 <table> | |
| 1332 <tr><td>None</td></tr> | |
| 1333 </table> | |
| 1334 | |
| 1335 | |
| 1336 <a NAME="IrcNetworkManager.__init__" ID="IrcNetworkManager.__init__"></a> | |
| 1337 <h4>IrcNetworkManager (Constructor)</h4> | |
| 1338 <b>IrcNetworkManager</b>(<i>parent=None</i>) | |
| 1339 <p> | |
| 1340 Constructor | |
| 1341 </p> | |
| 1342 | |
| 1343 <dl> | |
| 1344 | |
| 1345 <dt><i>parent</i> (QObject)</dt> | |
| 1346 <dd> | |
| 1347 reference to the parent object | |
| 1348 </dd> | |
| 1349 </dl> | |
| 1350 <a NAME="IrcNetworkManager.__load" ID="IrcNetworkManager.__load"></a> | |
| 1351 <h4>IrcNetworkManager.__load</h4> | |
| 1352 <b>__load</b>(<i></i>) | |
| 1353 <p> | |
| 1354 Private slot to load the IRC data. | |
| 1355 </p> | |
| 1356 | |
| 1357 <a NAME="IrcNetworkManager.__loadDefaults" ID="IrcNetworkManager.__loadDefaults"></a> | |
| 1358 <h4>IrcNetworkManager.__loadDefaults</h4> | |
| 1359 <b>__loadDefaults</b>(<i>identityOnly=False</i>) | |
| 1360 <p> | |
| 1361 Private method to load default values. | |
| 1362 </p> | |
| 1363 | |
| 1364 <dl> | |
| 1365 | |
| 1366 <dt><i>identityOnly</i> (bool)</dt> | |
| 1367 <dd> | |
| 1368 flag indicating to just load the default | |
| 1369 identity | |
| 1370 </dd> | |
| 1371 </dl> | |
| 1372 <a NAME="IrcNetworkManager.addIdentity" ID="IrcNetworkManager.addIdentity"></a> | |
| 1373 <h4>IrcNetworkManager.addIdentity</h4> | |
| 1374 <b>addIdentity</b>(<i>identity</i>) | |
| 1375 <p> | |
| 1376 Public method to add a new identity. | |
| 1377 </p> | |
| 1378 | |
| 1379 <dl> | |
| 1380 | |
| 1381 <dt><i>identity</i> (IrcIdentity)</dt> | |
| 1382 <dd> | |
| 1383 reference to the identity to add | |
| 1384 </dd> | |
| 1385 </dl> | |
| 1386 <a NAME="IrcNetworkManager.addNetwork" ID="IrcNetworkManager.addNetwork"></a> | |
| 1387 <h4>IrcNetworkManager.addNetwork</h4> | |
| 1388 <b>addNetwork</b>(<i>network</i>) | |
| 1389 <p> | |
| 1390 Public method to add a network. | |
| 1391 </p> | |
| 1392 | |
| 1393 <dl> | |
| 1394 | |
| 1395 <dt><i>network</i> (IrcNetwork)</dt> | |
| 1396 <dd> | |
| 1397 network object to add | |
| 1398 </dd> | |
| 1399 </dl> | |
| 1400 <a NAME="IrcNetworkManager.close" ID="IrcNetworkManager.close"></a> | |
| 1401 <h4>IrcNetworkManager.close</h4> | |
| 1402 <b>close</b>(<i></i>) | |
| 1403 <p> | |
| 1404 Public method to close the open search engines manager. | |
| 1405 </p> | |
| 1406 | |
| 1407 <a NAME="IrcNetworkManager.deleteIdentity" ID="IrcNetworkManager.deleteIdentity"></a> | |
| 1408 <h4>IrcNetworkManager.deleteIdentity</h4> | |
| 1409 <b>deleteIdentity</b>(<i>name</i>) | |
| 1410 <p> | |
| 1411 Public method to delete the given identity. | |
| 1412 </p> | |
| 1413 | |
| 1414 <dl> | |
| 1415 | |
| 1416 <dt><i>name</i> (str)</dt> | |
| 1417 <dd> | |
| 1418 name of the identity to delete | |
| 1419 </dd> | |
| 1420 </dl> | |
| 1421 <a NAME="IrcNetworkManager.deleteNetwork" ID="IrcNetworkManager.deleteNetwork"></a> | |
| 1422 <h4>IrcNetworkManager.deleteNetwork</h4> | |
| 1423 <b>deleteNetwork</b>(<i>name</i>) | |
| 1424 <p> | |
| 1425 Public method to delete the given network. | |
| 1426 </p> | |
| 1427 | |
| 1428 <dl> | |
| 1429 | |
| 1430 <dt><i>name</i> (str)</dt> | |
| 1431 <dd> | |
| 1432 name of the network to delete | |
| 1433 </dd> | |
| 1434 </dl> | |
| 1435 <a NAME="IrcNetworkManager.getIdentities" ID="IrcNetworkManager.getIdentities"></a> | |
| 1436 <h4>IrcNetworkManager.getIdentities</h4> | |
| 1437 <b>getIdentities</b>(<i></i>) | |
| 1438 <p> | |
| 1439 Public method to get a copy of all identities. | |
| 1440 </p> | |
| 1441 | |
| 1442 <dl> | |
| 1443 <dt>Return:</dt> | |
| 1444 <dd> | |
| 1445 dictionary of all identities | |
| 1446 </dd> | |
| 1447 </dl> | |
| 1448 <dl> | |
| 1449 <dt>Return Type:</dt> | |
| 1450 <dd> | |
| 1451 dict of IrcIdentity | |
| 1452 </dd> | |
| 1453 </dl> | |
| 1454 <a NAME="IrcNetworkManager.getIdentity" ID="IrcNetworkManager.getIdentity"></a> | |
| 1455 <h4>IrcNetworkManager.getIdentity</h4> | |
| 1456 <b>getIdentity</b>(<i>name, create=False</i>) | |
| 1457 <p> | |
| 1458 Public method to get an identity object. | |
| 1459 </p> | |
| 1460 | |
| 1461 <dl> | |
| 1462 | |
| 1463 <dt><i>name</i> (str)</dt> | |
| 1464 <dd> | |
| 1465 name of the identity to get | |
| 1466 </dd> | |
| 1467 <dt><i>create</i> (bool)</dt> | |
| 1468 <dd> | |
| 1469 flag indicating to create a new object, | |
| 1470 if none exists | |
| 1471 </dd> | |
| 1472 </dl> | |
| 1473 <dl> | |
| 1474 <dt>Return:</dt> | |
| 1475 <dd> | |
| 1476 reference to the identity | |
| 1477 </dd> | |
| 1478 </dl> | |
| 1479 <dl> | |
| 1480 <dt>Return Type:</dt> | |
| 1481 <dd> | |
| 1482 IrcIdentity | |
| 1483 </dd> | |
| 1484 </dl> | |
| 1485 <a NAME="IrcNetworkManager.getIdentityNames" ID="IrcNetworkManager.getIdentityNames"></a> | |
| 1486 <h4>IrcNetworkManager.getIdentityNames</h4> | |
| 1487 <b>getIdentityNames</b>(<i></i>) | |
| 1488 <p> | |
| 1489 Public method to get the names of all identities. | |
| 1490 </p> | |
| 1491 | |
| 1492 <dl> | |
| 1493 <dt>Return:</dt> | |
| 1494 <dd> | |
| 1495 names of all identities | |
| 1496 </dd> | |
| 1497 </dl> | |
| 1498 <dl> | |
| 1499 <dt>Return Type:</dt> | |
| 1500 <dd> | |
| 1501 list of string) | |
| 1502 </dd> | |
| 1503 </dl> | |
| 1504 <a NAME="IrcNetworkManager.getNetwork" ID="IrcNetworkManager.getNetwork"></a> | |
| 1505 <h4>IrcNetworkManager.getNetwork</h4> | |
| 1506 <b>getNetwork</b>(<i>name</i>) | |
| 1507 <p> | |
| 1508 Public method to get a network object. | |
| 1509 </p> | |
| 1510 | |
| 1511 <dl> | |
| 1512 | |
| 1513 <dt><i>name</i> (str)</dt> | |
| 1514 <dd> | |
| 1515 name of the network | |
| 1516 </dd> | |
| 1517 </dl> | |
| 1518 <dl> | |
| 1519 <dt>Return:</dt> | |
| 1520 <dd> | |
| 1521 reference to the network object | |
| 1522 </dd> | |
| 1523 </dl> | |
| 1524 <dl> | |
| 1525 <dt>Return Type:</dt> | |
| 1526 <dd> | |
| 1527 IrcNetwork | |
| 1528 </dd> | |
| 1529 </dl> | |
| 1530 <a NAME="IrcNetworkManager.getNetworkNames" ID="IrcNetworkManager.getNetworkNames"></a> | |
| 1531 <h4>IrcNetworkManager.getNetworkNames</h4> | |
| 1532 <b>getNetworkNames</b>(<i></i>) | |
| 1533 <p> | |
| 1534 Public method to get a list of all known network names. | |
| 1535 </p> | |
| 1536 | |
| 1537 <dl> | |
| 1538 <dt>Return:</dt> | |
| 1539 <dd> | |
| 1540 list of network names | |
| 1541 </dd> | |
| 1542 </dl> | |
| 1543 <dl> | |
| 1544 <dt>Return Type:</dt> | |
| 1545 <dd> | |
| 1546 list of str | |
| 1547 </dd> | |
| 1548 </dl> | |
| 1549 <a NAME="IrcNetworkManager.identityChanged" ID="IrcNetworkManager.identityChanged"></a> | |
| 1550 <h4>IrcNetworkManager.identityChanged</h4> | |
| 1551 <b>identityChanged</b>(<i></i>) | |
| 1552 <p> | |
| 1553 Public method to indicate a change of an identity object. | |
| 1554 </p> | |
| 1555 | |
| 1556 <a NAME="IrcNetworkManager.networkChanged" ID="IrcNetworkManager.networkChanged"></a> | |
| 1557 <h4>IrcNetworkManager.networkChanged</h4> | |
| 1558 <b>networkChanged</b>(<i></i>) | |
| 1559 <p> | |
| 1560 Public method to indicate a change of a network object. | |
| 1561 </p> | |
| 1562 | |
| 1563 <a NAME="IrcNetworkManager.renameIdentity" ID="IrcNetworkManager.renameIdentity"></a> | |
| 1564 <h4>IrcNetworkManager.renameIdentity</h4> | |
| 1565 <b>renameIdentity</b>(<i>oldName, newName</i>) | |
| 1566 <p> | |
| 1567 Public method to rename an identity. | |
| 1568 </p> | |
| 1569 | |
| 1570 <dl> | |
| 1571 | |
| 1572 <dt><i>oldName</i> (str)</dt> | |
| 1573 <dd> | |
| 1574 old name of the identity | |
| 1575 </dd> | |
| 1576 <dt><i>newName</i> (str)</dt> | |
| 1577 <dd> | |
| 1578 new name of the identity | |
| 1579 </dd> | |
| 1580 </dl> | |
| 1581 <a NAME="IrcNetworkManager.save" ID="IrcNetworkManager.save"></a> | |
| 1582 <h4>IrcNetworkManager.save</h4> | |
| 1583 <b>save</b>(<i></i>) | |
| 1584 <p> | |
| 1585 Public slot to save the IRC data. | |
| 1586 </p> | |
| 1587 | |
| 1588 <a NAME="IrcNetworkManager.setIdentities" ID="IrcNetworkManager.setIdentities"></a> | |
| 1589 <h4>IrcNetworkManager.setIdentities</h4> | |
| 1590 <b>setIdentities</b>(<i>identities</i>) | |
| 1591 <p> | |
| 1592 Public method to set the identities. | |
| 1593 </p> | |
| 1594 | |
| 1595 <dl> | |
| 1596 | |
| 1597 <dt><i>identities</i> (dict of IrcIdentity)</dt> | |
| 1598 <dd> | |
| 1599 dictionary of all identities | |
| 1600 </dd> | |
| 1601 </dl> | |
| 1602 <a NAME="IrcNetworkManager.setNetwork" ID="IrcNetworkManager.setNetwork"></a> | |
| 1603 <h4>IrcNetworkManager.setNetwork</h4> | |
| 1604 <b>setNetwork</b>(<i>network, networkName=""</i>) | |
| 1605 <p> | |
| 1606 Public method to set a network. | |
| 1607 </p> | |
| 1608 | |
| 1609 <dl> | |
| 1610 | |
| 1611 <dt><i>network</i> (IrcNetwork)</dt> | |
| 1612 <dd> | |
| 1613 network object to set | |
| 1614 </dd> | |
| 1615 <dt><i>networkName</i> (str)</dt> | |
| 1616 <dd> | |
| 1617 name the network was known for | |
| 1618 </dd> | |
| 1619 </dl> | |
| 1620 <div align="right"><a href="#top">Up</a></div> | |
| 1621 <hr /> | |
| 1622 <hr /> | |
| 1623 <a NAME="IrcServer" ID="IrcServer"></a> | |
| 1624 <h2>IrcServer</h2> | |
| 1625 <p> | |
| 1626 Class implementing the IRC identity object. | |
| 1627 </p> | |
| 1628 | |
| 1629 <h3>Derived from</h3> | |
| 1630 None | |
| 1631 <h3>Class Attributes</h3> | |
| 1632 <table> | |
| 1633 <tr><td>DefaultPort</td></tr> | |
| 1634 <tr><td>DefaultSslPort</td></tr> | |
| 1635 </table> | |
| 1636 | |
| 1637 <h3>Class Methods</h3> | |
| 1638 <table> | |
| 1639 <tr><td>None</td></tr> | |
| 1640 </table> | |
| 1641 | |
| 1642 <h3>Methods</h3> | |
| 1643 <table> | |
| 1644 <tr> | |
| 1645 <td><a href="#IrcServer.__init__">IrcServer</a></td> | |
| 1646 <td>Constructor</td> | |
| 1647 </tr> | |
| 1648 <tr> | |
| 1649 <td><a href="#IrcServer.getName">getName</a></td> | |
| 1650 <td>Public method to get the server name.</td> | |
| 1651 </tr> | |
| 1652 <tr> | |
| 1653 <td><a href="#IrcServer.getPassword">getPassword</a></td> | |
| 1654 <td>Public method to get the password.</td> | |
| 1655 </tr> | |
| 1656 <tr> | |
| 1657 <td><a href="#IrcServer.getPort">getPort</a></td> | |
| 1658 <td>Public method to get the server port number.</td> | |
| 1659 </tr> | |
| 1660 <tr> | |
| 1661 <td><a href="#IrcServer.load">load</a></td> | |
| 1662 <td>Public method to load the server data.</td> | |
| 1663 </tr> | |
| 1664 <tr> | |
| 1665 <td><a href="#IrcServer.save">save</a></td> | |
| 1666 <td>Public method to save the server data.</td> | |
| 1667 </tr> | |
| 1668 <tr> | |
| 1669 <td><a href="#IrcServer.setName">setName</a></td> | |
| 1670 <td>Public method to set the server name.</td> | |
| 1671 </tr> | |
| 1672 <tr> | |
| 1673 <td><a href="#IrcServer.setPassword">setPassword</a></td> | |
| 1674 <td>Public method to set a new password.</td> | |
| 1675 </tr> | |
| 1676 <tr> | |
| 1677 <td><a href="#IrcServer.setPort">setPort</a></td> | |
| 1678 <td>Public method to set the server port number.</td> | |
| 1679 </tr> | |
| 1680 <tr> | |
| 1681 <td><a href="#IrcServer.setUseSSL">setUseSSL</a></td> | |
| 1682 <td>Public method to set the SSL usage.</td> | |
| 1683 </tr> | |
| 1684 <tr> | |
| 1685 <td><a href="#IrcServer.useSSL">useSSL</a></td> | |
| 1686 <td>Public method to check for SSL usage.</td> | |
| 1687 </tr> | |
| 1688 </table> | |
| 1689 | |
| 1690 <h3>Static Methods</h3> | |
| 1691 <table> | |
| 1692 <tr><td>None</td></tr> | |
| 1693 </table> | |
| 1694 | |
| 1695 | |
| 1696 <a NAME="IrcServer.__init__" ID="IrcServer.__init__"></a> | |
| 1697 <h4>IrcServer (Constructor)</h4> | |
| 1698 <b>IrcServer</b>(<i>name</i>) | |
| 1699 <p> | |
| 1700 Constructor | |
| 1701 </p> | |
| 1702 | |
| 1703 <dl> | |
| 1704 | |
| 1705 <dt><i>name</i> (str)</dt> | |
| 1706 <dd> | |
| 1707 name of the server | |
| 1708 </dd> | |
| 1709 </dl> | |
| 1710 <a NAME="IrcServer.getName" ID="IrcServer.getName"></a> | |
| 1711 <h4>IrcServer.getName</h4> | |
| 1712 <b>getName</b>(<i></i>) | |
| 1713 <p> | |
| 1714 Public method to get the server name. | |
| 1715 </p> | |
| 1716 | |
| 1717 <dl> | |
| 1718 <dt>Return:</dt> | |
| 1719 <dd> | |
| 1720 server name | |
| 1721 </dd> | |
| 1722 </dl> | |
| 1723 <dl> | |
| 1724 <dt>Return Type:</dt> | |
| 1725 <dd> | |
| 1726 str | |
| 1727 </dd> | |
| 1728 </dl> | |
| 1729 <a NAME="IrcServer.getPassword" ID="IrcServer.getPassword"></a> | |
| 1730 <h4>IrcServer.getPassword</h4> | |
| 1731 <b>getPassword</b>(<i></i>) | |
| 1732 <p> | |
| 1733 Public method to get the password. | |
| 1734 </p> | |
| 1735 | |
| 1736 <dl> | |
| 1737 <dt>Return:</dt> | |
| 1738 <dd> | |
| 1739 password | |
| 1740 </dd> | |
| 1741 </dl> | |
| 1742 <dl> | |
| 1743 <dt>Return Type:</dt> | |
| 1744 <dd> | |
| 1745 str | |
| 1746 </dd> | |
| 1747 </dl> | |
| 1748 <a NAME="IrcServer.getPort" ID="IrcServer.getPort"></a> | |
| 1749 <h4>IrcServer.getPort</h4> | |
| 1750 <b>getPort</b>(<i></i>) | |
| 1751 <p> | |
| 1752 Public method to get the server port number. | |
| 1753 </p> | |
| 1754 | |
| 1755 <dl> | |
| 1756 <dt>Return:</dt> | |
| 1757 <dd> | |
| 1758 port number | |
| 1759 </dd> | |
| 1760 </dl> | |
| 1761 <dl> | |
| 1762 <dt>Return Type:</dt> | |
| 1763 <dd> | |
| 1764 int | |
| 1765 </dd> | |
| 1766 </dl> | |
| 1767 <a NAME="IrcServer.load" ID="IrcServer.load"></a> | |
| 1768 <h4>IrcServer.load</h4> | |
| 1769 <b>load</b>(<i>settings</i>) | |
| 1770 <p> | |
| 1771 Public method to load the server data. | |
| 1772 </p> | |
| 1773 | |
| 1774 <dl> | |
| 1775 | |
| 1776 <dt><i>settings</i> (QSettings)</dt> | |
| 1777 <dd> | |
| 1778 reference to the settings object | |
| 1779 </dd> | |
| 1780 </dl> | |
| 1781 <a NAME="IrcServer.save" ID="IrcServer.save"></a> | |
| 1782 <h4>IrcServer.save</h4> | |
| 1783 <b>save</b>(<i>settings</i>) | |
| 1784 <p> | |
| 1785 Public method to save the server data. | |
| 1786 </p> | |
| 1787 | |
| 1788 <dl> | |
| 1789 | |
| 1790 <dt><i>settings</i> (QSettings)</dt> | |
| 1791 <dd> | |
| 1792 reference to the settings object | |
| 1793 </dd> | |
| 1794 </dl> | |
| 1795 <a NAME="IrcServer.setName" ID="IrcServer.setName"></a> | |
| 1796 <h4>IrcServer.setName</h4> | |
| 1797 <b>setName</b>(<i>name</i>) | |
| 1798 <p> | |
| 1799 Public method to set the server name. | |
| 1800 </p> | |
| 1801 | |
| 1802 <dl> | |
| 1803 | |
| 1804 <dt><i>name</i> (str)</dt> | |
| 1805 <dd> | |
| 1806 server name | |
| 1807 </dd> | |
| 1808 </dl> | |
| 1809 <a NAME="IrcServer.setPassword" ID="IrcServer.setPassword"></a> | |
| 1810 <h4>IrcServer.setPassword</h4> | |
| 1811 <b>setPassword</b>(<i>password</i>) | |
| 1812 <p> | |
| 1813 Public method to set a new password. | |
| 1814 </p> | |
| 1815 | |
| 1816 <dl> | |
| 1817 | |
| 1818 <dt><i>password</i> (str)</dt> | |
| 1819 <dd> | |
| 1820 password to set | |
| 1821 </dd> | |
| 1822 </dl> | |
| 1823 <a NAME="IrcServer.setPort" ID="IrcServer.setPort"></a> | |
| 1824 <h4>IrcServer.setPort</h4> | |
| 1825 <b>setPort</b>(<i>port</i>) | |
| 1826 <p> | |
| 1827 Public method to set the server port number. | |
| 1828 </p> | |
| 1829 | |
| 1830 <dl> | |
| 1831 | |
| 1832 <dt><i>port</i> (int)</dt> | |
| 1833 <dd> | |
| 1834 server port number | |
| 1835 </dd> | |
| 1836 </dl> | |
| 1837 <a NAME="IrcServer.setUseSSL" ID="IrcServer.setUseSSL"></a> | |
| 1838 <h4>IrcServer.setUseSSL</h4> | |
| 1839 <b>setUseSSL</b>(<i>on</i>) | |
| 1840 <p> | |
| 1841 Public method to set the SSL usage. | |
| 1842 </p> | |
| 1843 | |
| 1844 <dl> | |
| 1845 | |
| 1846 <dt><i>on</i> (bool)</dt> | |
| 1847 <dd> | |
| 1848 flag indicating SSL usage | |
| 1849 </dd> | |
| 1850 </dl> | |
| 1851 <a NAME="IrcServer.useSSL" ID="IrcServer.useSSL"></a> | |
| 1852 <h4>IrcServer.useSSL</h4> | |
| 1853 <b>useSSL</b>(<i></i>) | |
| 1854 <p> | |
| 1855 Public method to check for SSL usage. | |
| 1856 </p> | |
| 1857 | |
| 1858 <dl> | |
| 1859 <dt>Return:</dt> | |
| 1860 <dd> | |
| 1861 flag indicating SSL usage | |
| 1862 </dd> | |
| 1863 </dl> | |
| 1864 <dl> | |
| 1865 <dt>Return Type:</dt> | |
| 1866 <dd> | |
| 1867 bool | |
| 1868 </dd> | |
| 1869 </dl> | |
| 1870 <div align="right"><a href="#top">Up</a></div> | |
| 1871 <hr /> | |
| 1872 </body></html> |
