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