Mercurial Repositories > eric / file comparison

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

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

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Network.IRC.IrcNetworkManager</h1>
23 <p>
24 Module implementing the IRC data structures and their manager.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#IrcChannel">IrcChannel</a></td>
34 <td>Class implementing the IRC channel object.</td>
35 </tr><tr>
36 <td><a href="#IrcIdentity">IrcIdentity</a></td>
37 <td>Class implementing the IRC identity object.</td>
38 </tr><tr>
39 <td><a href="#IrcNetwork">IrcNetwork</a></td>
40 <td>Class implementing the IRC network object.</td>
41 </tr><tr>
42 <td><a href="#IrcNetworkManager">IrcNetworkManager</a></td>
43 <td>Class implementing the IRC identity object.</td>
44 </tr><tr>
45 <td><a href="#IrcServer">IrcServer</a></td>
46 <td>Class implementing the IRC identity object.</td>
47 </tr>
48 </table>
49 <h3>Functions</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <hr /><hr />
54 <a NAME="IrcChannel" ID="IrcChannel"></a>
55 <h2>IrcChannel</h2>
56 <p>
57 Class implementing the IRC channel object.
58 </p>
59 <h3>Derived from</h3>
60 object
61 <h3>Class Attributes</h3>
62 <table>
63 <tr><td>None</td></tr>
64 </table>
65 <h3>Class Methods</h3>
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70 <table>
71 <tr>
72 <td><a href="#IrcChannel.__init__">IrcChannel</a></td>
73 <td>Constructor</td>
74 </tr><tr>
75 <td><a href="#IrcChannel.autoJoin">autoJoin</a></td>
76 <td>Public method to check the auto join status.</td>
77 </tr><tr>
78 <td><a href="#IrcChannel.getKey">getKey</a></td>
79 <td>Public method to get the channel key.</td>
80 </tr><tr>
81 <td><a href="#IrcChannel.getName">getName</a></td>
82 <td>Public method to get the channel name.</td>
83 </tr><tr>
84 <td><a href="#IrcChannel.load">load</a></td>
85 <td>Public method to load the network data.</td>
86 </tr><tr>
87 <td><a href="#IrcChannel.save">save</a></td>
88 <td>Public method to save the channel data.</td>
89 </tr><tr>
90 <td><a href="#IrcChannel.setAutoJoin">setAutoJoin</a></td>
91 <td>Public method to set the auto join status of the channel.</td>
92 </tr><tr>
93 <td><a href="#IrcChannel.setKey">setKey</a></td>
94 <td>Public method to set a new channel key.</td>
95 </tr>
96 </table>
97 <h3>Static Methods</h3>
98 <table>
99 <tr><td>None</td></tr>
100 </table>
101 <a NAME="IrcChannel.__init__" ID="IrcChannel.__init__"></a>
102 <h4>IrcChannel (Constructor)</h4>
103 <b>IrcChannel</b>(<i>name</i>)
104 <p>
105 Constructor
106 </p><dl>
107 <dt><i>name</i></dt>
108 <dd>
109 name of the network (string)
110 </dd>
111 </dl><a NAME="IrcChannel.autoJoin" ID="IrcChannel.autoJoin"></a>
112 <h4>IrcChannel.autoJoin</h4>
113 <b>autoJoin</b>(<i></i>)
114 <p>
115 Public method to check the auto join status.
116 </p><dl>
117 <dt>Returns:</dt>
118 <dd>
119 flag indicating if the channel should be
120 joined automatically (boolean)
121 </dd>
122 </dl><a NAME="IrcChannel.getKey" ID="IrcChannel.getKey"></a>
123 <h4>IrcChannel.getKey</h4>
124 <b>getKey</b>(<i></i>)
125 <p>
126 Public method to get the channel key.
127 </p><dl>
128 <dt>Returns:</dt>
129 <dd>
130 channel key (string)
131 </dd>
132 </dl><a NAME="IrcChannel.getName" ID="IrcChannel.getName"></a>
133 <h4>IrcChannel.getName</h4>
134 <b>getName</b>(<i></i>)
135 <p>
136 Public method to get the channel name.
137 </p><dl>
138 <dt>Returns:</dt>
139 <dd>
140 channel name (string)
141 </dd>
142 </dl><a NAME="IrcChannel.load" ID="IrcChannel.load"></a>
143 <h4>IrcChannel.load</h4>
144 <b>load</b>(<i>settings</i>)
145 <p>
146 Public method to load the network data.
147 </p><dl>
148 <dt><i>settings</i></dt>
149 <dd>
150 reference to the settings object (QSettings)
151 </dd>
152 </dl><a NAME="IrcChannel.save" ID="IrcChannel.save"></a>
153 <h4>IrcChannel.save</h4>
154 <b>save</b>(<i>settings</i>)
155 <p>
156 Public method to save the channel data.
157 </p><dl>
158 <dt><i>settings</i></dt>
159 <dd>
160 reference to the settings object (QSettings)
161 </dd>
162 </dl><a NAME="IrcChannel.setAutoJoin" ID="IrcChannel.setAutoJoin"></a>
163 <h4>IrcChannel.setAutoJoin</h4>
164 <b>setAutoJoin</b>(<i>enable</i>)
165 <p>
166 Public method to set the auto join status of the channel.
167 </p><dl>
168 <dt><i>enable</i></dt>
169 <dd>
170 flag indicating if the channel should be
171 joined automatically (boolean)
172 </dd>
173 </dl><a NAME="IrcChannel.setKey" ID="IrcChannel.setKey"></a>
174 <h4>IrcChannel.setKey</h4>
175 <b>setKey</b>(<i>key</i>)
176 <p>
177 Public method to set a new channel key.
178 </p><dl>
179 <dt><i>key</i></dt>
180 <dd>
181 channel key to set (string)
182 </dd>
183 </dl>
184 <div align="right"><a href="#top">Up</a></div>
185 <hr /><hr />
186 <a NAME="IrcIdentity" ID="IrcIdentity"></a>
187 <h2>IrcIdentity</h2>
188 <p>
189 Class implementing the IRC identity object.
190 </p>
191 <h3>Derived from</h3>
192 object
193 <h3>Class Attributes</h3>
194 <table>
195 <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>
196 </table>
197 <h3>Class Methods</h3>
198 <table>
199 <tr>
200 <td><a href="#IrcIdentity.createDefaultIdentity">createDefaultIdentity</a></td>
201 <td>Class method to create the default identity.</td>
202 </tr>
203 </table>
204 <h3>Methods</h3>
205 <table>
206 <tr>
207 <td><a href="#IrcIdentity.__init__">IrcIdentity</a></td>
208 <td>Constructor</td>
209 </tr><tr>
210 <td><a href="#IrcIdentity.getAwayMessage">getAwayMessage</a></td>
211 <td>Public method to get the AWAY message.</td>
212 </tr><tr>
213 <td><a href="#IrcIdentity.getIdent">getIdent</a></td>
214 <td>Public method to get the real identity name.</td>
215 </tr><tr>
216 <td><a href="#IrcIdentity.getName">getName</a></td>
217 <td>Public method to get the identity name.</td>
218 </tr><tr>
219 <td><a href="#IrcIdentity.getNickNames">getNickNames</a></td>
220 <td>Public method to get the nick names.</td>
221 </tr><tr>
222 <td><a href="#IrcIdentity.getPartMessage">getPartMessage</a></td>
223 <td>Public method to get the PART message.</td>
224 </tr><tr>
225 <td><a href="#IrcIdentity.getPassword">getPassword</a></td>
226 <td>Public method to get the password.</td>
227 </tr><tr>
228 <td><a href="#IrcIdentity.getQuitMessage">getQuitMessage</a></td>
229 <td>Public method to get the QUIT message.</td>
230 </tr><tr>
231 <td><a href="#IrcIdentity.getRealName">getRealName</a></td>
232 <td>Public method to get the real name.</td>
233 </tr><tr>
234 <td><a href="#IrcIdentity.getServiceName">getServiceName</a></td>
235 <td>Public method to get the service name of the identity used for identification.</td>
236 </tr><tr>
237 <td><a href="#IrcIdentity.load">load</a></td>
238 <td>Public method to load the identity data.</td>
239 </tr><tr>
240 <td><a href="#IrcIdentity.rememberAwayPosition">rememberAwayPosition</a></td>
241 <td>Public method to get a flag indicating to remember the chat position upon AWAY.</td>
242 </tr><tr>
243 <td><a href="#IrcIdentity.save">save</a></td>
244 <td>Public method to save the identity data.</td>
245 </tr><tr>
246 <td><a href="#IrcIdentity.setAwayMessage">setAwayMessage</a></td>
247 <td>Public method to set the AWAY message.</td>
248 </tr><tr>
249 <td><a href="#IrcIdentity.setIdent">setIdent</a></td>
250 <td>Public method to set the real identity name.</td>
251 </tr><tr>
252 <td><a href="#IrcIdentity.setName">setName</a></td>
253 <td>Public method to set the identity name.</td>
254 </tr><tr>
255 <td><a href="#IrcIdentity.setNickNames">setNickNames</a></td>
256 <td>Public method to set the nick names of the identity.</td>
257 </tr><tr>
258 <td><a href="#IrcIdentity.setPartMessage">setPartMessage</a></td>
259 <td>Public method to set the PART message.</td>
260 </tr><tr>
261 <td><a href="#IrcIdentity.setPassword">setPassword</a></td>
262 <td>Public method to set a new password.</td>
263 </tr><tr>
264 <td><a href="#IrcIdentity.setQuitMessage">setQuitMessage</a></td>
265 <td>Public method to set the QUIT message.</td>
266 </tr><tr>
267 <td><a href="#IrcIdentity.setRealName">setRealName</a></td>
268 <td>Public method to set the real name of the identity.</td>
269 </tr><tr>
270 <td><a href="#IrcIdentity.setRememberAwayPosition">setRememberAwayPosition</a></td>
271 <td>Public method to set to remember the chat position upon AWAY.</td>
272 </tr><tr>
273 <td><a href="#IrcIdentity.setServiceName">setServiceName</a></td>
274 <td>Public method to set the service name of the identity used for identification.</td>
275 </tr>
276 </table>
277 <h3>Static Methods</h3>
278 <table>
279 <tr><td>None</td></tr>
280 </table>
281 <a NAME="IrcIdentity.createDefaultIdentity" ID="IrcIdentity.createDefaultIdentity"></a>
282 <h4>IrcIdentity.createDefaultIdentity (class method)</h4>
283 <b>createDefaultIdentity</b>(<i></i>)
284 <p>
285 Class method to create the default identity.
286 </p><dl>
287 <dt>Returns:</dt>
288 <dd>
289 default identity (IrcIdentity)
290 </dd>
291 </dl><a NAME="IrcIdentity.__init__" ID="IrcIdentity.__init__"></a>
292 <h4>IrcIdentity (Constructor)</h4>
293 <b>IrcIdentity</b>(<i>name</i>)
294 <p>
295 Constructor
296 </p><dl>
297 <dt><i>name</i></dt>
298 <dd>
299 name of the identity (string)
300 </dd>
301 </dl><a NAME="IrcIdentity.getAwayMessage" ID="IrcIdentity.getAwayMessage"></a>
302 <h4>IrcIdentity.getAwayMessage</h4>
303 <b>getAwayMessage</b>(<i></i>)
304 <p>
305 Public method to get the AWAY message.
306 </p><dl>
307 <dt>Returns:</dt>
308 <dd>
309 AWAY message (string)
310 </dd>
311 </dl><a NAME="IrcIdentity.getIdent" ID="IrcIdentity.getIdent"></a>
312 <h4>IrcIdentity.getIdent</h4>
313 <b>getIdent</b>(<i></i>)
314 <p>
315 Public method to get the real identity name.
316 </p><dl>
317 <dt>Returns:</dt>
318 <dd>
319 real identity name (string)
320 </dd>
321 </dl><a NAME="IrcIdentity.getName" ID="IrcIdentity.getName"></a>
322 <h4>IrcIdentity.getName</h4>
323 <b>getName</b>(<i></i>)
324 <p>
325 Public method to get the identity name.
326 </p><dl>
327 <dt>Returns:</dt>
328 <dd>
329 identity name (string)
330 </dd>
331 </dl><a NAME="IrcIdentity.getNickNames" ID="IrcIdentity.getNickNames"></a>
332 <h4>IrcIdentity.getNickNames</h4>
333 <b>getNickNames</b>(<i></i>)
334 <p>
335 Public method to get the nick names.
336 </p><dl>
337 <dt>Returns:</dt>
338 <dd>
339 nick names (list of string)
340 </dd>
341 </dl><a NAME="IrcIdentity.getPartMessage" ID="IrcIdentity.getPartMessage"></a>
342 <h4>IrcIdentity.getPartMessage</h4>
343 <b>getPartMessage</b>(<i></i>)
344 <p>
345 Public method to get the PART message.
346 </p><dl>
347 <dt>Returns:</dt>
348 <dd>
349 PART message (string)
350 </dd>
351 </dl><a NAME="IrcIdentity.getPassword" ID="IrcIdentity.getPassword"></a>
352 <h4>IrcIdentity.getPassword</h4>
353 <b>getPassword</b>(<i></i>)
354 <p>
355 Public method to get the password.
356 </p><dl>
357 <dt>Returns:</dt>
358 <dd>
359 password (string)
360 </dd>
361 </dl><a NAME="IrcIdentity.getQuitMessage" ID="IrcIdentity.getQuitMessage"></a>
362 <h4>IrcIdentity.getQuitMessage</h4>
363 <b>getQuitMessage</b>(<i></i>)
364 <p>
365 Public method to get the QUIT message.
366 </p><dl>
367 <dt>Returns:</dt>
368 <dd>
369 QUIT message (string)
370 </dd>
371 </dl><a NAME="IrcIdentity.getRealName" ID="IrcIdentity.getRealName"></a>
372 <h4>IrcIdentity.getRealName</h4>
373 <b>getRealName</b>(<i></i>)
374 <p>
375 Public method to get the real name.
376 </p><dl>
377 <dt>Returns:</dt>
378 <dd>
379 real name (string)
380 </dd>
381 </dl><a NAME="IrcIdentity.getServiceName" ID="IrcIdentity.getServiceName"></a>
382 <h4>IrcIdentity.getServiceName</h4>
383 <b>getServiceName</b>(<i></i>)
384 <p>
385 Public method to get the service name of the identity used for
386 identification.
387 </p><dl>
388 <dt>Returns:</dt>
389 <dd>
390 service name (string)
391 </dd>
392 </dl><a NAME="IrcIdentity.load" ID="IrcIdentity.load"></a>
393 <h4>IrcIdentity.load</h4>
394 <b>load</b>(<i>settings</i>)
395 <p>
396 Public method to load the identity data.
397 </p><dl>
398 <dt><i>settings</i></dt>
399 <dd>
400 reference to the settings object (QSettings)
401 </dd>
402 </dl><a NAME="IrcIdentity.rememberAwayPosition" ID="IrcIdentity.rememberAwayPosition"></a>
403 <h4>IrcIdentity.rememberAwayPosition</h4>
404 <b>rememberAwayPosition</b>(<i></i>)
405 <p>
406 Public method to get a flag indicating to remember the chat position
407 upon AWAY.
408 </p><dl>
409 <dt>Returns:</dt>
410 <dd>
411 flag indicating to remember the chat position (boolean)
412 </dd>
413 </dl><a NAME="IrcIdentity.save" ID="IrcIdentity.save"></a>
414 <h4>IrcIdentity.save</h4>
415 <b>save</b>(<i>settings</i>)
416 <p>
417 Public method to save the identity data.
418 </p><dl>
419 <dt><i>settings</i></dt>
420 <dd>
421 reference to the settings object (QSettings)
422 </dd>
423 </dl><a NAME="IrcIdentity.setAwayMessage" ID="IrcIdentity.setAwayMessage"></a>
424 <h4>IrcIdentity.setAwayMessage</h4>
425 <b>setAwayMessage</b>(<i>message</i>)
426 <p>
427 Public method to set the AWAY message.
428 </p><dl>
429 <dt><i>message</i></dt>
430 <dd>
431 AWAY message (string)
432 </dd>
433 </dl><a NAME="IrcIdentity.setIdent" ID="IrcIdentity.setIdent"></a>
434 <h4>IrcIdentity.setIdent</h4>
435 <b>setIdent</b>(<i>name</i>)
436 <p>
437 Public method to set the real identity name.
438 </p><dl>
439 <dt><i>name</i></dt>
440 <dd>
441 real identity name (string)
442 </dd>
443 </dl><a NAME="IrcIdentity.setName" ID="IrcIdentity.setName"></a>
444 <h4>IrcIdentity.setName</h4>
445 <b>setName</b>(<i>name</i>)
446 <p>
447 Public method to set the identity name.
448 </p><dl>
449 <dt><i>name</i></dt>
450 <dd>
451 identity name (string)
452 </dd>
453 </dl><a NAME="IrcIdentity.setNickNames" ID="IrcIdentity.setNickNames"></a>
454 <h4>IrcIdentity.setNickNames</h4>
455 <b>setNickNames</b>(<i>names</i>)
456 <p>
457 Public method to set the nick names of the identity.
458 </p><dl>
459 <dt><i>names</i></dt>
460 <dd>
461 nick names (list of string)
462 </dd>
463 </dl><a NAME="IrcIdentity.setPartMessage" ID="IrcIdentity.setPartMessage"></a>
464 <h4>IrcIdentity.setPartMessage</h4>
465 <b>setPartMessage</b>(<i>message</i>)
466 <p>
467 Public method to set the PART message.
468 </p><dl>
469 <dt><i>message</i></dt>
470 <dd>
471 PART message (string)
472 </dd>
473 </dl><a NAME="IrcIdentity.setPassword" ID="IrcIdentity.setPassword"></a>
474 <h4>IrcIdentity.setPassword</h4>
475 <b>setPassword</b>(<i>password</i>)
476 <p>
477 Public method to set a new password.
478 </p><dl>
479 <dt><i>password</i></dt>
480 <dd>
481 password to set (string)
482 </dd>
483 </dl><a NAME="IrcIdentity.setQuitMessage" ID="IrcIdentity.setQuitMessage"></a>
484 <h4>IrcIdentity.setQuitMessage</h4>
485 <b>setQuitMessage</b>(<i>message</i>)
486 <p>
487 Public method to set the QUIT message.
488 </p><dl>
489 <dt><i>message</i></dt>
490 <dd>
491 QUIT message (string)
492 </dd>
493 </dl><a NAME="IrcIdentity.setRealName" ID="IrcIdentity.setRealName"></a>
494 <h4>IrcIdentity.setRealName</h4>
495 <b>setRealName</b>(<i>name</i>)
496 <p>
497 Public method to set the real name of the identity.
498 </p><dl>
499 <dt><i>name</i></dt>
500 <dd>
501 real name (string)
502 </dd>
503 </dl><a NAME="IrcIdentity.setRememberAwayPosition" ID="IrcIdentity.setRememberAwayPosition"></a>
504 <h4>IrcIdentity.setRememberAwayPosition</h4>
505 <b>setRememberAwayPosition</b>(<i>remember</i>)
506 <p>
507 Public method to set to remember the chat position upon AWAY.
508 </p><dl>
509 <dt><i>remember</i></dt>
510 <dd>
511 flag indicating to remember the chat position (boolean)
512 </dd>
513 </dl><a NAME="IrcIdentity.setServiceName" ID="IrcIdentity.setServiceName"></a>
514 <h4>IrcIdentity.setServiceName</h4>
515 <b>setServiceName</b>(<i>name</i>)
516 <p>
517 Public method to set the service name of the identity used for
518 identification.
519 </p><dl>
520 <dt><i>name</i></dt>
521 <dd>
522 service name (string)
523 </dd>
524 </dl>
525 <div align="right"><a href="#top">Up</a></div>
526 <hr /><hr />
527 <a NAME="IrcNetwork" ID="IrcNetwork"></a>
528 <h2>IrcNetwork</h2>
529 <p>
530 Class implementing the IRC network object.
531 </p>
532 <h3>Derived from</h3>
533 object
534 <h3>Class Attributes</h3>
535 <table>
536 <tr><td>None</td></tr>
537 </table>
538 <h3>Class Methods</h3>
539 <table>
540 <tr>
541 <td><a href="#IrcNetwork.createDefaultNetwork">createDefaultNetwork</a></td>
542 <td>Class method to create the default network.</td>
543 </tr>
544 </table>
545 <h3>Methods</h3>
546 <table>
547 <tr>
548 <td><a href="#IrcNetwork.__init__">IrcNetwork</a></td>
549 <td>Constructor</td>
550 </tr><tr>
551 <td><a href="#IrcNetwork.addChannel">addChannel</a></td>
552 <td>Public method to add a channel.</td>
553 </tr><tr>
554 <td><a href="#IrcNetwork.autoConnect">autoConnect</a></td>
555 <td>Public method to check, if the network should be connected to at start-up.</td>
556 </tr><tr>
557 <td><a href="#IrcNetwork.deleteChannel">deleteChannel</a></td>
558 <td>Public method to delete the given channel.</td>
559 </tr><tr>
560 <td><a href="#IrcNetwork.getChannel">getChannel</a></td>
561 <td>Public method to get a channel.</td>
562 </tr><tr>
563 <td><a href="#IrcNetwork.getChannelNames">getChannelNames</a></td>
564 <td>Public method to get the list of channels.</td>
565 </tr><tr>
566 <td><a href="#IrcNetwork.getChannels">getChannels</a></td>
567 <td>Public method to get the channels.</td>
568 </tr><tr>
569 <td><a href="#IrcNetwork.getIdentityName">getIdentityName</a></td>
570 <td>Public method to get the name of the identity.</td>
571 </tr><tr>
572 <td><a href="#IrcNetwork.getName">getName</a></td>
573 <td>Public method to get the network name.</td>
574 </tr><tr>
575 <td><a href="#IrcNetwork.getServer">getServer</a></td>
576 <td>Public method to get the server object.</td>
577 </tr><tr>
578 <td><a href="#IrcNetwork.getServerName">getServerName</a></td>
579 <td>Public method to get the server name.</td>
580 </tr><tr>
581 <td><a href="#IrcNetwork.load">load</a></td>
582 <td>Public method to load the network data.</td>
583 </tr><tr>
584 <td><a href="#IrcNetwork.save">save</a></td>
585 <td>Public method to save the network data.</td>
586 </tr><tr>
587 <td><a href="#IrcNetwork.setAutoConnect">setAutoConnect</a></td>
588 <td>Public method to set the auto connect flag.</td>
589 </tr><tr>
590 <td><a href="#IrcNetwork.setChannel">setChannel</a></td>
591 <td>Public method to set a channel.</td>
592 </tr><tr>
593 <td><a href="#IrcNetwork.setChannels">setChannels</a></td>
594 <td>Public method to set the list of channels.</td>
595 </tr><tr>
596 <td><a href="#IrcNetwork.setIdentityName">setIdentityName</a></td>
597 <td>Public method to set the name of the identity.</td>
598 </tr><tr>
599 <td><a href="#IrcNetwork.setName">setName</a></td>
600 <td>Public method to set the network name.</td>
601 </tr><tr>
602 <td><a href="#IrcNetwork.setServer">setServer</a></td>
603 <td>Public method to set the server.</td>
604 </tr>
605 </table>
606 <h3>Static Methods</h3>
607 <table>
608 <tr><td>None</td></tr>
609 </table>
610 <a NAME="IrcNetwork.createDefaultNetwork" ID="IrcNetwork.createDefaultNetwork"></a>
611 <h4>IrcNetwork.createDefaultNetwork (class method)</h4>
612 <b>createDefaultNetwork</b>(<i>ssl=False</i>)
613 <p>
614 Class method to create the default network.
615 </p><dl>
616 <dt><i>ssl</i></dt>
617 <dd>
618 flag indicating to create a SSL network configuration
619 (boolean)
620 </dd>
621 </dl><dl>
622 <dt>Returns:</dt>
623 <dd>
624 default network object (IrcNetwork)
625 </dd>
626 </dl><a NAME="IrcNetwork.__init__" ID="IrcNetwork.__init__"></a>
627 <h4>IrcNetwork (Constructor)</h4>
628 <b>IrcNetwork</b>(<i>name</i>)
629 <p>
630 Constructor
631 </p><dl>
632 <dt><i>name</i></dt>
633 <dd>
634 name of the network (string)
635 </dd>
636 </dl><a NAME="IrcNetwork.addChannel" ID="IrcNetwork.addChannel"></a>
637 <h4>IrcNetwork.addChannel</h4>
638 <b>addChannel</b>(<i>channel</i>)
639 <p>
640 Public method to add a channel.
641 </p><dl>
642 <dt><i>channel</i></dt>
643 <dd>
644 channel object to add (IrcChannel)
645 </dd>
646 </dl><a NAME="IrcNetwork.autoConnect" ID="IrcNetwork.autoConnect"></a>
647 <h4>IrcNetwork.autoConnect</h4>
648 <b>autoConnect</b>(<i></i>)
649 <p>
650 Public method to check, if the network should be connected to at
651 start-up.
652 </p><dl>
653 <dt>Returns:</dt>
654 <dd>
655 flag indicating an auto connect (boolean)
656 </dd>
657 </dl><a NAME="IrcNetwork.deleteChannel" ID="IrcNetwork.deleteChannel"></a>
658 <h4>IrcNetwork.deleteChannel</h4>
659 <b>deleteChannel</b>(<i>channelName</i>)
660 <p>
661 Public method to delete the given channel.
662 </p><dl>
663 <dt><i>channelName</i></dt>
664 <dd>
665 name of the channel to be deleted (string)
666 </dd>
667 </dl><a NAME="IrcNetwork.getChannel" ID="IrcNetwork.getChannel"></a>
668 <h4>IrcNetwork.getChannel</h4>
669 <b>getChannel</b>(<i>channelName</i>)
670 <p>
671 Public method to get a channel.
672 </p><dl>
673 <dt><i>channelName</i></dt>
674 <dd>
675 name of the channel to retrieve (string)
676 </dd>
677 </dl><dl>
678 <dt>Returns:</dt>
679 <dd>
680 reference to the channel (IrcChannel)
681 </dd>
682 </dl><a NAME="IrcNetwork.getChannelNames" ID="IrcNetwork.getChannelNames"></a>
683 <h4>IrcNetwork.getChannelNames</h4>
684 <b>getChannelNames</b>(<i></i>)
685 <p>
686 Public method to get the list of channels.
687 </p><dl>
688 <dt>Returns:</dt>
689 <dd>
690 list of channel names (list of string)
691 </dd>
692 </dl><a NAME="IrcNetwork.getChannels" ID="IrcNetwork.getChannels"></a>
693 <h4>IrcNetwork.getChannels</h4>
694 <b>getChannels</b>(<i></i>)
695 <p>
696 Public method to get the channels.
697 </p><dl>
698 <dt>Returns:</dt>
699 <dd>
700 list of channels for the network (list of IrcChannel)
701 </dd>
702 </dl><a NAME="IrcNetwork.getIdentityName" ID="IrcNetwork.getIdentityName"></a>
703 <h4>IrcNetwork.getIdentityName</h4>
704 <b>getIdentityName</b>(<i></i>)
705 <p>
706 Public method to get the name of the identity.
707 </p><dl>
708 <dt>Returns:</dt>
709 <dd>
710 identity name (string)
711 </dd>
712 </dl><a NAME="IrcNetwork.getName" ID="IrcNetwork.getName"></a>
713 <h4>IrcNetwork.getName</h4>
714 <b>getName</b>(<i></i>)
715 <p>
716 Public method to get the network name.
717 </p><dl>
718 <dt>Returns:</dt>
719 <dd>
720 network name (string)
721 </dd>
722 </dl><a NAME="IrcNetwork.getServer" ID="IrcNetwork.getServer"></a>
723 <h4>IrcNetwork.getServer</h4>
724 <b>getServer</b>(<i></i>)
725 <p>
726 Public method to get the server object.
727 </p><dl>
728 <dt>Returns:</dt>
729 <dd>
730 reference to the server (IrcServer)
731 </dd>
732 </dl><a NAME="IrcNetwork.getServerName" ID="IrcNetwork.getServerName"></a>
733 <h4>IrcNetwork.getServerName</h4>
734 <b>getServerName</b>(<i></i>)
735 <p>
736 Public method to get the server name.
737 </p><dl>
738 <dt>Returns:</dt>
739 <dd>
740 server name (string)
741 </dd>
742 </dl><a NAME="IrcNetwork.load" ID="IrcNetwork.load"></a>
743 <h4>IrcNetwork.load</h4>
744 <b>load</b>(<i>settings</i>)
745 <p>
746 Public method to load the network data.
747 </p><dl>
748 <dt><i>settings</i></dt>
749 <dd>
750 reference to the settings object (QSettings)
751 </dd>
752 </dl><a NAME="IrcNetwork.save" ID="IrcNetwork.save"></a>
753 <h4>IrcNetwork.save</h4>
754 <b>save</b>(<i>settings</i>)
755 <p>
756 Public method to save the network data.
757 </p><dl>
758 <dt><i>settings</i></dt>
759 <dd>
760 reference to the settings object (QSettings)
761 </dd>
762 </dl><a NAME="IrcNetwork.setAutoConnect" ID="IrcNetwork.setAutoConnect"></a>
763 <h4>IrcNetwork.setAutoConnect</h4>
764 <b>setAutoConnect</b>(<i>enable</i>)
765 <p>
766 Public method to set the auto connect flag.
767 </p><dl>
768 <dt><i>enable</i></dt>
769 <dd>
770 flag indicate to connect to the network at start-up.
771 </dd>
772 </dl><a NAME="IrcNetwork.setChannel" ID="IrcNetwork.setChannel"></a>
773 <h4>IrcNetwork.setChannel</h4>
774 <b>setChannel</b>(<i>channel</i>)
775 <p>
776 Public method to set a channel.
777 </p><dl>
778 <dt><i>channel</i></dt>
779 <dd>
780 channel object to set (IrcChannel)
781 </dd>
782 </dl><a NAME="IrcNetwork.setChannels" ID="IrcNetwork.setChannels"></a>
783 <h4>IrcNetwork.setChannels</h4>
784 <b>setChannels</b>(<i>channels</i>)
785 <p>
786 Public method to set the list of channels.
787 </p><dl>
788 <dt><i>channels</i></dt>
789 <dd>
790 list of channels for the network (list of IrcChannel)
791 </dd>
792 </dl><a NAME="IrcNetwork.setIdentityName" ID="IrcNetwork.setIdentityName"></a>
793 <h4>IrcNetwork.setIdentityName</h4>
794 <b>setIdentityName</b>(<i>name</i>)
795 <p>
796 Public method to set the name of the identity.
797 </p><dl>
798 <dt><i>name</i></dt>
799 <dd>
800 identity name (string)
801 </dd>
802 </dl><a NAME="IrcNetwork.setName" ID="IrcNetwork.setName"></a>
803 <h4>IrcNetwork.setName</h4>
804 <b>setName</b>(<i>name</i>)
805 <p>
806 Public method to set the network name.
807 </p><dl>
808 <dt><i>name</i></dt>
809 <dd>
810 network name (string)
811 </dd>
812 </dl><a NAME="IrcNetwork.setServer" ID="IrcNetwork.setServer"></a>
813 <h4>IrcNetwork.setServer</h4>
814 <b>setServer</b>(<i>server</i>)
815 <p>
816 Public method to set the server.
817 </p><dl>
818 <dt><i>server</i></dt>
819 <dd>
820 server object to set (IrcServer)
821 </dd>
822 </dl>
823 <div align="right"><a href="#top">Up</a></div>
824 <hr /><hr />
825 <a NAME="IrcNetworkManager" ID="IrcNetworkManager"></a>
826 <h2>IrcNetworkManager</h2>
827 <p>
828 Class implementing the IRC identity object.
829 </p><h3>Signals</h3>
830 <dl>
831 <dt>dataChanged()</dt>
832 <dd>
833 emitted after some data has changed
834 </dd><dt>identitiesChanged()</dt>
835 <dd>
836 emitted after an identity object has changed
837 </dd><dt>networksChanged()</dt>
838 <dd>
839 emitted after a network object has changed
840 </dd>
841 </dl>
842 <h3>Derived from</h3>
843 QObject
844 <h3>Class Attributes</h3>
845 <table>
846 <tr><td>None</td></tr>
847 </table>
848 <h3>Class Methods</h3>
849 <table>
850 <tr><td>None</td></tr>
851 </table>
852 <h3>Methods</h3>
853 <table>
854 <tr>
855 <td><a href="#IrcNetworkManager.__init__">IrcNetworkManager</a></td>
856 <td>Constructor</td>
857 </tr><tr>
858 <td><a href="#IrcNetworkManager.__load">__load</a></td>
859 <td>Private slot to load the IRC data.</td>
860 </tr><tr>
861 <td><a href="#IrcNetworkManager.__loadDefaults">__loadDefaults</a></td>
862 <td>Private method to load default values.</td>
863 </tr><tr>
864 <td><a href="#IrcNetworkManager.addIdentity">addIdentity</a></td>
865 <td>Public method to add a new identity.</td>
866 </tr><tr>
867 <td><a href="#IrcNetworkManager.addNetwork">addNetwork</a></td>
868 <td>Public method to add a network.</td>
869 </tr><tr>
870 <td><a href="#IrcNetworkManager.close">close</a></td>
871 <td>Public method to close the open search engines manager.</td>
872 </tr><tr>
873 <td><a href="#IrcNetworkManager.deleteIdentity">deleteIdentity</a></td>
874 <td>Public method to delete the given identity.</td>
875 </tr><tr>
876 <td><a href="#IrcNetworkManager.deleteNetwork">deleteNetwork</a></td>
877 <td>Public method to delete the given network.</td>
878 </tr><tr>
879 <td><a href="#IrcNetworkManager.getIdentities">getIdentities</a></td>
880 <td>Public method to get a copy of all identities.</td>
881 </tr><tr>
882 <td><a href="#IrcNetworkManager.getIdentity">getIdentity</a></td>
883 <td>Public method to get an identity object.</td>
884 </tr><tr>
885 <td><a href="#IrcNetworkManager.getIdentityNames">getIdentityNames</a></td>
886 <td>Public method to get the names of all identities.</td>
887 </tr><tr>
888 <td><a href="#IrcNetworkManager.getNetwork">getNetwork</a></td>
889 <td>Public method to get a network object.</td>
890 </tr><tr>
891 <td><a href="#IrcNetworkManager.getNetworkNames">getNetworkNames</a></td>
892 <td>Public method to get a list of all known network names.</td>
893 </tr><tr>
894 <td><a href="#IrcNetworkManager.identityChanged">identityChanged</a></td>
895 <td>Public method to indicate a change of an identity object.</td>
896 </tr><tr>
897 <td><a href="#IrcNetworkManager.networkChanged">networkChanged</a></td>
898 <td>Public method to indicate a change of a network object.</td>
899 </tr><tr>
900 <td><a href="#IrcNetworkManager.renameIdentity">renameIdentity</a></td>
901 <td>Public method to rename an identity.</td>
902 </tr><tr>
903 <td><a href="#IrcNetworkManager.save">save</a></td>
904 <td>Public slot to save the IRC data.</td>
905 </tr><tr>
906 <td><a href="#IrcNetworkManager.setIdentities">setIdentities</a></td>
907 <td>Public method to set the identities.</td>
908 </tr><tr>
909 <td><a href="#IrcNetworkManager.setNetwork">setNetwork</a></td>
910 <td>Public method to set a network.</td>
911 </tr>
912 </table>
913 <h3>Static Methods</h3>
914 <table>
915 <tr><td>None</td></tr>
916 </table>
917 <a NAME="IrcNetworkManager.__init__" ID="IrcNetworkManager.__init__"></a>
918 <h4>IrcNetworkManager (Constructor)</h4>
919 <b>IrcNetworkManager</b>(<i>parent=None</i>)
920 <p>
921 Constructor
922 </p><dl>
923 <dt><i>parent</i></dt>
924 <dd>
925 reference to the parent object (QObject)
926 </dd>
927 </dl><a NAME="IrcNetworkManager.__load" ID="IrcNetworkManager.__load"></a>
928 <h4>IrcNetworkManager.__load</h4>
929 <b>__load</b>(<i></i>)
930 <p>
931 Private slot to load the IRC data.
932 </p><a NAME="IrcNetworkManager.__loadDefaults" ID="IrcNetworkManager.__loadDefaults"></a>
933 <h4>IrcNetworkManager.__loadDefaults</h4>
934 <b>__loadDefaults</b>(<i>identityOnly=False</i>)
935 <p>
936 Private method to load default values.
937 </p><dl>
938 <dt><i>identityOnly</i></dt>
939 <dd>
940 flag indicating to just load the default
941 identity (boolean)
942 </dd>
943 </dl><a NAME="IrcNetworkManager.addIdentity" ID="IrcNetworkManager.addIdentity"></a>
944 <h4>IrcNetworkManager.addIdentity</h4>
945 <b>addIdentity</b>(<i>identity</i>)
946 <p>
947 Public method to add a new identity.
948 </p><dl>
949 <dt><i>identity</i></dt>
950 <dd>
951 reference to the identity to add (IrcIdentity)
952 </dd>
953 </dl><a NAME="IrcNetworkManager.addNetwork" ID="IrcNetworkManager.addNetwork"></a>
954 <h4>IrcNetworkManager.addNetwork</h4>
955 <b>addNetwork</b>(<i>network</i>)
956 <p>
957 Public method to add a network.
958 </p><dl>
959 <dt><i>network</i></dt>
960 <dd>
961 network object to add (IrcNetwork)
962 </dd>
963 </dl><a NAME="IrcNetworkManager.close" ID="IrcNetworkManager.close"></a>
964 <h4>IrcNetworkManager.close</h4>
965 <b>close</b>(<i></i>)
966 <p>
967 Public method to close the open search engines manager.
968 </p><a NAME="IrcNetworkManager.deleteIdentity" ID="IrcNetworkManager.deleteIdentity"></a>
969 <h4>IrcNetworkManager.deleteIdentity</h4>
970 <b>deleteIdentity</b>(<i>name</i>)
971 <p>
972 Public method to delete the given identity.
973 </p><dl>
974 <dt><i>name</i></dt>
975 <dd>
976 name of the identity to delete (string)
977 </dd>
978 </dl><a NAME="IrcNetworkManager.deleteNetwork" ID="IrcNetworkManager.deleteNetwork"></a>
979 <h4>IrcNetworkManager.deleteNetwork</h4>
980 <b>deleteNetwork</b>(<i>name</i>)
981 <p>
982 Public method to delete the given network.
983 </p><dl>
984 <dt><i>name</i></dt>
985 <dd>
986 name of the network to delete (string)
987 </dd>
988 </dl><a NAME="IrcNetworkManager.getIdentities" ID="IrcNetworkManager.getIdentities"></a>
989 <h4>IrcNetworkManager.getIdentities</h4>
990 <b>getIdentities</b>(<i></i>)
991 <p>
992 Public method to get a copy of all identities.
993 </p><dl>
994 <dt>Returns:</dt>
995 <dd>
996 dictionary of all identities (dict of IrcIdentity)
997 </dd>
998 </dl><a NAME="IrcNetworkManager.getIdentity" ID="IrcNetworkManager.getIdentity"></a>
999 <h4>IrcNetworkManager.getIdentity</h4>
1000 <b>getIdentity</b>(<i>name, create=False</i>)
1001 <p>
1002 Public method to get an identity object.
1003 </p><dl>
1004 <dt><i>name</i></dt>
1005 <dd>
1006 name of the identity to get (string)
1007 </dd><dt><i>create</i></dt>
1008 <dd>
1009 flag indicating to create a new object,
1010 if none exists (boolean)
1011 </dd>
1012 </dl><dl>
1013 <dt>Returns:</dt>
1014 <dd>
1015 reference to the identity (IrcIdentity)
1016 </dd>
1017 </dl><a NAME="IrcNetworkManager.getIdentityNames" ID="IrcNetworkManager.getIdentityNames"></a>
1018 <h4>IrcNetworkManager.getIdentityNames</h4>
1019 <b>getIdentityNames</b>(<i></i>)
1020 <p>
1021 Public method to get the names of all identities.
1022 </p><dl>
1023 <dt>Returns:</dt>
1024 <dd>
1025 names of all identities (list of string)
1026 </dd>
1027 </dl><a NAME="IrcNetworkManager.getNetwork" ID="IrcNetworkManager.getNetwork"></a>
1028 <h4>IrcNetworkManager.getNetwork</h4>
1029 <b>getNetwork</b>(<i>name</i>)
1030 <p>
1031 Public method to get a network object.
1032 </p><dl>
1033 <dt><i>name</i></dt>
1034 <dd>
1035 name of the network (string)
1036 </dd>
1037 </dl><dl>
1038 <dt>Returns:</dt>
1039 <dd>
1040 reference to the network object (IrcNetwork)
1041 </dd>
1042 </dl><a NAME="IrcNetworkManager.getNetworkNames" ID="IrcNetworkManager.getNetworkNames"></a>
1043 <h4>IrcNetworkManager.getNetworkNames</h4>
1044 <b>getNetworkNames</b>(<i></i>)
1045 <p>
1046 Public method to get a list of all known network names.
1047 </p><dl>
1048 <dt>Returns:</dt>
1049 <dd>
1050 list of network names (list of string)
1051 </dd>
1052 </dl><a NAME="IrcNetworkManager.identityChanged" ID="IrcNetworkManager.identityChanged"></a>
1053 <h4>IrcNetworkManager.identityChanged</h4>
1054 <b>identityChanged</b>(<i></i>)
1055 <p>
1056 Public method to indicate a change of an identity object.
1057 </p><a NAME="IrcNetworkManager.networkChanged" ID="IrcNetworkManager.networkChanged"></a>
1058 <h4>IrcNetworkManager.networkChanged</h4>
1059 <b>networkChanged</b>(<i></i>)
1060 <p>
1061 Public method to indicate a change of a network object.
1062 </p><a NAME="IrcNetworkManager.renameIdentity" ID="IrcNetworkManager.renameIdentity"></a>
1063 <h4>IrcNetworkManager.renameIdentity</h4>
1064 <b>renameIdentity</b>(<i>oldName, newName</i>)
1065 <p>
1066 Public method to rename an identity.
1067 </p><dl>
1068 <dt><i>oldName</i></dt>
1069 <dd>
1070 old name of the identity (string)
1071 </dd><dt><i>newName</i></dt>
1072 <dd>
1073 new name of the identity (string)
1074 </dd>
1075 </dl><a NAME="IrcNetworkManager.save" ID="IrcNetworkManager.save"></a>
1076 <h4>IrcNetworkManager.save</h4>
1077 <b>save</b>(<i></i>)
1078 <p>
1079 Public slot to save the IRC data.
1080 </p><a NAME="IrcNetworkManager.setIdentities" ID="IrcNetworkManager.setIdentities"></a>
1081 <h4>IrcNetworkManager.setIdentities</h4>
1082 <b>setIdentities</b>(<i>identities</i>)
1083 <p>
1084 Public method to set the identities.
1085 </p><dl>
1086 <dt><i>identities</i></dt>
1087 <dd>
1088 dictionary of all identities (dict of IrcIdentity)
1089 </dd>
1090 </dl><a NAME="IrcNetworkManager.setNetwork" ID="IrcNetworkManager.setNetwork"></a>
1091 <h4>IrcNetworkManager.setNetwork</h4>
1092 <b>setNetwork</b>(<i>network, networkName=""</i>)
1093 <p>
1094 Public method to set a network.
1095 </p><dl>
1096 <dt><i>network</i></dt>
1097 <dd>
1098 network object to set (IrcNetwork)
1099 </dd><dt><i>networkName</i></dt>
1100 <dd>
1101 name the network was known for (string)
1102 </dd>
1103 </dl>
1104 <div align="right"><a href="#top">Up</a></div>
1105 <hr /><hr />
1106 <a NAME="IrcServer" ID="IrcServer"></a>
1107 <h2>IrcServer</h2>
1108 <p>
1109 Class implementing the IRC identity object.
1110 </p>
1111 <h3>Derived from</h3>
1112 object
1113 <h3>Class Attributes</h3>
1114 <table>
1115 <tr><td>DefaultPort</td></tr><tr><td>DefaultSslPort</td></tr>
1116 </table>
1117 <h3>Class Methods</h3>
1118 <table>
1119 <tr><td>None</td></tr>
1120 </table>
1121 <h3>Methods</h3>
1122 <table>
1123 <tr>
1124 <td><a href="#IrcServer.__init__">IrcServer</a></td>
1125 <td>Constructor</td>
1126 </tr><tr>
1127 <td><a href="#IrcServer.getName">getName</a></td>
1128 <td>Public method to get the server name.</td>
1129 </tr><tr>
1130 <td><a href="#IrcServer.getPassword">getPassword</a></td>
1131 <td>Public method to get the password.</td>
1132 </tr><tr>
1133 <td><a href="#IrcServer.getPort">getPort</a></td>
1134 <td>Public method to get the server port number.</td>
1135 </tr><tr>
1136 <td><a href="#IrcServer.load">load</a></td>
1137 <td>Public method to load the server data.</td>
1138 </tr><tr>
1139 <td><a href="#IrcServer.save">save</a></td>
1140 <td>Public method to save the server data.</td>
1141 </tr><tr>
1142 <td><a href="#IrcServer.setName">setName</a></td>
1143 <td>Public method to set the server name.</td>
1144 </tr><tr>
1145 <td><a href="#IrcServer.setPassword">setPassword</a></td>
1146 <td>Public method to set a new password.</td>
1147 </tr><tr>
1148 <td><a href="#IrcServer.setPort">setPort</a></td>
1149 <td>Public method to set the server port number.</td>
1150 </tr><tr>
1151 <td><a href="#IrcServer.setUseSSL">setUseSSL</a></td>
1152 <td>Public method to set the SSL usage.</td>
1153 </tr><tr>
1154 <td><a href="#IrcServer.useSSL">useSSL</a></td>
1155 <td>Public method to check for SSL usage.</td>
1156 </tr>
1157 </table>
1158 <h3>Static Methods</h3>
1159 <table>
1160 <tr><td>None</td></tr>
1161 </table>
1162 <a NAME="IrcServer.__init__" ID="IrcServer.__init__"></a>
1163 <h4>IrcServer (Constructor)</h4>
1164 <b>IrcServer</b>(<i>name</i>)
1165 <p>
1166 Constructor
1167 </p><dl>
1168 <dt><i>name</i></dt>
1169 <dd>
1170 name of the server (string)
1171 </dd>
1172 </dl><a NAME="IrcServer.getName" ID="IrcServer.getName"></a>
1173 <h4>IrcServer.getName</h4>
1174 <b>getName</b>(<i></i>)
1175 <p>
1176 Public method to get the server name.
1177 </p><dl>
1178 <dt>Returns:</dt>
1179 <dd>
1180 server name (string)
1181 </dd>
1182 </dl><a NAME="IrcServer.getPassword" ID="IrcServer.getPassword"></a>
1183 <h4>IrcServer.getPassword</h4>
1184 <b>getPassword</b>(<i></i>)
1185 <p>
1186 Public method to get the password.
1187 </p><dl>
1188 <dt>Returns:</dt>
1189 <dd>
1190 password (string)
1191 </dd>
1192 </dl><a NAME="IrcServer.getPort" ID="IrcServer.getPort"></a>
1193 <h4>IrcServer.getPort</h4>
1194 <b>getPort</b>(<i></i>)
1195 <p>
1196 Public method to get the server port number.
1197 </p><dl>
1198 <dt>Returns:</dt>
1199 <dd>
1200 port number (integer)
1201 </dd>
1202 </dl><a NAME="IrcServer.load" ID="IrcServer.load"></a>
1203 <h4>IrcServer.load</h4>
1204 <b>load</b>(<i>settings</i>)
1205 <p>
1206 Public method to load the server data.
1207 </p><dl>
1208 <dt><i>settings</i></dt>
1209 <dd>
1210 reference to the settings object (QSettings)
1211 </dd>
1212 </dl><a NAME="IrcServer.save" ID="IrcServer.save"></a>
1213 <h4>IrcServer.save</h4>
1214 <b>save</b>(<i>settings</i>)
1215 <p>
1216 Public method to save the server data.
1217 </p><dl>
1218 <dt><i>settings</i></dt>
1219 <dd>
1220 reference to the settings object (QSettings)
1221 </dd>
1222 </dl><a NAME="IrcServer.setName" ID="IrcServer.setName"></a>
1223 <h4>IrcServer.setName</h4>
1224 <b>setName</b>(<i>name</i>)
1225 <p>
1226 Public method to set the server name.
1227 </p><dl>
1228 <dt><i>name</i></dt>
1229 <dd>
1230 server name (string)
1231 </dd>
1232 </dl><a NAME="IrcServer.setPassword" ID="IrcServer.setPassword"></a>
1233 <h4>IrcServer.setPassword</h4>
1234 <b>setPassword</b>(<i>password</i>)
1235 <p>
1236 Public method to set a new password.
1237 </p><dl>
1238 <dt><i>password</i></dt>
1239 <dd>
1240 password to set (string)
1241 </dd>
1242 </dl><a NAME="IrcServer.setPort" ID="IrcServer.setPort"></a>
1243 <h4>IrcServer.setPort</h4>
1244 <b>setPort</b>(<i>port</i>)
1245 <p>
1246 Public method to set the server port number.
1247 </p><dl>
1248 <dt><i>port</i></dt>
1249 <dd>
1250 server port number (integer)
1251 </dd>
1252 </dl><a NAME="IrcServer.setUseSSL" ID="IrcServer.setUseSSL"></a>
1253 <h4>IrcServer.setUseSSL</h4>
1254 <b>setUseSSL</b>(<i>on</i>)
1255 <p>
1256 Public method to set the SSL usage.
1257 </p><dl>
1258 <dt><i>on</i></dt>
1259 <dd>
1260 flag indicating SSL usage (boolean)
1261 </dd>
1262 </dl><a NAME="IrcServer.useSSL" ID="IrcServer.useSSL"></a>
1263 <h4>IrcServer.useSSL</h4>
1264 <b>useSSL</b>(<i></i>)
1265 <p>
1266 Public method to check for SSL usage.
1267 </p><dl>
1268 <dt>Returns:</dt>
1269 <dd>
1270 flag indicating SSL usage (boolean)
1271 </dd>
1272 </dl>
1273 <div align="right"><a href="#top">Up</a></div>
1274 <hr />
1275 </body></html>

Mercurial Repository: eric

eric ide

mercurial