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

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

eric ide

mercurial