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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10428
a071d4065202
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Network.IRC.IrcNetworkWidget</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Network.IRC.IrcNetworkWidget</h1>
10
11 <p>
12 Module implementing the network part of the IRC widget.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#IrcNetworkWidget">IrcNetworkWidget</a></td>
25 <td>Class implementing the network part of the IRC widget.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="IrcNetworkWidget" ID="IrcNetworkWidget"></a>
36 <h2>IrcNetworkWidget</h2>
37
38 <p>
39 Class implementing the network part of the IRC widget.
40 </p>
41 <h3>Signals</h3>
42 <dl>
43
44 <dt>autoConnected()</dt>
45 <dd>
46 emitted after an automatic connection was initiated
47 </dd>
48 <dt>away(bool)</dt>
49 <dd>
50 emitted to indicate the away status
51 </dd>
52 <dt>connectNetwork(str,bool,bool)</dt>
53 <dd>
54 emitted to connect or disconnect from
55 a network
56 </dd>
57 <dt>editNetwork(str)</dt>
58 <dd>
59 emitted to edit a network configuration
60 </dd>
61 <dt>joinChannel(str)</dt>
62 <dd>
63 emitted to join a channel
64 </dd>
65 <dt>nickChanged(str)</dt>
66 <dd>
67 emitted to change the nick name
68 </dd>
69 <dt>sendData(str)</dt>
70 <dd>
71 emitted to send a message to the channel
72 </dd>
73 </dl>
74 <h3>Derived from</h3>
75 QWidget, Ui_IrcNetworkWidget
76 <h3>Class Attributes</h3>
77
78 <table>
79 <tr><td>None</td></tr>
80 </table>
81 <h3>Class Methods</h3>
82
83 <table>
84 <tr><td>None</td></tr>
85 </table>
86 <h3>Methods</h3>
87
88 <table>
89
90 <tr>
91 <td><a href="#IrcNetworkWidget.__init__">IrcNetworkWidget</a></td>
92 <td>Constructor</td>
93 </tr>
94 <tr>
95 <td><a href="#IrcNetworkWidget.__autoConnect">__autoConnect</a></td>
96 <td>Private method to perform the IRC auto connection.</td>
97 </tr>
98 <tr>
99 <td><a href="#IrcNetworkWidget.__clearMessages">__clearMessages</a></td>
100 <td>Private slot to clear the contents of the messages display.</td>
101 </tr>
102 <tr>
103 <td><a href="#IrcNetworkWidget.__copyAllMessages">__copyAllMessages</a></td>
104 <td>Private slot to copy the contents of the messages display to the clipboard.</td>
105 </tr>
106 <tr>
107 <td><a href="#IrcNetworkWidget.__copyMessages">__copyMessages</a></td>
108 <td>Private slot to copy the selection of the messages display to the clipboard.</td>
109 </tr>
110 <tr>
111 <td><a href="#IrcNetworkWidget.__cutAllMessages">__cutAllMessages</a></td>
112 <td>Private slot to cut the contents of the messages display to the clipboard.</td>
113 </tr>
114 <tr>
115 <td><a href="#IrcNetworkWidget.__initMessagesMenu">__initMessagesMenu</a></td>
116 <td>Private slot to initialize the context menu of the messages pane.</td>
117 </tr>
118 <tr>
119 <td><a href="#IrcNetworkWidget.__onlineStateChanged">__onlineStateChanged</a></td>
120 <td>Private slot handling online state changes.</td>
121 </tr>
122 <tr>
123 <td><a href="#IrcNetworkWidget.__refreshNetworks">__refreshNetworks</a></td>
124 <td>Private slot to refresh all network related widgets.</td>
125 </tr>
126 <tr>
127 <td><a href="#IrcNetworkWidget.__saveMessages">__saveMessages</a></td>
128 <td>Private slot to save the contents of the messages display.</td>
129 </tr>
130 <tr>
131 <td><a href="#IrcNetworkWidget.addErrorMessage">addErrorMessage</a></td>
132 <td>Public method to add an error message.</td>
133 </tr>
134 <tr>
135 <td><a href="#IrcNetworkWidget.addMessage">addMessage</a></td>
136 <td>Public method to add a message.</td>
137 </tr>
138 <tr>
139 <td><a href="#IrcNetworkWidget.addServerMessage">addServerMessage</a></td>
140 <td>Public method to add a server message.</td>
141 </tr>
142 <tr>
143 <td><a href="#IrcNetworkWidget.autoConnect">autoConnect</a></td>
144 <td>Public method to perform the IRC auto connection.</td>
145 </tr>
146 <tr>
147 <td><a href="#IrcNetworkWidget.getNetworkChannels">getNetworkChannels</a></td>
148 <td>Public method to get the list of channels associated with the selected network.</td>
149 </tr>
150 <tr>
151 <td><a href="#IrcNetworkWidget.getNickname">getNickname</a></td>
152 <td>Public method to get the currently selected nick name.</td>
153 </tr>
154 <tr>
155 <td><a href="#IrcNetworkWidget.handleAwayCommand">handleAwayCommand</a></td>
156 <td>Public slot to process an away command.</td>
157 </tr>
158 <tr>
159 <td><a href="#IrcNetworkWidget.initialize">initialize</a></td>
160 <td>Public method to initialize the widget.</td>
161 </tr>
162 <tr>
163 <td><a href="#IrcNetworkWidget.isConnected">isConnected</a></td>
164 <td>Public method to check, if the network is connected.</td>
165 </tr>
166 <tr>
167 <td><a href="#IrcNetworkWidget.on_awayButton_clicked">on_awayButton_clicked</a></td>
168 <td>Private slot to toggle the away status.</td>
169 </tr>
170 <tr>
171 <td><a href="#IrcNetworkWidget.on_channelCombo_editTextChanged">on_channelCombo_editTextChanged</a></td>
172 <td>Private slot to react upon changes of the channel.</td>
173 </tr>
174 <tr>
175 <td><a href="#IrcNetworkWidget.on_connectButton_clicked">on_connectButton_clicked</a></td>
176 <td>Private slot to connect to a network.</td>
177 </tr>
178 <tr>
179 <td><a href="#IrcNetworkWidget.on_editButton_clicked">on_editButton_clicked</a></td>
180 <td>Private slot to edit a network.</td>
181 </tr>
182 <tr>
183 <td><a href="#IrcNetworkWidget.on_joinButton_clicked">on_joinButton_clicked</a></td>
184 <td>Private slot to join a channel.</td>
185 </tr>
186 <tr>
187 <td><a href="#IrcNetworkWidget.on_messages_anchorClicked">on_messages_anchorClicked</a></td>
188 <td>Private slot to open links in the default browser.</td>
189 </tr>
190 <tr>
191 <td><a href="#IrcNetworkWidget.on_messages_copyAvailable">on_messages_copyAvailable</a></td>
192 <td>Private slot to react to text selection/deselection of the messages edit.</td>
193 </tr>
194 <tr>
195 <td><a href="#IrcNetworkWidget.on_messages_customContextMenuRequested">on_messages_customContextMenuRequested</a></td>
196 <td>Private slot to show the context menu of the messages pane.</td>
197 </tr>
198 <tr>
199 <td><a href="#IrcNetworkWidget.on_networkCombo_currentIndexChanged">on_networkCombo_currentIndexChanged</a></td>
200 <td>Private slot to handle selections of a network.</td>
201 </tr>
202 <tr>
203 <td><a href="#IrcNetworkWidget.on_nickCombo_currentIndexChanged">on_nickCombo_currentIndexChanged</a></td>
204 <td>Private slot to use another nick name.</td>
205 </tr>
206 <tr>
207 <td><a href="#IrcNetworkWidget.setConnected">setConnected</a></td>
208 <td>Public slot to set the connection state.</td>
209 </tr>
210 <tr>
211 <td><a href="#IrcNetworkWidget.setNickName">setNickName</a></td>
212 <td>Public slot to set the nick name in use.</td>
213 </tr>
214 <tr>
215 <td><a href="#IrcNetworkWidget.setRegistered">setRegistered</a></td>
216 <td>Public slot to set the registered state.</td>
217 </tr>
218 </table>
219 <h3>Static Methods</h3>
220
221 <table>
222 <tr><td>None</td></tr>
223 </table>
224
225 <a NAME="IrcNetworkWidget.__init__" ID="IrcNetworkWidget.__init__"></a>
226 <h4>IrcNetworkWidget (Constructor)</h4>
227 <b>IrcNetworkWidget</b>(<i>parent=None</i>)
228
229 <p>
230 Constructor
231 </p>
232 <dl>
233
234 <dt><i>parent</i></dt>
235 <dd>
236 reference to the parent widget (QWidget)
237 </dd>
238 </dl>
239 <a NAME="IrcNetworkWidget.__autoConnect" ID="IrcNetworkWidget.__autoConnect"></a>
240 <h4>IrcNetworkWidget.__autoConnect</h4>
241 <b>__autoConnect</b>(<i></i>)
242
243 <p>
244 Private method to perform the IRC auto connection.
245 </p>
246 <a NAME="IrcNetworkWidget.__clearMessages" ID="IrcNetworkWidget.__clearMessages"></a>
247 <h4>IrcNetworkWidget.__clearMessages</h4>
248 <b>__clearMessages</b>(<i></i>)
249
250 <p>
251 Private slot to clear the contents of the messages display.
252 </p>
253 <a NAME="IrcNetworkWidget.__copyAllMessages" ID="IrcNetworkWidget.__copyAllMessages"></a>
254 <h4>IrcNetworkWidget.__copyAllMessages</h4>
255 <b>__copyAllMessages</b>(<i></i>)
256
257 <p>
258 Private slot to copy the contents of the messages display to
259 the clipboard.
260 </p>
261 <a NAME="IrcNetworkWidget.__copyMessages" ID="IrcNetworkWidget.__copyMessages"></a>
262 <h4>IrcNetworkWidget.__copyMessages</h4>
263 <b>__copyMessages</b>(<i></i>)
264
265 <p>
266 Private slot to copy the selection of the messages display to
267 the clipboard.
268 </p>
269 <a NAME="IrcNetworkWidget.__cutAllMessages" ID="IrcNetworkWidget.__cutAllMessages"></a>
270 <h4>IrcNetworkWidget.__cutAllMessages</h4>
271 <b>__cutAllMessages</b>(<i></i>)
272
273 <p>
274 Private slot to cut the contents of the messages display to
275 the clipboard.
276 </p>
277 <a NAME="IrcNetworkWidget.__initMessagesMenu" ID="IrcNetworkWidget.__initMessagesMenu"></a>
278 <h4>IrcNetworkWidget.__initMessagesMenu</h4>
279 <b>__initMessagesMenu</b>(<i></i>)
280
281 <p>
282 Private slot to initialize the context menu of the messages pane.
283 </p>
284 <a NAME="IrcNetworkWidget.__onlineStateChanged" ID="IrcNetworkWidget.__onlineStateChanged"></a>
285 <h4>IrcNetworkWidget.__onlineStateChanged</h4>
286 <b>__onlineStateChanged</b>(<i>online</i>)
287
288 <p>
289 Private slot handling online state changes.
290 </p>
291 <dl>
292
293 <dt><i>online</i> (bool)</dt>
294 <dd>
295 online state
296 </dd>
297 </dl>
298 <a NAME="IrcNetworkWidget.__refreshNetworks" ID="IrcNetworkWidget.__refreshNetworks"></a>
299 <h4>IrcNetworkWidget.__refreshNetworks</h4>
300 <b>__refreshNetworks</b>(<i></i>)
301
302 <p>
303 Private slot to refresh all network related widgets.
304 </p>
305 <a NAME="IrcNetworkWidget.__saveMessages" ID="IrcNetworkWidget.__saveMessages"></a>
306 <h4>IrcNetworkWidget.__saveMessages</h4>
307 <b>__saveMessages</b>(<i></i>)
308
309 <p>
310 Private slot to save the contents of the messages display.
311 </p>
312 <a NAME="IrcNetworkWidget.addErrorMessage" ID="IrcNetworkWidget.addErrorMessage"></a>
313 <h4>IrcNetworkWidget.addErrorMessage</h4>
314 <b>addErrorMessage</b>(<i>msgType, msg</i>)
315
316 <p>
317 Public method to add an error message.
318 </p>
319 <dl>
320
321 <dt><i>msgType</i></dt>
322 <dd>
323 txpe of the message (string)
324 </dd>
325 <dt><i>msg</i></dt>
326 <dd>
327 message to be added (string)
328 </dd>
329 </dl>
330 <a NAME="IrcNetworkWidget.addMessage" ID="IrcNetworkWidget.addMessage"></a>
331 <h4>IrcNetworkWidget.addMessage</h4>
332 <b>addMessage</b>(<i>msg</i>)
333
334 <p>
335 Public method to add a message.
336 </p>
337 <dl>
338
339 <dt><i>msg</i></dt>
340 <dd>
341 message to be added (string)
342 </dd>
343 </dl>
344 <a NAME="IrcNetworkWidget.addServerMessage" ID="IrcNetworkWidget.addServerMessage"></a>
345 <h4>IrcNetworkWidget.addServerMessage</h4>
346 <b>addServerMessage</b>(<i>msgType, msg, filterMsg=True</i>)
347
348 <p>
349 Public method to add a server message.
350 </p>
351 <dl>
352
353 <dt><i>msgType</i></dt>
354 <dd>
355 txpe of the message (string)
356 </dd>
357 <dt><i>msg</i></dt>
358 <dd>
359 message to be added (string)
360 </dd>
361 <dt><i>filterMsg</i></dt>
362 <dd>
363 flag indicating to filter the message (boolean)
364 </dd>
365 </dl>
366 <a NAME="IrcNetworkWidget.autoConnect" ID="IrcNetworkWidget.autoConnect"></a>
367 <h4>IrcNetworkWidget.autoConnect</h4>
368 <b>autoConnect</b>(<i></i>)
369
370 <p>
371 Public method to perform the IRC auto connection.
372 </p>
373 <a NAME="IrcNetworkWidget.getNetworkChannels" ID="IrcNetworkWidget.getNetworkChannels"></a>
374 <h4>IrcNetworkWidget.getNetworkChannels</h4>
375 <b>getNetworkChannels</b>(<i></i>)
376
377 <p>
378 Public method to get the list of channels associated with the
379 selected network.
380 </p>
381 <dl>
382 <dt>Return:</dt>
383 <dd>
384 associated channels (list of IrcChannel)
385 </dd>
386 </dl>
387 <a NAME="IrcNetworkWidget.getNickname" ID="IrcNetworkWidget.getNickname"></a>
388 <h4>IrcNetworkWidget.getNickname</h4>
389 <b>getNickname</b>(<i></i>)
390
391 <p>
392 Public method to get the currently selected nick name.
393 </p>
394 <dl>
395 <dt>Return:</dt>
396 <dd>
397 selected nick name (string)
398 </dd>
399 </dl>
400 <a NAME="IrcNetworkWidget.handleAwayCommand" ID="IrcNetworkWidget.handleAwayCommand"></a>
401 <h4>IrcNetworkWidget.handleAwayCommand</h4>
402 <b>handleAwayCommand</b>(<i>awayMessage</i>)
403
404 <p>
405 Public slot to process an away command.
406 </p>
407 <dl>
408
409 <dt><i>awayMessage</i> (str)</dt>
410 <dd>
411 message to be set for being away
412 </dd>
413 </dl>
414 <a NAME="IrcNetworkWidget.initialize" ID="IrcNetworkWidget.initialize"></a>
415 <h4>IrcNetworkWidget.initialize</h4>
416 <b>initialize</b>(<i>manager</i>)
417
418 <p>
419 Public method to initialize the widget.
420 </p>
421 <dl>
422
423 <dt><i>manager</i></dt>
424 <dd>
425 reference to the network manager (IrcNetworkManager)
426 </dd>
427 </dl>
428 <a NAME="IrcNetworkWidget.isConnected" ID="IrcNetworkWidget.isConnected"></a>
429 <h4>IrcNetworkWidget.isConnected</h4>
430 <b>isConnected</b>(<i></i>)
431
432 <p>
433 Public method to check, if the network is connected.
434 </p>
435 <dl>
436 <dt>Return:</dt>
437 <dd>
438 flag indicating a connected network (boolean)
439 </dd>
440 </dl>
441 <a NAME="IrcNetworkWidget.on_awayButton_clicked" ID="IrcNetworkWidget.on_awayButton_clicked"></a>
442 <h4>IrcNetworkWidget.on_awayButton_clicked</h4>
443 <b>on_awayButton_clicked</b>(<i></i>)
444
445 <p>
446 Private slot to toggle the away status.
447 </p>
448 <a NAME="IrcNetworkWidget.on_channelCombo_editTextChanged" ID="IrcNetworkWidget.on_channelCombo_editTextChanged"></a>
449 <h4>IrcNetworkWidget.on_channelCombo_editTextChanged</h4>
450 <b>on_channelCombo_editTextChanged</b>(<i>txt</i>)
451
452 <p>
453 Private slot to react upon changes of the channel.
454 </p>
455 <dl>
456
457 <dt><i>txt</i></dt>
458 <dd>
459 current text of the channel combo (string)
460 </dd>
461 </dl>
462 <a NAME="IrcNetworkWidget.on_connectButton_clicked" ID="IrcNetworkWidget.on_connectButton_clicked"></a>
463 <h4>IrcNetworkWidget.on_connectButton_clicked</h4>
464 <b>on_connectButton_clicked</b>(<i></i>)
465
466 <p>
467 Private slot to connect to a network.
468 </p>
469 <a NAME="IrcNetworkWidget.on_editButton_clicked" ID="IrcNetworkWidget.on_editButton_clicked"></a>
470 <h4>IrcNetworkWidget.on_editButton_clicked</h4>
471 <b>on_editButton_clicked</b>(<i></i>)
472
473 <p>
474 Private slot to edit a network.
475 </p>
476 <a NAME="IrcNetworkWidget.on_joinButton_clicked" ID="IrcNetworkWidget.on_joinButton_clicked"></a>
477 <h4>IrcNetworkWidget.on_joinButton_clicked</h4>
478 <b>on_joinButton_clicked</b>(<i></i>)
479
480 <p>
481 Private slot to join a channel.
482 </p>
483 <a NAME="IrcNetworkWidget.on_messages_anchorClicked" ID="IrcNetworkWidget.on_messages_anchorClicked"></a>
484 <h4>IrcNetworkWidget.on_messages_anchorClicked</h4>
485 <b>on_messages_anchorClicked</b>(<i>url</i>)
486
487 <p>
488 Private slot to open links in the default browser.
489 </p>
490 <dl>
491
492 <dt><i>url</i></dt>
493 <dd>
494 URL to be opened (QUrl)
495 </dd>
496 </dl>
497 <a NAME="IrcNetworkWidget.on_messages_copyAvailable" ID="IrcNetworkWidget.on_messages_copyAvailable"></a>
498 <h4>IrcNetworkWidget.on_messages_copyAvailable</h4>
499 <b>on_messages_copyAvailable</b>(<i>yes</i>)
500
501 <p>
502 Private slot to react to text selection/deselection of the
503 messages edit.
504 </p>
505 <dl>
506
507 <dt><i>yes</i></dt>
508 <dd>
509 flag signaling the availability of selected text (boolean)
510 </dd>
511 </dl>
512 <a NAME="IrcNetworkWidget.on_messages_customContextMenuRequested" ID="IrcNetworkWidget.on_messages_customContextMenuRequested"></a>
513 <h4>IrcNetworkWidget.on_messages_customContextMenuRequested</h4>
514 <b>on_messages_customContextMenuRequested</b>(<i>pos</i>)
515
516 <p>
517 Private slot to show the context menu of the messages pane.
518 </p>
519 <dl>
520
521 <dt><i>pos</i></dt>
522 <dd>
523 position the menu should be opened at (QPoint)
524 </dd>
525 </dl>
526 <a NAME="IrcNetworkWidget.on_networkCombo_currentIndexChanged" ID="IrcNetworkWidget.on_networkCombo_currentIndexChanged"></a>
527 <h4>IrcNetworkWidget.on_networkCombo_currentIndexChanged</h4>
528 <b>on_networkCombo_currentIndexChanged</b>(<i>index</i>)
529
530 <p>
531 Private slot to handle selections of a network.
532 </p>
533 <dl>
534
535 <dt><i>index</i> (int)</dt>
536 <dd>
537 index of the selected entry
538 </dd>
539 </dl>
540 <a NAME="IrcNetworkWidget.on_nickCombo_currentIndexChanged" ID="IrcNetworkWidget.on_nickCombo_currentIndexChanged"></a>
541 <h4>IrcNetworkWidget.on_nickCombo_currentIndexChanged</h4>
542 <b>on_nickCombo_currentIndexChanged</b>(<i>nick=0</i>)
543
544 <p>
545 Private slot to use another nick name.
546 </p>
547 <dl>
548
549 <dt><i>nick</i></dt>
550 <dd>
551 index of the selected nick name (unused)
552 </dd>
553 </dl>
554 <a NAME="IrcNetworkWidget.setConnected" ID="IrcNetworkWidget.setConnected"></a>
555 <h4>IrcNetworkWidget.setConnected</h4>
556 <b>setConnected</b>(<i>connected</i>)
557
558 <p>
559 Public slot to set the connection state.
560 </p>
561 <dl>
562
563 <dt><i>connected</i></dt>
564 <dd>
565 flag indicating the connection state (boolean)
566 </dd>
567 </dl>
568 <a NAME="IrcNetworkWidget.setNickName" ID="IrcNetworkWidget.setNickName"></a>
569 <h4>IrcNetworkWidget.setNickName</h4>
570 <b>setNickName</b>(<i>nick</i>)
571
572 <p>
573 Public slot to set the nick name in use.
574 </p>
575 <dl>
576
577 <dt><i>nick</i></dt>
578 <dd>
579 nick name in use (string)
580 </dd>
581 </dl>
582 <a NAME="IrcNetworkWidget.setRegistered" ID="IrcNetworkWidget.setRegistered"></a>
583 <h4>IrcNetworkWidget.setRegistered</h4>
584 <b>setRegistered</b>(<i>registered</i>)
585
586 <p>
587 Public slot to set the registered state.
588 </p>
589 <dl>
590
591 <dt><i>registered</i></dt>
592 <dd>
593 flag indicating the registration state (boolean)
594 </dd>
595 </dl>
596 <div align="right"><a href="#top">Up</a></div>
597 <hr />
598 </body></html>

eric ide

mercurial