Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Network.IRC.IrcNetworkManager.html

eric7/Documentation/Source/eric7.Network.IRC.IrcNetworkManager.html

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

Mercurial Repository: eric

eric ide

mercurial