Mercurial Repositories > eric / file comparison

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

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

changeset 2266
f885a0bc2ccc
child 2271
7dd914b6eb7d
equal deleted inserted replaced
2265:72e6f479987b 2266:f885a0bc2ccc
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Network.IRC.IrcChannelWidget</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Network.IRC.IrcChannelWidget</h1>
24 <p>
25 Module implementing the IRC channel widget.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#IrcChannelWidget">IrcChannelWidget</a></td>
35 <td>Class implementing the IRC channel widget.</td>
36 </tr><tr>
37 <td><a href="#IrcUserItem">IrcUserItem</a></td>
38 <td>Class implementing a list widget item containing an IRC channel user.</td>
39 </tr>
40 </table>
41 <h3>Functions</h3>
42 <table>
43 <tr><td>None</td></tr>
44 </table>
45 <hr /><hr />
46 <a NAME="IrcChannelWidget" ID="IrcChannelWidget"></a>
47 <h2>IrcChannelWidget</h2>
48 <p>
49 Class implementing the IRC channel widget.
50 </p><h3>Signals</h3>
51 <dl>
52 <dt>channelClosed(str)</dt>
53 <dd>
54 emitted after the user has left the channel
55 </dd><dt>openPrivateChat(str)</dt>
56 <dd>
57 emitted to open a "channel" for private 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.__cutMessages">__cutMessages</a></td>
113 <td>Private slot to cut the selection of the messages display to the clipboard.</td>
114 </tr><tr>
115 <td><a href="#IrcChannelWidget.__extractPrivilege">__extractPrivilege</a></td>
116 <td>Private method to extract the user privileges out of the name.</td>
117 </tr><tr>
118 <td><a href="#IrcChannelWidget.__findUser">__findUser</a></td>
119 <td>Private method to find the user in the list of users.</td>
120 </tr><tr>
121 <td><a href="#IrcChannelWidget.__handleCtcp">__handleCtcp</a></td>
122 <td>Private method to handle a CTCP channel command.</td>
123 </tr><tr>
124 <td><a href="#IrcChannelWidget.__help">__help</a></td>
125 <td>Private method to handle a help message.</td>
126 </tr><tr>
127 <td><a href="#IrcChannelWidget.__ignore">__ignore</a></td>
128 <td>Private method to handle a channel message we are not interested in.</td>
129 </tr><tr>
130 <td><a href="#IrcChannelWidget.__initMessagesMenu">__initMessagesMenu</a></td>
131 <td>Private slot to initialize the context menu of the messages pane.</td>
132 </tr><tr>
133 <td><a href="#IrcChannelWidget.__initUsersMenu">__initUsersMenu</a></td>
134 <td>Private slot to initialize the users list context menu.</td>
135 </tr><tr>
136 <td><a href="#IrcChannelWidget.__message">__message</a></td>
137 <td>Private method to handle messages to the channel.</td>
138 </tr><tr>
139 <td><a href="#IrcChannelWidget.__openPrivateChat">__openPrivateChat</a></td>
140 <td>Private slot to open a chat with the selected user.</td>
141 </tr><tr>
142 <td><a href="#IrcChannelWidget.__saveMessages">__saveMessages</a></td>
143 <td>Private slot to save the contents of the messages display.</td>
144 </tr><tr>
145 <td><a href="#IrcChannelWidget.__sendAutoWhoCommand">__sendAutoWhoCommand</a></td>
146 <td>Private slot to send the WHO command to update the users list.</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_messageEdit_returnPressed">on_messageEdit_returnPressed</a></td>
245 <td>Private slot to send a message to the channel.</td>
246 </tr><tr>
247 <td><a href="#IrcChannelWidget.on_messages_copyAvailable">on_messages_copyAvailable</a></td>
248 <td>Private slot to react to text selection/deselection of the messages edit.</td>
249 </tr><tr>
250 <td><a href="#IrcChannelWidget.on_messages_customContextMenuRequested">on_messages_customContextMenuRequested</a></td>
251 <td>Private slot to show the context menu of the messages pane.</td>
252 </tr><tr>
253 <td><a href="#IrcChannelWidget.on_usersList_customContextMenuRequested">on_usersList_customContextMenuRequested</a></td>
254 <td>Private slot to show the context menu of the users list.</td>
255 </tr><tr>
256 <td><a href="#IrcChannelWidget.partMessage">partMessage</a></td>
257 <td>Public method to get the part message.</td>
258 </tr><tr>
259 <td><a href="#IrcChannelWidget.requestLeave">requestLeave</a></td>
260 <td>Public method to leave the channel.</td>
261 </tr><tr>
262 <td><a href="#IrcChannelWidget.setMarkerLine">setMarkerLine</a></td>
263 <td>Public method to draw a line to mark the current position.</td>
264 </tr><tr>
265 <td><a href="#IrcChannelWidget.setName">setName</a></td>
266 <td>Public method to set the name of the channel.</td>
267 </tr><tr>
268 <td><a href="#IrcChannelWidget.setPartMessage">setPartMessage</a></td>
269 <td>Public method to set the part message.</td>
270 </tr><tr>
271 <td><a href="#IrcChannelWidget.setPrivate">setPrivate</a></td>
272 <td>Public method to set the private chat mode.</td>
273 </tr><tr>
274 <td><a href="#IrcChannelWidget.setPrivateInfo">setPrivateInfo</a></td>
275 <td>Public method to set some info text for private chat mode.</td>
276 </tr><tr>
277 <td><a href="#IrcChannelWidget.setUserName">setUserName</a></td>
278 <td>Public method to set the user name for the channel.</td>
279 </tr><tr>
280 <td><a href="#IrcChannelWidget.setUserPrivilegePrefix">setUserPrivilegePrefix</a></td>
281 <td>Public method to set the user privilege to prefix mapping.</td>
282 </tr><tr>
283 <td><a href="#IrcChannelWidget.showEvent">showEvent</a></td>
284 <td>Protected method handling show events.</td>
285 </tr><tr>
286 <td><a href="#IrcChannelWidget.unsetMarkerLine">unsetMarkerLine</a></td>
287 <td>Public method to remove the marker line.</td>
288 </tr><tr>
289 <td><a href="#IrcChannelWidget.userName">userName</a></td>
290 <td>Public method to get the nick name of the user.</td>
291 </tr>
292 </table>
293 <h3>Static Methods</h3>
294 <table>
295 <tr><td>None</td></tr>
296 </table>
297 <a NAME="IrcChannelWidget.__init__" ID="IrcChannelWidget.__init__"></a>
298 <h4>IrcChannelWidget (Constructor)</h4>
299 <b>IrcChannelWidget</b>(<i>parent=None</i>)
300 <p>
301 Constructor
302 </p><dl>
303 <dt><i>parent</i></dt>
304 <dd>
305 reference to the parent widget (QWidget)
306 </dd>
307 </dl><a NAME="IrcChannelWidget.__addManagementMessage" ID="IrcChannelWidget.__addManagementMessage"></a>
308 <h4>IrcChannelWidget.__addManagementMessage</h4>
309 <b>__addManagementMessage</b>(<i>indicator, message</i>)
310 <p>
311 Private method to add a channel management message to the list.
312 </p><dl>
313 <dt><i>indicator</i></dt>
314 <dd>
315 indicator to be shown (string)
316 </dd><dt><i>message</i></dt>
317 <dd>
318 message to be shown (string)
319 </dd><dt><i>isLocal=</i></dt>
320 <dd>
321 flag indicating a message related to the local user (boolean)
322 </dd>
323 </dl><a NAME="IrcChannelWidget.__appendMessage" ID="IrcChannelWidget.__appendMessage"></a>
324 <h4>IrcChannelWidget.__appendMessage</h4>
325 <b>__appendMessage</b>(<i>message</i>)
326 <p>
327 Private slot to append a message.
328 </p><a NAME="IrcChannelWidget.__autoWhoEntry" ID="IrcChannelWidget.__autoWhoEntry"></a>
329 <h4>IrcChannelWidget.__autoWhoEntry</h4>
330 <b>__autoWhoEntry</b>(<i>match</i>)
331 <p>
332 Private method to handle a WHO entry returned by the server as requested
333 automatically.
334 </p><dl>
335 <dt><i>match</i></dt>
336 <dd>
337 match object that matched the pattern
338 </dd>
339 </dl><dl>
340 <dt>Returns:</dt>
341 <dd>
342 flag indicating whether the message was handled (boolean)
343 </dd>
344 </dl><a NAME="IrcChannelWidget.__channelCreated" ID="IrcChannelWidget.__channelCreated"></a>
345 <h4>IrcChannelWidget.__channelCreated</h4>
346 <b>__channelCreated</b>(<i>match</i>)
347 <p>
348 Private method to handle a channel created message.
349 </p><dl>
350 <dt><i>match</i></dt>
351 <dd>
352 match object that matched the pattern
353 </dd>
354 </dl><dl>
355 <dt>Returns:</dt>
356 <dd>
357 flag indicating whether the message was handled (boolean)
358 </dd>
359 </dl><a NAME="IrcChannelWidget.__channelModes" ID="IrcChannelWidget.__channelModes"></a>
360 <h4>IrcChannelWidget.__channelModes</h4>
361 <b>__channelModes</b>(<i>match</i>)
362 <p>
363 Private method to handle a message reporting the channel modes.
364 </p><dl>
365 <dt><i>match</i></dt>
366 <dd>
367 match object that matched the pattern
368 </dd>
369 </dl><dl>
370 <dt>Returns:</dt>
371 <dd>
372 flag indicating whether the message was handled (boolean)
373 </dd>
374 </dl><a NAME="IrcChannelWidget.__channelUrl" ID="IrcChannelWidget.__channelUrl"></a>
375 <h4>IrcChannelWidget.__channelUrl</h4>
376 <b>__channelUrl</b>(<i>match</i>)
377 <p>
378 Private method to handle a channel URL message.
379 </p><dl>
380 <dt><i>match</i></dt>
381 <dd>
382 match object that matched the pattern
383 </dd>
384 </dl><dl>
385 <dt>Returns:</dt>
386 <dd>
387 flag indicating whether the message was handled (boolean)
388 </dd>
389 </dl><a NAME="IrcChannelWidget.__clearMessages" ID="IrcChannelWidget.__clearMessages"></a>
390 <h4>IrcChannelWidget.__clearMessages</h4>
391 <b>__clearMessages</b>(<i></i>)
392 <p>
393 Private slot to clear the contents of the messages display.
394 </p><a NAME="IrcChannelWidget.__copyAllMessages" ID="IrcChannelWidget.__copyAllMessages"></a>
395 <h4>IrcChannelWidget.__copyAllMessages</h4>
396 <b>__copyAllMessages</b>(<i></i>)
397 <p>
398 Private slot to copy the contents of the messages display to the clipboard.
399 </p><a NAME="IrcChannelWidget.__copyMessages" ID="IrcChannelWidget.__copyMessages"></a>
400 <h4>IrcChannelWidget.__copyMessages</h4>
401 <b>__copyMessages</b>(<i></i>)
402 <p>
403 Private slot to copy the selection of the messages display to the clipboard.
404 </p><a NAME="IrcChannelWidget.__cutAllMessages" ID="IrcChannelWidget.__cutAllMessages"></a>
405 <h4>IrcChannelWidget.__cutAllMessages</h4>
406 <b>__cutAllMessages</b>(<i></i>)
407 <p>
408 Private slot to cut the contents of the messages display to the clipboard.
409 </p><a NAME="IrcChannelWidget.__cutMessages" ID="IrcChannelWidget.__cutMessages"></a>
410 <h4>IrcChannelWidget.__cutMessages</h4>
411 <b>__cutMessages</b>(<i></i>)
412 <p>
413 Private slot to cut the selection of the messages display to the clipboard.
414 </p><a NAME="IrcChannelWidget.__extractPrivilege" ID="IrcChannelWidget.__extractPrivilege"></a>
415 <h4>IrcChannelWidget.__extractPrivilege</h4>
416 <b>__extractPrivilege</b>(<i>name</i>)
417 <p>
418 Private method to extract the user privileges out of the name.
419 </p><dl>
420 <dt><i>name</i></dt>
421 <dd>
422 user name and prefixes (string)
423 return list of privileges and user name (list of string, string)
424 </dd>
425 </dl><a NAME="IrcChannelWidget.__findUser" ID="IrcChannelWidget.__findUser"></a>
426 <h4>IrcChannelWidget.__findUser</h4>
427 <b>__findUser</b>(<i>name</i>)
428 <p>
429 Private method to find the user in the list of users.
430 </p><dl>
431 <dt><i>name</i></dt>
432 <dd>
433 user name to search for (string)
434 </dd>
435 </dl><dl>
436 <dt>Returns:</dt>
437 <dd>
438 reference to the list entry (QListWidgetItem)
439 </dd>
440 </dl><a NAME="IrcChannelWidget.__handleCtcp" ID="IrcChannelWidget.__handleCtcp"></a>
441 <h4>IrcChannelWidget.__handleCtcp</h4>
442 <b>__handleCtcp</b>(<i>match</i>)
443 <p>
444 Private method to handle a CTCP channel command.
445 </p><dl>
446 <dt><i>reference</i></dt>
447 <dd>
448 to the match object
449 </dd>
450 </dl><dl>
451 <dt>Returns:</dt>
452 <dd>
453 flag indicating, if the message was handled (boolean)
454 </dd>
455 </dl><a NAME="IrcChannelWidget.__help" ID="IrcChannelWidget.__help"></a>
456 <h4>IrcChannelWidget.__help</h4>
457 <b>__help</b>(<i>match</i>)
458 <p>
459 Private method to handle a help message.
460 </p><dl>
461 <dt><i>match</i></dt>
462 <dd>
463 match object that matched the pattern
464 </dd>
465 </dl><dl>
466 <dt>Returns:</dt>
467 <dd>
468 flag indicating whether the message was handled (boolean)
469 </dd>
470 </dl><a NAME="IrcChannelWidget.__ignore" ID="IrcChannelWidget.__ignore"></a>
471 <h4>IrcChannelWidget.__ignore</h4>
472 <b>__ignore</b>(<i>match</i>)
473 <p>
474 Private method to handle a channel message we are not interested in.
475 </p><dl>
476 <dt><i>match</i></dt>
477 <dd>
478 match object that matched the pattern
479 </dd>
480 </dl><dl>
481 <dt>Returns:</dt>
482 <dd>
483 flag indicating whether the message was handled (boolean)
484 </dd>
485 </dl><a NAME="IrcChannelWidget.__initMessagesMenu" ID="IrcChannelWidget.__initMessagesMenu"></a>
486 <h4>IrcChannelWidget.__initMessagesMenu</h4>
487 <b>__initMessagesMenu</b>(<i></i>)
488 <p>
489 Private slot to initialize the context menu of the messages pane.
490 </p><a NAME="IrcChannelWidget.__initUsersMenu" ID="IrcChannelWidget.__initUsersMenu"></a>
491 <h4>IrcChannelWidget.__initUsersMenu</h4>
492 <b>__initUsersMenu</b>(<i></i>)
493 <p>
494 Private slot to initialize the users list context menu.
495 </p><a NAME="IrcChannelWidget.__message" ID="IrcChannelWidget.__message"></a>
496 <h4>IrcChannelWidget.__message</h4>
497 <b>__message</b>(<i>match</i>)
498 <p>
499 Private method to handle messages to the channel.
500 </p><dl>
501 <dt><i>match</i></dt>
502 <dd>
503 match object that matched the pattern
504 </dd>
505 </dl><dl>
506 <dt>Returns:</dt>
507 <dd>
508 flag indicating whether the message was handled (boolean)
509 </dd>
510 </dl><a NAME="IrcChannelWidget.__openPrivateChat" ID="IrcChannelWidget.__openPrivateChat"></a>
511 <h4>IrcChannelWidget.__openPrivateChat</h4>
512 <b>__openPrivateChat</b>(<i></i>)
513 <p>
514 Private slot to open a chat with the selected user.
515 </p><a NAME="IrcChannelWidget.__saveMessages" ID="IrcChannelWidget.__saveMessages"></a>
516 <h4>IrcChannelWidget.__saveMessages</h4>
517 <b>__saveMessages</b>(<i></i>)
518 <p>
519 Private slot to save the contents of the messages display.
520 </p><a NAME="IrcChannelWidget.__sendAutoWhoCommand" ID="IrcChannelWidget.__sendAutoWhoCommand"></a>
521 <h4>IrcChannelWidget.__sendAutoWhoCommand</h4>
522 <b>__sendAutoWhoCommand</b>(<i></i>)
523 <p>
524 Private slot to send the WHO command to update the users list.
525 </p><a NAME="IrcChannelWidget.__setTopic" ID="IrcChannelWidget.__setTopic"></a>
526 <h4>IrcChannelWidget.__setTopic</h4>
527 <b>__setTopic</b>(<i>match</i>)
528 <p>
529 Private method to handle a topic change of the channel.
530 </p><dl>
531 <dt><i>match</i></dt>
532 <dd>
533 match object that matched the pattern
534 </dd>
535 </dl><dl>
536 <dt>Returns:</dt>
537 <dd>
538 flag indicating whether the message was handled (boolean)
539 </dd>
540 </dl><a NAME="IrcChannelWidget.__setUserPrivilege" ID="IrcChannelWidget.__setUserPrivilege"></a>
541 <h4>IrcChannelWidget.__setUserPrivilege</h4>
542 <b>__setUserPrivilege</b>(<i>match</i>)
543 <p>
544 Private method to handle a change of user privileges for 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.__topicCreated" ID="IrcChannelWidget.__topicCreated"></a>
556 <h4>IrcChannelWidget.__topicCreated</h4>
557 <b>__topicCreated</b>(<i>match</i>)
558 <p>
559 Private method to handle a topic created message.
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.__updateChannelModes" ID="IrcChannelWidget.__updateChannelModes"></a>
571 <h4>IrcChannelWidget.__updateChannelModes</h4>
572 <b>__updateChannelModes</b>(<i>match</i>)
573 <p>
574 Private method to handle a message reporting the channel modes.
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.__userAway" ID="IrcChannelWidget.__userAway"></a>
586 <h4>IrcChannelWidget.__userAway</h4>
587 <b>__userAway</b>(<i>match</i>)
588 <p>
589 Private method to handle a topic change of the channel.
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.__userJoin" ID="IrcChannelWidget.__userJoin"></a>
601 <h4>IrcChannelWidget.__userJoin</h4>
602 <b>__userJoin</b>(<i>match</i>)
603 <p>
604 Private method to handle a user joining 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.__userList" ID="IrcChannelWidget.__userList"></a>
616 <h4>IrcChannelWidget.__userList</h4>
617 <b>__userList</b>(<i>match</i>)
618 <p>
619 Private method to handle the receipt of a list of users of 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.__userNickChange" ID="IrcChannelWidget.__userNickChange"></a>
631 <h4>IrcChannelWidget.__userNickChange</h4>
632 <b>__userNickChange</b>(<i>match</i>)
633 <p>
634 Private method to handle a nickname change of a user.
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.__userPart" ID="IrcChannelWidget.__userPart"></a>
646 <h4>IrcChannelWidget.__userPart</h4>
647 <b>__userPart</b>(<i>match</i>)
648 <p>
649 Private method to handle a user leaving the channel.
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.__userQuit" ID="IrcChannelWidget.__userQuit"></a>
661 <h4>IrcChannelWidget.__userQuit</h4>
662 <b>__userQuit</b>(<i>match</i>)
663 <p>
664 Private method to handle a user logging off the server.
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.__whoEnd" ID="IrcChannelWidget.__whoEnd"></a>
676 <h4>IrcChannelWidget.__whoEnd</h4>
677 <b>__whoEnd</b>(<i>match</i>)
678 <p>
679 Private method to handle the end of the WHO list.
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.__whoEntry" ID="IrcChannelWidget.__whoEntry"></a>
691 <h4>IrcChannelWidget.__whoEntry</h4>
692 <b>__whoEntry</b>(<i>match</i>)
693 <p>
694 Private method to handle a WHO entry returned by the server as requested
695 manually.
696 </p><dl>
697 <dt><i>match</i></dt>
698 <dd>
699 match object that matched the pattern
700 </dd>
701 </dl><dl>
702 <dt>Returns:</dt>
703 <dd>
704 flag indicating whether the message was handled (boolean)
705 </dd>
706 </dl><a NAME="IrcChannelWidget.__whoIs" ID="IrcChannelWidget.__whoIs"></a>
707 <h4>IrcChannelWidget.__whoIs</h4>
708 <b>__whoIs</b>(<i></i>)
709 <p>
710 Private slot to get information about the selected user.
711 </p><a NAME="IrcChannelWidget.__whoIsAccount" ID="IrcChannelWidget.__whoIsAccount"></a>
712 <h4>IrcChannelWidget.__whoIsAccount</h4>
713 <b>__whoIsAccount</b>(<i>match</i>)
714 <p>
715 Private method to handle the WHOIS account reply.
716 </p><dl>
717 <dt><i>match</i></dt>
718 <dd>
719 match object that matched the pattern
720 </dd>
721 </dl><dl>
722 <dt>Returns:</dt>
723 <dd>
724 flag indicating whether the message was handled (boolean)
725 </dd>
726 </dl><a NAME="IrcChannelWidget.__whoIsActually" ID="IrcChannelWidget.__whoIsActually"></a>
727 <h4>IrcChannelWidget.__whoIsActually</h4>
728 <b>__whoIsActually</b>(<i>match</i>)
729 <p>
730 Private method to handle the WHOIS actually 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.__whoIsChannels" ID="IrcChannelWidget.__whoIsChannels"></a>
742 <h4>IrcChannelWidget.__whoIsChannels</h4>
743 <b>__whoIsChannels</b>(<i>match</i>)
744 <p>
745 Private method to handle the WHOIS channels 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.__whoIsConnection" ID="IrcChannelWidget.__whoIsConnection"></a>
757 <h4>IrcChannelWidget.__whoIsConnection</h4>
758 <b>__whoIsConnection</b>(<i>match</i>)
759 <p>
760 Private method to handle the WHOIS connection 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.__whoIsEnd" ID="IrcChannelWidget.__whoIsEnd"></a>
772 <h4>IrcChannelWidget.__whoIsEnd</h4>
773 <b>__whoIsEnd</b>(<i>match</i>)
774 <p>
775 Private method to handle the end of WHOIS 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.__whoIsHelper" ID="IrcChannelWidget.__whoIsHelper"></a>
787 <h4>IrcChannelWidget.__whoIsHelper</h4>
788 <b>__whoIsHelper</b>(<i>match</i>)
789 <p>
790 Private method to handle the WHOIS helper 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.__whoIsIdentify" ID="IrcChannelWidget.__whoIsIdentify"></a>
802 <h4>IrcChannelWidget.__whoIsIdentify</h4>
803 <b>__whoIsIdentify</b>(<i>match</i>)
804 <p>
805 Private method to handle the WHOIS identify and identified replies.
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.__whoIsIdle" ID="IrcChannelWidget.__whoIsIdle"></a>
817 <h4>IrcChannelWidget.__whoIsIdle</h4>
818 <b>__whoIsIdle</b>(<i>match</i>)
819 <p>
820 Private method to handle the WHOIS idle reply.
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.__whoIsOperator" ID="IrcChannelWidget.__whoIsOperator"></a>
832 <h4>IrcChannelWidget.__whoIsOperator</h4>
833 <b>__whoIsOperator</b>(<i>match</i>)
834 <p>
835 Private method to handle the WHOIS operator 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.__whoIsSecure" ID="IrcChannelWidget.__whoIsSecure"></a>
847 <h4>IrcChannelWidget.__whoIsSecure</h4>
848 <b>__whoIsSecure</b>(<i>match</i>)
849 <p>
850 Private method to handle the WHOIS secure 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.__whoIsServer" ID="IrcChannelWidget.__whoIsServer"></a>
862 <h4>IrcChannelWidget.__whoIsServer</h4>
863 <b>__whoIsServer</b>(<i>match</i>)
864 <p>
865 Private method to handle the WHOIS server 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.__whoIsUser" ID="IrcChannelWidget.__whoIsUser"></a>
877 <h4>IrcChannelWidget.__whoIsUser</h4>
878 <b>__whoIsUser</b>(<i>match</i>)
879 <p>
880 Private method to handle the WHOIS user 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.addMessage" ID="IrcChannelWidget.addMessage"></a>
892 <h4>IrcChannelWidget.addMessage</h4>
893 <b>addMessage</b>(<i>sender, msg</i>)
894 <p>
895 Public method to add a message from external.
896 </p><dl>
897 <dt><i>sender</i></dt>
898 <dd>
899 nick name of the sender (string)
900 </dd><dt><i>msg</i></dt>
901 <dd>
902 message received from sender (string)
903 </dd>
904 </dl><a NAME="IrcChannelWidget.addUsers" ID="IrcChannelWidget.addUsers"></a>
905 <h4>IrcChannelWidget.addUsers</h4>
906 <b>addUsers</b>(<i>users</i>)
907 <p>
908 Public method to add users to the channel.
909 </p><dl>
910 <dt><i>users</i></dt>
911 <dd>
912 list of user names to add (list of string)
913 </dd>
914 </dl><a NAME="IrcChannelWidget.getUsersCount" ID="IrcChannelWidget.getUsersCount"></a>
915 <h4>IrcChannelWidget.getUsersCount</h4>
916 <b>getUsersCount</b>(<i></i>)
917 <p>
918 Public method to get the users count of the channel.
919 </p><dl>
920 <dt>Returns:</dt>
921 <dd>
922 users count of the channel (integer)
923 </dd>
924 </dl><a NAME="IrcChannelWidget.handleMessage" ID="IrcChannelWidget.handleMessage"></a>
925 <h4>IrcChannelWidget.handleMessage</h4>
926 <b>handleMessage</b>(<i>line</i>)
927 <p>
928 Public method to handle the message sent by the server.
929 </p><dl>
930 <dt><i>line</i></dt>
931 <dd>
932 server message (string)
933 </dd>
934 </dl><dl>
935 <dt>Returns:</dt>
936 <dd>
937 flag indicating, if the message was handled (boolean)
938 </dd>
939 </dl><a NAME="IrcChannelWidget.hideEvent" ID="IrcChannelWidget.hideEvent"></a>
940 <h4>IrcChannelWidget.hideEvent</h4>
941 <b>hideEvent</b>(<i>evt</i>)
942 <p>
943 Protected method handling hide events.
944 </p><dl>
945 <dt><i>evt</i></dt>
946 <dd>
947 reference to the hide event (QHideEvent)
948 </dd>
949 </dl><a NAME="IrcChannelWidget.initAutoWho" ID="IrcChannelWidget.initAutoWho"></a>
950 <h4>IrcChannelWidget.initAutoWho</h4>
951 <b>initAutoWho</b>(<i></i>)
952 <p>
953 Public method to initialize the Auto Who system.
954 </p><a NAME="IrcChannelWidget.name" ID="IrcChannelWidget.name"></a>
955 <h4>IrcChannelWidget.name</h4>
956 <b>name</b>(<i></i>)
957 <p>
958 Public method to get the name of the channel.
959 </p><dl>
960 <dt>Returns:</dt>
961 <dd>
962 name of the channel (string)
963 </dd>
964 </dl><a NAME="IrcChannelWidget.on_messageEdit_returnPressed" ID="IrcChannelWidget.on_messageEdit_returnPressed"></a>
965 <h4>IrcChannelWidget.on_messageEdit_returnPressed</h4>
966 <b>on_messageEdit_returnPressed</b>(<i></i>)
967 <p>
968 Private slot to send a message to the channel.
969 </p><a NAME="IrcChannelWidget.on_messages_copyAvailable" ID="IrcChannelWidget.on_messages_copyAvailable"></a>
970 <h4>IrcChannelWidget.on_messages_copyAvailable</h4>
971 <b>on_messages_copyAvailable</b>(<i>yes</i>)
972 <p>
973 Private slot to react to text selection/deselection of the messages edit.
974 </p><dl>
975 <dt><i>yes</i></dt>
976 <dd>
977 flag signaling the availability of selected text (boolean)
978 </dd>
979 </dl><a NAME="IrcChannelWidget.on_messages_customContextMenuRequested" ID="IrcChannelWidget.on_messages_customContextMenuRequested"></a>
980 <h4>IrcChannelWidget.on_messages_customContextMenuRequested</h4>
981 <b>on_messages_customContextMenuRequested</b>(<i>pos</i>)
982 <p>
983 Private slot to show the context menu of the messages pane.
984 </p><dl>
985 <dt><i>pos</i></dt>
986 <dd>
987 the position of the mouse pointer (QPoint)
988 </dd>
989 </dl><a NAME="IrcChannelWidget.on_usersList_customContextMenuRequested" ID="IrcChannelWidget.on_usersList_customContextMenuRequested"></a>
990 <h4>IrcChannelWidget.on_usersList_customContextMenuRequested</h4>
991 <b>on_usersList_customContextMenuRequested</b>(<i>pos</i>)
992 <p>
993 Private slot to show the context menu of the users list.
994 </p><dl>
995 <dt><i>pos</i></dt>
996 <dd>
997 the position of the mouse pointer (QPoint)
998 </dd>
999 </dl><a NAME="IrcChannelWidget.partMessage" ID="IrcChannelWidget.partMessage"></a>
1000 <h4>IrcChannelWidget.partMessage</h4>
1001 <b>partMessage</b>(<i></i>)
1002 <p>
1003 Public method to get the part message.
1004 </p><dl>
1005 <dt>Returns:</dt>
1006 <dd>
1007 part message (string)
1008 </dd>
1009 </dl><a NAME="IrcChannelWidget.requestLeave" ID="IrcChannelWidget.requestLeave"></a>
1010 <h4>IrcChannelWidget.requestLeave</h4>
1011 <b>requestLeave</b>(<i></i>)
1012 <p>
1013 Public method to leave the channel.
1014 </p><a NAME="IrcChannelWidget.setMarkerLine" ID="IrcChannelWidget.setMarkerLine"></a>
1015 <h4>IrcChannelWidget.setMarkerLine</h4>
1016 <b>setMarkerLine</b>(<i></i>)
1017 <p>
1018 Public method to draw a line to mark the current position.
1019 </p><a NAME="IrcChannelWidget.setName" ID="IrcChannelWidget.setName"></a>
1020 <h4>IrcChannelWidget.setName</h4>
1021 <b>setName</b>(<i>name</i>)
1022 <p>
1023 Public method to set the name of the channel.
1024 </p><dl>
1025 <dt><i>name</i></dt>
1026 <dd>
1027 of the channel (string)
1028 </dd>
1029 </dl><a NAME="IrcChannelWidget.setPartMessage" ID="IrcChannelWidget.setPartMessage"></a>
1030 <h4>IrcChannelWidget.setPartMessage</h4>
1031 <b>setPartMessage</b>(<i>message</i>)
1032 <p>
1033 Public method to set the part message.
1034 </p><dl>
1035 <dt><i>message</i></dt>
1036 <dd>
1037 message to be used for PART messages (string)
1038 </dd>
1039 </dl><a NAME="IrcChannelWidget.setPrivate" ID="IrcChannelWidget.setPrivate"></a>
1040 <h4>IrcChannelWidget.setPrivate</h4>
1041 <b>setPrivate</b>(<i>private, partner=""</i>)
1042 <p>
1043 Public method to set the private chat mode.
1044 </p><dl>
1045 <dt><i>private</i></dt>
1046 <dd>
1047 flag indicating private chat mode (boolean)
1048 </dd><dt><i>partner</i></dt>
1049 <dd>
1050 name of the partner user (string)
1051 </dd>
1052 </dl><a NAME="IrcChannelWidget.setPrivateInfo" ID="IrcChannelWidget.setPrivateInfo"></a>
1053 <h4>IrcChannelWidget.setPrivateInfo</h4>
1054 <b>setPrivateInfo</b>(<i>infoText</i>)
1055 <p>
1056 Public method to set some info text for private chat mode.
1057 </p><dl>
1058 <dt><i>infoText</i></dt>
1059 <dd>
1060 info text to be shown (string)
1061 </dd>
1062 </dl><a NAME="IrcChannelWidget.setUserName" ID="IrcChannelWidget.setUserName"></a>
1063 <h4>IrcChannelWidget.setUserName</h4>
1064 <b>setUserName</b>(<i>name</i>)
1065 <p>
1066 Public method to set the user name for the channel.
1067 </p><dl>
1068 <dt><i>name</i></dt>
1069 <dd>
1070 user name for the channel (string)
1071 </dd>
1072 </dl><a NAME="IrcChannelWidget.setUserPrivilegePrefix" ID="IrcChannelWidget.setUserPrivilegePrefix"></a>
1073 <h4>IrcChannelWidget.setUserPrivilegePrefix</h4>
1074 <b>setUserPrivilegePrefix</b>(<i>prefixes</i>)
1075 <p>
1076 Public method to set the user privilege to prefix mapping.
1077 </p><dl>
1078 <dt><i>prefixes</i></dt>
1079 <dd>
1080 dictionary with privilege as key and prefix as value
1081 </dd>
1082 </dl><a NAME="IrcChannelWidget.showEvent" ID="IrcChannelWidget.showEvent"></a>
1083 <h4>IrcChannelWidget.showEvent</h4>
1084 <b>showEvent</b>(<i>evt</i>)
1085 <p>
1086 Protected method handling show events.
1087 </p><dl>
1088 <dt><i>evt</i></dt>
1089 <dd>
1090 reference to the show event (QShowEvent)
1091 </dd>
1092 </dl><a NAME="IrcChannelWidget.unsetMarkerLine" ID="IrcChannelWidget.unsetMarkerLine"></a>
1093 <h4>IrcChannelWidget.unsetMarkerLine</h4>
1094 <b>unsetMarkerLine</b>(<i></i>)
1095 <p>
1096 Public method to remove the marker line.
1097 </p><a NAME="IrcChannelWidget.userName" ID="IrcChannelWidget.userName"></a>
1098 <h4>IrcChannelWidget.userName</h4>
1099 <b>userName</b>(<i></i>)
1100 <p>
1101 Public method to get the nick name of the user.
1102 </p><dl>
1103 <dt>Returns:</dt>
1104 <dd>
1105 nick name of the user (string)
1106 </dd>
1107 </dl>
1108 <div align="right"><a href="#top">Up</a></div>
1109 <hr /><hr />
1110 <a NAME="IrcUserItem" ID="IrcUserItem"></a>
1111 <h2>IrcUserItem</h2>
1112 <p>
1113 Class implementing a list widget item containing an IRC channel user.
1114 </p>
1115 <h3>Derived from</h3>
1116 QListWidgetItem
1117 <h3>Class Attributes</h3>
1118 <table>
1119 <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>
1120 </table>
1121 <h3>Class Methods</h3>
1122 <table>
1123 <tr><td>None</td></tr>
1124 </table>
1125 <h3>Methods</h3>
1126 <table>
1127 <tr>
1128 <td><a href="#IrcUserItem.__init__">IrcUserItem</a></td>
1129 <td>Constructor</td>
1130 </tr><tr>
1131 <td><a href="#IrcUserItem.__awayIcon">__awayIcon</a></td>
1132 <td>Private method to convert an icon to an away icon.</td>
1133 </tr><tr>
1134 <td><a href="#IrcUserItem.__setIcon">__setIcon</a></td>
1135 <td>Private method to set the icon dependent on user privileges.</td>
1136 </tr><tr>
1137 <td><a href="#IrcUserItem.changePrivilege">changePrivilege</a></td>
1138 <td>Public method to set or unset a user privilege.</td>
1139 </tr><tr>
1140 <td><a href="#IrcUserItem.clearPrivileges">clearPrivileges</a></td>
1141 <td>Public method to clear the user privileges.</td>
1142 </tr><tr>
1143 <td><a href="#IrcUserItem.name">name</a></td>
1144 <td>Public method to get the user name.</td>
1145 </tr><tr>
1146 <td><a href="#IrcUserItem.parseWhoFlags">parseWhoFlags</a></td>
1147 <td>Public method to parse the user flags reported by a WHO command.</td>
1148 </tr><tr>
1149 <td><a href="#IrcUserItem.setName">setName</a></td>
1150 <td>Public method to set a new nick name.</td>
1151 </tr>
1152 </table>
1153 <h3>Static Methods</h3>
1154 <table>
1155 <tr><td>None</td></tr>
1156 </table>
1157 <a NAME="IrcUserItem.__init__" ID="IrcUserItem.__init__"></a>
1158 <h4>IrcUserItem (Constructor)</h4>
1159 <b>IrcUserItem</b>(<i>name, parent=None</i>)
1160 <p>
1161 Constructor
1162 </p><dl>
1163 <dt><i>name</i></dt>
1164 <dd>
1165 string with user name and privilege prefix (string)
1166 </dd><dt><i>parent</i></dt>
1167 <dd>
1168 reference to the parent widget (QListWidget or QListWidgetItem)
1169 </dd>
1170 </dl><a NAME="IrcUserItem.__awayIcon" ID="IrcUserItem.__awayIcon"></a>
1171 <h4>IrcUserItem.__awayIcon</h4>
1172 <b>__awayIcon</b>(<i>icon</i>)
1173 <p>
1174 Private method to convert an icon to an away icon.
1175 </p><dl>
1176 <dt><i>icon</i></dt>
1177 <dd>
1178 icon to be converted (QIcon)
1179 </dd><dt><i>away</i></dt>
1180 <dd>
1181 icon (QIcon)
1182 </dd>
1183 </dl><a NAME="IrcUserItem.__setIcon" ID="IrcUserItem.__setIcon"></a>
1184 <h4>IrcUserItem.__setIcon</h4>
1185 <b>__setIcon</b>(<i></i>)
1186 <p>
1187 Private method to set the icon dependent on user privileges.
1188 </p><a NAME="IrcUserItem.changePrivilege" ID="IrcUserItem.changePrivilege"></a>
1189 <h4>IrcUserItem.changePrivilege</h4>
1190 <b>changePrivilege</b>(<i>privilege</i>)
1191 <p>
1192 Public method to set or unset a user privilege.
1193 </p><dl>
1194 <dt><i>privilege</i></dt>
1195 <dd>
1196 privilege to set or unset (string)
1197 </dd>
1198 </dl><a NAME="IrcUserItem.clearPrivileges" ID="IrcUserItem.clearPrivileges"></a>
1199 <h4>IrcUserItem.clearPrivileges</h4>
1200 <b>clearPrivileges</b>(<i></i>)
1201 <p>
1202 Public method to clear the user privileges.
1203 </p><a NAME="IrcUserItem.name" ID="IrcUserItem.name"></a>
1204 <h4>IrcUserItem.name</h4>
1205 <b>name</b>(<i></i>)
1206 <p>
1207 Public method to get the user name.
1208 </p><dl>
1209 <dt>Returns:</dt>
1210 <dd>
1211 user name (string)
1212 </dd>
1213 </dl><a NAME="IrcUserItem.parseWhoFlags" ID="IrcUserItem.parseWhoFlags"></a>
1214 <h4>IrcUserItem.parseWhoFlags</h4>
1215 <b>parseWhoFlags</b>(<i>flags</i>)
1216 <p>
1217 Public method to parse the user flags reported by a WHO command.
1218 </p><dl>
1219 <dt><i>flags</i></dt>
1220 <dd>
1221 user flags as reported by WHO (string)
1222 </dd>
1223 </dl><a NAME="IrcUserItem.setName" ID="IrcUserItem.setName"></a>
1224 <h4>IrcUserItem.setName</h4>
1225 <b>setName</b>(<i>name</i>)
1226 <p>
1227 Public method to set a new nick name.
1228 </p><dl>
1229 <dt><i>name</i></dt>
1230 <dd>
1231 new nick name for the user (string)
1232 </dd>
1233 </dl>
1234 <div align="right"><a href="#top">Up</a></div>
1235 <hr />
1236 </body></html>

Mercurial Repository: eric

eric ide

mercurial