Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial