Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial