Mercurial Repositories > eric / file comparison

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

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

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Network.IRC.IrcWidget</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.IrcWidget</h1>
23 <p>
24 Module implementing the IRC window.
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="#IrcWidget">IrcWidget</a></td>
34 <td>Class implementing the IRC window.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="IrcWidget" ID="IrcWidget"></a>
43 <h2>IrcWidget</h2>
44 <p>
45 Class implementing the IRC window.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>autoConnected()</dt>
49 <dd>
50 emitted after an automatic connection was initiated
51 </dd>
52 </dl>
53 <h3>Derived from</h3>
54 QWidget, Ui_IrcWidget
55 <h3>Class Attributes</h3>
56 <table>
57 <tr><td>ServerConnected</td></tr><tr><td>ServerConnecting</td></tr><tr><td>ServerDisconnected</td></tr>
58 </table>
59 <h3>Class Methods</h3>
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Methods</h3>
64 <table>
65 <tr>
66 <td><a href="#IrcWidget.__init__">IrcWidget</a></td>
67 <td>Constructor</td>
68 </tr><tr>
69 <td><a href="#IrcWidget.__autoJoinChannels">__autoJoinChannels</a></td>
70 <td>Private slot to join channels automatically once a server got connected.</td>
71 </tr><tr>
72 <td><a href="#IrcWidget.__away">__away</a></td>
73 <td>Private slot handling the change of the away state.</td>
74 </tr><tr>
75 <td><a href="#IrcWidget.__changeNick">__changeNick</a></td>
76 <td>Private slot to use a new nick name.</td>
77 </tr><tr>
78 <td><a href="#IrcWidget.__closeAllChannels">__closeAllChannels</a></td>
79 <td>Private method to close all channels.</td>
80 </tr><tr>
81 <td><a href="#IrcWidget.__closeChannel">__closeChannel</a></td>
82 <td>Private slot handling the closing of a channel.</td>
83 </tr><tr>
84 <td><a href="#IrcWidget.__connectNetwork">__connectNetwork</a></td>
85 <td>Private slot to connect to or disconnect from the given network.</td>
86 </tr><tr>
87 <td><a href="#IrcWidget.__editNetwork">__editNetwork</a></td>
88 <td>Private slot to edit the network configuration.</td>
89 </tr><tr>
90 <td><a href="#IrcWidget.__handleCtcp">__handleCtcp</a></td>
91 <td>Private method to handle a CTCP command.</td>
92 </tr><tr>
93 <td><a href="#IrcWidget.__handleCtcpReply">__handleCtcpReply</a></td>
94 <td>Private method to handle a server message containing a CTCP reply.</td>
95 </tr><tr>
96 <td><a href="#IrcWidget.__handleNamedMessage">__handleNamedMessage</a></td>
97 <td>Private method to handle a server message containing a message name.</td>
98 </tr><tr>
99 <td><a href="#IrcWidget.__handleNickInUse">__handleNickInUse</a></td>
100 <td>Private method to handle a 443 server error.</td>
101 </tr><tr>
102 <td><a href="#IrcWidget.__handleNickInUseLogin">__handleNickInUseLogin</a></td>
103 <td>Private method to handle a 443 server error at login.</td>
104 </tr><tr>
105 <td><a href="#IrcWidget.__handleNumericMessage">__handleNumericMessage</a></td>
106 <td>Private method to handle a server message containing a numeric code.</td>
107 </tr><tr>
108 <td><a href="#IrcWidget.__handleServerError">__handleServerError</a></td>
109 <td>Private slot to handle a server error reply.</td>
110 </tr><tr>
111 <td><a href="#IrcWidget.__handleServerReply">__handleServerReply</a></td>
112 <td>Private slot to handle a server reply.</td>
113 </tr><tr>
114 <td><a href="#IrcWidget.__hostConnected">__hostConnected</a></td>
115 <td>Private slot to log in to the server after the connection was established.</td>
116 </tr><tr>
117 <td><a href="#IrcWidget.__hostDisconnected">__hostDisconnected</a></td>
118 <td>Private slot to indicate the host was disconnected.</td>
119 </tr><tr>
120 <td><a href="#IrcWidget.__hostFound">__hostFound</a></td>
121 <td>Private slot to indicate the host was found.</td>
122 </tr><tr>
123 <td><a href="#IrcWidget.__leaveAllChannels">__leaveAllChannels</a></td>
124 <td>Private slot to leave all channels and close their tabs.</td>
125 </tr><tr>
126 <td><a href="#IrcWidget.__leaveChannel">__leaveChannel</a></td>
127 <td>Private slot to leave a channel and close the associated tab.</td>
128 </tr><tr>
129 <td><a href="#IrcWidget.__leaveChannels">__leaveChannels</a></td>
130 <td>Private slot to leave a list of channels and close their associated tabs.</td>
131 </tr><tr>
132 <td><a href="#IrcWidget.__networkDataChanged">__networkDataChanged</a></td>
133 <td>Private slot handling changes of the network and identity definitions.</td>
134 </tr><tr>
135 <td><a href="#IrcWidget.__openPrivate">__openPrivate</a></td>
136 <td>Private slot to open a private chat with the given user.</td>
137 </tr><tr>
138 <td><a href="#IrcWidget.__ping">__ping</a></td>
139 <td>Private method to handle a PING message.</td>
140 </tr><tr>
141 <td><a href="#IrcWidget.__query">__query</a></td>
142 <td>Private method to handle a new private connection.</td>
143 </tr><tr>
144 <td><a href="#IrcWidget.__readyRead">__readyRead</a></td>
145 <td>Private slot to read data from the socket.</td>
146 </tr><tr>
147 <td><a href="#IrcWidget.__registerWithServices">__registerWithServices</a></td>
148 <td>Private method to register to services.</td>
149 </tr><tr>
150 <td><a href="#IrcWidget.__send">__send</a></td>
151 <td>Private slot to send data to the IRC server.</td>
152 </tr><tr>
153 <td><a href="#IrcWidget.__sendCtcpReply">__sendCtcpReply</a></td>
154 <td>Private slot to send a CTCP reply.</td>
155 </tr><tr>
156 <td><a href="#IrcWidget.__sendCtcpRequest">__sendCtcpRequest</a></td>
157 <td>Private slot to send a CTCP request.</td>
158 </tr><tr>
159 <td><a href="#IrcWidget.__setChannelTypePrefixes">__setChannelTypePrefixes</a></td>
160 <td>Private method to set the channel type prefixes.</td>
161 </tr><tr>
162 <td><a href="#IrcWidget.__setUserPrivilegePrefix">__setUserPrivilegePrefix</a></td>
163 <td>Private method to set the user privilege prefix.</td>
164 </tr><tr>
165 <td><a href="#IrcWidget.__sslErrors">__sslErrors</a></td>
166 <td>Private slot to handle SSL errors.</td>
167 </tr><tr>
168 <td><a href="#IrcWidget.__tcpError">__tcpError</a></td>
169 <td>Private slot to handle errors reported by the TCP socket.</td>
170 </tr><tr>
171 <td><a href="#IrcWidget.__updateUsersCount">__updateUsersCount</a></td>
172 <td>Private method to update the users count on the channel tabs.</td>
173 </tr><tr>
174 <td><a href="#IrcWidget.autoConnect">autoConnect</a></td>
175 <td>Public method to initiate the IRC auto connection.</td>
176 </tr><tr>
177 <td><a href="#IrcWidget.isChannelName">isChannelName</a></td>
178 <td>Public method to check, if the given name is a channel name.</td>
179 </tr><tr>
180 <td><a href="#IrcWidget.joinChannel">joinChannel</a></td>
181 <td>Public slot to join a channel.</td>
182 </tr><tr>
183 <td><a href="#IrcWidget.on_channelsWidget_tabCloseRequested">on_channelsWidget_tabCloseRequested</a></td>
184 <td>Private slot to close a channel by pressing the close button of the channels widget.</td>
185 </tr><tr>
186 <td><a href="#IrcWidget.shutdown">shutdown</a></td>
187 <td>Public method to shut down the widget.</td>
188 </tr>
189 </table>
190 <h3>Static Methods</h3>
191 <table>
192 <tr><td>None</td></tr>
193 </table>
194 <a NAME="IrcWidget.__init__" ID="IrcWidget.__init__"></a>
195 <h4>IrcWidget (Constructor)</h4>
196 <b>IrcWidget</b>(<i>parent=None</i>)
197 <p>
198 Constructor
199 </p><dl>
200 <dt><i>parent</i></dt>
201 <dd>
202 reference to the parent widget (QWidget)
203 </dd>
204 </dl><a NAME="IrcWidget.__autoJoinChannels" ID="IrcWidget.__autoJoinChannels"></a>
205 <h4>IrcWidget.__autoJoinChannels</h4>
206 <b>__autoJoinChannels</b>(<i></i>)
207 <p>
208 Private slot to join channels automatically once a server got
209 connected.
210 </p><a NAME="IrcWidget.__away" ID="IrcWidget.__away"></a>
211 <h4>IrcWidget.__away</h4>
212 <b>__away</b>(<i>isAway</i>)
213 <p>
214 Private slot handling the change of the away state.
215 </p><dl>
216 <dt><i>isAway</i></dt>
217 <dd>
218 flag indicating the current away state (boolean)
219 </dd>
220 </dl><a NAME="IrcWidget.__changeNick" ID="IrcWidget.__changeNick"></a>
221 <h4>IrcWidget.__changeNick</h4>
222 <b>__changeNick</b>(<i>nick</i>)
223 <p>
224 Private slot to use a new nick name.
225 </p><dl>
226 <dt><i>nick</i></dt>
227 <dd>
228 nick name to use (str)
229 </dd>
230 </dl><a NAME="IrcWidget.__closeAllChannels" ID="IrcWidget.__closeAllChannels"></a>
231 <h4>IrcWidget.__closeAllChannels</h4>
232 <b>__closeAllChannels</b>(<i></i>)
233 <p>
234 Private method to close all channels.
235 </p><a NAME="IrcWidget.__closeChannel" ID="IrcWidget.__closeChannel"></a>
236 <h4>IrcWidget.__closeChannel</h4>
237 <b>__closeChannel</b>(<i>name</i>)
238 <p>
239 Private slot handling the closing of a channel.
240 </p><dl>
241 <dt><i>name</i></dt>
242 <dd>
243 name of the closed channel (string)
244 </dd>
245 </dl><a NAME="IrcWidget.__connectNetwork" ID="IrcWidget.__connectNetwork"></a>
246 <h4>IrcWidget.__connectNetwork</h4>
247 <b>__connectNetwork</b>(<i>name, connect, silent</i>)
248 <p>
249 Private slot to connect to or disconnect from the given network.
250 </p><dl>
251 <dt><i>name</i></dt>
252 <dd>
253 name of the network to connect to (string)
254 </dd><dt><i>connect</i></dt>
255 <dd>
256 flag indicating to connect (boolean)
257 </dd><dt><i>silent</i></dt>
258 <dd>
259 flag indicating a silent connect/disconnect (boolean)
260 </dd>
261 </dl><a NAME="IrcWidget.__editNetwork" ID="IrcWidget.__editNetwork"></a>
262 <h4>IrcWidget.__editNetwork</h4>
263 <b>__editNetwork</b>(<i>name</i>)
264 <p>
265 Private slot to edit the network configuration.
266 </p><dl>
267 <dt><i>name</i></dt>
268 <dd>
269 name of the network to edit (string)
270 </dd>
271 </dl><a NAME="IrcWidget.__handleCtcp" ID="IrcWidget.__handleCtcp"></a>
272 <h4>IrcWidget.__handleCtcp</h4>
273 <b>__handleCtcp</b>(<i>match</i>)
274 <p>
275 Private method to handle a CTCP command.
276 </p><dl>
277 <dt><i>match</i></dt>
278 <dd>
279 reference to the match object
280 </dd>
281 </dl><dl>
282 <dt>Returns:</dt>
283 <dd>
284 flag indicating, if the message was handled (boolean)
285 </dd>
286 </dl><a NAME="IrcWidget.__handleCtcpReply" ID="IrcWidget.__handleCtcpReply"></a>
287 <h4>IrcWidget.__handleCtcpReply</h4>
288 <b>__handleCtcpReply</b>(<i>match</i>)
289 <p>
290 Private method to handle a server message containing a CTCP reply.
291 </p><dl>
292 <dt><i>match</i></dt>
293 <dd>
294 reference to the match object
295 </dd>
296 </dl><a NAME="IrcWidget.__handleNamedMessage" ID="IrcWidget.__handleNamedMessage"></a>
297 <h4>IrcWidget.__handleNamedMessage</h4>
298 <b>__handleNamedMessage</b>(<i>match</i>)
299 <p>
300 Private method to handle a server message containing a message name.
301 </p><dl>
302 <dt><i>match</i></dt>
303 <dd>
304 reference to the match object
305 </dd>
306 </dl><dl>
307 <dt>Returns:</dt>
308 <dd>
309 flag indicating, if the message was handled (boolean)
310 </dd>
311 </dl><a NAME="IrcWidget.__handleNickInUse" ID="IrcWidget.__handleNickInUse"></a>
312 <h4>IrcWidget.__handleNickInUse</h4>
313 <b>__handleNickInUse</b>(<i></i>)
314 <p>
315 Private method to handle a 443 server error.
316 </p><a NAME="IrcWidget.__handleNickInUseLogin" ID="IrcWidget.__handleNickInUseLogin"></a>
317 <h4>IrcWidget.__handleNickInUseLogin</h4>
318 <b>__handleNickInUseLogin</b>(<i></i>)
319 <p>
320 Private method to handle a 443 server error at login.
321 </p><a NAME="IrcWidget.__handleNumericMessage" ID="IrcWidget.__handleNumericMessage"></a>
322 <h4>IrcWidget.__handleNumericMessage</h4>
323 <b>__handleNumericMessage</b>(<i>match</i>)
324 <p>
325 Private method to handle a server message containing a numeric code.
326 </p><dl>
327 <dt><i>match</i></dt>
328 <dd>
329 reference to the match object
330 </dd>
331 </dl><dl>
332 <dt>Returns:</dt>
333 <dd>
334 flag indicating, if the message was handled (boolean)
335 </dd>
336 </dl><a NAME="IrcWidget.__handleServerError" ID="IrcWidget.__handleServerError"></a>
337 <h4>IrcWidget.__handleServerError</h4>
338 <b>__handleServerError</b>(<i>code, server, message</i>)
339 <p>
340 Private slot to handle a server error reply.
341 </p><dl>
342 <dt><i>code</i></dt>
343 <dd>
344 numerical code sent by the server (integer)
345 </dd><dt><i>server</i></dt>
346 <dd>
347 name of the server (string)
348 </dd><dt><i>message</i></dt>
349 <dd>
350 message sent by the server (string)
351 </dd>
352 </dl><dl>
353 <dt>Returns:</dt>
354 <dd>
355 flag indicating, if the message was handled (boolean)
356 </dd>
357 </dl><a NAME="IrcWidget.__handleServerReply" ID="IrcWidget.__handleServerReply"></a>
358 <h4>IrcWidget.__handleServerReply</h4>
359 <b>__handleServerReply</b>(<i>code, server, message</i>)
360 <p>
361 Private slot to handle a server reply.
362 </p><dl>
363 <dt><i>code</i></dt>
364 <dd>
365 numerical code sent by the server (integer)
366 </dd><dt><i>server</i></dt>
367 <dd>
368 name of the server (string)
369 </dd><dt><i>message</i></dt>
370 <dd>
371 message sent by the server (string)
372 </dd>
373 </dl><dl>
374 <dt>Returns:</dt>
375 <dd>
376 flag indicating, if the message was handled (boolean)
377 </dd>
378 </dl><a NAME="IrcWidget.__hostConnected" ID="IrcWidget.__hostConnected"></a>
379 <h4>IrcWidget.__hostConnected</h4>
380 <b>__hostConnected</b>(<i></i>)
381 <p>
382 Private slot to log in to the server after the connection was
383 established.
384 </p><a NAME="IrcWidget.__hostDisconnected" ID="IrcWidget.__hostDisconnected"></a>
385 <h4>IrcWidget.__hostDisconnected</h4>
386 <b>__hostDisconnected</b>(<i></i>)
387 <p>
388 Private slot to indicate the host was disconnected.
389 </p><a NAME="IrcWidget.__hostFound" ID="IrcWidget.__hostFound"></a>
390 <h4>IrcWidget.__hostFound</h4>
391 <b>__hostFound</b>(<i></i>)
392 <p>
393 Private slot to indicate the host was found.
394 </p><a NAME="IrcWidget.__leaveAllChannels" ID="IrcWidget.__leaveAllChannels"></a>
395 <h4>IrcWidget.__leaveAllChannels</h4>
396 <b>__leaveAllChannels</b>(<i></i>)
397 <p>
398 Private slot to leave all channels and close their tabs.
399 </p><a NAME="IrcWidget.__leaveChannel" ID="IrcWidget.__leaveChannel"></a>
400 <h4>IrcWidget.__leaveChannel</h4>
401 <b>__leaveChannel</b>(<i></i>)
402 <p>
403 Private slot to leave a channel and close the associated tab.
404 </p><a NAME="IrcWidget.__leaveChannels" ID="IrcWidget.__leaveChannels"></a>
405 <h4>IrcWidget.__leaveChannels</h4>
406 <b>__leaveChannels</b>(<i>channelNames</i>)
407 <p>
408 Private slot to leave a list of channels and close their associated
409 tabs.
410 </p><dl>
411 <dt><i>channelNames</i> (list of str)</dt>
412 <dd>
413 list of channels to leave
414 </dd>
415 </dl><a NAME="IrcWidget.__networkDataChanged" ID="IrcWidget.__networkDataChanged"></a>
416 <h4>IrcWidget.__networkDataChanged</h4>
417 <b>__networkDataChanged</b>(<i></i>)
418 <p>
419 Private slot handling changes of the network and identity definitions.
420 </p><a NAME="IrcWidget.__openPrivate" ID="IrcWidget.__openPrivate"></a>
421 <h4>IrcWidget.__openPrivate</h4>
422 <b>__openPrivate</b>(<i>name</i>)
423 <p>
424 Private slot to open a private chat with the given user.
425 </p><dl>
426 <dt><i>name</i></dt>
427 <dd>
428 name of the user (string)
429 </dd>
430 </dl><a NAME="IrcWidget.__ping" ID="IrcWidget.__ping"></a>
431 <h4>IrcWidget.__ping</h4>
432 <b>__ping</b>(<i>match</i>)
433 <p>
434 Private method to handle a PING message.
435 </p><dl>
436 <dt><i>match</i></dt>
437 <dd>
438 reference to the match object
439 </dd>
440 </dl><dl>
441 <dt>Returns:</dt>
442 <dd>
443 flag indicating, if the message was handled (boolean)
444 </dd>
445 </dl><a NAME="IrcWidget.__query" ID="IrcWidget.__query"></a>
446 <h4>IrcWidget.__query</h4>
447 <b>__query</b>(<i>match</i>)
448 <p>
449 Private method to handle a new private connection.
450 </p><dl>
451 <dt><i>match</i></dt>
452 <dd>
453 reference to the match object
454 </dd>
455 </dl><dl>
456 <dt>Returns:</dt>
457 <dd>
458 flag indicating, if the message was handled (boolean)
459 </dd>
460 </dl><a NAME="IrcWidget.__readyRead" ID="IrcWidget.__readyRead"></a>
461 <h4>IrcWidget.__readyRead</h4>
462 <b>__readyRead</b>(<i></i>)
463 <p>
464 Private slot to read data from the socket.
465 </p><a NAME="IrcWidget.__registerWithServices" ID="IrcWidget.__registerWithServices"></a>
466 <h4>IrcWidget.__registerWithServices</h4>
467 <b>__registerWithServices</b>(<i></i>)
468 <p>
469 Private method to register to services.
470 </p><a NAME="IrcWidget.__send" ID="IrcWidget.__send"></a>
471 <h4>IrcWidget.__send</h4>
472 <b>__send</b>(<i>data</i>)
473 <p>
474 Private slot to send data to the IRC server.
475 </p><dl>
476 <dt><i>data</i></dt>
477 <dd>
478 data to be sent (string)
479 </dd>
480 </dl><a NAME="IrcWidget.__sendCtcpReply" ID="IrcWidget.__sendCtcpReply"></a>
481 <h4>IrcWidget.__sendCtcpReply</h4>
482 <b>__sendCtcpReply</b>(<i>receiver, text</i>)
483 <p>
484 Private slot to send a CTCP reply.
485 </p><dl>
486 <dt><i>receiver</i> (str)</dt>
487 <dd>
488 nick name of the receiver
489 </dd><dt><i>text</i> (str)</dt>
490 <dd>
491 text to be sent
492 </dd>
493 </dl><a NAME="IrcWidget.__sendCtcpRequest" ID="IrcWidget.__sendCtcpRequest"></a>
494 <h4>IrcWidget.__sendCtcpRequest</h4>
495 <b>__sendCtcpRequest</b>(<i>receiver, request, arguments</i>)
496 <p>
497 Private slot to send a CTCP request.
498 </p><dl>
499 <dt><i>receiver</i> (str)</dt>
500 <dd>
501 nick name of the receiver
502 </dd><dt><i>request</i> (str)</dt>
503 <dd>
504 CTCP request to be sent
505 </dd><dt><i>arguments</i> (str)</dt>
506 <dd>
507 arguments to be sent
508 </dd>
509 </dl><a NAME="IrcWidget.__setChannelTypePrefixes" ID="IrcWidget.__setChannelTypePrefixes"></a>
510 <h4>IrcWidget.__setChannelTypePrefixes</h4>
511 <b>__setChannelTypePrefixes</b>(<i>prefixes</i>)
512 <p>
513 Private method to set the channel type prefixes.
514 </p><dl>
515 <dt><i>prefixes</i></dt>
516 <dd>
517 channel prefix characters (string)
518 </dd>
519 </dl><a NAME="IrcWidget.__setUserPrivilegePrefix" ID="IrcWidget.__setUserPrivilegePrefix"></a>
520 <h4>IrcWidget.__setUserPrivilegePrefix</h4>
521 <b>__setUserPrivilegePrefix</b>(<i>prefix1, prefix2</i>)
522 <p>
523 Private method to set the user privilege prefix.
524 </p><dl>
525 <dt><i>prefix1</i></dt>
526 <dd>
527 first part of the prefix (string)
528 </dd><dt><i>prefix2</i></dt>
529 <dd>
530 indictors the first part gets mapped to (string)
531 </dd>
532 </dl><a NAME="IrcWidget.__sslErrors" ID="IrcWidget.__sslErrors"></a>
533 <h4>IrcWidget.__sslErrors</h4>
534 <b>__sslErrors</b>(<i>errors</i>)
535 <p>
536 Private slot to handle SSL errors.
537 </p><dl>
538 <dt><i>errors</i></dt>
539 <dd>
540 list of SSL errors (list of QSslError)
541 </dd>
542 </dl><a NAME="IrcWidget.__tcpError" ID="IrcWidget.__tcpError"></a>
543 <h4>IrcWidget.__tcpError</h4>
544 <b>__tcpError</b>(<i>error</i>)
545 <p>
546 Private slot to handle errors reported by the TCP socket.
547 </p><dl>
548 <dt><i>error</i></dt>
549 <dd>
550 error code reported by the socket
551 (QAbstractSocket.SocketError)
552 </dd>
553 </dl><a NAME="IrcWidget.__updateUsersCount" ID="IrcWidget.__updateUsersCount"></a>
554 <h4>IrcWidget.__updateUsersCount</h4>
555 <b>__updateUsersCount</b>(<i></i>)
556 <p>
557 Private method to update the users count on the channel tabs.
558 </p><a NAME="IrcWidget.autoConnect" ID="IrcWidget.autoConnect"></a>
559 <h4>IrcWidget.autoConnect</h4>
560 <b>autoConnect</b>(<i></i>)
561 <p>
562 Public method to initiate the IRC auto connection.
563 </p><a NAME="IrcWidget.isChannelName" ID="IrcWidget.isChannelName"></a>
564 <h4>IrcWidget.isChannelName</h4>
565 <b>isChannelName</b>(<i>name</i>)
566 <p>
567 Public method to check, if the given name is a channel name.
568 </p><dl>
569 <dt><i>name</i></dt>
570 <dd>
571 name to check (string)
572 </dd>
573 </dl><dl>
574 <dt>Returns:</dt>
575 <dd>
576 flag indicating a channel name (boolean)
577 </dd>
578 </dl><a NAME="IrcWidget.joinChannel" ID="IrcWidget.joinChannel"></a>
579 <h4>IrcWidget.joinChannel</h4>
580 <b>joinChannel</b>(<i>name, key=""</i>)
581 <p>
582 Public slot to join a channel.
583 </p><dl>
584 <dt><i>name</i></dt>
585 <dd>
586 name of the channel (string)
587 </dd><dt><i>key</i></dt>
588 <dd>
589 key of the channel (string)
590 </dd>
591 </dl><a NAME="IrcWidget.on_channelsWidget_tabCloseRequested" ID="IrcWidget.on_channelsWidget_tabCloseRequested"></a>
592 <h4>IrcWidget.on_channelsWidget_tabCloseRequested</h4>
593 <b>on_channelsWidget_tabCloseRequested</b>(<i>index</i>)
594 <p>
595 Private slot to close a channel by pressing the close button of
596 the channels widget.
597 </p><dl>
598 <dt><i>index</i></dt>
599 <dd>
600 index of the tab to be closed (integer)
601 </dd>
602 </dl><a NAME="IrcWidget.shutdown" ID="IrcWidget.shutdown"></a>
603 <h4>IrcWidget.shutdown</h4>
604 <b>shutdown</b>(<i></i>)
605 <p>
606 Public method to shut down the widget.
607 </p><dl>
608 <dt>Returns:</dt>
609 <dd>
610 flag indicating successful shutdown (boolean)
611 </dd>
612 </dl>
613 <div align="right"><a href="#top">Up</a></div>
614 <hr />
615 </body></html>

Mercurial Repository: eric

eric ide

mercurial