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 10428
a071d4065202
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
10427:3733e2b23cf7 10428:a071d4065202
116 <p> 116 <p>
117 Constructor 117 Constructor
118 </p> 118 </p>
119 <dl> 119 <dl>
120 120
121 <dt><i>name</i></dt> 121 <dt><i>name</i> (str)</dt>
122 <dd> 122 <dd>
123 name of the network (string) 123 name of the network
124 </dd> 124 </dd>
125 </dl> 125 </dl>
126 <a NAME="IrcChannel.autoJoin" ID="IrcChannel.autoJoin"></a> 126 <a NAME="IrcChannel.autoJoin" ID="IrcChannel.autoJoin"></a>
127 <h4>IrcChannel.autoJoin</h4> 127 <h4>IrcChannel.autoJoin</h4>
128 <b>autoJoin</b>(<i></i>) 128 <b>autoJoin</b>(<i></i>)
132 </p> 132 </p>
133 <dl> 133 <dl>
134 <dt>Return:</dt> 134 <dt>Return:</dt>
135 <dd> 135 <dd>
136 flag indicating if the channel should be 136 flag indicating if the channel should be
137 joined automatically (boolean) 137 joined automatically
138 </dd>
139 </dl>
140 <dl>
141 <dt>Return Type:</dt>
142 <dd>
143 bool
138 </dd> 144 </dd>
139 </dl> 145 </dl>
140 <a NAME="IrcChannel.getKey" ID="IrcChannel.getKey"></a> 146 <a NAME="IrcChannel.getKey" ID="IrcChannel.getKey"></a>
141 <h4>IrcChannel.getKey</h4> 147 <h4>IrcChannel.getKey</h4>
142 <b>getKey</b>(<i></i>) 148 <b>getKey</b>(<i></i>)
145 Public method to get the channel key. 151 Public method to get the channel key.
146 </p> 152 </p>
147 <dl> 153 <dl>
148 <dt>Return:</dt> 154 <dt>Return:</dt>
149 <dd> 155 <dd>
150 channel key (string) 156 channel key
157 </dd>
158 </dl>
159 <dl>
160 <dt>Return Type:</dt>
161 <dd>
162 str
151 </dd> 163 </dd>
152 </dl> 164 </dl>
153 <a NAME="IrcChannel.getName" ID="IrcChannel.getName"></a> 165 <a NAME="IrcChannel.getName" ID="IrcChannel.getName"></a>
154 <h4>IrcChannel.getName</h4> 166 <h4>IrcChannel.getName</h4>
155 <b>getName</b>(<i></i>) 167 <b>getName</b>(<i></i>)
158 Public method to get the channel name. 170 Public method to get the channel name.
159 </p> 171 </p>
160 <dl> 172 <dl>
161 <dt>Return:</dt> 173 <dt>Return:</dt>
162 <dd> 174 <dd>
163 channel name (string) 175 channel name
176 </dd>
177 </dl>
178 <dl>
179 <dt>Return Type:</dt>
180 <dd>
181 str
164 </dd> 182 </dd>
165 </dl> 183 </dl>
166 <a NAME="IrcChannel.load" ID="IrcChannel.load"></a> 184 <a NAME="IrcChannel.load" ID="IrcChannel.load"></a>
167 <h4>IrcChannel.load</h4> 185 <h4>IrcChannel.load</h4>
168 <b>load</b>(<i>settings</i>) 186 <b>load</b>(<i>settings</i>)
170 <p> 188 <p>
171 Public method to load the network data. 189 Public method to load the network data.
172 </p> 190 </p>
173 <dl> 191 <dl>
174 192
175 <dt><i>settings</i></dt> 193 <dt><i>settings</i> (QSettings)</dt>
176 <dd> 194 <dd>
177 reference to the settings object (QSettings) 195 reference to the settings object
178 </dd> 196 </dd>
179 </dl> 197 </dl>
180 <a NAME="IrcChannel.save" ID="IrcChannel.save"></a> 198 <a NAME="IrcChannel.save" ID="IrcChannel.save"></a>
181 <h4>IrcChannel.save</h4> 199 <h4>IrcChannel.save</h4>
182 <b>save</b>(<i>settings</i>) 200 <b>save</b>(<i>settings</i>)
184 <p> 202 <p>
185 Public method to save the channel data. 203 Public method to save the channel data.
186 </p> 204 </p>
187 <dl> 205 <dl>
188 206
189 <dt><i>settings</i></dt> 207 <dt><i>settings</i> (QSettings)</dt>
190 <dd> 208 <dd>
191 reference to the settings object (QSettings) 209 reference to the settings object
192 </dd> 210 </dd>
193 </dl> 211 </dl>
194 <a NAME="IrcChannel.setAutoJoin" ID="IrcChannel.setAutoJoin"></a> 212 <a NAME="IrcChannel.setAutoJoin" ID="IrcChannel.setAutoJoin"></a>
195 <h4>IrcChannel.setAutoJoin</h4> 213 <h4>IrcChannel.setAutoJoin</h4>
196 <b>setAutoJoin</b>(<i>enable</i>) 214 <b>setAutoJoin</b>(<i>enable</i>)
198 <p> 216 <p>
199 Public method to set the auto join status of the channel. 217 Public method to set the auto join status of the channel.
200 </p> 218 </p>
201 <dl> 219 <dl>
202 220
203 <dt><i>enable</i></dt> 221 <dt><i>enable</i> (bool)</dt>
204 <dd> 222 <dd>
205 flag indicating if the channel should be 223 flag indicating if the channel should be
206 joined automatically (boolean) 224 joined automatically
207 </dd> 225 </dd>
208 </dl> 226 </dl>
209 <a NAME="IrcChannel.setKey" ID="IrcChannel.setKey"></a> 227 <a NAME="IrcChannel.setKey" ID="IrcChannel.setKey"></a>
210 <h4>IrcChannel.setKey</h4> 228 <h4>IrcChannel.setKey</h4>
211 <b>setKey</b>(<i>key</i>) 229 <b>setKey</b>(<i>key</i>)
213 <p> 231 <p>
214 Public method to set a new channel key. 232 Public method to set a new channel key.
215 </p> 233 </p>
216 <dl> 234 <dl>
217 235
218 <dt><i>key</i></dt> 236 <dt><i>key</i> (str)</dt>
219 <dd> 237 <dd>
220 channel key to set (string) 238 channel key to set
221 </dd> 239 </dd>
222 </dl> 240 </dl>
223 <div align="right"><a href="#top">Up</a></div> 241 <div align="right"><a href="#top">Up</a></div>
224 <hr /> 242 <hr />
225 <hr /> 243 <hr />
356 Class method to create the default identity. 374 Class method to create the default identity.
357 </p> 375 </p>
358 <dl> 376 <dl>
359 <dt>Return:</dt> 377 <dt>Return:</dt>
360 <dd> 378 <dd>
361 default identity (IrcIdentity) 379 default identity
380 </dd>
381 </dl>
382 <dl>
383 <dt>Return Type:</dt>
384 <dd>
385 IrcIdentity
362 </dd> 386 </dd>
363 </dl> 387 </dl>
364 <a NAME="IrcIdentity.__init__" ID="IrcIdentity.__init__"></a> 388 <a NAME="IrcIdentity.__init__" ID="IrcIdentity.__init__"></a>
365 <h4>IrcIdentity (Constructor)</h4> 389 <h4>IrcIdentity (Constructor)</h4>
366 <b>IrcIdentity</b>(<i>name</i>) 390 <b>IrcIdentity</b>(<i>name</i>)
368 <p> 392 <p>
369 Constructor 393 Constructor
370 </p> 394 </p>
371 <dl> 395 <dl>
372 396
373 <dt><i>name</i></dt> 397 <dt><i>name</i> (str)</dt>
374 <dd> 398 <dd>
375 name of the identity (string) 399 name of the identity
376 </dd> 400 </dd>
377 </dl> 401 </dl>
378 <a NAME="IrcIdentity.getAwayMessage" ID="IrcIdentity.getAwayMessage"></a> 402 <a NAME="IrcIdentity.getAwayMessage" ID="IrcIdentity.getAwayMessage"></a>
379 <h4>IrcIdentity.getAwayMessage</h4> 403 <h4>IrcIdentity.getAwayMessage</h4>
380 <b>getAwayMessage</b>(<i></i>) 404 <b>getAwayMessage</b>(<i></i>)
383 Public method to get the AWAY message. 407 Public method to get the AWAY message.
384 </p> 408 </p>
385 <dl> 409 <dl>
386 <dt>Return:</dt> 410 <dt>Return:</dt>
387 <dd> 411 <dd>
388 AWAY message (string) 412 AWAY message
413 </dd>
414 </dl>
415 <dl>
416 <dt>Return Type:</dt>
417 <dd>
418 str
389 </dd> 419 </dd>
390 </dl> 420 </dl>
391 <a NAME="IrcIdentity.getIdent" ID="IrcIdentity.getIdent"></a> 421 <a NAME="IrcIdentity.getIdent" ID="IrcIdentity.getIdent"></a>
392 <h4>IrcIdentity.getIdent</h4> 422 <h4>IrcIdentity.getIdent</h4>
393 <b>getIdent</b>(<i></i>) 423 <b>getIdent</b>(<i></i>)
396 Public method to get the real identity name. 426 Public method to get the real identity name.
397 </p> 427 </p>
398 <dl> 428 <dl>
399 <dt>Return:</dt> 429 <dt>Return:</dt>
400 <dd> 430 <dd>
401 real identity name (string) 431 real identity name
432 </dd>
433 </dl>
434 <dl>
435 <dt>Return Type:</dt>
436 <dd>
437 str
402 </dd> 438 </dd>
403 </dl> 439 </dl>
404 <a NAME="IrcIdentity.getName" ID="IrcIdentity.getName"></a> 440 <a NAME="IrcIdentity.getName" ID="IrcIdentity.getName"></a>
405 <h4>IrcIdentity.getName</h4> 441 <h4>IrcIdentity.getName</h4>
406 <b>getName</b>(<i></i>) 442 <b>getName</b>(<i></i>)
409 Public method to get the identity name. 445 Public method to get the identity name.
410 </p> 446 </p>
411 <dl> 447 <dl>
412 <dt>Return:</dt> 448 <dt>Return:</dt>
413 <dd> 449 <dd>
414 identity name (string) 450 identity name
451 </dd>
452 </dl>
453 <dl>
454 <dt>Return Type:</dt>
455 <dd>
456 str
415 </dd> 457 </dd>
416 </dl> 458 </dl>
417 <a NAME="IrcIdentity.getNickNames" ID="IrcIdentity.getNickNames"></a> 459 <a NAME="IrcIdentity.getNickNames" ID="IrcIdentity.getNickNames"></a>
418 <h4>IrcIdentity.getNickNames</h4> 460 <h4>IrcIdentity.getNickNames</h4>
419 <b>getNickNames</b>(<i></i>) 461 <b>getNickNames</b>(<i></i>)
422 Public method to get the nick names. 464 Public method to get the nick names.
423 </p> 465 </p>
424 <dl> 466 <dl>
425 <dt>Return:</dt> 467 <dt>Return:</dt>
426 <dd> 468 <dd>
427 nick names (list of string) 469 nick names
470 </dd>
471 </dl>
472 <dl>
473 <dt>Return Type:</dt>
474 <dd>
475 list of str
428 </dd> 476 </dd>
429 </dl> 477 </dl>
430 <a NAME="IrcIdentity.getPartMessage" ID="IrcIdentity.getPartMessage"></a> 478 <a NAME="IrcIdentity.getPartMessage" ID="IrcIdentity.getPartMessage"></a>
431 <h4>IrcIdentity.getPartMessage</h4> 479 <h4>IrcIdentity.getPartMessage</h4>
432 <b>getPartMessage</b>(<i></i>) 480 <b>getPartMessage</b>(<i></i>)
435 Public method to get the PART message. 483 Public method to get the PART message.
436 </p> 484 </p>
437 <dl> 485 <dl>
438 <dt>Return:</dt> 486 <dt>Return:</dt>
439 <dd> 487 <dd>
440 PART message (string) 488 PART message
489 </dd>
490 </dl>
491 <dl>
492 <dt>Return Type:</dt>
493 <dd>
494 str
441 </dd> 495 </dd>
442 </dl> 496 </dl>
443 <a NAME="IrcIdentity.getPassword" ID="IrcIdentity.getPassword"></a> 497 <a NAME="IrcIdentity.getPassword" ID="IrcIdentity.getPassword"></a>
444 <h4>IrcIdentity.getPassword</h4> 498 <h4>IrcIdentity.getPassword</h4>
445 <b>getPassword</b>(<i></i>) 499 <b>getPassword</b>(<i></i>)
448 Public method to get the password. 502 Public method to get the password.
449 </p> 503 </p>
450 <dl> 504 <dl>
451 <dt>Return:</dt> 505 <dt>Return:</dt>
452 <dd> 506 <dd>
453 password (string) 507 password
508 </dd>
509 </dl>
510 <dl>
511 <dt>Return Type:</dt>
512 <dd>
513 str
454 </dd> 514 </dd>
455 </dl> 515 </dl>
456 <a NAME="IrcIdentity.getQuitMessage" ID="IrcIdentity.getQuitMessage"></a> 516 <a NAME="IrcIdentity.getQuitMessage" ID="IrcIdentity.getQuitMessage"></a>
457 <h4>IrcIdentity.getQuitMessage</h4> 517 <h4>IrcIdentity.getQuitMessage</h4>
458 <b>getQuitMessage</b>(<i></i>) 518 <b>getQuitMessage</b>(<i></i>)
461 Public method to get the QUIT message. 521 Public method to get the QUIT message.
462 </p> 522 </p>
463 <dl> 523 <dl>
464 <dt>Return:</dt> 524 <dt>Return:</dt>
465 <dd> 525 <dd>
466 QUIT message (string) 526 QUIT message
527 </dd>
528 </dl>
529 <dl>
530 <dt>Return Type:</dt>
531 <dd>
532 str
467 </dd> 533 </dd>
468 </dl> 534 </dl>
469 <a NAME="IrcIdentity.getRealName" ID="IrcIdentity.getRealName"></a> 535 <a NAME="IrcIdentity.getRealName" ID="IrcIdentity.getRealName"></a>
470 <h4>IrcIdentity.getRealName</h4> 536 <h4>IrcIdentity.getRealName</h4>
471 <b>getRealName</b>(<i></i>) 537 <b>getRealName</b>(<i></i>)
474 Public method to get the real name. 540 Public method to get the real name.
475 </p> 541 </p>
476 <dl> 542 <dl>
477 <dt>Return:</dt> 543 <dt>Return:</dt>
478 <dd> 544 <dd>
479 real name (string) 545 real name
546 </dd>
547 </dl>
548 <dl>
549 <dt>Return Type:</dt>
550 <dd>
551 str
480 </dd> 552 </dd>
481 </dl> 553 </dl>
482 <a NAME="IrcIdentity.getServiceName" ID="IrcIdentity.getServiceName"></a> 554 <a NAME="IrcIdentity.getServiceName" ID="IrcIdentity.getServiceName"></a>
483 <h4>IrcIdentity.getServiceName</h4> 555 <h4>IrcIdentity.getServiceName</h4>
484 <b>getServiceName</b>(<i></i>) 556 <b>getServiceName</b>(<i></i>)
488 identification. 560 identification.
489 </p> 561 </p>
490 <dl> 562 <dl>
491 <dt>Return:</dt> 563 <dt>Return:</dt>
492 <dd> 564 <dd>
493 service name (string) 565 service name
566 </dd>
567 </dl>
568 <dl>
569 <dt>Return Type:</dt>
570 <dd>
571 str
494 </dd> 572 </dd>
495 </dl> 573 </dl>
496 <a NAME="IrcIdentity.load" ID="IrcIdentity.load"></a> 574 <a NAME="IrcIdentity.load" ID="IrcIdentity.load"></a>
497 <h4>IrcIdentity.load</h4> 575 <h4>IrcIdentity.load</h4>
498 <b>load</b>(<i>settings</i>) 576 <b>load</b>(<i>settings</i>)
500 <p> 578 <p>
501 Public method to load the identity data. 579 Public method to load the identity data.
502 </p> 580 </p>
503 <dl> 581 <dl>
504 582
505 <dt><i>settings</i></dt> 583 <dt><i>settings</i> (QSettings)</dt>
506 <dd> 584 <dd>
507 reference to the settings object (QSettings) 585 reference to the settings object
508 </dd> 586 </dd>
509 </dl> 587 </dl>
510 <a NAME="IrcIdentity.rememberAwayPosition" ID="IrcIdentity.rememberAwayPosition"></a> 588 <a NAME="IrcIdentity.rememberAwayPosition" ID="IrcIdentity.rememberAwayPosition"></a>
511 <h4>IrcIdentity.rememberAwayPosition</h4> 589 <h4>IrcIdentity.rememberAwayPosition</h4>
512 <b>rememberAwayPosition</b>(<i></i>) 590 <b>rememberAwayPosition</b>(<i></i>)
516 upon AWAY. 594 upon AWAY.
517 </p> 595 </p>
518 <dl> 596 <dl>
519 <dt>Return:</dt> 597 <dt>Return:</dt>
520 <dd> 598 <dd>
521 flag indicating to remember the chat position (boolean) 599 flag indicating to remember the chat position
600 </dd>
601 </dl>
602 <dl>
603 <dt>Return Type:</dt>
604 <dd>
605 bool
522 </dd> 606 </dd>
523 </dl> 607 </dl>
524 <a NAME="IrcIdentity.save" ID="IrcIdentity.save"></a> 608 <a NAME="IrcIdentity.save" ID="IrcIdentity.save"></a>
525 <h4>IrcIdentity.save</h4> 609 <h4>IrcIdentity.save</h4>
526 <b>save</b>(<i>settings</i>) 610 <b>save</b>(<i>settings</i>)
528 <p> 612 <p>
529 Public method to save the identity data. 613 Public method to save the identity data.
530 </p> 614 </p>
531 <dl> 615 <dl>
532 616
533 <dt><i>settings</i></dt> 617 <dt><i>settings</i> (QSettings)</dt>
534 <dd> 618 <dd>
535 reference to the settings object (QSettings) 619 reference to the settings object
536 </dd> 620 </dd>
537 </dl> 621 </dl>
538 <a NAME="IrcIdentity.setAwayMessage" ID="IrcIdentity.setAwayMessage"></a> 622 <a NAME="IrcIdentity.setAwayMessage" ID="IrcIdentity.setAwayMessage"></a>
539 <h4>IrcIdentity.setAwayMessage</h4> 623 <h4>IrcIdentity.setAwayMessage</h4>
540 <b>setAwayMessage</b>(<i>message</i>) 624 <b>setAwayMessage</b>(<i>message</i>)
542 <p> 626 <p>
543 Public method to set the AWAY message. 627 Public method to set the AWAY message.
544 </p> 628 </p>
545 <dl> 629 <dl>
546 630
547 <dt><i>message</i></dt> 631 <dt><i>message</i> (str)</dt>
548 <dd> 632 <dd>
549 AWAY message (string) 633 AWAY message
550 </dd> 634 </dd>
551 </dl> 635 </dl>
552 <a NAME="IrcIdentity.setIdent" ID="IrcIdentity.setIdent"></a> 636 <a NAME="IrcIdentity.setIdent" ID="IrcIdentity.setIdent"></a>
553 <h4>IrcIdentity.setIdent</h4> 637 <h4>IrcIdentity.setIdent</h4>
554 <b>setIdent</b>(<i>name</i>) 638 <b>setIdent</b>(<i>name</i>)
556 <p> 640 <p>
557 Public method to set the real identity name. 641 Public method to set the real identity name.
558 </p> 642 </p>
559 <dl> 643 <dl>
560 644
561 <dt><i>name</i></dt> 645 <dt><i>name</i> (str)</dt>
562 <dd> 646 <dd>
563 real identity name (string) 647 real identity name
564 </dd> 648 </dd>
565 </dl> 649 </dl>
566 <a NAME="IrcIdentity.setName" ID="IrcIdentity.setName"></a> 650 <a NAME="IrcIdentity.setName" ID="IrcIdentity.setName"></a>
567 <h4>IrcIdentity.setName</h4> 651 <h4>IrcIdentity.setName</h4>
568 <b>setName</b>(<i>name</i>) 652 <b>setName</b>(<i>name</i>)
570 <p> 654 <p>
571 Public method to set the identity name. 655 Public method to set the identity name.
572 </p> 656 </p>
573 <dl> 657 <dl>
574 658
575 <dt><i>name</i></dt> 659 <dt><i>name</i> (str)</dt>
576 <dd> 660 <dd>
577 identity name (string) 661 identity name
578 </dd> 662 </dd>
579 </dl> 663 </dl>
580 <a NAME="IrcIdentity.setNickNames" ID="IrcIdentity.setNickNames"></a> 664 <a NAME="IrcIdentity.setNickNames" ID="IrcIdentity.setNickNames"></a>
581 <h4>IrcIdentity.setNickNames</h4> 665 <h4>IrcIdentity.setNickNames</h4>
582 <b>setNickNames</b>(<i>names</i>) 666 <b>setNickNames</b>(<i>names</i>)
584 <p> 668 <p>
585 Public method to set the nick names of the identity. 669 Public method to set the nick names of the identity.
586 </p> 670 </p>
587 <dl> 671 <dl>
588 672
589 <dt><i>names</i></dt> 673 <dt><i>names</i> (list of str)</dt>
590 <dd> 674 <dd>
591 nick names (list of string) 675 nick names
592 </dd> 676 </dd>
593 </dl> 677 </dl>
594 <a NAME="IrcIdentity.setPartMessage" ID="IrcIdentity.setPartMessage"></a> 678 <a NAME="IrcIdentity.setPartMessage" ID="IrcIdentity.setPartMessage"></a>
595 <h4>IrcIdentity.setPartMessage</h4> 679 <h4>IrcIdentity.setPartMessage</h4>
596 <b>setPartMessage</b>(<i>message</i>) 680 <b>setPartMessage</b>(<i>message</i>)
598 <p> 682 <p>
599 Public method to set the PART message. 683 Public method to set the PART message.
600 </p> 684 </p>
601 <dl> 685 <dl>
602 686
603 <dt><i>message</i></dt> 687 <dt><i>message</i> (str)</dt>
604 <dd> 688 <dd>
605 PART message (string) 689 PART message
606 </dd> 690 </dd>
607 </dl> 691 </dl>
608 <a NAME="IrcIdentity.setPassword" ID="IrcIdentity.setPassword"></a> 692 <a NAME="IrcIdentity.setPassword" ID="IrcIdentity.setPassword"></a>
609 <h4>IrcIdentity.setPassword</h4> 693 <h4>IrcIdentity.setPassword</h4>
610 <b>setPassword</b>(<i>password</i>) 694 <b>setPassword</b>(<i>password</i>)
612 <p> 696 <p>
613 Public method to set a new password. 697 Public method to set a new password.
614 </p> 698 </p>
615 <dl> 699 <dl>
616 700
617 <dt><i>password</i></dt> 701 <dt><i>password</i> (str)</dt>
618 <dd> 702 <dd>
619 password to set (string) 703 password to set
620 </dd> 704 </dd>
621 </dl> 705 </dl>
622 <a NAME="IrcIdentity.setQuitMessage" ID="IrcIdentity.setQuitMessage"></a> 706 <a NAME="IrcIdentity.setQuitMessage" ID="IrcIdentity.setQuitMessage"></a>
623 <h4>IrcIdentity.setQuitMessage</h4> 707 <h4>IrcIdentity.setQuitMessage</h4>
624 <b>setQuitMessage</b>(<i>message</i>) 708 <b>setQuitMessage</b>(<i>message</i>)
626 <p> 710 <p>
627 Public method to set the QUIT message. 711 Public method to set the QUIT message.
628 </p> 712 </p>
629 <dl> 713 <dl>
630 714
631 <dt><i>message</i></dt> 715 <dt><i>message</i> (str)</dt>
632 <dd> 716 <dd>
633 QUIT message (string) 717 QUIT message
634 </dd> 718 </dd>
635 </dl> 719 </dl>
636 <a NAME="IrcIdentity.setRealName" ID="IrcIdentity.setRealName"></a> 720 <a NAME="IrcIdentity.setRealName" ID="IrcIdentity.setRealName"></a>
637 <h4>IrcIdentity.setRealName</h4> 721 <h4>IrcIdentity.setRealName</h4>
638 <b>setRealName</b>(<i>name</i>) 722 <b>setRealName</b>(<i>name</i>)
640 <p> 724 <p>
641 Public method to set the real name of the identity. 725 Public method to set the real name of the identity.
642 </p> 726 </p>
643 <dl> 727 <dl>
644 728
645 <dt><i>name</i></dt> 729 <dt><i>name</i> (str)</dt>
646 <dd> 730 <dd>
647 real name (string) 731 real name
648 </dd> 732 </dd>
649 </dl> 733 </dl>
650 <a NAME="IrcIdentity.setRememberAwayPosition" ID="IrcIdentity.setRememberAwayPosition"></a> 734 <a NAME="IrcIdentity.setRememberAwayPosition" ID="IrcIdentity.setRememberAwayPosition"></a>
651 <h4>IrcIdentity.setRememberAwayPosition</h4> 735 <h4>IrcIdentity.setRememberAwayPosition</h4>
652 <b>setRememberAwayPosition</b>(<i>remember</i>) 736 <b>setRememberAwayPosition</b>(<i>remember</i>)
654 <p> 738 <p>
655 Public method to set to remember the chat position upon AWAY. 739 Public method to set to remember the chat position upon AWAY.
656 </p> 740 </p>
657 <dl> 741 <dl>
658 742
659 <dt><i>remember</i></dt> 743 <dt><i>remember</i> (bool)</dt>
660 <dd> 744 <dd>
661 flag indicating to remember the chat position (boolean) 745 flag indicating to remember the chat position
662 </dd> 746 </dd>
663 </dl> 747 </dl>
664 <a NAME="IrcIdentity.setServiceName" ID="IrcIdentity.setServiceName"></a> 748 <a NAME="IrcIdentity.setServiceName" ID="IrcIdentity.setServiceName"></a>
665 <h4>IrcIdentity.setServiceName</h4> 749 <h4>IrcIdentity.setServiceName</h4>
666 <b>setServiceName</b>(<i>name</i>) 750 <b>setServiceName</b>(<i>name</i>)
669 Public method to set the service name of the identity used for 753 Public method to set the service name of the identity used for
670 identification. 754 identification.
671 </p> 755 </p>
672 <dl> 756 <dl>
673 757
674 <dt><i>name</i></dt> 758 <dt><i>name</i> (str)</dt>
675 <dd> 759 <dd>
676 service name (string) 760 service name
677 </dd> 761 </dd>
678 </dl> 762 </dl>
679 <div align="right"><a href="#top">Up</a></div> 763 <div align="right"><a href="#top">Up</a></div>
680 <hr /> 764 <hr />
681 <hr /> 765 <hr />
795 <p> 879 <p>
796 Class method to create the default network. 880 Class method to create the default network.
797 </p> 881 </p>
798 <dl> 882 <dl>
799 883
800 <dt><i>ssl</i></dt> 884 <dt><i>ssl</i> (bool)</dt>
801 <dd> 885 <dd>
802 flag indicating to create a SSL network configuration 886 flag indicating to create a SSL network configuration
803 (boolean) 887 </dd>
804 </dd> 888 </dl>
805 </dl> 889 <dl>
806 <dl> 890 <dt>Return:</dt>
807 <dt>Return:</dt> 891 <dd>
808 <dd> 892 default network object
809 default network object (IrcNetwork) 893 </dd>
894 </dl>
895 <dl>
896 <dt>Return Type:</dt>
897 <dd>
898 IrcNetwork
810 </dd> 899 </dd>
811 </dl> 900 </dl>
812 <a NAME="IrcNetwork.__init__" ID="IrcNetwork.__init__"></a> 901 <a NAME="IrcNetwork.__init__" ID="IrcNetwork.__init__"></a>
813 <h4>IrcNetwork (Constructor)</h4> 902 <h4>IrcNetwork (Constructor)</h4>
814 <b>IrcNetwork</b>(<i>name</i>) 903 <b>IrcNetwork</b>(<i>name</i>)
816 <p> 905 <p>
817 Constructor 906 Constructor
818 </p> 907 </p>
819 <dl> 908 <dl>
820 909
821 <dt><i>name</i></dt> 910 <dt><i>name</i> (str)</dt>
822 <dd> 911 <dd>
823 name of the network (string) 912 name of the network
824 </dd> 913 </dd>
825 </dl> 914 </dl>
826 <a NAME="IrcNetwork.addChannel" ID="IrcNetwork.addChannel"></a> 915 <a NAME="IrcNetwork.addChannel" ID="IrcNetwork.addChannel"></a>
827 <h4>IrcNetwork.addChannel</h4> 916 <h4>IrcNetwork.addChannel</h4>
828 <b>addChannel</b>(<i>channel</i>) 917 <b>addChannel</b>(<i>channel</i>)
830 <p> 919 <p>
831 Public method to add a channel. 920 Public method to add a channel.
832 </p> 921 </p>
833 <dl> 922 <dl>
834 923
835 <dt><i>channel</i></dt> 924 <dt><i>channel</i> (IrcChannel)</dt>
836 <dd> 925 <dd>
837 channel object to add (IrcChannel) 926 channel object to add
838 </dd> 927 </dd>
839 </dl> 928 </dl>
840 <a NAME="IrcNetwork.autoConnect" ID="IrcNetwork.autoConnect"></a> 929 <a NAME="IrcNetwork.autoConnect" ID="IrcNetwork.autoConnect"></a>
841 <h4>IrcNetwork.autoConnect</h4> 930 <h4>IrcNetwork.autoConnect</h4>
842 <b>autoConnect</b>(<i></i>) 931 <b>autoConnect</b>(<i></i>)
846 start-up. 935 start-up.
847 </p> 936 </p>
848 <dl> 937 <dl>
849 <dt>Return:</dt> 938 <dt>Return:</dt>
850 <dd> 939 <dd>
851 flag indicating an auto connect (boolean) 940 flag indicating an auto connect
941 </dd>
942 </dl>
943 <dl>
944 <dt>Return Type:</dt>
945 <dd>
946 bool
852 </dd> 947 </dd>
853 </dl> 948 </dl>
854 <a NAME="IrcNetwork.deleteChannel" ID="IrcNetwork.deleteChannel"></a> 949 <a NAME="IrcNetwork.deleteChannel" ID="IrcNetwork.deleteChannel"></a>
855 <h4>IrcNetwork.deleteChannel</h4> 950 <h4>IrcNetwork.deleteChannel</h4>
856 <b>deleteChannel</b>(<i>channelName</i>) 951 <b>deleteChannel</b>(<i>channelName</i>)
858 <p> 953 <p>
859 Public method to delete the given channel. 954 Public method to delete the given channel.
860 </p> 955 </p>
861 <dl> 956 <dl>
862 957
863 <dt><i>channelName</i></dt> 958 <dt><i>channelName</i> (str)</dt>
864 <dd> 959 <dd>
865 name of the channel to be deleted (string) 960 name of the channel to be deleted
866 </dd> 961 </dd>
867 </dl> 962 </dl>
868 <a NAME="IrcNetwork.getChannel" ID="IrcNetwork.getChannel"></a> 963 <a NAME="IrcNetwork.getChannel" ID="IrcNetwork.getChannel"></a>
869 <h4>IrcNetwork.getChannel</h4> 964 <h4>IrcNetwork.getChannel</h4>
870 <b>getChannel</b>(<i>channelName</i>) 965 <b>getChannel</b>(<i>channelName</i>)
872 <p> 967 <p>
873 Public method to get a channel. 968 Public method to get a channel.
874 </p> 969 </p>
875 <dl> 970 <dl>
876 971
877 <dt><i>channelName</i></dt> 972 <dt><i>channelName</i> (str)</dt>
878 <dd> 973 <dd>
879 name of the channel to retrieve (string) 974 name of the channel to retrieve
880 </dd> 975 </dd>
881 </dl> 976 </dl>
882 <dl> 977 <dl>
883 <dt>Return:</dt> 978 <dt>Return:</dt>
884 <dd> 979 <dd>
885 reference to the channel (IrcChannel) 980 reference to the channel
981 </dd>
982 </dl>
983 <dl>
984 <dt>Return Type:</dt>
985 <dd>
986 IrcChannel
886 </dd> 987 </dd>
887 </dl> 988 </dl>
888 <a NAME="IrcNetwork.getChannelNames" ID="IrcNetwork.getChannelNames"></a> 989 <a NAME="IrcNetwork.getChannelNames" ID="IrcNetwork.getChannelNames"></a>
889 <h4>IrcNetwork.getChannelNames</h4> 990 <h4>IrcNetwork.getChannelNames</h4>
890 <b>getChannelNames</b>(<i></i>) 991 <b>getChannelNames</b>(<i></i>)
893 Public method to get the list of channels. 994 Public method to get the list of channels.
894 </p> 995 </p>
895 <dl> 996 <dl>
896 <dt>Return:</dt> 997 <dt>Return:</dt>
897 <dd> 998 <dd>
898 list of channel names (list of string) 999 list of channel names
1000 </dd>
1001 </dl>
1002 <dl>
1003 <dt>Return Type:</dt>
1004 <dd>
1005 list of str
899 </dd> 1006 </dd>
900 </dl> 1007 </dl>
901 <a NAME="IrcNetwork.getChannels" ID="IrcNetwork.getChannels"></a> 1008 <a NAME="IrcNetwork.getChannels" ID="IrcNetwork.getChannels"></a>
902 <h4>IrcNetwork.getChannels</h4> 1009 <h4>IrcNetwork.getChannels</h4>
903 <b>getChannels</b>(<i></i>) 1010 <b>getChannels</b>(<i></i>)
906 Public method to get the channels. 1013 Public method to get the channels.
907 </p> 1014 </p>
908 <dl> 1015 <dl>
909 <dt>Return:</dt> 1016 <dt>Return:</dt>
910 <dd> 1017 <dd>
911 list of channels for the network (list of IrcChannel) 1018 list of channels for the network
1019 </dd>
1020 </dl>
1021 <dl>
1022 <dt>Return Type:</dt>
1023 <dd>
1024 list of IrcChannel
912 </dd> 1025 </dd>
913 </dl> 1026 </dl>
914 <a NAME="IrcNetwork.getIdentityName" ID="IrcNetwork.getIdentityName"></a> 1027 <a NAME="IrcNetwork.getIdentityName" ID="IrcNetwork.getIdentityName"></a>
915 <h4>IrcNetwork.getIdentityName</h4> 1028 <h4>IrcNetwork.getIdentityName</h4>
916 <b>getIdentityName</b>(<i></i>) 1029 <b>getIdentityName</b>(<i></i>)
919 Public method to get the name of the identity. 1032 Public method to get the name of the identity.
920 </p> 1033 </p>
921 <dl> 1034 <dl>
922 <dt>Return:</dt> 1035 <dt>Return:</dt>
923 <dd> 1036 <dd>
924 identity name (string) 1037 identity name
1038 </dd>
1039 </dl>
1040 <dl>
1041 <dt>Return Type:</dt>
1042 <dd>
1043 str
925 </dd> 1044 </dd>
926 </dl> 1045 </dl>
927 <a NAME="IrcNetwork.getName" ID="IrcNetwork.getName"></a> 1046 <a NAME="IrcNetwork.getName" ID="IrcNetwork.getName"></a>
928 <h4>IrcNetwork.getName</h4> 1047 <h4>IrcNetwork.getName</h4>
929 <b>getName</b>(<i></i>) 1048 <b>getName</b>(<i></i>)
932 Public method to get the network name. 1051 Public method to get the network name.
933 </p> 1052 </p>
934 <dl> 1053 <dl>
935 <dt>Return:</dt> 1054 <dt>Return:</dt>
936 <dd> 1055 <dd>
937 network name (string) 1056 network name
1057 </dd>
1058 </dl>
1059 <dl>
1060 <dt>Return Type:</dt>
1061 <dd>
1062 str
938 </dd> 1063 </dd>
939 </dl> 1064 </dl>
940 <a NAME="IrcNetwork.getServer" ID="IrcNetwork.getServer"></a> 1065 <a NAME="IrcNetwork.getServer" ID="IrcNetwork.getServer"></a>
941 <h4>IrcNetwork.getServer</h4> 1066 <h4>IrcNetwork.getServer</h4>
942 <b>getServer</b>(<i></i>) 1067 <b>getServer</b>(<i></i>)
945 Public method to get the server object. 1070 Public method to get the server object.
946 </p> 1071 </p>
947 <dl> 1072 <dl>
948 <dt>Return:</dt> 1073 <dt>Return:</dt>
949 <dd> 1074 <dd>
950 reference to the server (IrcServer) 1075 reference to the server
1076 </dd>
1077 </dl>
1078 <dl>
1079 <dt>Return Type:</dt>
1080 <dd>
1081 IrcServer
951 </dd> 1082 </dd>
952 </dl> 1083 </dl>
953 <a NAME="IrcNetwork.getServerName" ID="IrcNetwork.getServerName"></a> 1084 <a NAME="IrcNetwork.getServerName" ID="IrcNetwork.getServerName"></a>
954 <h4>IrcNetwork.getServerName</h4> 1085 <h4>IrcNetwork.getServerName</h4>
955 <b>getServerName</b>(<i></i>) 1086 <b>getServerName</b>(<i></i>)
958 Public method to get the server name. 1089 Public method to get the server name.
959 </p> 1090 </p>
960 <dl> 1091 <dl>
961 <dt>Return:</dt> 1092 <dt>Return:</dt>
962 <dd> 1093 <dd>
963 server name (string) 1094 server name
1095 </dd>
1096 </dl>
1097 <dl>
1098 <dt>Return Type:</dt>
1099 <dd>
1100 str
964 </dd> 1101 </dd>
965 </dl> 1102 </dl>
966 <a NAME="IrcNetwork.load" ID="IrcNetwork.load"></a> 1103 <a NAME="IrcNetwork.load" ID="IrcNetwork.load"></a>
967 <h4>IrcNetwork.load</h4> 1104 <h4>IrcNetwork.load</h4>
968 <b>load</b>(<i>settings</i>) 1105 <b>load</b>(<i>settings</i>)
970 <p> 1107 <p>
971 Public method to load the network data. 1108 Public method to load the network data.
972 </p> 1109 </p>
973 <dl> 1110 <dl>
974 1111
975 <dt><i>settings</i></dt> 1112 <dt><i>settings</i> (QSettings)</dt>
976 <dd> 1113 <dd>
977 reference to the settings object (QSettings) 1114 reference to the settings object
978 </dd> 1115 </dd>
979 </dl> 1116 </dl>
980 <a NAME="IrcNetwork.save" ID="IrcNetwork.save"></a> 1117 <a NAME="IrcNetwork.save" ID="IrcNetwork.save"></a>
981 <h4>IrcNetwork.save</h4> 1118 <h4>IrcNetwork.save</h4>
982 <b>save</b>(<i>settings</i>) 1119 <b>save</b>(<i>settings</i>)
984 <p> 1121 <p>
985 Public method to save the network data. 1122 Public method to save the network data.
986 </p> 1123 </p>
987 <dl> 1124 <dl>
988 1125
989 <dt><i>settings</i></dt> 1126 <dt><i>settings</i> (QSettings)</dt>
990 <dd> 1127 <dd>
991 reference to the settings object (QSettings) 1128 reference to the settings object
992 </dd> 1129 </dd>
993 </dl> 1130 </dl>
994 <a NAME="IrcNetwork.setAutoConnect" ID="IrcNetwork.setAutoConnect"></a> 1131 <a NAME="IrcNetwork.setAutoConnect" ID="IrcNetwork.setAutoConnect"></a>
995 <h4>IrcNetwork.setAutoConnect</h4> 1132 <h4>IrcNetwork.setAutoConnect</h4>
996 <b>setAutoConnect</b>(<i>enable</i>) 1133 <b>setAutoConnect</b>(<i>enable</i>)
998 <p> 1135 <p>
999 Public method to set the auto connect flag. 1136 Public method to set the auto connect flag.
1000 </p> 1137 </p>
1001 <dl> 1138 <dl>
1002 1139
1003 <dt><i>enable</i></dt> 1140 <dt><i>enable</i> (bool)</dt>
1004 <dd> 1141 <dd>
1005 flag indicate to connect to the network at start-up. 1142 flag indicate to connect to the network at start-up
1006 </dd> 1143 </dd>
1007 </dl> 1144 </dl>
1008 <a NAME="IrcNetwork.setChannel" ID="IrcNetwork.setChannel"></a> 1145 <a NAME="IrcNetwork.setChannel" ID="IrcNetwork.setChannel"></a>
1009 <h4>IrcNetwork.setChannel</h4> 1146 <h4>IrcNetwork.setChannel</h4>
1010 <b>setChannel</b>(<i>channel</i>) 1147 <b>setChannel</b>(<i>channel</i>)
1012 <p> 1149 <p>
1013 Public method to set a channel. 1150 Public method to set a channel.
1014 </p> 1151 </p>
1015 <dl> 1152 <dl>
1016 1153
1017 <dt><i>channel</i></dt> 1154 <dt><i>channel</i> (IrcChannel)</dt>
1018 <dd> 1155 <dd>
1019 channel object to set (IrcChannel) 1156 channel object to set
1020 </dd> 1157 </dd>
1021 </dl> 1158 </dl>
1022 <a NAME="IrcNetwork.setChannels" ID="IrcNetwork.setChannels"></a> 1159 <a NAME="IrcNetwork.setChannels" ID="IrcNetwork.setChannels"></a>
1023 <h4>IrcNetwork.setChannels</h4> 1160 <h4>IrcNetwork.setChannels</h4>
1024 <b>setChannels</b>(<i>channels</i>) 1161 <b>setChannels</b>(<i>channels</i>)
1026 <p> 1163 <p>
1027 Public method to set the list of channels. 1164 Public method to set the list of channels.
1028 </p> 1165 </p>
1029 <dl> 1166 <dl>
1030 1167
1031 <dt><i>channels</i></dt> 1168 <dt><i>channels</i> (list of IrcChannel)</dt>
1032 <dd> 1169 <dd>
1033 list of channels for the network (list of IrcChannel) 1170 list of channels for the network
1034 </dd> 1171 </dd>
1035 </dl> 1172 </dl>
1036 <a NAME="IrcNetwork.setIdentityName" ID="IrcNetwork.setIdentityName"></a> 1173 <a NAME="IrcNetwork.setIdentityName" ID="IrcNetwork.setIdentityName"></a>
1037 <h4>IrcNetwork.setIdentityName</h4> 1174 <h4>IrcNetwork.setIdentityName</h4>
1038 <b>setIdentityName</b>(<i>name</i>) 1175 <b>setIdentityName</b>(<i>name</i>)
1040 <p> 1177 <p>
1041 Public method to set the name of the identity. 1178 Public method to set the name of the identity.
1042 </p> 1179 </p>
1043 <dl> 1180 <dl>
1044 1181
1045 <dt><i>name</i></dt> 1182 <dt><i>name</i> (str)</dt>
1046 <dd> 1183 <dd>
1047 identity name (string) 1184 identity name
1048 </dd> 1185 </dd>
1049 </dl> 1186 </dl>
1050 <a NAME="IrcNetwork.setName" ID="IrcNetwork.setName"></a> 1187 <a NAME="IrcNetwork.setName" ID="IrcNetwork.setName"></a>
1051 <h4>IrcNetwork.setName</h4> 1188 <h4>IrcNetwork.setName</h4>
1052 <b>setName</b>(<i>name</i>) 1189 <b>setName</b>(<i>name</i>)
1054 <p> 1191 <p>
1055 Public method to set the network name. 1192 Public method to set the network name.
1056 </p> 1193 </p>
1057 <dl> 1194 <dl>
1058 1195
1059 <dt><i>name</i></dt> 1196 <dt><i>name</i> (str)</dt>
1060 <dd> 1197 <dd>
1061 network name (string) 1198 network name
1062 </dd> 1199 </dd>
1063 </dl> 1200 </dl>
1064 <a NAME="IrcNetwork.setServer" ID="IrcNetwork.setServer"></a> 1201 <a NAME="IrcNetwork.setServer" ID="IrcNetwork.setServer"></a>
1065 <h4>IrcNetwork.setServer</h4> 1202 <h4>IrcNetwork.setServer</h4>
1066 <b>setServer</b>(<i>server</i>) 1203 <b>setServer</b>(<i>server</i>)
1068 <p> 1205 <p>
1069 Public method to set the server. 1206 Public method to set the server.
1070 </p> 1207 </p>
1071 <dl> 1208 <dl>
1072 1209
1073 <dt><i>server</i></dt> 1210 <dt><i>server</i> (IrcServer)</dt>
1074 <dd> 1211 <dd>
1075 server object to set (IrcServer) 1212 server object to set
1076 </dd> 1213 </dd>
1077 </dl> 1214 </dl>
1078 <div align="right"><a href="#top">Up</a></div> 1215 <div align="right"><a href="#top">Up</a></div>
1079 <hr /> 1216 <hr />
1080 <hr /> 1217 <hr />
1206 <p> 1343 <p>
1207 Constructor 1344 Constructor
1208 </p> 1345 </p>
1209 <dl> 1346 <dl>
1210 1347
1211 <dt><i>parent</i></dt> 1348 <dt><i>parent</i> (QObject)</dt>
1212 <dd> 1349 <dd>
1213 reference to the parent object (QObject) 1350 reference to the parent object
1214 </dd> 1351 </dd>
1215 </dl> 1352 </dl>
1216 <a NAME="IrcNetworkManager.__load" ID="IrcNetworkManager.__load"></a> 1353 <a NAME="IrcNetworkManager.__load" ID="IrcNetworkManager.__load"></a>
1217 <h4>IrcNetworkManager.__load</h4> 1354 <h4>IrcNetworkManager.__load</h4>
1218 <b>__load</b>(<i></i>) 1355 <b>__load</b>(<i></i>)
1227 <p> 1364 <p>
1228 Private method to load default values. 1365 Private method to load default values.
1229 </p> 1366 </p>
1230 <dl> 1367 <dl>
1231 1368
1232 <dt><i>identityOnly</i></dt> 1369 <dt><i>identityOnly</i> (bool)</dt>
1233 <dd> 1370 <dd>
1234 flag indicating to just load the default 1371 flag indicating to just load the default
1235 identity (boolean) 1372 identity
1236 </dd> 1373 </dd>
1237 </dl> 1374 </dl>
1238 <a NAME="IrcNetworkManager.addIdentity" ID="IrcNetworkManager.addIdentity"></a> 1375 <a NAME="IrcNetworkManager.addIdentity" ID="IrcNetworkManager.addIdentity"></a>
1239 <h4>IrcNetworkManager.addIdentity</h4> 1376 <h4>IrcNetworkManager.addIdentity</h4>
1240 <b>addIdentity</b>(<i>identity</i>) 1377 <b>addIdentity</b>(<i>identity</i>)
1242 <p> 1379 <p>
1243 Public method to add a new identity. 1380 Public method to add a new identity.
1244 </p> 1381 </p>
1245 <dl> 1382 <dl>
1246 1383
1247 <dt><i>identity</i></dt> 1384 <dt><i>identity</i> (IrcIdentity)</dt>
1248 <dd> 1385 <dd>
1249 reference to the identity to add (IrcIdentity) 1386 reference to the identity to add
1250 </dd> 1387 </dd>
1251 </dl> 1388 </dl>
1252 <a NAME="IrcNetworkManager.addNetwork" ID="IrcNetworkManager.addNetwork"></a> 1389 <a NAME="IrcNetworkManager.addNetwork" ID="IrcNetworkManager.addNetwork"></a>
1253 <h4>IrcNetworkManager.addNetwork</h4> 1390 <h4>IrcNetworkManager.addNetwork</h4>
1254 <b>addNetwork</b>(<i>network</i>) 1391 <b>addNetwork</b>(<i>network</i>)
1256 <p> 1393 <p>
1257 Public method to add a network. 1394 Public method to add a network.
1258 </p> 1395 </p>
1259 <dl> 1396 <dl>
1260 1397
1261 <dt><i>network</i></dt> 1398 <dt><i>network</i> (IrcNetwork)</dt>
1262 <dd> 1399 <dd>
1263 network object to add (IrcNetwork) 1400 network object to add
1264 </dd> 1401 </dd>
1265 </dl> 1402 </dl>
1266 <a NAME="IrcNetworkManager.close" ID="IrcNetworkManager.close"></a> 1403 <a NAME="IrcNetworkManager.close" ID="IrcNetworkManager.close"></a>
1267 <h4>IrcNetworkManager.close</h4> 1404 <h4>IrcNetworkManager.close</h4>
1268 <b>close</b>(<i></i>) 1405 <b>close</b>(<i></i>)
1277 <p> 1414 <p>
1278 Public method to delete the given identity. 1415 Public method to delete the given identity.
1279 </p> 1416 </p>
1280 <dl> 1417 <dl>
1281 1418
1282 <dt><i>name</i></dt> 1419 <dt><i>name</i> (str)</dt>
1283 <dd> 1420 <dd>
1284 name of the identity to delete (string) 1421 name of the identity to delete
1285 </dd> 1422 </dd>
1286 </dl> 1423 </dl>
1287 <a NAME="IrcNetworkManager.deleteNetwork" ID="IrcNetworkManager.deleteNetwork"></a> 1424 <a NAME="IrcNetworkManager.deleteNetwork" ID="IrcNetworkManager.deleteNetwork"></a>
1288 <h4>IrcNetworkManager.deleteNetwork</h4> 1425 <h4>IrcNetworkManager.deleteNetwork</h4>
1289 <b>deleteNetwork</b>(<i>name</i>) 1426 <b>deleteNetwork</b>(<i>name</i>)
1291 <p> 1428 <p>
1292 Public method to delete the given network. 1429 Public method to delete the given network.
1293 </p> 1430 </p>
1294 <dl> 1431 <dl>
1295 1432
1296 <dt><i>name</i></dt> 1433 <dt><i>name</i> (str)</dt>
1297 <dd> 1434 <dd>
1298 name of the network to delete (string) 1435 name of the network to delete
1299 </dd> 1436 </dd>
1300 </dl> 1437 </dl>
1301 <a NAME="IrcNetworkManager.getIdentities" ID="IrcNetworkManager.getIdentities"></a> 1438 <a NAME="IrcNetworkManager.getIdentities" ID="IrcNetworkManager.getIdentities"></a>
1302 <h4>IrcNetworkManager.getIdentities</h4> 1439 <h4>IrcNetworkManager.getIdentities</h4>
1303 <b>getIdentities</b>(<i></i>) 1440 <b>getIdentities</b>(<i></i>)
1306 Public method to get a copy of all identities. 1443 Public method to get a copy of all identities.
1307 </p> 1444 </p>
1308 <dl> 1445 <dl>
1309 <dt>Return:</dt> 1446 <dt>Return:</dt>
1310 <dd> 1447 <dd>
1311 dictionary of all identities (dict of IrcIdentity) 1448 dictionary of all identities
1449 </dd>
1450 </dl>
1451 <dl>
1452 <dt>Return Type:</dt>
1453 <dd>
1454 dict of IrcIdentity
1312 </dd> 1455 </dd>
1313 </dl> 1456 </dl>
1314 <a NAME="IrcNetworkManager.getIdentity" ID="IrcNetworkManager.getIdentity"></a> 1457 <a NAME="IrcNetworkManager.getIdentity" ID="IrcNetworkManager.getIdentity"></a>
1315 <h4>IrcNetworkManager.getIdentity</h4> 1458 <h4>IrcNetworkManager.getIdentity</h4>
1316 <b>getIdentity</b>(<i>name, create=False</i>) 1459 <b>getIdentity</b>(<i>name, create=False</i>)
1318 <p> 1461 <p>
1319 Public method to get an identity object. 1462 Public method to get an identity object.
1320 </p> 1463 </p>
1321 <dl> 1464 <dl>
1322 1465
1323 <dt><i>name</i></dt> 1466 <dt><i>name</i> (str)</dt>
1324 <dd> 1467 <dd>
1325 name of the identity to get (string) 1468 name of the identity to get
1326 </dd> 1469 </dd>
1327 <dt><i>create</i></dt> 1470 <dt><i>create</i> (bool)</dt>
1328 <dd> 1471 <dd>
1329 flag indicating to create a new object, 1472 flag indicating to create a new object,
1330 if none exists (boolean) 1473 if none exists
1331 </dd> 1474 </dd>
1332 </dl> 1475 </dl>
1333 <dl> 1476 <dl>
1334 <dt>Return:</dt> 1477 <dt>Return:</dt>
1335 <dd> 1478 <dd>
1336 reference to the identity (IrcIdentity) 1479 reference to the identity
1480 </dd>
1481 </dl>
1482 <dl>
1483 <dt>Return Type:</dt>
1484 <dd>
1485 IrcIdentity
1337 </dd> 1486 </dd>
1338 </dl> 1487 </dl>
1339 <a NAME="IrcNetworkManager.getIdentityNames" ID="IrcNetworkManager.getIdentityNames"></a> 1488 <a NAME="IrcNetworkManager.getIdentityNames" ID="IrcNetworkManager.getIdentityNames"></a>
1340 <h4>IrcNetworkManager.getIdentityNames</h4> 1489 <h4>IrcNetworkManager.getIdentityNames</h4>
1341 <b>getIdentityNames</b>(<i></i>) 1490 <b>getIdentityNames</b>(<i></i>)
1344 Public method to get the names of all identities. 1493 Public method to get the names of all identities.
1345 </p> 1494 </p>
1346 <dl> 1495 <dl>
1347 <dt>Return:</dt> 1496 <dt>Return:</dt>
1348 <dd> 1497 <dd>
1349 names of all identities (list of string) 1498 names of all identities
1499 </dd>
1500 </dl>
1501 <dl>
1502 <dt>Return Type:</dt>
1503 <dd>
1504 list of string)
1350 </dd> 1505 </dd>
1351 </dl> 1506 </dl>
1352 <a NAME="IrcNetworkManager.getNetwork" ID="IrcNetworkManager.getNetwork"></a> 1507 <a NAME="IrcNetworkManager.getNetwork" ID="IrcNetworkManager.getNetwork"></a>
1353 <h4>IrcNetworkManager.getNetwork</h4> 1508 <h4>IrcNetworkManager.getNetwork</h4>
1354 <b>getNetwork</b>(<i>name</i>) 1509 <b>getNetwork</b>(<i>name</i>)
1356 <p> 1511 <p>
1357 Public method to get a network object. 1512 Public method to get a network object.
1358 </p> 1513 </p>
1359 <dl> 1514 <dl>
1360 1515
1361 <dt><i>name</i></dt> 1516 <dt><i>name</i> (str)</dt>
1362 <dd> 1517 <dd>
1363 name of the network (string) 1518 name of the network
1364 </dd> 1519 </dd>
1365 </dl> 1520 </dl>
1366 <dl> 1521 <dl>
1367 <dt>Return:</dt> 1522 <dt>Return:</dt>
1368 <dd> 1523 <dd>
1369 reference to the network object (IrcNetwork) 1524 reference to the network object
1525 </dd>
1526 </dl>
1527 <dl>
1528 <dt>Return Type:</dt>
1529 <dd>
1530 IrcNetwork
1370 </dd> 1531 </dd>
1371 </dl> 1532 </dl>
1372 <a NAME="IrcNetworkManager.getNetworkNames" ID="IrcNetworkManager.getNetworkNames"></a> 1533 <a NAME="IrcNetworkManager.getNetworkNames" ID="IrcNetworkManager.getNetworkNames"></a>
1373 <h4>IrcNetworkManager.getNetworkNames</h4> 1534 <h4>IrcNetworkManager.getNetworkNames</h4>
1374 <b>getNetworkNames</b>(<i></i>) 1535 <b>getNetworkNames</b>(<i></i>)
1377 Public method to get a list of all known network names. 1538 Public method to get a list of all known network names.
1378 </p> 1539 </p>
1379 <dl> 1540 <dl>
1380 <dt>Return:</dt> 1541 <dt>Return:</dt>
1381 <dd> 1542 <dd>
1382 list of network names (list of string) 1543 list of network names
1544 </dd>
1545 </dl>
1546 <dl>
1547 <dt>Return Type:</dt>
1548 <dd>
1549 list of str
1383 </dd> 1550 </dd>
1384 </dl> 1551 </dl>
1385 <a NAME="IrcNetworkManager.identityChanged" ID="IrcNetworkManager.identityChanged"></a> 1552 <a NAME="IrcNetworkManager.identityChanged" ID="IrcNetworkManager.identityChanged"></a>
1386 <h4>IrcNetworkManager.identityChanged</h4> 1553 <h4>IrcNetworkManager.identityChanged</h4>
1387 <b>identityChanged</b>(<i></i>) 1554 <b>identityChanged</b>(<i></i>)
1403 <p> 1570 <p>
1404 Public method to rename an identity. 1571 Public method to rename an identity.
1405 </p> 1572 </p>
1406 <dl> 1573 <dl>
1407 1574
1408 <dt><i>oldName</i></dt> 1575 <dt><i>oldName</i> (str)</dt>
1409 <dd> 1576 <dd>
1410 old name of the identity (string) 1577 old name of the identity
1411 </dd> 1578 </dd>
1412 <dt><i>newName</i></dt> 1579 <dt><i>newName</i> (str)</dt>
1413 <dd> 1580 <dd>
1414 new name of the identity (string) 1581 new name of the identity
1415 </dd> 1582 </dd>
1416 </dl> 1583 </dl>
1417 <a NAME="IrcNetworkManager.save" ID="IrcNetworkManager.save"></a> 1584 <a NAME="IrcNetworkManager.save" ID="IrcNetworkManager.save"></a>
1418 <h4>IrcNetworkManager.save</h4> 1585 <h4>IrcNetworkManager.save</h4>
1419 <b>save</b>(<i></i>) 1586 <b>save</b>(<i></i>)
1428 <p> 1595 <p>
1429 Public method to set the identities. 1596 Public method to set the identities.
1430 </p> 1597 </p>
1431 <dl> 1598 <dl>
1432 1599
1433 <dt><i>identities</i></dt> 1600 <dt><i>identities</i> (dict of IrcIdentity)</dt>
1434 <dd> 1601 <dd>
1435 dictionary of all identities (dict of IrcIdentity) 1602 dictionary of all identities
1436 </dd> 1603 </dd>
1437 </dl> 1604 </dl>
1438 <a NAME="IrcNetworkManager.setNetwork" ID="IrcNetworkManager.setNetwork"></a> 1605 <a NAME="IrcNetworkManager.setNetwork" ID="IrcNetworkManager.setNetwork"></a>
1439 <h4>IrcNetworkManager.setNetwork</h4> 1606 <h4>IrcNetworkManager.setNetwork</h4>
1440 <b>setNetwork</b>(<i>network, networkName=""</i>) 1607 <b>setNetwork</b>(<i>network, networkName=""</i>)
1442 <p> 1609 <p>
1443 Public method to set a network. 1610 Public method to set a network.
1444 </p> 1611 </p>
1445 <dl> 1612 <dl>
1446 1613
1447 <dt><i>network</i></dt> 1614 <dt><i>network</i> (IrcNetwork)</dt>
1448 <dd> 1615 <dd>
1449 network object to set (IrcNetwork) 1616 network object to set
1450 </dd> 1617 </dd>
1451 <dt><i>networkName</i></dt> 1618 <dt><i>networkName</i> (str)</dt>
1452 <dd> 1619 <dd>
1453 name the network was known for (string) 1620 name the network was known for
1454 </dd> 1621 </dd>
1455 </dl> 1622 </dl>
1456 <div align="right"><a href="#top">Up</a></div> 1623 <div align="right"><a href="#top">Up</a></div>
1457 <hr /> 1624 <hr />
1458 <hr /> 1625 <hr />
1536 <p> 1703 <p>
1537 Constructor 1704 Constructor
1538 </p> 1705 </p>
1539 <dl> 1706 <dl>
1540 1707
1541 <dt><i>name</i></dt> 1708 <dt><i>name</i> (str)</dt>
1542 <dd> 1709 <dd>
1543 name of the server (string) 1710 name of the server
1544 </dd> 1711 </dd>
1545 </dl> 1712 </dl>
1546 <a NAME="IrcServer.getName" ID="IrcServer.getName"></a> 1713 <a NAME="IrcServer.getName" ID="IrcServer.getName"></a>
1547 <h4>IrcServer.getName</h4> 1714 <h4>IrcServer.getName</h4>
1548 <b>getName</b>(<i></i>) 1715 <b>getName</b>(<i></i>)
1551 Public method to get the server name. 1718 Public method to get the server name.
1552 </p> 1719 </p>
1553 <dl> 1720 <dl>
1554 <dt>Return:</dt> 1721 <dt>Return:</dt>
1555 <dd> 1722 <dd>
1556 server name (string) 1723 server name
1724 </dd>
1725 </dl>
1726 <dl>
1727 <dt>Return Type:</dt>
1728 <dd>
1729 str
1557 </dd> 1730 </dd>
1558 </dl> 1731 </dl>
1559 <a NAME="IrcServer.getPassword" ID="IrcServer.getPassword"></a> 1732 <a NAME="IrcServer.getPassword" ID="IrcServer.getPassword"></a>
1560 <h4>IrcServer.getPassword</h4> 1733 <h4>IrcServer.getPassword</h4>
1561 <b>getPassword</b>(<i></i>) 1734 <b>getPassword</b>(<i></i>)
1564 Public method to get the password. 1737 Public method to get the password.
1565 </p> 1738 </p>
1566 <dl> 1739 <dl>
1567 <dt>Return:</dt> 1740 <dt>Return:</dt>
1568 <dd> 1741 <dd>
1569 password (string) 1742 password
1743 </dd>
1744 </dl>
1745 <dl>
1746 <dt>Return Type:</dt>
1747 <dd>
1748 str
1570 </dd> 1749 </dd>
1571 </dl> 1750 </dl>
1572 <a NAME="IrcServer.getPort" ID="IrcServer.getPort"></a> 1751 <a NAME="IrcServer.getPort" ID="IrcServer.getPort"></a>
1573 <h4>IrcServer.getPort</h4> 1752 <h4>IrcServer.getPort</h4>
1574 <b>getPort</b>(<i></i>) 1753 <b>getPort</b>(<i></i>)
1577 Public method to get the server port number. 1756 Public method to get the server port number.
1578 </p> 1757 </p>
1579 <dl> 1758 <dl>
1580 <dt>Return:</dt> 1759 <dt>Return:</dt>
1581 <dd> 1760 <dd>
1582 port number (integer) 1761 port number
1762 </dd>
1763 </dl>
1764 <dl>
1765 <dt>Return Type:</dt>
1766 <dd>
1767 int
1583 </dd> 1768 </dd>
1584 </dl> 1769 </dl>
1585 <a NAME="IrcServer.load" ID="IrcServer.load"></a> 1770 <a NAME="IrcServer.load" ID="IrcServer.load"></a>
1586 <h4>IrcServer.load</h4> 1771 <h4>IrcServer.load</h4>
1587 <b>load</b>(<i>settings</i>) 1772 <b>load</b>(<i>settings</i>)
1589 <p> 1774 <p>
1590 Public method to load the server data. 1775 Public method to load the server data.
1591 </p> 1776 </p>
1592 <dl> 1777 <dl>
1593 1778
1594 <dt><i>settings</i></dt> 1779 <dt><i>settings</i> (QSettings)</dt>
1595 <dd> 1780 <dd>
1596 reference to the settings object (QSettings) 1781 reference to the settings object
1597 </dd> 1782 </dd>
1598 </dl> 1783 </dl>
1599 <a NAME="IrcServer.save" ID="IrcServer.save"></a> 1784 <a NAME="IrcServer.save" ID="IrcServer.save"></a>
1600 <h4>IrcServer.save</h4> 1785 <h4>IrcServer.save</h4>
1601 <b>save</b>(<i>settings</i>) 1786 <b>save</b>(<i>settings</i>)
1603 <p> 1788 <p>
1604 Public method to save the server data. 1789 Public method to save the server data.
1605 </p> 1790 </p>
1606 <dl> 1791 <dl>
1607 1792
1608 <dt><i>settings</i></dt> 1793 <dt><i>settings</i> (QSettings)</dt>
1609 <dd> 1794 <dd>
1610 reference to the settings object (QSettings) 1795 reference to the settings object
1611 </dd> 1796 </dd>
1612 </dl> 1797 </dl>
1613 <a NAME="IrcServer.setName" ID="IrcServer.setName"></a> 1798 <a NAME="IrcServer.setName" ID="IrcServer.setName"></a>
1614 <h4>IrcServer.setName</h4> 1799 <h4>IrcServer.setName</h4>
1615 <b>setName</b>(<i>name</i>) 1800 <b>setName</b>(<i>name</i>)
1617 <p> 1802 <p>
1618 Public method to set the server name. 1803 Public method to set the server name.
1619 </p> 1804 </p>
1620 <dl> 1805 <dl>
1621 1806
1622 <dt><i>name</i></dt> 1807 <dt><i>name</i> (str)</dt>
1623 <dd> 1808 <dd>
1624 server name (string) 1809 server name
1625 </dd> 1810 </dd>
1626 </dl> 1811 </dl>
1627 <a NAME="IrcServer.setPassword" ID="IrcServer.setPassword"></a> 1812 <a NAME="IrcServer.setPassword" ID="IrcServer.setPassword"></a>
1628 <h4>IrcServer.setPassword</h4> 1813 <h4>IrcServer.setPassword</h4>
1629 <b>setPassword</b>(<i>password</i>) 1814 <b>setPassword</b>(<i>password</i>)
1631 <p> 1816 <p>
1632 Public method to set a new password. 1817 Public method to set a new password.
1633 </p> 1818 </p>
1634 <dl> 1819 <dl>
1635 1820
1636 <dt><i>password</i></dt> 1821 <dt><i>password</i> (str)</dt>
1637 <dd> 1822 <dd>
1638 password to set (string) 1823 password to set
1639 </dd> 1824 </dd>
1640 </dl> 1825 </dl>
1641 <a NAME="IrcServer.setPort" ID="IrcServer.setPort"></a> 1826 <a NAME="IrcServer.setPort" ID="IrcServer.setPort"></a>
1642 <h4>IrcServer.setPort</h4> 1827 <h4>IrcServer.setPort</h4>
1643 <b>setPort</b>(<i>port</i>) 1828 <b>setPort</b>(<i>port</i>)
1645 <p> 1830 <p>
1646 Public method to set the server port number. 1831 Public method to set the server port number.
1647 </p> 1832 </p>
1648 <dl> 1833 <dl>
1649 1834
1650 <dt><i>port</i></dt> 1835 <dt><i>port</i> (int)</dt>
1651 <dd> 1836 <dd>
1652 server port number (integer) 1837 server port number
1653 </dd> 1838 </dd>
1654 </dl> 1839 </dl>
1655 <a NAME="IrcServer.setUseSSL" ID="IrcServer.setUseSSL"></a> 1840 <a NAME="IrcServer.setUseSSL" ID="IrcServer.setUseSSL"></a>
1656 <h4>IrcServer.setUseSSL</h4> 1841 <h4>IrcServer.setUseSSL</h4>
1657 <b>setUseSSL</b>(<i>on</i>) 1842 <b>setUseSSL</b>(<i>on</i>)
1659 <p> 1844 <p>
1660 Public method to set the SSL usage. 1845 Public method to set the SSL usage.
1661 </p> 1846 </p>
1662 <dl> 1847 <dl>
1663 1848
1664 <dt><i>on</i></dt> 1849 <dt><i>on</i> (bool)</dt>
1665 <dd> 1850 <dd>
1666 flag indicating SSL usage (boolean) 1851 flag indicating SSL usage
1667 </dd> 1852 </dd>
1668 </dl> 1853 </dl>
1669 <a NAME="IrcServer.useSSL" ID="IrcServer.useSSL"></a> 1854 <a NAME="IrcServer.useSSL" ID="IrcServer.useSSL"></a>
1670 <h4>IrcServer.useSSL</h4> 1855 <h4>IrcServer.useSSL</h4>
1671 <b>useSSL</b>(<i></i>) 1856 <b>useSSL</b>(<i></i>)
1674 Public method to check for SSL usage. 1859 Public method to check for SSL usage.
1675 </p> 1860 </p>
1676 <dl> 1861 <dl>
1677 <dt>Return:</dt> 1862 <dt>Return:</dt>
1678 <dd> 1863 <dd>
1679 flag indicating SSL usage (boolean) 1864 flag indicating SSL usage
1865 </dd>
1866 </dl>
1867 <dl>
1868 <dt>Return Type:</dt>
1869 <dd>
1870 bool
1680 </dd> 1871 </dd>
1681 </dl> 1872 </dl>
1682 <div align="right"><a href="#top">Up</a></div> 1873 <div align="right"><a href="#top">Up</a></div>
1683 <hr /> 1874 <hr />
1684 </body></html> 1875 </body></html>

Mercurial Repository: eric

eric ide

mercurial