Mercurial Repositories > eric / file comparison

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

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

changeset 3673
e26d7d0c1088
child 6514
f11a703e4664
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Network.IRC.IrcChannelWidget</h1>
23 <p>
24 Module implementing the IRC channel widget.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#IrcChannelWidget">IrcChannelWidget</a></td>
34 <td>Class implementing the IRC channel widget.</td>
35 </tr><tr>
36 <td><a href="#IrcUserItem">IrcUserItem</a></td>
37 <td>Class implementing a list widget item containing an IRC channel user.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="IrcChannelWidget" ID="IrcChannelWidget"></a>
46 <h2>IrcChannelWidget</h2>
47 <p>
48 Class implementing the IRC channel widget.
49 </p><h3>Signals</h3>
50 <dl>
51 <dt>channelClosed(str)</dt>
52 <dd>
53 emitted after the user has left the channel
54 </dd><dt>openPrivateChat(str)</dt>
55 <dd>
56 emitted to open a "channel" for private
57 messages
58 </dd><dt>sendCtcpReply(str, str)</dt>
59 <dd>
60 emitted to send a CTCP reply
61 </dd><dt>sendData(str)</dt>
62 <dd>
63 emitted to send a message to the channel
64 </dd>
65 </dl>
66 <h3>Derived from</h3>
67 QWidget, Ui_IrcChannelWidget
68 <h3>Class Attributes</h3>
69 <table>
70 <tr><td>JoinIndicator</td></tr><tr><td>LeaveIndicator</td></tr><tr><td>MessageIndicator</td></tr><tr><td>UrlRe</td></tr>
71 </table>
72 <h3>Class Methods</h3>
73 <table>
74 <tr><td>None</td></tr>
75 </table>
76 <h3>Methods</h3>
77 <table>
78 <tr>
79 <td><a href="#IrcChannelWidget.__init__">IrcChannelWidget</a></td>
80 <td>Constructor</td>
81 </tr><tr>
82 <td><a href="#IrcChannelWidget.__addManagementMessage">__addManagementMessage</a></td>
83 <td>Private method to add a channel management message to the list.</td>
84 </tr><tr>
85 <td><a href="#IrcChannelWidget.__appendMessage">__appendMessage</a></td>
86 <td>Private slot to append a message.</td>
87 </tr><tr>
88 <td><a href="#IrcChannelWidget.__autoWhoEntry">__autoWhoEntry</a></td>
89 <td>Private method to handle a WHO entry returned by the server as requested automatically.</td>
90 </tr><tr>
91 <td><a href="#IrcChannelWidget.__channelCreated">__channelCreated</a></td>
92 <td>Private method to handle a channel created message.</td>
93 </tr><tr>
94 <td><a href="#IrcChannelWidget.__channelModes">__channelModes</a></td>
95 <td>Private method to handle a message reporting the channel modes.</td>
96 </tr><tr>
97 <td><a href="#IrcChannelWidget.__channelUrl">__channelUrl</a></td>
98 <td>Private method to handle a channel URL message.</td>
99 </tr><tr>
100 <td><a href="#IrcChannelWidget.__clearMessages">__clearMessages</a></td>
101 <td>Private slot to clear the contents of the messages display.</td>
102 </tr><tr>
103 <td><a href="#IrcChannelWidget.__copyAllMessages">__copyAllMessages</a></td>
104 <td>Private slot to copy the contents of the messages display to the clipboard.</td>
105 </tr><tr>
106 <td><a href="#IrcChannelWidget.__copyMessages">__copyMessages</a></td>
107 <td>Private slot to copy the selection of the messages display to the clipboard.</td>
108 </tr><tr>
109 <td><a href="#IrcChannelWidget.__cutAllMessages">__cutAllMessages</a></td>
110 <td>Private slot to cut the contents of the messages display to the clipboard.</td>
111 </tr><tr>
112 <td><a href="#IrcChannelWidget.__extractPrivilege">__extractPrivilege</a></td>
113 <td>Private method to extract the user privileges out of the name.</td>
114 </tr><tr>
115 <td><a href="#IrcChannelWidget.__findUser">__findUser</a></td>
116 <td>Private method to find the user in the list of users.</td>
117 </tr><tr>
118 <td><a href="#IrcChannelWidget.__handleCtcp">__handleCtcp</a></td>
119 <td>Private method to handle a CTCP channel command.</td>
120 </tr><tr>
121 <td><a href="#IrcChannelWidget.__help">__help</a></td>
122 <td>Private method to handle a help message.</td>
123 </tr><tr>
124 <td><a href="#IrcChannelWidget.__ignore">__ignore</a></td>
125 <td>Private method to handle a channel message we are not interested in.</td>
126 </tr><tr>
127 <td><a href="#IrcChannelWidget.__initMessagesMenu">__initMessagesMenu</a></td>
128 <td>Private slot to initialize the context menu of the messages pane.</td>
129 </tr><tr>
130 <td><a href="#IrcChannelWidget.__initUsersMenu">__initUsersMenu</a></td>
131 <td>Private slot to initialize the users list context menu.</td>
132 </tr><tr>
133 <td><a href="#IrcChannelWidget.__message">__message</a></td>
134 <td>Private method to handle messages to the channel.</td>
135 </tr><tr>
136 <td><a href="#IrcChannelWidget.__openPrivateChat">__openPrivateChat</a></td>
137 <td>Private slot to open a chat with the selected user.</td>
138 </tr><tr>
139 <td><a href="#IrcChannelWidget.__saveMessages">__saveMessages</a></td>
140 <td>Private slot to save the contents of the messages display.</td>
141 </tr><tr>
142 <td><a href="#IrcChannelWidget.__sendAutoWhoCommand">__sendAutoWhoCommand</a></td>
143 <td>Private slot to send the WHO command to update the users list.</td>
144 </tr><tr>
145 <td><a href="#IrcChannelWidget.__setEditTopicButton">__setEditTopicButton</a></td>
146 <td>Private method to set the visibility of the Edit Topic button.</td>
147 </tr><tr>
148 <td><a href="#IrcChannelWidget.__setTopic">__setTopic</a></td>
149 <td>Private method to handle a topic change of the channel.</td>
150 </tr><tr>
151 <td><a href="#IrcChannelWidget.__setUserPrivilege">__setUserPrivilege</a></td>
152 <td>Private method to handle a change of user privileges for the channel.</td>
153 </tr><tr>
154 <td><a href="#IrcChannelWidget.__topicCreated">__topicCreated</a></td>
155 <td>Private method to handle a topic created message.</td>
156 </tr><tr>
157 <td><a href="#IrcChannelWidget.__updateChannelModes">__updateChannelModes</a></td>
158 <td>Private method to handle a message reporting the channel modes.</td>
159 </tr><tr>
160 <td><a href="#IrcChannelWidget.__userAway">__userAway</a></td>
161 <td>Private method to handle a topic change of the channel.</td>
162 </tr><tr>
163 <td><a href="#IrcChannelWidget.__userJoin">__userJoin</a></td>
164 <td>Private method to handle a user joining the channel.</td>
165 </tr><tr>
166 <td><a href="#IrcChannelWidget.__userList">__userList</a></td>
167 <td>Private method to handle the receipt of a list of users of the channel.</td>
168 </tr><tr>
169 <td><a href="#IrcChannelWidget.__userNickChange">__userNickChange</a></td>
170 <td>Private method to handle a nickname change of a user.</td>
171 </tr><tr>
172 <td><a href="#IrcChannelWidget.__userPart">__userPart</a></td>
173 <td>Private method to handle a user leaving the channel.</td>
174 </tr><tr>
175 <td><a href="#IrcChannelWidget.__userQuit">__userQuit</a></td>
176 <td>Private method to handle a user logging off the server.</td>
177 </tr><tr>
178 <td><a href="#IrcChannelWidget.__whoEnd">__whoEnd</a></td>
179 <td>Private method to handle the end of the WHO list.</td>
180 </tr><tr>
181 <td><a href="#IrcChannelWidget.__whoEntry">__whoEntry</a></td>
182 <td>Private method to handle a WHO entry returned by the server as requested manually.</td>
183 </tr><tr>
184 <td><a href="#IrcChannelWidget.__whoIs">__whoIs</a></td>
185 <td>Private slot to get information about the selected user.</td>
186 </tr><tr>
187 <td><a href="#IrcChannelWidget.__whoIsAccount">__whoIsAccount</a></td>
188 <td>Private method to handle the WHOIS account reply.</td>
189 </tr><tr>
190 <td><a href="#IrcChannelWidget.__whoIsActually">__whoIsActually</a></td>
191 <td>Private method to handle the WHOIS actually reply.</td>
192 </tr><tr>
193 <td><a href="#IrcChannelWidget.__whoIsChannels">__whoIsChannels</a></td>
194 <td>Private method to handle the WHOIS channels reply.</td>
195 </tr><tr>
196 <td><a href="#IrcChannelWidget.__whoIsConnection">__whoIsConnection</a></td>
197 <td>Private method to handle the WHOIS connection reply.</td>
198 </tr><tr>
199 <td><a href="#IrcChannelWidget.__whoIsEnd">__whoIsEnd</a></td>
200 <td>Private method to handle the end of WHOIS reply.</td>
201 </tr><tr>
202 <td><a href="#IrcChannelWidget.__whoIsHelper">__whoIsHelper</a></td>
203 <td>Private method to handle the WHOIS helper reply.</td>
204 </tr><tr>
205 <td><a href="#IrcChannelWidget.__whoIsIdentify">__whoIsIdentify</a></td>
206 <td>Private method to handle the WHOIS identify and identified replies.</td>
207 </tr><tr>
208 <td><a href="#IrcChannelWidget.__whoIsIdle">__whoIsIdle</a></td>
209 <td>Private method to handle the WHOIS idle reply.</td>
210 </tr><tr>
211 <td><a href="#IrcChannelWidget.__whoIsOperator">__whoIsOperator</a></td>
212 <td>Private method to handle the WHOIS operator reply.</td>
213 </tr><tr>
214 <td><a href="#IrcChannelWidget.__whoIsSecure">__whoIsSecure</a></td>
215 <td>Private method to handle the WHOIS secure reply.</td>
216 </tr><tr>
217 <td><a href="#IrcChannelWidget.__whoIsServer">__whoIsServer</a></td>
218 <td>Private method to handle the WHOIS server reply.</td>
219 </tr><tr>
220 <td><a href="#IrcChannelWidget.__whoIsUser">__whoIsUser</a></td>
221 <td>Private method to handle the WHOIS user reply.</td>
222 </tr><tr>
223 <td><a href="#IrcChannelWidget.addMessage">addMessage</a></td>
224 <td>Public method to add a message from external.</td>
225 </tr><tr>
226 <td><a href="#IrcChannelWidget.addUsers">addUsers</a></td>
227 <td>Public method to add users to the channel.</td>
228 </tr><tr>
229 <td><a href="#IrcChannelWidget.getUsersCount">getUsersCount</a></td>
230 <td>Public method to get the users count of the channel.</td>
231 </tr><tr>
232 <td><a href="#IrcChannelWidget.handleMessage">handleMessage</a></td>
233 <td>Public method to handle the message sent by the server.</td>
234 </tr><tr>
235 <td><a href="#IrcChannelWidget.hideEvent">hideEvent</a></td>
236 <td>Protected method handling hide events.</td>
237 </tr><tr>
238 <td><a href="#IrcChannelWidget.initAutoWho">initAutoWho</a></td>
239 <td>Public method to initialize the Auto Who system.</td>
240 </tr><tr>
241 <td><a href="#IrcChannelWidget.name">name</a></td>
242 <td>Public method to get the name of the channel.</td>
243 </tr><tr>
244 <td><a href="#IrcChannelWidget.on_editTopicButton_clicked">on_editTopicButton_clicked</a></td>
245 <td>Private slot to change the topic of the channel.</td>
246 </tr><tr>
247 <td><a href="#IrcChannelWidget.on_messageEdit_returnPressed">on_messageEdit_returnPressed</a></td>
248 <td>Private slot to send a message to the channel.</td>
249 </tr><tr>
250 <td><a href="#IrcChannelWidget.on_messages_anchorClicked">on_messages_anchorClicked</a></td>
251 <td>Private slot to open links in the default browser.</td>
252 </tr><tr>
253 <td><a href="#IrcChannelWidget.on_messages_copyAvailable">on_messages_copyAvailable</a></td>
254 <td>Private slot to react to text selection/deselection of the messages edit.</td>
255 </tr><tr>
256 <td><a href="#IrcChannelWidget.on_messages_customContextMenuRequested">on_messages_customContextMenuRequested</a></td>
257 <td>Private slot to show the context menu of the messages pane.</td>
258 </tr><tr>
259 <td><a href="#IrcChannelWidget.on_usersList_customContextMenuRequested">on_usersList_customContextMenuRequested</a></td>
260 <td>Private slot to show the context menu of the users list.</td>
261 </tr><tr>
262 <td><a href="#IrcChannelWidget.partMessage">partMessage</a></td>
263 <td>Public method to get the part message.</td>
264 </tr><tr>
265 <td><a href="#IrcChannelWidget.requestLeave">requestLeave</a></td>
266 <td>Public method to leave the channel.</td>
267 </tr><tr>
268 <td><a href="#IrcChannelWidget.setMarkerLine">setMarkerLine</a></td>
269 <td>Public method to draw a line to mark the current position.</td>
270 </tr><tr>
271 <td><a href="#IrcChannelWidget.setName">setName</a></td>
272 <td>Public method to set the name of the channel.</td>
273 </tr><tr>
274 <td><a href="#IrcChannelWidget.setPartMessage">setPartMessage</a></td>
275 <td>Public method to set the part message.</td>
276 </tr><tr>
277 <td><a href="#IrcChannelWidget.setPrivate">setPrivate</a></td>
278 <td>Public method to set the private chat mode.</td>
279 </tr><tr>
280 <td><a href="#IrcChannelWidget.setPrivateInfo">setPrivateInfo</a></td>
281 <td>Public method to set some info text for private chat mode.</td>
282 </tr><tr>
283 <td><a href="#IrcChannelWidget.setUserName">setUserName</a></td>
284 <td>Public method to set the user name for the channel.</td>
285 </tr><tr>
286 <td><a href="#IrcChannelWidget.setUserPrivilegePrefix">setUserPrivilegePrefix</a></td>
287 <td>Public method to set the user privilege to prefix mapping.</td>
288 </tr><tr>
289 <td><a href="#IrcChannelWidget.showEvent">showEvent</a></td>
290 <td>Protected method handling show events.</td>
291 </tr><tr>
292 <td><a href="#IrcChannelWidget.unsetMarkerLine">unsetMarkerLine</a></td>
293 <td>Public method to remove the marker line.</td>
294 </tr><tr>
295 <td><a href="#IrcChannelWidget.userName">userName</a></td>
296 <td>Public method to get the nick name of the user.</td>
297 </tr>
298 </table>
299 <h3>Static Methods</h3>
300 <table>
301 <tr><td>None</td></tr>
302 </table>
303 <a NAME="IrcChannelWidget.__init__" ID="IrcChannelWidget.__init__"></a>
304 <h4>IrcChannelWidget (Constructor)</h4>
305 <b>IrcChannelWidget</b>(<i>parent=None</i>)
306 <p>
307 Constructor
308 </p><dl>
309 <dt><i>parent</i></dt>
310 <dd>
311 reference to the parent widget (QWidget)
312 </dd>
313 </dl><a NAME="IrcChannelWidget.__addManagementMessage" ID="IrcChannelWidget.__addManagementMessage"></a>
314 <h4>IrcChannelWidget.__addManagementMessage</h4>
315 <b>__addManagementMessage</b>(<i>indicator, message</i>)
316 <p>
317 Private method to add a channel management message to the list.
318 </p><dl>
319 <dt><i>indicator</i></dt>
320 <dd>
321 indicator to be shown (string)
322 </dd><dt><i>message</i></dt>
323 <dd>
324 message to be shown (string)
325 </dd>
326 </dl><a NAME="IrcChannelWidget.__appendMessage" ID="IrcChannelWidget.__appendMessage"></a>
327 <h4>IrcChannelWidget.__appendMessage</h4>
328 <b>__appendMessage</b>(<i>message</i>)
329 <p>
330 Private slot to append a message.
331 </p><dl>
332 <dt><i>message</i></dt>
333 <dd>
334 message to be appended (string)
335 </dd>
336 </dl><a NAME="IrcChannelWidget.__autoWhoEntry" ID="IrcChannelWidget.__autoWhoEntry"></a>
337 <h4>IrcChannelWidget.__autoWhoEntry</h4>
338 <b>__autoWhoEntry</b>(<i>match</i>)
339 <p>
340 Private method to handle a WHO entry returned by the server as
341 requested automatically.
342 </p><dl>
343 <dt><i>match</i></dt>
344 <dd>
345 match object that matched the pattern
346 </dd>
347 </dl><dl>
348 <dt>Returns:</dt>
349 <dd>
350 flag indicating whether the message was handled (boolean)
351 </dd>
352 </dl><a NAME="IrcChannelWidget.__channelCreated" ID="IrcChannelWidget.__channelCreated"></a>
353 <h4>IrcChannelWidget.__channelCreated</h4>
354 <b>__channelCreated</b>(<i>match</i>)
355 <p>
356 Private method to handle a channel created message.
357 </p><dl>
358 <dt><i>match</i></dt>
359 <dd>
360 match object that matched the pattern
361 </dd>
362 </dl><dl>
363 <dt>Returns:</dt>
364 <dd>
365 flag indicating whether the message was handled (boolean)
366 </dd>
367 </dl><a NAME="IrcChannelWidget.__channelModes" ID="IrcChannelWidget.__channelModes"></a>
368 <h4>IrcChannelWidget.__channelModes</h4>
369 <b>__channelModes</b>(<i>match</i>)
370 <p>
371 Private method to handle a message reporting the channel modes.
372 </p><dl>
373 <dt><i>match</i></dt>
374 <dd>
375 match object that matched the pattern
376 </dd>
377 </dl><dl>
378 <dt>Returns:</dt>
379 <dd>
380 flag indicating whether the message was handled (boolean)
381 </dd>
382 </dl><a NAME="IrcChannelWidget.__channelUrl" ID="IrcChannelWidget.__channelUrl"></a>
383 <h4>IrcChannelWidget.__channelUrl</h4>
384 <b>__channelUrl</b>(<i>match</i>)
385 <p>
386 Private method to handle a channel URL message.
387 </p><dl>
388 <dt><i>match</i></dt>
389 <dd>
390 match object that matched the pattern
391 </dd>
392 </dl><dl>
393 <dt>Returns:</dt>
394 <dd>
395 flag indicating whether the message was handled (boolean)
396 </dd>
397 </dl><a NAME="IrcChannelWidget.__clearMessages" ID="IrcChannelWidget.__clearMessages"></a>
398 <h4>IrcChannelWidget.__clearMessages</h4>
399 <b>__clearMessages</b>(<i></i>)
400 <p>
401 Private slot to clear the contents of the messages display.
402 </p><a NAME="IrcChannelWidget.__copyAllMessages" ID="IrcChannelWidget.__copyAllMessages"></a>
403 <h4>IrcChannelWidget.__copyAllMessages</h4>
404 <b>__copyAllMessages</b>(<i></i>)
405 <p>
406 Private slot to copy the contents of the messages display to the
407 clipboard.
408 </p><a NAME="IrcChannelWidget.__copyMessages" ID="IrcChannelWidget.__copyMessages"></a>
409 <h4>IrcChannelWidget.__copyMessages</h4>
410 <b>__copyMessages</b>(<i></i>)
411 <p>
412 Private slot to copy the selection of the messages display to the
413 clipboard.
414 </p><a NAME="IrcChannelWidget.__cutAllMessages" ID="IrcChannelWidget.__cutAllMessages"></a>
415 <h4>IrcChannelWidget.__cutAllMessages</h4>
416 <b>__cutAllMessages</b>(<i></i>)
417 <p>
418 Private slot to cut the contents of the messages display to the
419 clipboard.
420 </p><a NAME="IrcChannelWidget.__extractPrivilege" ID="IrcChannelWidget.__extractPrivilege"></a>
421 <h4>IrcChannelWidget.__extractPrivilege</h4>
422 <b>__extractPrivilege</b>(<i>name</i>)
423 <p>
424 Private method to extract the user privileges out of the name.
425 </p><dl>
426 <dt><i>name</i></dt>
427 <dd>
428 user name and prefixes (string)
429 </dd>
430 </dl><dl>
431 <dt>Returns:</dt>
432 <dd>
433 list of privileges and user name (list of string, string)
434 </dd>
435 </dl><a NAME="IrcChannelWidget.__findUser" ID="IrcChannelWidget.__findUser"></a>
436 <h4>IrcChannelWidget.__findUser</h4>
437 <b>__findUser</b>(<i>name</i>)
438 <p>
439 Private method to find the user in the list of users.
440 </p><dl>
441 <dt><i>name</i></dt>
442 <dd>
443 user name to search for (string)
444 </dd>
445 </dl><dl>
446 <dt>Returns:</dt>
447 <dd>
448 reference to the list entry (QListWidgetItem)
449 </dd>
450 </dl><a NAME="IrcChannelWidget.__handleCtcp" ID="IrcChannelWidget.__handleCtcp"></a>
451 <h4>IrcChannelWidget.__handleCtcp</h4>
452 <b>__handleCtcp</b>(<i>match</i>)
453 <p>
454 Private method to handle a CTCP channel command.
455 </p><dl>
456 <dt><i>match</i></dt>
457 <dd>
458 reference to the match object
459 </dd>
460 </dl><dl>
461 <dt>Returns:</dt>
462 <dd>
463 flag indicating, if the message was handled (boolean)
464 </dd>
465 </dl><a NAME="IrcChannelWidget.__help" ID="IrcChannelWidget.__help"></a>
466 <h4>IrcChannelWidget.__help</h4>
467 <b>__help</b>(<i>match</i>)
468 <p>
469 Private method to handle a help message.
470 </p><dl>
471 <dt><i>match</i></dt>
472 <dd>
473 match object that matched the pattern
474 </dd>
475 </dl><dl>
476 <dt>Returns:</dt>
477 <dd>
478 flag indicating whether the message was handled (boolean)
479 </dd>
480 </dl><a NAME="IrcChannelWidget.__ignore" ID="IrcChannelWidget.__ignore"></a>
481 <h4>IrcChannelWidget.__ignore</h4>
482 <b>__ignore</b>(<i>match</i>)
483 <p>
484 Private method to handle a channel message we are not interested in.
485 </p><dl>
486 <dt><i>match</i></dt>
487 <dd>
488 match object that matched the pattern
489 </dd>
490 </dl><dl>
491 <dt>Returns:</dt>
492 <dd>
493 flag indicating whether the message was handled (boolean)
494 </dd>
495 </dl><a NAME="IrcChannelWidget.__initMessagesMenu" ID="IrcChannelWidget.__initMessagesMenu"></a>
496 <h4>IrcChannelWidget.__initMessagesMenu</h4>
497 <b>__initMessagesMenu</b>(<i></i>)
498 <p>
499 Private slot to initialize the context menu of the messages pane.
500 </p><a NAME="IrcChannelWidget.__initUsersMenu" ID="IrcChannelWidget.__initUsersMenu"></a>
501 <h4>IrcChannelWidget.__initUsersMenu</h4>
502 <b>__initUsersMenu</b>(<i></i>)
503 <p>
504 Private slot to initialize the users list context menu.
505 </p><a NAME="IrcChannelWidget.__message" ID="IrcChannelWidget.__message"></a>
506 <h4>IrcChannelWidget.__message</h4>
507 <b>__message</b>(<i>match</i>)
508 <p>
509 Private method to handle messages to the channel.
510 </p><dl>
511 <dt><i>match</i></dt>
512 <dd>
513 match object that matched the pattern
514 </dd>
515 </dl><dl>
516 <dt>Returns:</dt>
517 <dd>
518 flag indicating whether the message was handled (boolean)
519 </dd>
520 </dl><a NAME="IrcChannelWidget.__openPrivateChat" ID="IrcChannelWidget.__openPrivateChat"></a>
521 <h4>IrcChannelWidget.__openPrivateChat</h4>
522 <b>__openPrivateChat</b>(<i></i>)
523 <p>
524 Private slot to open a chat with the selected user.
525 </p><a NAME="IrcChannelWidget.__saveMessages" ID="IrcChannelWidget.__saveMessages"></a>
526 <h4>IrcChannelWidget.__saveMessages</h4>
527 <b>__saveMessages</b>(<i></i>)
528 <p>
529 Private slot to save the contents of the messages display.
530 </p><a NAME="IrcChannelWidget.__sendAutoWhoCommand" ID="IrcChannelWidget.__sendAutoWhoCommand"></a>
531 <h4>IrcChannelWidget.__sendAutoWhoCommand</h4>
532 <b>__sendAutoWhoCommand</b>(<i></i>)
533 <p>
534 Private slot to send the WHO command to update the users list.
535 </p><a NAME="IrcChannelWidget.__setEditTopicButton" ID="IrcChannelWidget.__setEditTopicButton"></a>
536 <h4>IrcChannelWidget.__setEditTopicButton</h4>
537 <b>__setEditTopicButton</b>(<i></i>)
538 <p>
539 Private method to set the visibility of the Edit Topic button.
540 </p><a NAME="IrcChannelWidget.__setTopic" ID="IrcChannelWidget.__setTopic"></a>
541 <h4>IrcChannelWidget.__setTopic</h4>
542 <b>__setTopic</b>(<i>match</i>)
543 <p>
544 Private method to handle a topic change of the channel.
545 </p><dl>
546 <dt><i>match</i></dt>
547 <dd>
548 match object that matched the pattern
549 </dd>
550 </dl><dl>
551 <dt>Returns:</dt>
552 <dd>
553 flag indicating whether the message was handled (boolean)
554 </dd>
555 </dl><a NAME="IrcChannelWidget.__setUserPrivilege" ID="IrcChannelWidget.__setUserPrivilege"></a>
556 <h4>IrcChannelWidget.__setUserPrivilege</h4>
557 <b>__setUserPrivilege</b>(<i>match</i>)
558 <p>
559 Private method to handle a change of user privileges for the channel.
560 </p><dl>
561 <dt><i>match</i></dt>
562 <dd>
563 match object that matched the pattern
564 </dd>
565 </dl><dl>
566 <dt>Returns:</dt>
567 <dd>
568 flag indicating whether the message was handled (boolean)
569 </dd>
570 </dl><a NAME="IrcChannelWidget.__topicCreated" ID="IrcChannelWidget.__topicCreated"></a>
571 <h4>IrcChannelWidget.__topicCreated</h4>
572 <b>__topicCreated</b>(<i>match</i>)
573 <p>
574 Private method to handle a topic created message.
575 </p><dl>
576 <dt><i>match</i></dt>
577 <dd>
578 match object that matched the pattern
579 </dd>
580 </dl><dl>
581 <dt>Returns:</dt>
582 <dd>
583 flag indicating whether the message was handled (boolean)
584 </dd>
585 </dl><a NAME="IrcChannelWidget.__updateChannelModes" ID="IrcChannelWidget.__updateChannelModes"></a>
586 <h4>IrcChannelWidget.__updateChannelModes</h4>
587 <b>__updateChannelModes</b>(<i>match</i>)
588 <p>
589 Private method to handle a message reporting the channel modes.
590 </p><dl>
591 <dt><i>match</i></dt>
592 <dd>
593 match object that matched the pattern
594 </dd>
595 </dl><dl>
596 <dt>Returns:</dt>
597 <dd>
598 flag indicating whether the message was handled (boolean)
599 </dd>
600 </dl><a NAME="IrcChannelWidget.__userAway" ID="IrcChannelWidget.__userAway"></a>
601 <h4>IrcChannelWidget.__userAway</h4>
602 <b>__userAway</b>(<i>match</i>)
603 <p>
604 Private method to handle a topic change of the channel.
605 </p><dl>
606 <dt><i>match</i></dt>
607 <dd>
608 match object that matched the pattern
609 </dd>
610 </dl><dl>
611 <dt>Returns:</dt>
612 <dd>
613 flag indicating whether the message was handled (boolean)
614 </dd>
615 </dl><a NAME="IrcChannelWidget.__userJoin" ID="IrcChannelWidget.__userJoin"></a>
616 <h4>IrcChannelWidget.__userJoin</h4>
617 <b>__userJoin</b>(<i>match</i>)
618 <p>
619 Private method to handle a user joining the channel.
620 </p><dl>
621 <dt><i>match</i></dt>
622 <dd>
623 match object that matched the pattern
624 </dd>
625 </dl><dl>
626 <dt>Returns:</dt>
627 <dd>
628 flag indicating whether the message was handled (boolean)
629 </dd>
630 </dl><a NAME="IrcChannelWidget.__userList" ID="IrcChannelWidget.__userList"></a>
631 <h4>IrcChannelWidget.__userList</h4>
632 <b>__userList</b>(<i>match</i>)
633 <p>
634 Private method to handle the receipt of a list of users of the channel.
635 </p><dl>
636 <dt><i>match</i></dt>
637 <dd>
638 match object that matched the pattern
639 </dd>
640 </dl><dl>
641 <dt>Returns:</dt>
642 <dd>
643 flag indicating whether the message was handled (boolean)
644 </dd>
645 </dl><a NAME="IrcChannelWidget.__userNickChange" ID="IrcChannelWidget.__userNickChange"></a>
646 <h4>IrcChannelWidget.__userNickChange</h4>
647 <b>__userNickChange</b>(<i>match</i>)
648 <p>
649 Private method to handle a nickname change of a user.
650 </p><dl>
651 <dt><i>match</i></dt>
652 <dd>
653 match object that matched the pattern
654 </dd>
655 </dl><dl>
656 <dt>Returns:</dt>
657 <dd>
658 flag indicating whether the message was handled (boolean)
659 </dd>
660 </dl><a NAME="IrcChannelWidget.__userPart" ID="IrcChannelWidget.__userPart"></a>
661 <h4>IrcChannelWidget.__userPart</h4>
662 <b>__userPart</b>(<i>match</i>)
663 <p>
664 Private method to handle a user leaving the channel.
665 </p><dl>
666 <dt><i>match</i></dt>
667 <dd>
668 match object that matched the pattern
669 </dd>
670 </dl><dl>
671 <dt>Returns:</dt>
672 <dd>
673 flag indicating whether the message was handled (boolean)
674 </dd>
675 </dl><a NAME="IrcChannelWidget.__userQuit" ID="IrcChannelWidget.__userQuit"></a>
676 <h4>IrcChannelWidget.__userQuit</h4>
677 <b>__userQuit</b>(<i>match</i>)
678 <p>
679 Private method to handle a user logging off the server.
680 </p><dl>
681 <dt><i>match</i></dt>
682 <dd>
683 match object that matched the pattern
684 </dd>
685 </dl><dl>
686 <dt>Returns:</dt>
687 <dd>
688 flag indicating whether the message was handled (boolean)
689 </dd>
690 </dl><a NAME="IrcChannelWidget.__whoEnd" ID="IrcChannelWidget.__whoEnd"></a>
691 <h4>IrcChannelWidget.__whoEnd</h4>
692 <b>__whoEnd</b>(<i>match</i>)
693 <p>
694 Private method to handle the end of the WHO list.
695 </p><dl>
696 <dt><i>match</i></dt>
697 <dd>
698 match object that matched the pattern
699 </dd>
700 </dl><dl>
701 <dt>Returns:</dt>
702 <dd>
703 flag indicating whether the message was handled (boolean)
704 </dd>
705 </dl><a NAME="IrcChannelWidget.__whoEntry" ID="IrcChannelWidget.__whoEntry"></a>
706 <h4>IrcChannelWidget.__whoEntry</h4>
707 <b>__whoEntry</b>(<i>match</i>)
708 <p>
709 Private method to handle a WHO entry returned by the server as
710 requested manually.
711 </p><dl>
712 <dt><i>match</i></dt>
713 <dd>
714 match object that matched the pattern
715 </dd>
716 </dl><dl>
717 <dt>Returns:</dt>
718 <dd>
719 flag indicating whether the message was handled (boolean)
720 </dd>
721 </dl><a NAME="IrcChannelWidget.__whoIs" ID="IrcChannelWidget.__whoIs"></a>
722 <h4>IrcChannelWidget.__whoIs</h4>
723 <b>__whoIs</b>(<i></i>)
724 <p>
725 Private slot to get information about the selected user.
726 </p><a NAME="IrcChannelWidget.__whoIsAccount" ID="IrcChannelWidget.__whoIsAccount"></a>
727 <h4>IrcChannelWidget.__whoIsAccount</h4>
728 <b>__whoIsAccount</b>(<i>match</i>)
729 <p>
730 Private method to handle the WHOIS account reply.
731 </p><dl>
732 <dt><i>match</i></dt>
733 <dd>
734 match object that matched the pattern
735 </dd>
736 </dl><dl>
737 <dt>Returns:</dt>
738 <dd>
739 flag indicating whether the message was handled (boolean)
740 </dd>
741 </dl><a NAME="IrcChannelWidget.__whoIsActually" ID="IrcChannelWidget.__whoIsActually"></a>
742 <h4>IrcChannelWidget.__whoIsActually</h4>
743 <b>__whoIsActually</b>(<i>match</i>)
744 <p>
745 Private method to handle the WHOIS actually reply.
746 </p><dl>
747 <dt><i>match</i></dt>
748 <dd>
749 match object that matched the pattern
750 </dd>
751 </dl><dl>
752 <dt>Returns:</dt>
753 <dd>
754 flag indicating whether the message was handled (boolean)
755 </dd>
756 </dl><a NAME="IrcChannelWidget.__whoIsChannels" ID="IrcChannelWidget.__whoIsChannels"></a>
757 <h4>IrcChannelWidget.__whoIsChannels</h4>
758 <b>__whoIsChannels</b>(<i>match</i>)
759 <p>
760 Private method to handle the WHOIS channels reply.
761 </p><dl>
762 <dt><i>match</i></dt>
763 <dd>
764 match object that matched the pattern
765 </dd>
766 </dl><dl>
767 <dt>Returns:</dt>
768 <dd>
769 flag indicating whether the message was handled (boolean)
770 </dd>
771 </dl><a NAME="IrcChannelWidget.__whoIsConnection" ID="IrcChannelWidget.__whoIsConnection"></a>
772 <h4>IrcChannelWidget.__whoIsConnection</h4>
773 <b>__whoIsConnection</b>(<i>match</i>)
774 <p>
775 Private method to handle the WHOIS connection reply.
776 </p><dl>
777 <dt><i>match</i></dt>
778 <dd>
779 match object that matched the pattern
780 </dd>
781 </dl><dl>
782 <dt>Returns:</dt>
783 <dd>
784 flag indicating whether the message was handled (boolean)
785 </dd>
786 </dl><a NAME="IrcChannelWidget.__whoIsEnd" ID="IrcChannelWidget.__whoIsEnd"></a>
787 <h4>IrcChannelWidget.__whoIsEnd</h4>
788 <b>__whoIsEnd</b>(<i>match</i>)
789 <p>
790 Private method to handle the end of WHOIS reply.
791 </p><dl>
792 <dt><i>match</i></dt>
793 <dd>
794 match object that matched the pattern
795 </dd>
796 </dl><dl>
797 <dt>Returns:</dt>
798 <dd>
799 flag indicating whether the message was handled (boolean)
800 </dd>
801 </dl><a NAME="IrcChannelWidget.__whoIsHelper" ID="IrcChannelWidget.__whoIsHelper"></a>
802 <h4>IrcChannelWidget.__whoIsHelper</h4>
803 <b>__whoIsHelper</b>(<i>match</i>)
804 <p>
805 Private method to handle the WHOIS helper reply.
806 </p><dl>
807 <dt><i>match</i></dt>
808 <dd>
809 match object that matched the pattern
810 </dd>
811 </dl><dl>
812 <dt>Returns:</dt>
813 <dd>
814 flag indicating whether the message was handled (boolean)
815 </dd>
816 </dl><a NAME="IrcChannelWidget.__whoIsIdentify" ID="IrcChannelWidget.__whoIsIdentify"></a>
817 <h4>IrcChannelWidget.__whoIsIdentify</h4>
818 <b>__whoIsIdentify</b>(<i>match</i>)
819 <p>
820 Private method to handle the WHOIS identify and identified replies.
821 </p><dl>
822 <dt><i>match</i></dt>
823 <dd>
824 match object that matched the pattern
825 </dd>
826 </dl><dl>
827 <dt>Returns:</dt>
828 <dd>
829 flag indicating whether the message was handled (boolean)
830 </dd>
831 </dl><a NAME="IrcChannelWidget.__whoIsIdle" ID="IrcChannelWidget.__whoIsIdle"></a>
832 <h4>IrcChannelWidget.__whoIsIdle</h4>
833 <b>__whoIsIdle</b>(<i>match</i>)
834 <p>
835 Private method to handle the WHOIS idle reply.
836 </p><dl>
837 <dt><i>match</i></dt>
838 <dd>
839 match object that matched the pattern
840 </dd>
841 </dl><dl>
842 <dt>Returns:</dt>
843 <dd>
844 flag indicating whether the message was handled (boolean)
845 </dd>
846 </dl><a NAME="IrcChannelWidget.__whoIsOperator" ID="IrcChannelWidget.__whoIsOperator"></a>
847 <h4>IrcChannelWidget.__whoIsOperator</h4>
848 <b>__whoIsOperator</b>(<i>match</i>)
849 <p>
850 Private method to handle the WHOIS operator reply.
851 </p><dl>
852 <dt><i>match</i></dt>
853 <dd>
854 match object that matched the pattern
855 </dd>
856 </dl><dl>
857 <dt>Returns:</dt>
858 <dd>
859 flag indicating whether the message was handled (boolean)
860 </dd>
861 </dl><a NAME="IrcChannelWidget.__whoIsSecure" ID="IrcChannelWidget.__whoIsSecure"></a>
862 <h4>IrcChannelWidget.__whoIsSecure</h4>
863 <b>__whoIsSecure</b>(<i>match</i>)
864 <p>
865 Private method to handle the WHOIS secure reply.
866 </p><dl>
867 <dt><i>match</i></dt>
868 <dd>
869 match object that matched the pattern
870 </dd>
871 </dl><dl>
872 <dt>Returns:</dt>
873 <dd>
874 flag indicating whether the message was handled (boolean)
875 </dd>
876 </dl><a NAME="IrcChannelWidget.__whoIsServer" ID="IrcChannelWidget.__whoIsServer"></a>
877 <h4>IrcChannelWidget.__whoIsServer</h4>
878 <b>__whoIsServer</b>(<i>match</i>)
879 <p>
880 Private method to handle the WHOIS server reply.
881 </p><dl>
882 <dt><i>match</i></dt>
883 <dd>
884 match object that matched the pattern
885 </dd>
886 </dl><dl>
887 <dt>Returns:</dt>
888 <dd>
889 flag indicating whether the message was handled (boolean)
890 </dd>
891 </dl><a NAME="IrcChannelWidget.__whoIsUser" ID="IrcChannelWidget.__whoIsUser"></a>
892 <h4>IrcChannelWidget.__whoIsUser</h4>
893 <b>__whoIsUser</b>(<i>match</i>)
894 <p>
895 Private method to handle the WHOIS user reply.
896 </p><dl>
897 <dt><i>match</i></dt>
898 <dd>
899 match object that matched the pattern
900 </dd>
901 </dl><dl>
902 <dt>Returns:</dt>
903 <dd>
904 flag indicating whether the message was handled (boolean)
905 </dd>
906 </dl><a NAME="IrcChannelWidget.addMessage" ID="IrcChannelWidget.addMessage"></a>
907 <h4>IrcChannelWidget.addMessage</h4>
908 <b>addMessage</b>(<i>sender, msg</i>)
909 <p>
910 Public method to add a message from external.
911 </p><dl>
912 <dt><i>sender</i></dt>
913 <dd>
914 nick name of the sender (string)
915 </dd><dt><i>msg</i></dt>
916 <dd>
917 message received from sender (string)
918 </dd>
919 </dl><a NAME="IrcChannelWidget.addUsers" ID="IrcChannelWidget.addUsers"></a>
920 <h4>IrcChannelWidget.addUsers</h4>
921 <b>addUsers</b>(<i>users</i>)
922 <p>
923 Public method to add users to the channel.
924 </p><dl>
925 <dt><i>users</i></dt>
926 <dd>
927 list of user names to add (list of string)
928 </dd>
929 </dl><a NAME="IrcChannelWidget.getUsersCount" ID="IrcChannelWidget.getUsersCount"></a>
930 <h4>IrcChannelWidget.getUsersCount</h4>
931 <b>getUsersCount</b>(<i></i>)
932 <p>
933 Public method to get the users count of the channel.
934 </p><dl>
935 <dt>Returns:</dt>
936 <dd>
937 users count of the channel (integer)
938 </dd>
939 </dl><a NAME="IrcChannelWidget.handleMessage" ID="IrcChannelWidget.handleMessage"></a>
940 <h4>IrcChannelWidget.handleMessage</h4>
941 <b>handleMessage</b>(<i>line</i>)
942 <p>
943 Public method to handle the message sent by the server.
944 </p><dl>
945 <dt><i>line</i></dt>
946 <dd>
947 server message (string)
948 </dd>
949 </dl><dl>
950 <dt>Returns:</dt>
951 <dd>
952 flag indicating, if the message was handled (boolean)
953 </dd>
954 </dl><a NAME="IrcChannelWidget.hideEvent" ID="IrcChannelWidget.hideEvent"></a>
955 <h4>IrcChannelWidget.hideEvent</h4>
956 <b>hideEvent</b>(<i>evt</i>)
957 <p>
958 Protected method handling hide events.
959 </p><dl>
960 <dt><i>evt</i></dt>
961 <dd>
962 reference to the hide event (QHideEvent)
963 </dd>
964 </dl><a NAME="IrcChannelWidget.initAutoWho" ID="IrcChannelWidget.initAutoWho"></a>
965 <h4>IrcChannelWidget.initAutoWho</h4>
966 <b>initAutoWho</b>(<i></i>)
967 <p>
968 Public method to initialize the Auto Who system.
969 </p><a NAME="IrcChannelWidget.name" ID="IrcChannelWidget.name"></a>
970 <h4>IrcChannelWidget.name</h4>
971 <b>name</b>(<i></i>)
972 <p>
973 Public method to get the name of the channel.
974 </p><dl>
975 <dt>Returns:</dt>
976 <dd>
977 name of the channel (string)
978 </dd>
979 </dl><a NAME="IrcChannelWidget.on_editTopicButton_clicked" ID="IrcChannelWidget.on_editTopicButton_clicked"></a>
980 <h4>IrcChannelWidget.on_editTopicButton_clicked</h4>
981 <b>on_editTopicButton_clicked</b>(<i></i>)
982 <p>
983 Private slot to change the topic of the channel.
984 </p><a NAME="IrcChannelWidget.on_messageEdit_returnPressed" ID="IrcChannelWidget.on_messageEdit_returnPressed"></a>
985 <h4>IrcChannelWidget.on_messageEdit_returnPressed</h4>
986 <b>on_messageEdit_returnPressed</b>(<i></i>)
987 <p>
988 Private slot to send a message to the channel.
989 </p><a NAME="IrcChannelWidget.on_messages_anchorClicked" ID="IrcChannelWidget.on_messages_anchorClicked"></a>
990 <h4>IrcChannelWidget.on_messages_anchorClicked</h4>
991 <b>on_messages_anchorClicked</b>(<i>url</i>)
992 <p>
993 Private slot to open links in the default browser.
994 </p><dl>
995 <dt><i>url</i></dt>
996 <dd>
997 URL to be opened (QUrl)
998 </dd>
999 </dl><a NAME="IrcChannelWidget.on_messages_copyAvailable" ID="IrcChannelWidget.on_messages_copyAvailable"></a>
1000 <h4>IrcChannelWidget.on_messages_copyAvailable</h4>
1001 <b>on_messages_copyAvailable</b>(<i>yes</i>)
1002 <p>
1003 Private slot to react to text selection/deselection of the messages
1004 edit.
1005 </p><dl>
1006 <dt><i>yes</i></dt>
1007 <dd>
1008 flag signaling the availability of selected text (boolean)
1009 </dd>
1010 </dl><a NAME="IrcChannelWidget.on_messages_customContextMenuRequested" ID="IrcChannelWidget.on_messages_customContextMenuRequested"></a>
1011 <h4>IrcChannelWidget.on_messages_customContextMenuRequested</h4>
1012 <b>on_messages_customContextMenuRequested</b>(<i>pos</i>)
1013 <p>
1014 Private slot to show the context menu of the messages pane.
1015 </p><dl>
1016 <dt><i>pos</i></dt>
1017 <dd>
1018 the position of the mouse pointer (QPoint)
1019 </dd>
1020 </dl><a NAME="IrcChannelWidget.on_usersList_customContextMenuRequested" ID="IrcChannelWidget.on_usersList_customContextMenuRequested"></a>
1021 <h4>IrcChannelWidget.on_usersList_customContextMenuRequested</h4>
1022 <b>on_usersList_customContextMenuRequested</b>(<i>pos</i>)
1023 <p>
1024 Private slot to show the context menu of the users list.
1025 </p><dl>
1026 <dt><i>pos</i></dt>
1027 <dd>
1028 the position of the mouse pointer (QPoint)
1029 </dd>
1030 </dl><a NAME="IrcChannelWidget.partMessage" ID="IrcChannelWidget.partMessage"></a>
1031 <h4>IrcChannelWidget.partMessage</h4>
1032 <b>partMessage</b>(<i></i>)
1033 <p>
1034 Public method to get the part message.
1035 </p><dl>
1036 <dt>Returns:</dt>
1037 <dd>
1038 part message (string)
1039 </dd>
1040 </dl><a NAME="IrcChannelWidget.requestLeave" ID="IrcChannelWidget.requestLeave"></a>
1041 <h4>IrcChannelWidget.requestLeave</h4>
1042 <b>requestLeave</b>(<i></i>)
1043 <p>
1044 Public method to leave the channel.
1045 </p><a NAME="IrcChannelWidget.setMarkerLine" ID="IrcChannelWidget.setMarkerLine"></a>
1046 <h4>IrcChannelWidget.setMarkerLine</h4>
1047 <b>setMarkerLine</b>(<i></i>)
1048 <p>
1049 Public method to draw a line to mark the current position.
1050 </p><a NAME="IrcChannelWidget.setName" ID="IrcChannelWidget.setName"></a>
1051 <h4>IrcChannelWidget.setName</h4>
1052 <b>setName</b>(<i>name</i>)
1053 <p>
1054 Public method to set the name of the channel.
1055 </p><dl>
1056 <dt><i>name</i></dt>
1057 <dd>
1058 of the channel (string)
1059 </dd>
1060 </dl><a NAME="IrcChannelWidget.setPartMessage" ID="IrcChannelWidget.setPartMessage"></a>
1061 <h4>IrcChannelWidget.setPartMessage</h4>
1062 <b>setPartMessage</b>(<i>message</i>)
1063 <p>
1064 Public method to set the part message.
1065 </p><dl>
1066 <dt><i>message</i></dt>
1067 <dd>
1068 message to be used for PART messages (string)
1069 </dd>
1070 </dl><a NAME="IrcChannelWidget.setPrivate" ID="IrcChannelWidget.setPrivate"></a>
1071 <h4>IrcChannelWidget.setPrivate</h4>
1072 <b>setPrivate</b>(<i>private, partner=""</i>)
1073 <p>
1074 Public method to set the private chat mode.
1075 </p><dl>
1076 <dt><i>private</i></dt>
1077 <dd>
1078 flag indicating private chat mode (boolean)
1079 </dd><dt><i>partner</i></dt>
1080 <dd>
1081 name of the partner user (string)
1082 </dd>
1083 </dl><a NAME="IrcChannelWidget.setPrivateInfo" ID="IrcChannelWidget.setPrivateInfo"></a>
1084 <h4>IrcChannelWidget.setPrivateInfo</h4>
1085 <b>setPrivateInfo</b>(<i>infoText</i>)
1086 <p>
1087 Public method to set some info text for private chat mode.
1088 </p><dl>
1089 <dt><i>infoText</i></dt>
1090 <dd>
1091 info text to be shown (string)
1092 </dd>
1093 </dl><a NAME="IrcChannelWidget.setUserName" ID="IrcChannelWidget.setUserName"></a>
1094 <h4>IrcChannelWidget.setUserName</h4>
1095 <b>setUserName</b>(<i>name</i>)
1096 <p>
1097 Public method to set the user name for the channel.
1098 </p><dl>
1099 <dt><i>name</i></dt>
1100 <dd>
1101 user name for the channel (string)
1102 </dd>
1103 </dl><a NAME="IrcChannelWidget.setUserPrivilegePrefix" ID="IrcChannelWidget.setUserPrivilegePrefix"></a>
1104 <h4>IrcChannelWidget.setUserPrivilegePrefix</h4>
1105 <b>setUserPrivilegePrefix</b>(<i>prefixes</i>)
1106 <p>
1107 Public method to set the user privilege to prefix mapping.
1108 </p><dl>
1109 <dt><i>prefixes</i></dt>
1110 <dd>
1111 dictionary with privilege as key and prefix as value
1112 </dd>
1113 </dl><a NAME="IrcChannelWidget.showEvent" ID="IrcChannelWidget.showEvent"></a>
1114 <h4>IrcChannelWidget.showEvent</h4>
1115 <b>showEvent</b>(<i>evt</i>)
1116 <p>
1117 Protected method handling show events.
1118 </p><dl>
1119 <dt><i>evt</i></dt>
1120 <dd>
1121 reference to the show event (QShowEvent)
1122 </dd>
1123 </dl><a NAME="IrcChannelWidget.unsetMarkerLine" ID="IrcChannelWidget.unsetMarkerLine"></a>
1124 <h4>IrcChannelWidget.unsetMarkerLine</h4>
1125 <b>unsetMarkerLine</b>(<i></i>)
1126 <p>
1127 Public method to remove the marker line.
1128 </p><a NAME="IrcChannelWidget.userName" ID="IrcChannelWidget.userName"></a>
1129 <h4>IrcChannelWidget.userName</h4>
1130 <b>userName</b>(<i></i>)
1131 <p>
1132 Public method to get the nick name of the user.
1133 </p><dl>
1134 <dt>Returns:</dt>
1135 <dd>
1136 nick name of the user (string)
1137 </dd>
1138 </dl>
1139 <div align="right"><a href="#top">Up</a></div>
1140 <hr /><hr />
1141 <a NAME="IrcUserItem" ID="IrcUserItem"></a>
1142 <h2>IrcUserItem</h2>
1143 <p>
1144 Class implementing a list widget item containing an IRC channel user.
1145 </p>
1146 <h3>Derived from</h3>
1147 QListWidgetItem
1148 <h3>Class Attributes</h3>
1149 <table>
1150 <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>
1151 </table>
1152 <h3>Class Methods</h3>
1153 <table>
1154 <tr><td>None</td></tr>
1155 </table>
1156 <h3>Methods</h3>
1157 <table>
1158 <tr>
1159 <td><a href="#IrcUserItem.__init__">IrcUserItem</a></td>
1160 <td>Constructor</td>
1161 </tr><tr>
1162 <td><a href="#IrcUserItem.__awayIcon">__awayIcon</a></td>
1163 <td>Private method to convert an icon to an away icon.</td>
1164 </tr><tr>
1165 <td><a href="#IrcUserItem.__setIcon">__setIcon</a></td>
1166 <td>Private method to set the icon dependent on user privileges.</td>
1167 </tr><tr>
1168 <td><a href="#IrcUserItem.canChangeTopic">canChangeTopic</a></td>
1169 <td>Public method to check, if the user is allowed to change the topic.</td>
1170 </tr><tr>
1171 <td><a href="#IrcUserItem.changePrivilege">changePrivilege</a></td>
1172 <td>Public method to set or unset a user privilege.</td>
1173 </tr><tr>
1174 <td><a href="#IrcUserItem.clearPrivileges">clearPrivileges</a></td>
1175 <td>Public method to clear the user privileges.</td>
1176 </tr><tr>
1177 <td><a href="#IrcUserItem.name">name</a></td>
1178 <td>Public method to get the user name.</td>
1179 </tr><tr>
1180 <td><a href="#IrcUserItem.parseWhoFlags">parseWhoFlags</a></td>
1181 <td>Public method to parse the user flags reported by a WHO command.</td>
1182 </tr><tr>
1183 <td><a href="#IrcUserItem.setName">setName</a></td>
1184 <td>Public method to set a new nick name.</td>
1185 </tr>
1186 </table>
1187 <h3>Static Methods</h3>
1188 <table>
1189 <tr><td>None</td></tr>
1190 </table>
1191 <a NAME="IrcUserItem.__init__" ID="IrcUserItem.__init__"></a>
1192 <h4>IrcUserItem (Constructor)</h4>
1193 <b>IrcUserItem</b>(<i>name, parent=None</i>)
1194 <p>
1195 Constructor
1196 </p><dl>
1197 <dt><i>name</i></dt>
1198 <dd>
1199 string with user name and privilege prefix (string)
1200 </dd><dt><i>parent</i></dt>
1201 <dd>
1202 reference to the parent widget (QListWidget or
1203 QListWidgetItem)
1204 </dd>
1205 </dl><a NAME="IrcUserItem.__awayIcon" ID="IrcUserItem.__awayIcon"></a>
1206 <h4>IrcUserItem.__awayIcon</h4>
1207 <b>__awayIcon</b>(<i>icon</i>)
1208 <p>
1209 Private method to convert an icon to an away icon.
1210 </p><dl>
1211 <dt><i>icon</i></dt>
1212 <dd>
1213 icon to be converted (QIcon)
1214 </dd>
1215 </dl><dl>
1216 <dt>Returns:</dt>
1217 <dd>
1218 away icon (QIcon)
1219 </dd>
1220 </dl><a NAME="IrcUserItem.__setIcon" ID="IrcUserItem.__setIcon"></a>
1221 <h4>IrcUserItem.__setIcon</h4>
1222 <b>__setIcon</b>(<i></i>)
1223 <p>
1224 Private method to set the icon dependent on user privileges.
1225 </p><a NAME="IrcUserItem.canChangeTopic" ID="IrcUserItem.canChangeTopic"></a>
1226 <h4>IrcUserItem.canChangeTopic</h4>
1227 <b>canChangeTopic</b>(<i></i>)
1228 <p>
1229 Public method to check, if the user is allowed to change the topic.
1230 </p><dl>
1231 <dt>Returns:</dt>
1232 <dd>
1233 flag indicating that the topic can be changed (boolean)
1234 </dd>
1235 </dl><a NAME="IrcUserItem.changePrivilege" ID="IrcUserItem.changePrivilege"></a>
1236 <h4>IrcUserItem.changePrivilege</h4>
1237 <b>changePrivilege</b>(<i>privilege</i>)
1238 <p>
1239 Public method to set or unset a user privilege.
1240 </p><dl>
1241 <dt><i>privilege</i></dt>
1242 <dd>
1243 privilege to set or unset (string)
1244 </dd>
1245 </dl><a NAME="IrcUserItem.clearPrivileges" ID="IrcUserItem.clearPrivileges"></a>
1246 <h4>IrcUserItem.clearPrivileges</h4>
1247 <b>clearPrivileges</b>(<i></i>)
1248 <p>
1249 Public method to clear the user privileges.
1250 </p><a NAME="IrcUserItem.name" ID="IrcUserItem.name"></a>
1251 <h4>IrcUserItem.name</h4>
1252 <b>name</b>(<i></i>)
1253 <p>
1254 Public method to get the user name.
1255 </p><dl>
1256 <dt>Returns:</dt>
1257 <dd>
1258 user name (string)
1259 </dd>
1260 </dl><a NAME="IrcUserItem.parseWhoFlags" ID="IrcUserItem.parseWhoFlags"></a>
1261 <h4>IrcUserItem.parseWhoFlags</h4>
1262 <b>parseWhoFlags</b>(<i>flags</i>)
1263 <p>
1264 Public method to parse the user flags reported by a WHO command.
1265 </p><dl>
1266 <dt><i>flags</i></dt>
1267 <dd>
1268 user flags as reported by WHO (string)
1269 </dd>
1270 </dl><a NAME="IrcUserItem.setName" ID="IrcUserItem.setName"></a>
1271 <h4>IrcUserItem.setName</h4>
1272 <b>setName</b>(<i>name</i>)
1273 <p>
1274 Public method to set a new nick name.
1275 </p><dl>
1276 <dt><i>name</i></dt>
1277 <dd>
1278 new nick name for the user (string)
1279 </dd>
1280 </dl>
1281 <div align="right"><a href="#top">Up</a></div>
1282 <hr />
1283 </body></html>

Mercurial Repository: eric

eric ide

mercurial