src/eric7/Documentation/Source/eric7.Network.IRC.IrcChannelWidget.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10428
a071d4065202
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Network.IRC.IrcChannelWidget</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Network.IRC.IrcChannelWidget</h1>
10
11 <p>
12 Module implementing the IRC channel widget.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#IrcChannelWidget">IrcChannelWidget</a></td>
25 <td>Class implementing the IRC channel widget.</td>
26 </tr>
27 <tr>
28 <td><a href="#IrcUserItem">IrcUserItem</a></td>
29 <td>Class implementing a list widget item containing an IRC channel user.</td>
30 </tr>
31 </table>
32 <h3>Functions</h3>
33
34 <table>
35 <tr><td>None</td></tr>
36 </table>
37 <hr />
38 <hr />
39 <a NAME="IrcChannelWidget" ID="IrcChannelWidget"></a>
40 <h2>IrcChannelWidget</h2>
41
42 <p>
43 Class implementing the IRC channel widget.
44 </p>
45 <h3>Signals</h3>
46 <dl>
47
48 <dt>awayCommand(str)</dt>
49 <dd>
50 emitted to set the away status via the /away
51 command
52 </dd>
53 <dt>channelClosed(str)</dt>
54 <dd>
55 emitted after the user has left the channel
56 </dd>
57 <dt>leaveAllChannels()</dt>
58 <dd>
59 emitted to leave all channels
60 </dd>
61 <dt>leaveChannels(list)</dt>
62 <dd>
63 emitted to leave a list of channels
64 </dd>
65 <dt>openPrivateChat(str)</dt>
66 <dd>
67 emitted to open a "channel" for private
68 messages
69 </dd>
70 <dt>sendCtcpReply(str, str)</dt>
71 <dd>
72 emitted to send a CTCP reply
73 </dd>
74 <dt>sendCtcpRequest(str, str, str)</dt>
75 <dd>
76 emitted to send a CTCP request
77 </dd>
78 <dt>sendData(str)</dt>
79 <dd>
80 emitted to send a message to the channel
81 </dd>
82 </dl>
83 <h3>Derived from</h3>
84 QWidget, Ui_IrcChannelWidget
85 <h3>Class Attributes</h3>
86
87 <table>
88 <tr><td>JoinIndicator</td></tr><tr><td>LeaveIndicator</td></tr><tr><td>MessageIndicator</td></tr><tr><td>UrlRe</td></tr>
89 </table>
90 <h3>Class Methods</h3>
91
92 <table>
93 <tr><td>None</td></tr>
94 </table>
95 <h3>Methods</h3>
96
97 <table>
98
99 <tr>
100 <td><a href="#IrcChannelWidget.__init__">IrcChannelWidget</a></td>
101 <td>Constructor</td>
102 </tr>
103 <tr>
104 <td><a href="#IrcChannelWidget.__addManagementMessage">__addManagementMessage</a></td>
105 <td>Private method to add a channel management message to the list.</td>
106 </tr>
107 <tr>
108 <td><a href="#IrcChannelWidget.__appendMessage">__appendMessage</a></td>
109 <td>Private slot to append a message.</td>
110 </tr>
111 <tr>
112 <td><a href="#IrcChannelWidget.__autoWhoEntry">__autoWhoEntry</a></td>
113 <td>Private method to handle a WHO entry returned by the server as requested automatically.</td>
114 </tr>
115 <tr>
116 <td><a href="#IrcChannelWidget.__channelCreated">__channelCreated</a></td>
117 <td>Private method to handle a channel created message.</td>
118 </tr>
119 <tr>
120 <td><a href="#IrcChannelWidget.__channelModes">__channelModes</a></td>
121 <td>Private method to handle a message reporting the channel modes.</td>
122 </tr>
123 <tr>
124 <td><a href="#IrcChannelWidget.__channelUrl">__channelUrl</a></td>
125 <td>Private method to handle a channel URL message.</td>
126 </tr>
127 <tr>
128 <td><a href="#IrcChannelWidget.__clearMessages">__clearMessages</a></td>
129 <td>Private slot to clear the contents of the messages display.</td>
130 </tr>
131 <tr>
132 <td><a href="#IrcChannelWidget.__copyAllMessages">__copyAllMessages</a></td>
133 <td>Private slot to copy the contents of the messages display to the clipboard.</td>
134 </tr>
135 <tr>
136 <td><a href="#IrcChannelWidget.__copyMessages">__copyMessages</a></td>
137 <td>Private slot to copy the selection of the messages display to the clipboard.</td>
138 </tr>
139 <tr>
140 <td><a href="#IrcChannelWidget.__cutAllMessages">__cutAllMessages</a></td>
141 <td>Private slot to cut the contents of the messages display to the clipboard.</td>
142 </tr>
143 <tr>
144 <td><a href="#IrcChannelWidget.__extractPrivilege">__extractPrivilege</a></td>
145 <td>Private method to extract the user privileges out of the name.</td>
146 </tr>
147 <tr>
148 <td><a href="#IrcChannelWidget.__findUser">__findUser</a></td>
149 <td>Private method to find the user in the list of users.</td>
150 </tr>
151 <tr>
152 <td><a href="#IrcChannelWidget.__handleCtcp">__handleCtcp</a></td>
153 <td>Private method to handle a CTCP channel command.</td>
154 </tr>
155 <tr>
156 <td><a href="#IrcChannelWidget.__help">__help</a></td>
157 <td>Private method to handle a help message.</td>
158 </tr>
159 <tr>
160 <td><a href="#IrcChannelWidget.__ignore">__ignore</a></td>
161 <td>Private method to handle a channel message we are not interested in.</td>
162 </tr>
163 <tr>
164 <td><a href="#IrcChannelWidget.__ignoreUser">__ignoreUser</a></td>
165 <td>Private slot to ignore a specific user.</td>
166 </tr>
167 <tr>
168 <td><a href="#IrcChannelWidget.__initMessagesMenu">__initMessagesMenu</a></td>
169 <td>Private slot to initialize the context menu of the messages pane.</td>
170 </tr>
171 <tr>
172 <td><a href="#IrcChannelWidget.__initUsersMenu">__initUsersMenu</a></td>
173 <td>Private slot to initialize the users list context menu.</td>
174 </tr>
175 <tr>
176 <td><a href="#IrcChannelWidget.__message">__message</a></td>
177 <td>Private method to handle messages to the channel.</td>
178 </tr>
179 <tr>
180 <td><a href="#IrcChannelWidget.__openPrivateChat">__openPrivateChat</a></td>
181 <td>Private slot to open a chat with the selected user.</td>
182 </tr>
183 <tr>
184 <td><a href="#IrcChannelWidget.__pingUser">__pingUser</a></td>
185 <td>Private slot to send a ping to a specific user.</td>
186 </tr>
187 <tr>
188 <td><a href="#IrcChannelWidget.__processUserMessage">__processUserMessage</a></td>
189 <td>Private method to process a message entered by the user or via the user list context menu.</td>
190 </tr>
191 <tr>
192 <td><a href="#IrcChannelWidget.__saveMessages">__saveMessages</a></td>
193 <td>Private slot to save the contents of the messages display.</td>
194 </tr>
195 <tr>
196 <td><a href="#IrcChannelWidget.__sendAutoWhoCommand">__sendAutoWhoCommand</a></td>
197 <td>Private slot to send the WHO command to update the users list.</td>
198 </tr>
199 <tr>
200 <td><a href="#IrcChannelWidget.__sendUserMessage">__sendUserMessage</a></td>
201 <td>Private slot to send a private message to a specific user.</td>
202 </tr>
203 <tr>
204 <td><a href="#IrcChannelWidget.__sendUserNotice">__sendUserNotice</a></td>
205 <td>Private slot to send a notice message to a specific user.</td>
206 </tr>
207 <tr>
208 <td><a href="#IrcChannelWidget.__sendUserQuery">__sendUserQuery</a></td>
209 <td>Private slot to send a query message to a specific user.</td>
210 </tr>
211 <tr>
212 <td><a href="#IrcChannelWidget.__setEditTopicButton">__setEditTopicButton</a></td>
213 <td>Private method to set the visibility of the Edit Topic button.</td>
214 </tr>
215 <tr>
216 <td><a href="#IrcChannelWidget.__setTopic">__setTopic</a></td>
217 <td>Private method to handle a topic change of the channel.</td>
218 </tr>
219 <tr>
220 <td><a href="#IrcChannelWidget.__setUserPrivilege">__setUserPrivilege</a></td>
221 <td>Private method to handle a change of user privileges for the channel.</td>
222 </tr>
223 <tr>
224 <td><a href="#IrcChannelWidget.__topicCreated">__topicCreated</a></td>
225 <td>Private method to handle a topic created message.</td>
226 </tr>
227 <tr>
228 <td><a href="#IrcChannelWidget.__updateChannelModes">__updateChannelModes</a></td>
229 <td>Private method to handle a message reporting the channel modes.</td>
230 </tr>
231 <tr>
232 <td><a href="#IrcChannelWidget.__userAway">__userAway</a></td>
233 <td>Private method to handle a topic change of the channel.</td>
234 </tr>
235 <tr>
236 <td><a href="#IrcChannelWidget.__userJoin">__userJoin</a></td>
237 <td>Private method to handle a user joining the channel.</td>
238 </tr>
239 <tr>
240 <td><a href="#IrcChannelWidget.__userList">__userList</a></td>
241 <td>Private method to handle the receipt of a list of users of the channel.</td>
242 </tr>
243 <tr>
244 <td><a href="#IrcChannelWidget.__userNickChange">__userNickChange</a></td>
245 <td>Private method to handle a nickname change of a user.</td>
246 </tr>
247 <tr>
248 <td><a href="#IrcChannelWidget.__userPart">__userPart</a></td>
249 <td>Private method to handle a user leaving the channel.</td>
250 </tr>
251 <tr>
252 <td><a href="#IrcChannelWidget.__userQuit">__userQuit</a></td>
253 <td>Private method to handle a user logging off the server.</td>
254 </tr>
255 <tr>
256 <td><a href="#IrcChannelWidget.__whoEnd">__whoEnd</a></td>
257 <td>Private method to handle the end of the WHO list.</td>
258 </tr>
259 <tr>
260 <td><a href="#IrcChannelWidget.__whoEntry">__whoEntry</a></td>
261 <td>Private method to handle a WHO entry returned by the server as requested manually.</td>
262 </tr>
263 <tr>
264 <td><a href="#IrcChannelWidget.__whoIs">__whoIs</a></td>
265 <td>Private slot to get information about the selected user.</td>
266 </tr>
267 <tr>
268 <td><a href="#IrcChannelWidget.__whoIsAccount">__whoIsAccount</a></td>
269 <td>Private method to handle the WHOIS account reply.</td>
270 </tr>
271 <tr>
272 <td><a href="#IrcChannelWidget.__whoIsActually">__whoIsActually</a></td>
273 <td>Private method to handle the WHOIS actually reply.</td>
274 </tr>
275 <tr>
276 <td><a href="#IrcChannelWidget.__whoIsChannels">__whoIsChannels</a></td>
277 <td>Private method to handle the WHOIS channels reply.</td>
278 </tr>
279 <tr>
280 <td><a href="#IrcChannelWidget.__whoIsConnection">__whoIsConnection</a></td>
281 <td>Private method to handle the WHOIS connection reply.</td>
282 </tr>
283 <tr>
284 <td><a href="#IrcChannelWidget.__whoIsEnd">__whoIsEnd</a></td>
285 <td>Private method to handle the end of WHOIS reply.</td>
286 </tr>
287 <tr>
288 <td><a href="#IrcChannelWidget.__whoIsHelper">__whoIsHelper</a></td>
289 <td>Private method to handle the WHOIS helper reply.</td>
290 </tr>
291 <tr>
292 <td><a href="#IrcChannelWidget.__whoIsIdentify">__whoIsIdentify</a></td>
293 <td>Private method to handle the WHOIS identify and identified replies.</td>
294 </tr>
295 <tr>
296 <td><a href="#IrcChannelWidget.__whoIsIdle">__whoIsIdle</a></td>
297 <td>Private method to handle the WHOIS idle reply.</td>
298 </tr>
299 <tr>
300 <td><a href="#IrcChannelWidget.__whoIsOperator">__whoIsOperator</a></td>
301 <td>Private method to handle the WHOIS operator reply.</td>
302 </tr>
303 <tr>
304 <td><a href="#IrcChannelWidget.__whoIsSecure">__whoIsSecure</a></td>
305 <td>Private method to handle the WHOIS secure reply.</td>
306 </tr>
307 <tr>
308 <td><a href="#IrcChannelWidget.__whoIsServer">__whoIsServer</a></td>
309 <td>Private method to handle the WHOIS server reply.</td>
310 </tr>
311 <tr>
312 <td><a href="#IrcChannelWidget.__whoIsUser">__whoIsUser</a></td>
313 <td>Private method to handle the WHOIS user reply.</td>
314 </tr>
315 <tr>
316 <td><a href="#IrcChannelWidget.addMessage">addMessage</a></td>
317 <td>Public method to add a message from external.</td>
318 </tr>
319 <tr>
320 <td><a href="#IrcChannelWidget.addUsers">addUsers</a></td>
321 <td>Public method to add users to the channel.</td>
322 </tr>
323 <tr>
324 <td><a href="#IrcChannelWidget.getUsersCount">getUsersCount</a></td>
325 <td>Public method to get the users count of the channel.</td>
326 </tr>
327 <tr>
328 <td><a href="#IrcChannelWidget.handleMessage">handleMessage</a></td>
329 <td>Public method to handle the message sent by the server.</td>
330 </tr>
331 <tr>
332 <td><a href="#IrcChannelWidget.hideEvent">hideEvent</a></td>
333 <td>Protected method handling hide events.</td>
334 </tr>
335 <tr>
336 <td><a href="#IrcChannelWidget.initAutoWho">initAutoWho</a></td>
337 <td>Public method to initialize the Auto Who system.</td>
338 </tr>
339 <tr>
340 <td><a href="#IrcChannelWidget.leaveChannel">leaveChannel</a></td>
341 <td>Public slot to leave the channel.</td>
342 </tr>
343 <tr>
344 <td><a href="#IrcChannelWidget.name">name</a></td>
345 <td>Public method to get the name of the channel.</td>
346 </tr>
347 <tr>
348 <td><a href="#IrcChannelWidget.on_editTopicButton_clicked">on_editTopicButton_clicked</a></td>
349 <td>Private slot to change the topic of the channel.</td>
350 </tr>
351 <tr>
352 <td><a href="#IrcChannelWidget.on_messageEdit_returnPressed">on_messageEdit_returnPressed</a></td>
353 <td>Private slot to send a message to the channel.</td>
354 </tr>
355 <tr>
356 <td><a href="#IrcChannelWidget.on_messages_anchorClicked">on_messages_anchorClicked</a></td>
357 <td>Private slot to open links in the default browser.</td>
358 </tr>
359 <tr>
360 <td><a href="#IrcChannelWidget.on_messages_copyAvailable">on_messages_copyAvailable</a></td>
361 <td>Private slot to react to text selection/deselection of the messages edit.</td>
362 </tr>
363 <tr>
364 <td><a href="#IrcChannelWidget.on_messages_customContextMenuRequested">on_messages_customContextMenuRequested</a></td>
365 <td>Private slot to show the context menu of the messages pane.</td>
366 </tr>
367 <tr>
368 <td><a href="#IrcChannelWidget.on_usersList_customContextMenuRequested">on_usersList_customContextMenuRequested</a></td>
369 <td>Private slot to show the context menu of the users list.</td>
370 </tr>
371 <tr>
372 <td><a href="#IrcChannelWidget.partMessage">partMessage</a></td>
373 <td>Public method to get the part message.</td>
374 </tr>
375 <tr>
376 <td><a href="#IrcChannelWidget.requestLeave">requestLeave</a></td>
377 <td>Public method to leave the channel.</td>
378 </tr>
379 <tr>
380 <td><a href="#IrcChannelWidget.setMarkerLine">setMarkerLine</a></td>
381 <td>Public method to draw a line to mark the current position.</td>
382 </tr>
383 <tr>
384 <td><a href="#IrcChannelWidget.setName">setName</a></td>
385 <td>Public method to set the name of the channel.</td>
386 </tr>
387 <tr>
388 <td><a href="#IrcChannelWidget.setPartMessage">setPartMessage</a></td>
389 <td>Public method to set the part message.</td>
390 </tr>
391 <tr>
392 <td><a href="#IrcChannelWidget.setPrivate">setPrivate</a></td>
393 <td>Public method to set the private chat mode.</td>
394 </tr>
395 <tr>
396 <td><a href="#IrcChannelWidget.setPrivateInfo">setPrivateInfo</a></td>
397 <td>Public method to set some info text for private chat mode.</td>
398 </tr>
399 <tr>
400 <td><a href="#IrcChannelWidget.setUserName">setUserName</a></td>
401 <td>Public method to set the user name for the channel.</td>
402 </tr>
403 <tr>
404 <td><a href="#IrcChannelWidget.setUserPrivilegePrefix">setUserPrivilegePrefix</a></td>
405 <td>Public method to set the user privilege to prefix mapping.</td>
406 </tr>
407 <tr>
408 <td><a href="#IrcChannelWidget.showEvent">showEvent</a></td>
409 <td>Protected method handling show events.</td>
410 </tr>
411 <tr>
412 <td><a href="#IrcChannelWidget.unsetMarkerLine">unsetMarkerLine</a></td>
413 <td>Public method to remove the marker line.</td>
414 </tr>
415 <tr>
416 <td><a href="#IrcChannelWidget.userName">userName</a></td>
417 <td>Public method to get the nick name of the user.</td>
418 </tr>
419 </table>
420 <h3>Static Methods</h3>
421
422 <table>
423 <tr><td>None</td></tr>
424 </table>
425
426 <a NAME="IrcChannelWidget.__init__" ID="IrcChannelWidget.__init__"></a>
427 <h4>IrcChannelWidget (Constructor)</h4>
428 <b>IrcChannelWidget</b>(<i>parent=None</i>)
429
430 <p>
431 Constructor
432 </p>
433 <dl>
434
435 <dt><i>parent</i></dt>
436 <dd>
437 reference to the parent widget (QWidget)
438 </dd>
439 </dl>
440 <a NAME="IrcChannelWidget.__addManagementMessage" ID="IrcChannelWidget.__addManagementMessage"></a>
441 <h4>IrcChannelWidget.__addManagementMessage</h4>
442 <b>__addManagementMessage</b>(<i>indicator, message</i>)
443
444 <p>
445 Private method to add a channel management message to the list.
446 </p>
447 <dl>
448
449 <dt><i>indicator</i></dt>
450 <dd>
451 indicator to be shown (string)
452 </dd>
453 <dt><i>message</i></dt>
454 <dd>
455 message to be shown (string)
456 </dd>
457 </dl>
458 <a NAME="IrcChannelWidget.__appendMessage" ID="IrcChannelWidget.__appendMessage"></a>
459 <h4>IrcChannelWidget.__appendMessage</h4>
460 <b>__appendMessage</b>(<i>message</i>)
461
462 <p>
463 Private slot to append a message.
464 </p>
465 <dl>
466
467 <dt><i>message</i></dt>
468 <dd>
469 message to be appended (string)
470 </dd>
471 </dl>
472 <a NAME="IrcChannelWidget.__autoWhoEntry" ID="IrcChannelWidget.__autoWhoEntry"></a>
473 <h4>IrcChannelWidget.__autoWhoEntry</h4>
474 <b>__autoWhoEntry</b>(<i>match</i>)
475
476 <p>
477 Private method to handle a WHO entry returned by the server as
478 requested automatically.
479 </p>
480 <dl>
481
482 <dt><i>match</i></dt>
483 <dd>
484 match object that matched the pattern
485 </dd>
486 </dl>
487 <dl>
488 <dt>Return:</dt>
489 <dd>
490 flag indicating whether the message was handled (boolean)
491 </dd>
492 </dl>
493 <a NAME="IrcChannelWidget.__channelCreated" ID="IrcChannelWidget.__channelCreated"></a>
494 <h4>IrcChannelWidget.__channelCreated</h4>
495 <b>__channelCreated</b>(<i>match</i>)
496
497 <p>
498 Private method to handle a channel created message.
499 </p>
500 <dl>
501
502 <dt><i>match</i></dt>
503 <dd>
504 match object that matched the pattern
505 </dd>
506 </dl>
507 <dl>
508 <dt>Return:</dt>
509 <dd>
510 flag indicating whether the message was handled (boolean)
511 </dd>
512 </dl>
513 <a NAME="IrcChannelWidget.__channelModes" ID="IrcChannelWidget.__channelModes"></a>
514 <h4>IrcChannelWidget.__channelModes</h4>
515 <b>__channelModes</b>(<i>match</i>)
516
517 <p>
518 Private method to handle a message reporting the channel modes.
519 </p>
520 <dl>
521
522 <dt><i>match</i></dt>
523 <dd>
524 match object that matched the pattern
525 </dd>
526 </dl>
527 <dl>
528 <dt>Return:</dt>
529 <dd>
530 flag indicating whether the message was handled (boolean)
531 </dd>
532 </dl>
533 <a NAME="IrcChannelWidget.__channelUrl" ID="IrcChannelWidget.__channelUrl"></a>
534 <h4>IrcChannelWidget.__channelUrl</h4>
535 <b>__channelUrl</b>(<i>match</i>)
536
537 <p>
538 Private method to handle a channel URL message.
539 </p>
540 <dl>
541
542 <dt><i>match</i></dt>
543 <dd>
544 match object that matched the pattern
545 </dd>
546 </dl>
547 <dl>
548 <dt>Return:</dt>
549 <dd>
550 flag indicating whether the message was handled (boolean)
551 </dd>
552 </dl>
553 <a NAME="IrcChannelWidget.__clearMessages" ID="IrcChannelWidget.__clearMessages"></a>
554 <h4>IrcChannelWidget.__clearMessages</h4>
555 <b>__clearMessages</b>(<i></i>)
556
557 <p>
558 Private slot to clear the contents of the messages display.
559 </p>
560 <a NAME="IrcChannelWidget.__copyAllMessages" ID="IrcChannelWidget.__copyAllMessages"></a>
561 <h4>IrcChannelWidget.__copyAllMessages</h4>
562 <b>__copyAllMessages</b>(<i></i>)
563
564 <p>
565 Private slot to copy the contents of the messages display to the
566 clipboard.
567 </p>
568 <a NAME="IrcChannelWidget.__copyMessages" ID="IrcChannelWidget.__copyMessages"></a>
569 <h4>IrcChannelWidget.__copyMessages</h4>
570 <b>__copyMessages</b>(<i></i>)
571
572 <p>
573 Private slot to copy the selection of the messages display to the
574 clipboard.
575 </p>
576 <a NAME="IrcChannelWidget.__cutAllMessages" ID="IrcChannelWidget.__cutAllMessages"></a>
577 <h4>IrcChannelWidget.__cutAllMessages</h4>
578 <b>__cutAllMessages</b>(<i></i>)
579
580 <p>
581 Private slot to cut the contents of the messages display to the
582 clipboard.
583 </p>
584 <a NAME="IrcChannelWidget.__extractPrivilege" ID="IrcChannelWidget.__extractPrivilege"></a>
585 <h4>IrcChannelWidget.__extractPrivilege</h4>
586 <b>__extractPrivilege</b>(<i>name</i>)
587
588 <p>
589 Private method to extract the user privileges out of the name.
590 </p>
591 <dl>
592
593 <dt><i>name</i></dt>
594 <dd>
595 user name and prefixes (string)
596 </dd>
597 </dl>
598 <dl>
599 <dt>Return:</dt>
600 <dd>
601 list of privileges and user name (list of string, string)
602 </dd>
603 </dl>
604 <a NAME="IrcChannelWidget.__findUser" ID="IrcChannelWidget.__findUser"></a>
605 <h4>IrcChannelWidget.__findUser</h4>
606 <b>__findUser</b>(<i>name</i>)
607
608 <p>
609 Private method to find the user in the list of users.
610 </p>
611 <dl>
612
613 <dt><i>name</i></dt>
614 <dd>
615 user name to search for (string)
616 </dd>
617 </dl>
618 <dl>
619 <dt>Return:</dt>
620 <dd>
621 reference to the list entry (QListWidgetItem)
622 </dd>
623 </dl>
624 <a NAME="IrcChannelWidget.__handleCtcp" ID="IrcChannelWidget.__handleCtcp"></a>
625 <h4>IrcChannelWidget.__handleCtcp</h4>
626 <b>__handleCtcp</b>(<i>match</i>)
627
628 <p>
629 Private method to handle a CTCP channel command.
630 </p>
631 <dl>
632
633 <dt><i>match</i></dt>
634 <dd>
635 reference to the match object
636 </dd>
637 </dl>
638 <dl>
639 <dt>Return:</dt>
640 <dd>
641 flag indicating, if the message was handled (boolean)
642 </dd>
643 </dl>
644 <a NAME="IrcChannelWidget.__help" ID="IrcChannelWidget.__help"></a>
645 <h4>IrcChannelWidget.__help</h4>
646 <b>__help</b>(<i>match</i>)
647
648 <p>
649 Private method to handle a help message.
650 </p>
651 <dl>
652
653 <dt><i>match</i></dt>
654 <dd>
655 match object that matched the pattern
656 </dd>
657 </dl>
658 <dl>
659 <dt>Return:</dt>
660 <dd>
661 flag indicating whether the message was handled (boolean)
662 </dd>
663 </dl>
664 <a NAME="IrcChannelWidget.__ignore" ID="IrcChannelWidget.__ignore"></a>
665 <h4>IrcChannelWidget.__ignore</h4>
666 <b>__ignore</b>(<i>match</i>)
667
668 <p>
669 Private method to handle a channel message we are not interested in.
670 </p>
671 <dl>
672
673 <dt><i>match</i></dt>
674 <dd>
675 match object that matched the pattern
676 </dd>
677 </dl>
678 <dl>
679 <dt>Return:</dt>
680 <dd>
681 flag indicating whether the message was handled (boolean)
682 </dd>
683 </dl>
684 <a NAME="IrcChannelWidget.__ignoreUser" ID="IrcChannelWidget.__ignoreUser"></a>
685 <h4>IrcChannelWidget.__ignoreUser</h4>
686 <b>__ignoreUser</b>(<i></i>)
687
688 <p>
689 Private slot to ignore a specific user.
690 </p>
691 <a NAME="IrcChannelWidget.__initMessagesMenu" ID="IrcChannelWidget.__initMessagesMenu"></a>
692 <h4>IrcChannelWidget.__initMessagesMenu</h4>
693 <b>__initMessagesMenu</b>(<i></i>)
694
695 <p>
696 Private slot to initialize the context menu of the messages pane.
697 </p>
698 <a NAME="IrcChannelWidget.__initUsersMenu" ID="IrcChannelWidget.__initUsersMenu"></a>
699 <h4>IrcChannelWidget.__initUsersMenu</h4>
700 <b>__initUsersMenu</b>(<i></i>)
701
702 <p>
703 Private slot to initialize the users list context menu.
704 </p>
705 <a NAME="IrcChannelWidget.__message" ID="IrcChannelWidget.__message"></a>
706 <h4>IrcChannelWidget.__message</h4>
707 <b>__message</b>(<i>match</i>)
708
709 <p>
710 Private method to handle messages to the channel.
711 </p>
712 <dl>
713
714 <dt><i>match</i></dt>
715 <dd>
716 match object that matched the pattern
717 </dd>
718 </dl>
719 <dl>
720 <dt>Return:</dt>
721 <dd>
722 flag indicating whether the message was handled (boolean)
723 </dd>
724 </dl>
725 <a NAME="IrcChannelWidget.__openPrivateChat" ID="IrcChannelWidget.__openPrivateChat"></a>
726 <h4>IrcChannelWidget.__openPrivateChat</h4>
727 <b>__openPrivateChat</b>(<i></i>)
728
729 <p>
730 Private slot to open a chat with the selected user.
731 </p>
732 <a NAME="IrcChannelWidget.__pingUser" ID="IrcChannelWidget.__pingUser"></a>
733 <h4>IrcChannelWidget.__pingUser</h4>
734 <b>__pingUser</b>(<i></i>)
735
736 <p>
737 Private slot to send a ping to a specific user.
738 </p>
739 <a NAME="IrcChannelWidget.__processUserMessage" ID="IrcChannelWidget.__processUserMessage"></a>
740 <h4>IrcChannelWidget.__processUserMessage</h4>
741 <b>__processUserMessage</b>(<i>msg</i>)
742
743 <p>
744 Private method to process a message entered by the user or via the
745 user list context menu.
746 </p>
747 <dl>
748
749 <dt><i>msg</i> (str)</dt>
750 <dd>
751 message to be processed
752 </dd>
753 </dl>
754 <a NAME="IrcChannelWidget.__saveMessages" ID="IrcChannelWidget.__saveMessages"></a>
755 <h4>IrcChannelWidget.__saveMessages</h4>
756 <b>__saveMessages</b>(<i></i>)
757
758 <p>
759 Private slot to save the contents of the messages display.
760 </p>
761 <a NAME="IrcChannelWidget.__sendAutoWhoCommand" ID="IrcChannelWidget.__sendAutoWhoCommand"></a>
762 <h4>IrcChannelWidget.__sendAutoWhoCommand</h4>
763 <b>__sendAutoWhoCommand</b>(<i></i>)
764
765 <p>
766 Private slot to send the WHO command to update the users list.
767 </p>
768 <a NAME="IrcChannelWidget.__sendUserMessage" ID="IrcChannelWidget.__sendUserMessage"></a>
769 <h4>IrcChannelWidget.__sendUserMessage</h4>
770 <b>__sendUserMessage</b>(<i></i>)
771
772 <p>
773 Private slot to send a private message to a specific user.
774 </p>
775 <a NAME="IrcChannelWidget.__sendUserNotice" ID="IrcChannelWidget.__sendUserNotice"></a>
776 <h4>IrcChannelWidget.__sendUserNotice</h4>
777 <b>__sendUserNotice</b>(<i></i>)
778
779 <p>
780 Private slot to send a notice message to a specific user.
781 </p>
782 <a NAME="IrcChannelWidget.__sendUserQuery" ID="IrcChannelWidget.__sendUserQuery"></a>
783 <h4>IrcChannelWidget.__sendUserQuery</h4>
784 <b>__sendUserQuery</b>(<i></i>)
785
786 <p>
787 Private slot to send a query message to a specific user.
788 </p>
789 <a NAME="IrcChannelWidget.__setEditTopicButton" ID="IrcChannelWidget.__setEditTopicButton"></a>
790 <h4>IrcChannelWidget.__setEditTopicButton</h4>
791 <b>__setEditTopicButton</b>(<i></i>)
792
793 <p>
794 Private method to set the visibility of the Edit Topic button.
795 </p>
796 <a NAME="IrcChannelWidget.__setTopic" ID="IrcChannelWidget.__setTopic"></a>
797 <h4>IrcChannelWidget.__setTopic</h4>
798 <b>__setTopic</b>(<i>match</i>)
799
800 <p>
801 Private method to handle a topic change of the channel.
802 </p>
803 <dl>
804
805 <dt><i>match</i></dt>
806 <dd>
807 match object that matched the pattern
808 </dd>
809 </dl>
810 <dl>
811 <dt>Return:</dt>
812 <dd>
813 flag indicating whether the message was handled (boolean)
814 </dd>
815 </dl>
816 <a NAME="IrcChannelWidget.__setUserPrivilege" ID="IrcChannelWidget.__setUserPrivilege"></a>
817 <h4>IrcChannelWidget.__setUserPrivilege</h4>
818 <b>__setUserPrivilege</b>(<i>match</i>)
819
820 <p>
821 Private method to handle a change of user privileges for the channel.
822 </p>
823 <dl>
824
825 <dt><i>match</i></dt>
826 <dd>
827 match object that matched the pattern
828 </dd>
829 </dl>
830 <dl>
831 <dt>Return:</dt>
832 <dd>
833 flag indicating whether the message was handled (boolean)
834 </dd>
835 </dl>
836 <a NAME="IrcChannelWidget.__topicCreated" ID="IrcChannelWidget.__topicCreated"></a>
837 <h4>IrcChannelWidget.__topicCreated</h4>
838 <b>__topicCreated</b>(<i>match</i>)
839
840 <p>
841 Private method to handle a topic created message.
842 </p>
843 <dl>
844
845 <dt><i>match</i></dt>
846 <dd>
847 match object that matched the pattern
848 </dd>
849 </dl>
850 <dl>
851 <dt>Return:</dt>
852 <dd>
853 flag indicating whether the message was handled (boolean)
854 </dd>
855 </dl>
856 <a NAME="IrcChannelWidget.__updateChannelModes" ID="IrcChannelWidget.__updateChannelModes"></a>
857 <h4>IrcChannelWidget.__updateChannelModes</h4>
858 <b>__updateChannelModes</b>(<i>match</i>)
859
860 <p>
861 Private method to handle a message reporting the channel modes.
862 </p>
863 <dl>
864
865 <dt><i>match</i></dt>
866 <dd>
867 match object that matched the pattern
868 </dd>
869 </dl>
870 <dl>
871 <dt>Return:</dt>
872 <dd>
873 flag indicating whether the message was handled (boolean)
874 </dd>
875 </dl>
876 <a NAME="IrcChannelWidget.__userAway" ID="IrcChannelWidget.__userAway"></a>
877 <h4>IrcChannelWidget.__userAway</h4>
878 <b>__userAway</b>(<i>match</i>)
879
880 <p>
881 Private method to handle a topic change of the channel.
882 </p>
883 <dl>
884
885 <dt><i>match</i></dt>
886 <dd>
887 match object that matched the pattern
888 </dd>
889 </dl>
890 <dl>
891 <dt>Return:</dt>
892 <dd>
893 flag indicating whether the message was handled (boolean)
894 </dd>
895 </dl>
896 <a NAME="IrcChannelWidget.__userJoin" ID="IrcChannelWidget.__userJoin"></a>
897 <h4>IrcChannelWidget.__userJoin</h4>
898 <b>__userJoin</b>(<i>match</i>)
899
900 <p>
901 Private method to handle a user joining the channel.
902 </p>
903 <dl>
904
905 <dt><i>match</i></dt>
906 <dd>
907 match object that matched the pattern
908 </dd>
909 </dl>
910 <dl>
911 <dt>Return:</dt>
912 <dd>
913 flag indicating whether the message was handled (boolean)
914 </dd>
915 </dl>
916 <a NAME="IrcChannelWidget.__userList" ID="IrcChannelWidget.__userList"></a>
917 <h4>IrcChannelWidget.__userList</h4>
918 <b>__userList</b>(<i>match</i>)
919
920 <p>
921 Private method to handle the receipt of a list of users of the channel.
922 </p>
923 <dl>
924
925 <dt><i>match</i></dt>
926 <dd>
927 match object that matched the pattern
928 </dd>
929 </dl>
930 <dl>
931 <dt>Return:</dt>
932 <dd>
933 flag indicating whether the message was handled (boolean)
934 </dd>
935 </dl>
936 <a NAME="IrcChannelWidget.__userNickChange" ID="IrcChannelWidget.__userNickChange"></a>
937 <h4>IrcChannelWidget.__userNickChange</h4>
938 <b>__userNickChange</b>(<i>match</i>)
939
940 <p>
941 Private method to handle a nickname change of a user.
942 </p>
943 <dl>
944
945 <dt><i>match</i></dt>
946 <dd>
947 match object that matched the pattern
948 </dd>
949 </dl>
950 <dl>
951 <dt>Return:</dt>
952 <dd>
953 flag indicating whether the message was handled (boolean)
954 </dd>
955 </dl>
956 <a NAME="IrcChannelWidget.__userPart" ID="IrcChannelWidget.__userPart"></a>
957 <h4>IrcChannelWidget.__userPart</h4>
958 <b>__userPart</b>(<i>match</i>)
959
960 <p>
961 Private method to handle a user leaving the channel.
962 </p>
963 <dl>
964
965 <dt><i>match</i></dt>
966 <dd>
967 match object that matched the pattern
968 </dd>
969 </dl>
970 <dl>
971 <dt>Return:</dt>
972 <dd>
973 flag indicating whether the message was handled (boolean)
974 </dd>
975 </dl>
976 <a NAME="IrcChannelWidget.__userQuit" ID="IrcChannelWidget.__userQuit"></a>
977 <h4>IrcChannelWidget.__userQuit</h4>
978 <b>__userQuit</b>(<i>match</i>)
979
980 <p>
981 Private method to handle a user logging off the server.
982 </p>
983 <dl>
984
985 <dt><i>match</i></dt>
986 <dd>
987 match object that matched the pattern
988 </dd>
989 </dl>
990 <dl>
991 <dt>Return:</dt>
992 <dd>
993 flag indicating whether the message was handled (boolean)
994 </dd>
995 </dl>
996 <a NAME="IrcChannelWidget.__whoEnd" ID="IrcChannelWidget.__whoEnd"></a>
997 <h4>IrcChannelWidget.__whoEnd</h4>
998 <b>__whoEnd</b>(<i>match</i>)
999
1000 <p>
1001 Private method to handle the end of the WHO list.
1002 </p>
1003 <dl>
1004
1005 <dt><i>match</i></dt>
1006 <dd>
1007 match object that matched the pattern
1008 </dd>
1009 </dl>
1010 <dl>
1011 <dt>Return:</dt>
1012 <dd>
1013 flag indicating whether the message was handled (boolean)
1014 </dd>
1015 </dl>
1016 <a NAME="IrcChannelWidget.__whoEntry" ID="IrcChannelWidget.__whoEntry"></a>
1017 <h4>IrcChannelWidget.__whoEntry</h4>
1018 <b>__whoEntry</b>(<i>match</i>)
1019
1020 <p>
1021 Private method to handle a WHO entry returned by the server as
1022 requested manually.
1023 </p>
1024 <dl>
1025
1026 <dt><i>match</i></dt>
1027 <dd>
1028 match object that matched the pattern
1029 </dd>
1030 </dl>
1031 <dl>
1032 <dt>Return:</dt>
1033 <dd>
1034 flag indicating whether the message was handled (boolean)
1035 </dd>
1036 </dl>
1037 <a NAME="IrcChannelWidget.__whoIs" ID="IrcChannelWidget.__whoIs"></a>
1038 <h4>IrcChannelWidget.__whoIs</h4>
1039 <b>__whoIs</b>(<i></i>)
1040
1041 <p>
1042 Private slot to get information about the selected user.
1043 </p>
1044 <a NAME="IrcChannelWidget.__whoIsAccount" ID="IrcChannelWidget.__whoIsAccount"></a>
1045 <h4>IrcChannelWidget.__whoIsAccount</h4>
1046 <b>__whoIsAccount</b>(<i>match</i>)
1047
1048 <p>
1049 Private method to handle the WHOIS account reply.
1050 </p>
1051 <dl>
1052
1053 <dt><i>match</i></dt>
1054 <dd>
1055 match object that matched the pattern
1056 </dd>
1057 </dl>
1058 <dl>
1059 <dt>Return:</dt>
1060 <dd>
1061 flag indicating whether the message was handled (boolean)
1062 </dd>
1063 </dl>
1064 <a NAME="IrcChannelWidget.__whoIsActually" ID="IrcChannelWidget.__whoIsActually"></a>
1065 <h4>IrcChannelWidget.__whoIsActually</h4>
1066 <b>__whoIsActually</b>(<i>match</i>)
1067
1068 <p>
1069 Private method to handle the WHOIS actually reply.
1070 </p>
1071 <dl>
1072
1073 <dt><i>match</i></dt>
1074 <dd>
1075 match object that matched the pattern
1076 </dd>
1077 </dl>
1078 <dl>
1079 <dt>Return:</dt>
1080 <dd>
1081 flag indicating whether the message was handled (boolean)
1082 </dd>
1083 </dl>
1084 <a NAME="IrcChannelWidget.__whoIsChannels" ID="IrcChannelWidget.__whoIsChannels"></a>
1085 <h4>IrcChannelWidget.__whoIsChannels</h4>
1086 <b>__whoIsChannels</b>(<i>match</i>)
1087
1088 <p>
1089 Private method to handle the WHOIS channels reply.
1090 </p>
1091 <dl>
1092
1093 <dt><i>match</i></dt>
1094 <dd>
1095 match object that matched the pattern
1096 </dd>
1097 </dl>
1098 <dl>
1099 <dt>Return:</dt>
1100 <dd>
1101 flag indicating whether the message was handled (boolean)
1102 </dd>
1103 </dl>
1104 <a NAME="IrcChannelWidget.__whoIsConnection" ID="IrcChannelWidget.__whoIsConnection"></a>
1105 <h4>IrcChannelWidget.__whoIsConnection</h4>
1106 <b>__whoIsConnection</b>(<i>match</i>)
1107
1108 <p>
1109 Private method to handle the WHOIS connection reply.
1110 </p>
1111 <dl>
1112
1113 <dt><i>match</i></dt>
1114 <dd>
1115 match object that matched the pattern
1116 </dd>
1117 </dl>
1118 <dl>
1119 <dt>Return:</dt>
1120 <dd>
1121 flag indicating whether the message was handled (boolean)
1122 </dd>
1123 </dl>
1124 <a NAME="IrcChannelWidget.__whoIsEnd" ID="IrcChannelWidget.__whoIsEnd"></a>
1125 <h4>IrcChannelWidget.__whoIsEnd</h4>
1126 <b>__whoIsEnd</b>(<i>match</i>)
1127
1128 <p>
1129 Private method to handle the end of WHOIS reply.
1130 </p>
1131 <dl>
1132
1133 <dt><i>match</i></dt>
1134 <dd>
1135 match object that matched the pattern
1136 </dd>
1137 </dl>
1138 <dl>
1139 <dt>Return:</dt>
1140 <dd>
1141 flag indicating whether the message was handled (boolean)
1142 </dd>
1143 </dl>
1144 <a NAME="IrcChannelWidget.__whoIsHelper" ID="IrcChannelWidget.__whoIsHelper"></a>
1145 <h4>IrcChannelWidget.__whoIsHelper</h4>
1146 <b>__whoIsHelper</b>(<i>match</i>)
1147
1148 <p>
1149 Private method to handle the WHOIS helper reply.
1150 </p>
1151 <dl>
1152
1153 <dt><i>match</i></dt>
1154 <dd>
1155 match object that matched the pattern
1156 </dd>
1157 </dl>
1158 <dl>
1159 <dt>Return:</dt>
1160 <dd>
1161 flag indicating whether the message was handled (boolean)
1162 </dd>
1163 </dl>
1164 <a NAME="IrcChannelWidget.__whoIsIdentify" ID="IrcChannelWidget.__whoIsIdentify"></a>
1165 <h4>IrcChannelWidget.__whoIsIdentify</h4>
1166 <b>__whoIsIdentify</b>(<i>match</i>)
1167
1168 <p>
1169 Private method to handle the WHOIS identify and identified replies.
1170 </p>
1171 <dl>
1172
1173 <dt><i>match</i></dt>
1174 <dd>
1175 match object that matched the pattern
1176 </dd>
1177 </dl>
1178 <dl>
1179 <dt>Return:</dt>
1180 <dd>
1181 flag indicating whether the message was handled (boolean)
1182 </dd>
1183 </dl>
1184 <a NAME="IrcChannelWidget.__whoIsIdle" ID="IrcChannelWidget.__whoIsIdle"></a>
1185 <h4>IrcChannelWidget.__whoIsIdle</h4>
1186 <b>__whoIsIdle</b>(<i>match</i>)
1187
1188 <p>
1189 Private method to handle the WHOIS idle reply.
1190 </p>
1191 <dl>
1192
1193 <dt><i>match</i></dt>
1194 <dd>
1195 match object that matched the pattern
1196 </dd>
1197 </dl>
1198 <dl>
1199 <dt>Return:</dt>
1200 <dd>
1201 flag indicating whether the message was handled (boolean)
1202 </dd>
1203 </dl>
1204 <a NAME="IrcChannelWidget.__whoIsOperator" ID="IrcChannelWidget.__whoIsOperator"></a>
1205 <h4>IrcChannelWidget.__whoIsOperator</h4>
1206 <b>__whoIsOperator</b>(<i>match</i>)
1207
1208 <p>
1209 Private method to handle the WHOIS operator reply.
1210 </p>
1211 <dl>
1212
1213 <dt><i>match</i></dt>
1214 <dd>
1215 match object that matched the pattern
1216 </dd>
1217 </dl>
1218 <dl>
1219 <dt>Return:</dt>
1220 <dd>
1221 flag indicating whether the message was handled (boolean)
1222 </dd>
1223 </dl>
1224 <a NAME="IrcChannelWidget.__whoIsSecure" ID="IrcChannelWidget.__whoIsSecure"></a>
1225 <h4>IrcChannelWidget.__whoIsSecure</h4>
1226 <b>__whoIsSecure</b>(<i>match</i>)
1227
1228 <p>
1229 Private method to handle the WHOIS secure reply.
1230 </p>
1231 <dl>
1232
1233 <dt><i>match</i></dt>
1234 <dd>
1235 match object that matched the pattern
1236 </dd>
1237 </dl>
1238 <dl>
1239 <dt>Return:</dt>
1240 <dd>
1241 flag indicating whether the message was handled (boolean)
1242 </dd>
1243 </dl>
1244 <a NAME="IrcChannelWidget.__whoIsServer" ID="IrcChannelWidget.__whoIsServer"></a>
1245 <h4>IrcChannelWidget.__whoIsServer</h4>
1246 <b>__whoIsServer</b>(<i>match</i>)
1247
1248 <p>
1249 Private method to handle the WHOIS server reply.
1250 </p>
1251 <dl>
1252
1253 <dt><i>match</i></dt>
1254 <dd>
1255 match object that matched the pattern
1256 </dd>
1257 </dl>
1258 <dl>
1259 <dt>Return:</dt>
1260 <dd>
1261 flag indicating whether the message was handled (boolean)
1262 </dd>
1263 </dl>
1264 <a NAME="IrcChannelWidget.__whoIsUser" ID="IrcChannelWidget.__whoIsUser"></a>
1265 <h4>IrcChannelWidget.__whoIsUser</h4>
1266 <b>__whoIsUser</b>(<i>match</i>)
1267
1268 <p>
1269 Private method to handle the WHOIS user reply.
1270 </p>
1271 <dl>
1272
1273 <dt><i>match</i></dt>
1274 <dd>
1275 match object that matched the pattern
1276 </dd>
1277 </dl>
1278 <dl>
1279 <dt>Return:</dt>
1280 <dd>
1281 flag indicating whether the message was handled (boolean)
1282 </dd>
1283 </dl>
1284 <a NAME="IrcChannelWidget.addMessage" ID="IrcChannelWidget.addMessage"></a>
1285 <h4>IrcChannelWidget.addMessage</h4>
1286 <b>addMessage</b>(<i>sender, msg</i>)
1287
1288 <p>
1289 Public method to add a message from external.
1290 </p>
1291 <dl>
1292
1293 <dt><i>sender</i></dt>
1294 <dd>
1295 nick name of the sender (string)
1296 </dd>
1297 <dt><i>msg</i></dt>
1298 <dd>
1299 message received from sender (string)
1300 </dd>
1301 </dl>
1302 <a NAME="IrcChannelWidget.addUsers" ID="IrcChannelWidget.addUsers"></a>
1303 <h4>IrcChannelWidget.addUsers</h4>
1304 <b>addUsers</b>(<i>users</i>)
1305
1306 <p>
1307 Public method to add users to the channel.
1308 </p>
1309 <dl>
1310
1311 <dt><i>users</i></dt>
1312 <dd>
1313 list of user names to add (list of string)
1314 </dd>
1315 </dl>
1316 <a NAME="IrcChannelWidget.getUsersCount" ID="IrcChannelWidget.getUsersCount"></a>
1317 <h4>IrcChannelWidget.getUsersCount</h4>
1318 <b>getUsersCount</b>(<i></i>)
1319
1320 <p>
1321 Public method to get the users count of the channel.
1322 </p>
1323 <dl>
1324 <dt>Return:</dt>
1325 <dd>
1326 users count of the channel (integer)
1327 </dd>
1328 </dl>
1329 <a NAME="IrcChannelWidget.handleMessage" ID="IrcChannelWidget.handleMessage"></a>
1330 <h4>IrcChannelWidget.handleMessage</h4>
1331 <b>handleMessage</b>(<i>line</i>)
1332
1333 <p>
1334 Public method to handle the message sent by the server.
1335 </p>
1336 <dl>
1337
1338 <dt><i>line</i></dt>
1339 <dd>
1340 server message (string)
1341 </dd>
1342 </dl>
1343 <dl>
1344 <dt>Return:</dt>
1345 <dd>
1346 flag indicating, if the message was handled (boolean)
1347 </dd>
1348 </dl>
1349 <a NAME="IrcChannelWidget.hideEvent" ID="IrcChannelWidget.hideEvent"></a>
1350 <h4>IrcChannelWidget.hideEvent</h4>
1351 <b>hideEvent</b>(<i>evt</i>)
1352
1353 <p>
1354 Protected method handling hide events.
1355 </p>
1356 <dl>
1357
1358 <dt><i>evt</i></dt>
1359 <dd>
1360 reference to the hide event (QHideEvent)
1361 </dd>
1362 </dl>
1363 <a NAME="IrcChannelWidget.initAutoWho" ID="IrcChannelWidget.initAutoWho"></a>
1364 <h4>IrcChannelWidget.initAutoWho</h4>
1365 <b>initAutoWho</b>(<i></i>)
1366
1367 <p>
1368 Public method to initialize the Auto Who system.
1369 </p>
1370 <a NAME="IrcChannelWidget.leaveChannel" ID="IrcChannelWidget.leaveChannel"></a>
1371 <h4>IrcChannelWidget.leaveChannel</h4>
1372 <b>leaveChannel</b>(<i></i>)
1373
1374 <p>
1375 Public slot to leave the channel.
1376 </p>
1377 <a NAME="IrcChannelWidget.name" ID="IrcChannelWidget.name"></a>
1378 <h4>IrcChannelWidget.name</h4>
1379 <b>name</b>(<i></i>)
1380
1381 <p>
1382 Public method to get the name of the channel.
1383 </p>
1384 <dl>
1385 <dt>Return:</dt>
1386 <dd>
1387 name of the channel (string)
1388 </dd>
1389 </dl>
1390 <a NAME="IrcChannelWidget.on_editTopicButton_clicked" ID="IrcChannelWidget.on_editTopicButton_clicked"></a>
1391 <h4>IrcChannelWidget.on_editTopicButton_clicked</h4>
1392 <b>on_editTopicButton_clicked</b>(<i></i>)
1393
1394 <p>
1395 Private slot to change the topic of the channel.
1396 </p>
1397 <a NAME="IrcChannelWidget.on_messageEdit_returnPressed" ID="IrcChannelWidget.on_messageEdit_returnPressed"></a>
1398 <h4>IrcChannelWidget.on_messageEdit_returnPressed</h4>
1399 <b>on_messageEdit_returnPressed</b>(<i></i>)
1400
1401 <p>
1402 Private slot to send a message to the channel.
1403 </p>
1404 <a NAME="IrcChannelWidget.on_messages_anchorClicked" ID="IrcChannelWidget.on_messages_anchorClicked"></a>
1405 <h4>IrcChannelWidget.on_messages_anchorClicked</h4>
1406 <b>on_messages_anchorClicked</b>(<i>url</i>)
1407
1408 <p>
1409 Private slot to open links in the default browser.
1410 </p>
1411 <dl>
1412
1413 <dt><i>url</i></dt>
1414 <dd>
1415 URL to be opened (QUrl)
1416 </dd>
1417 </dl>
1418 <a NAME="IrcChannelWidget.on_messages_copyAvailable" ID="IrcChannelWidget.on_messages_copyAvailable"></a>
1419 <h4>IrcChannelWidget.on_messages_copyAvailable</h4>
1420 <b>on_messages_copyAvailable</b>(<i>yes</i>)
1421
1422 <p>
1423 Private slot to react to text selection/deselection of the messages
1424 edit.
1425 </p>
1426 <dl>
1427
1428 <dt><i>yes</i></dt>
1429 <dd>
1430 flag signaling the availability of selected text (boolean)
1431 </dd>
1432 </dl>
1433 <a NAME="IrcChannelWidget.on_messages_customContextMenuRequested" ID="IrcChannelWidget.on_messages_customContextMenuRequested"></a>
1434 <h4>IrcChannelWidget.on_messages_customContextMenuRequested</h4>
1435 <b>on_messages_customContextMenuRequested</b>(<i>pos</i>)
1436
1437 <p>
1438 Private slot to show the context menu of the messages pane.
1439 </p>
1440 <dl>
1441
1442 <dt><i>pos</i></dt>
1443 <dd>
1444 the position of the mouse pointer (QPoint)
1445 </dd>
1446 </dl>
1447 <a NAME="IrcChannelWidget.on_usersList_customContextMenuRequested" ID="IrcChannelWidget.on_usersList_customContextMenuRequested"></a>
1448 <h4>IrcChannelWidget.on_usersList_customContextMenuRequested</h4>
1449 <b>on_usersList_customContextMenuRequested</b>(<i>pos</i>)
1450
1451 <p>
1452 Private slot to show the context menu of the users list.
1453 </p>
1454 <dl>
1455
1456 <dt><i>pos</i></dt>
1457 <dd>
1458 the position of the mouse pointer (QPoint)
1459 </dd>
1460 </dl>
1461 <a NAME="IrcChannelWidget.partMessage" ID="IrcChannelWidget.partMessage"></a>
1462 <h4>IrcChannelWidget.partMessage</h4>
1463 <b>partMessage</b>(<i></i>)
1464
1465 <p>
1466 Public method to get the part message.
1467 </p>
1468 <dl>
1469 <dt>Return:</dt>
1470 <dd>
1471 part message (string)
1472 </dd>
1473 </dl>
1474 <a NAME="IrcChannelWidget.requestLeave" ID="IrcChannelWidget.requestLeave"></a>
1475 <h4>IrcChannelWidget.requestLeave</h4>
1476 <b>requestLeave</b>(<i></i>)
1477
1478 <p>
1479 Public method to leave the channel.
1480 </p>
1481 <a NAME="IrcChannelWidget.setMarkerLine" ID="IrcChannelWidget.setMarkerLine"></a>
1482 <h4>IrcChannelWidget.setMarkerLine</h4>
1483 <b>setMarkerLine</b>(<i></i>)
1484
1485 <p>
1486 Public method to draw a line to mark the current position.
1487 </p>
1488 <a NAME="IrcChannelWidget.setName" ID="IrcChannelWidget.setName"></a>
1489 <h4>IrcChannelWidget.setName</h4>
1490 <b>setName</b>(<i>name</i>)
1491
1492 <p>
1493 Public method to set the name of the channel.
1494 </p>
1495 <dl>
1496
1497 <dt><i>name</i></dt>
1498 <dd>
1499 of the channel (string)
1500 </dd>
1501 </dl>
1502 <a NAME="IrcChannelWidget.setPartMessage" ID="IrcChannelWidget.setPartMessage"></a>
1503 <h4>IrcChannelWidget.setPartMessage</h4>
1504 <b>setPartMessage</b>(<i>message</i>)
1505
1506 <p>
1507 Public method to set the part message.
1508 </p>
1509 <dl>
1510
1511 <dt><i>message</i></dt>
1512 <dd>
1513 message to be used for PART messages (string)
1514 </dd>
1515 </dl>
1516 <a NAME="IrcChannelWidget.setPrivate" ID="IrcChannelWidget.setPrivate"></a>
1517 <h4>IrcChannelWidget.setPrivate</h4>
1518 <b>setPrivate</b>(<i>private, partner=""</i>)
1519
1520 <p>
1521 Public method to set the private chat mode.
1522 </p>
1523 <dl>
1524
1525 <dt><i>private</i></dt>
1526 <dd>
1527 flag indicating private chat mode (boolean)
1528 </dd>
1529 <dt><i>partner</i></dt>
1530 <dd>
1531 name of the partner user (string)
1532 </dd>
1533 </dl>
1534 <a NAME="IrcChannelWidget.setPrivateInfo" ID="IrcChannelWidget.setPrivateInfo"></a>
1535 <h4>IrcChannelWidget.setPrivateInfo</h4>
1536 <b>setPrivateInfo</b>(<i>infoText</i>)
1537
1538 <p>
1539 Public method to set some info text for private chat mode.
1540 </p>
1541 <dl>
1542
1543 <dt><i>infoText</i></dt>
1544 <dd>
1545 info text to be shown (string)
1546 </dd>
1547 </dl>
1548 <a NAME="IrcChannelWidget.setUserName" ID="IrcChannelWidget.setUserName"></a>
1549 <h4>IrcChannelWidget.setUserName</h4>
1550 <b>setUserName</b>(<i>name</i>)
1551
1552 <p>
1553 Public method to set the user name for the channel.
1554 </p>
1555 <dl>
1556
1557 <dt><i>name</i></dt>
1558 <dd>
1559 user name for the channel (string)
1560 </dd>
1561 </dl>
1562 <a NAME="IrcChannelWidget.setUserPrivilegePrefix" ID="IrcChannelWidget.setUserPrivilegePrefix"></a>
1563 <h4>IrcChannelWidget.setUserPrivilegePrefix</h4>
1564 <b>setUserPrivilegePrefix</b>(<i>prefixes</i>)
1565
1566 <p>
1567 Public method to set the user privilege to prefix mapping.
1568 </p>
1569 <dl>
1570
1571 <dt><i>prefixes</i></dt>
1572 <dd>
1573 dictionary with privilege as key and prefix as value
1574 </dd>
1575 </dl>
1576 <a NAME="IrcChannelWidget.showEvent" ID="IrcChannelWidget.showEvent"></a>
1577 <h4>IrcChannelWidget.showEvent</h4>
1578 <b>showEvent</b>(<i>evt</i>)
1579
1580 <p>
1581 Protected method handling show events.
1582 </p>
1583 <dl>
1584
1585 <dt><i>evt</i></dt>
1586 <dd>
1587 reference to the show event (QShowEvent)
1588 </dd>
1589 </dl>
1590 <a NAME="IrcChannelWidget.unsetMarkerLine" ID="IrcChannelWidget.unsetMarkerLine"></a>
1591 <h4>IrcChannelWidget.unsetMarkerLine</h4>
1592 <b>unsetMarkerLine</b>(<i></i>)
1593
1594 <p>
1595 Public method to remove the marker line.
1596 </p>
1597 <a NAME="IrcChannelWidget.userName" ID="IrcChannelWidget.userName"></a>
1598 <h4>IrcChannelWidget.userName</h4>
1599 <b>userName</b>(<i></i>)
1600
1601 <p>
1602 Public method to get the nick name of the user.
1603 </p>
1604 <dl>
1605 <dt>Return:</dt>
1606 <dd>
1607 nick name of the user (string)
1608 </dd>
1609 </dl>
1610 <div align="right"><a href="#top">Up</a></div>
1611 <hr />
1612 <hr />
1613 <a NAME="IrcUserItem" ID="IrcUserItem"></a>
1614 <h2>IrcUserItem</h2>
1615
1616 <p>
1617 Class implementing a list widget item containing an IRC channel user.
1618 </p>
1619 <h3>Derived from</h3>
1620 QListWidgetItem
1621 <h3>Class Attributes</h3>
1622
1623 <table>
1624 <tr><td>Admin</td></tr><tr><td>Away</td></tr><tr><td>Halfop</td></tr><tr><td>Normal</td></tr><tr><td>Operator</td></tr><tr><td>Owner</td></tr><tr><td>PrivilegeMapping</td></tr><tr><td>Voice</td></tr>
1625 </table>
1626 <h3>Class Methods</h3>
1627
1628 <table>
1629 <tr><td>None</td></tr>
1630 </table>
1631 <h3>Methods</h3>
1632
1633 <table>
1634
1635 <tr>
1636 <td><a href="#IrcUserItem.__init__">IrcUserItem</a></td>
1637 <td>Constructor</td>
1638 </tr>
1639 <tr>
1640 <td><a href="#IrcUserItem.__awayIcon">__awayIcon</a></td>
1641 <td>Private method to convert an icon to an away icon.</td>
1642 </tr>
1643 <tr>
1644 <td><a href="#IrcUserItem.__setIcon">__setIcon</a></td>
1645 <td>Private method to set the icon dependent on user privileges.</td>
1646 </tr>
1647 <tr>
1648 <td><a href="#IrcUserItem.__setText">__setText</a></td>
1649 <td>Private method to set the user item text.</td>
1650 </tr>
1651 <tr>
1652 <td><a href="#IrcUserItem.canChangeTopic">canChangeTopic</a></td>
1653 <td>Public method to check, if the user is allowed to change the topic.</td>
1654 </tr>
1655 <tr>
1656 <td><a href="#IrcUserItem.changePrivilege">changePrivilege</a></td>
1657 <td>Public method to set or unset a user privilege.</td>
1658 </tr>
1659 <tr>
1660 <td><a href="#IrcUserItem.clearPrivileges">clearPrivileges</a></td>
1661 <td>Public method to clear the user privileges.</td>
1662 </tr>
1663 <tr>
1664 <td><a href="#IrcUserItem.isIgnored">isIgnored</a></td>
1665 <td>Public method to check, if this user is ignored.</td>
1666 </tr>
1667 <tr>
1668 <td><a href="#IrcUserItem.name">name</a></td>
1669 <td>Public method to get the user name.</td>
1670 </tr>
1671 <tr>
1672 <td><a href="#IrcUserItem.parseWhoFlags">parseWhoFlags</a></td>
1673 <td>Public method to parse the user flags reported by a WHO command.</td>
1674 </tr>
1675 <tr>
1676 <td><a href="#IrcUserItem.setIgnored">setIgnored</a></td>
1677 <td>Public method to set the user status to ignored.</td>
1678 </tr>
1679 <tr>
1680 <td><a href="#IrcUserItem.setName">setName</a></td>
1681 <td>Public method to set a new nick name.</td>
1682 </tr>
1683 </table>
1684 <h3>Static Methods</h3>
1685
1686 <table>
1687 <tr><td>None</td></tr>
1688 </table>
1689
1690 <a NAME="IrcUserItem.__init__" ID="IrcUserItem.__init__"></a>
1691 <h4>IrcUserItem (Constructor)</h4>
1692 <b>IrcUserItem</b>(<i>name, parent=None</i>)
1693
1694 <p>
1695 Constructor
1696 </p>
1697 <dl>
1698
1699 <dt><i>name</i></dt>
1700 <dd>
1701 string with user name and privilege prefix (string)
1702 </dd>
1703 <dt><i>parent</i></dt>
1704 <dd>
1705 reference to the parent widget (QListWidget or
1706 QListWidgetItem)
1707 </dd>
1708 </dl>
1709 <a NAME="IrcUserItem.__awayIcon" ID="IrcUserItem.__awayIcon"></a>
1710 <h4>IrcUserItem.__awayIcon</h4>
1711 <b>__awayIcon</b>(<i>icon</i>)
1712
1713 <p>
1714 Private method to convert an icon to an away icon.
1715 </p>
1716 <dl>
1717
1718 <dt><i>icon</i></dt>
1719 <dd>
1720 icon to be converted (QIcon)
1721 </dd>
1722 </dl>
1723 <dl>
1724 <dt>Return:</dt>
1725 <dd>
1726 away icon (QIcon)
1727 </dd>
1728 </dl>
1729 <a NAME="IrcUserItem.__setIcon" ID="IrcUserItem.__setIcon"></a>
1730 <h4>IrcUserItem.__setIcon</h4>
1731 <b>__setIcon</b>(<i></i>)
1732
1733 <p>
1734 Private method to set the icon dependent on user privileges.
1735 </p>
1736 <a NAME="IrcUserItem.__setText" ID="IrcUserItem.__setText"></a>
1737 <h4>IrcUserItem.__setText</h4>
1738 <b>__setText</b>(<i></i>)
1739
1740 <p>
1741 Private method to set the user item text.
1742 </p>
1743 <a NAME="IrcUserItem.canChangeTopic" ID="IrcUserItem.canChangeTopic"></a>
1744 <h4>IrcUserItem.canChangeTopic</h4>
1745 <b>canChangeTopic</b>(<i></i>)
1746
1747 <p>
1748 Public method to check, if the user is allowed to change the topic.
1749 </p>
1750 <dl>
1751 <dt>Return:</dt>
1752 <dd>
1753 flag indicating that the topic can be changed (boolean)
1754 </dd>
1755 </dl>
1756 <a NAME="IrcUserItem.changePrivilege" ID="IrcUserItem.changePrivilege"></a>
1757 <h4>IrcUserItem.changePrivilege</h4>
1758 <b>changePrivilege</b>(<i>privilege</i>)
1759
1760 <p>
1761 Public method to set or unset a user privilege.
1762 </p>
1763 <dl>
1764
1765 <dt><i>privilege</i></dt>
1766 <dd>
1767 privilege to set or unset (string)
1768 </dd>
1769 </dl>
1770 <a NAME="IrcUserItem.clearPrivileges" ID="IrcUserItem.clearPrivileges"></a>
1771 <h4>IrcUserItem.clearPrivileges</h4>
1772 <b>clearPrivileges</b>(<i></i>)
1773
1774 <p>
1775 Public method to clear the user privileges.
1776 </p>
1777 <a NAME="IrcUserItem.isIgnored" ID="IrcUserItem.isIgnored"></a>
1778 <h4>IrcUserItem.isIgnored</h4>
1779 <b>isIgnored</b>(<i></i>)
1780
1781 <p>
1782 Public method to check, if this user is ignored.
1783 </p>
1784 <dl>
1785 <dt>Return:</dt>
1786 <dd>
1787 flag indicating the ignored status
1788 </dd>
1789 </dl>
1790 <dl>
1791 <dt>Return Type:</dt>
1792 <dd>
1793 bool
1794 </dd>
1795 </dl>
1796 <a NAME="IrcUserItem.name" ID="IrcUserItem.name"></a>
1797 <h4>IrcUserItem.name</h4>
1798 <b>name</b>(<i></i>)
1799
1800 <p>
1801 Public method to get the user name.
1802 </p>
1803 <dl>
1804 <dt>Return:</dt>
1805 <dd>
1806 user name (string)
1807 </dd>
1808 </dl>
1809 <a NAME="IrcUserItem.parseWhoFlags" ID="IrcUserItem.parseWhoFlags"></a>
1810 <h4>IrcUserItem.parseWhoFlags</h4>
1811 <b>parseWhoFlags</b>(<i>flags</i>)
1812
1813 <p>
1814 Public method to parse the user flags reported by a WHO command.
1815 </p>
1816 <dl>
1817
1818 <dt><i>flags</i></dt>
1819 <dd>
1820 user flags as reported by WHO (string)
1821 </dd>
1822 </dl>
1823 <a NAME="IrcUserItem.setIgnored" ID="IrcUserItem.setIgnored"></a>
1824 <h4>IrcUserItem.setIgnored</h4>
1825 <b>setIgnored</b>(<i>ignored</i>)
1826
1827 <p>
1828 Public method to set the user status to ignored.
1829 </p>
1830 <dl>
1831
1832 <dt><i>ignored</i> (bool)</dt>
1833 <dd>
1834 flag indicating the new ignored status
1835 </dd>
1836 </dl>
1837 <a NAME="IrcUserItem.setName" ID="IrcUserItem.setName"></a>
1838 <h4>IrcUserItem.setName</h4>
1839 <b>setName</b>(<i>name</i>)
1840
1841 <p>
1842 Public method to set a new nick name.
1843 </p>
1844 <dl>
1845
1846 <dt><i>name</i></dt>
1847 <dd>
1848 new nick name for the user (string)
1849 </dd>
1850 </dl>
1851 <div align="right"><a href="#top">Up</a></div>
1852 <hr />
1853 </body></html>

eric ide

mercurial