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