Mercurial Repositories > eric / file comparison

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

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

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Network.IRC.IrcNetworkWidget</h1>
23 <p>
24 Module implementing the network part of the IRC widget.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#IrcNetworkWidget">IrcNetworkWidget</a></td>
34 <td>Class implementing the network part of the IRC widget.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="IrcNetworkWidget" ID="IrcNetworkWidget"></a>
43 <h2>IrcNetworkWidget</h2>
44 <p>
45 Class implementing the network part of the IRC widget.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>autoConnected()</dt>
49 <dd>
50 emitted after an automatic connection was initiated
51 </dd><dt>away(bool)</dt>
52 <dd>
53 emitted to indicate the away status
54 </dd><dt>connectNetwork(str,bool,bool)</dt>
55 <dd>
56 emitted to connect or disconnect from
57 a network
58 </dd><dt>editNetwork(str)</dt>
59 <dd>
60 emitted to edit a network configuration
61 </dd><dt>joinChannel(str)</dt>
62 <dd>
63 emitted to join a channel
64 </dd><dt>nickChanged(str)</dt>
65 <dd>
66 emitted to change the nick name
67 </dd><dt>sendData(str)</dt>
68 <dd>
69 emitted to send a message to the channel
70 </dd>
71 </dl>
72 <h3>Derived from</h3>
73 QWidget, Ui_IrcNetworkWidget
74 <h3>Class Attributes</h3>
75 <table>
76 <tr><td>None</td></tr>
77 </table>
78 <h3>Class Methods</h3>
79 <table>
80 <tr><td>None</td></tr>
81 </table>
82 <h3>Methods</h3>
83 <table>
84 <tr>
85 <td><a href="#IrcNetworkWidget.__init__">IrcNetworkWidget</a></td>
86 <td>Constructor</td>
87 </tr><tr>
88 <td><a href="#IrcNetworkWidget.__autoConnect">__autoConnect</a></td>
89 <td>Private method to perform the IRC auto connection.</td>
90 </tr><tr>
91 <td><a href="#IrcNetworkWidget.__clearMessages">__clearMessages</a></td>
92 <td>Private slot to clear the contents of the messages display.</td>
93 </tr><tr>
94 <td><a href="#IrcNetworkWidget.__copyAllMessages">__copyAllMessages</a></td>
95 <td>Private slot to copy the contents of the messages display to the clipboard.</td>
96 </tr><tr>
97 <td><a href="#IrcNetworkWidget.__copyMessages">__copyMessages</a></td>
98 <td>Private slot to copy the selection of the messages display to the clipboard.</td>
99 </tr><tr>
100 <td><a href="#IrcNetworkWidget.__cutAllMessages">__cutAllMessages</a></td>
101 <td>Private slot to cut the contents of the messages display to the clipboard.</td>
102 </tr><tr>
103 <td><a href="#IrcNetworkWidget.__initMessagesMenu">__initMessagesMenu</a></td>
104 <td>Private slot to initialize the context menu of the messages pane.</td>
105 </tr><tr>
106 <td><a href="#IrcNetworkWidget.__onlineStateChanged">__onlineStateChanged</a></td>
107 <td>Private slot handling online state changes.</td>
108 </tr><tr>
109 <td><a href="#IrcNetworkWidget.__refreshNetworks">__refreshNetworks</a></td>
110 <td>Private slot to refresh all network related widgets.</td>
111 </tr><tr>
112 <td><a href="#IrcNetworkWidget.__saveMessages">__saveMessages</a></td>
113 <td>Private slot to save the contents of the messages display.</td>
114 </tr><tr>
115 <td><a href="#IrcNetworkWidget.addErrorMessage">addErrorMessage</a></td>
116 <td>Public method to add an error message.</td>
117 </tr><tr>
118 <td><a href="#IrcNetworkWidget.addMessage">addMessage</a></td>
119 <td>Public method to add a message.</td>
120 </tr><tr>
121 <td><a href="#IrcNetworkWidget.addServerMessage">addServerMessage</a></td>
122 <td>Public method to add a server message.</td>
123 </tr><tr>
124 <td><a href="#IrcNetworkWidget.autoConnect">autoConnect</a></td>
125 <td>Public method to perform the IRC auto connection.</td>
126 </tr><tr>
127 <td><a href="#IrcNetworkWidget.getNetworkChannels">getNetworkChannels</a></td>
128 <td>Public method to get the list of channels associated with the selected network.</td>
129 </tr><tr>
130 <td><a href="#IrcNetworkWidget.getNickname">getNickname</a></td>
131 <td>Public method to get the currently selected nick name.</td>
132 </tr><tr>
133 <td><a href="#IrcNetworkWidget.handleAwayCommand">handleAwayCommand</a></td>
134 <td>Public slot to process an away command.</td>
135 </tr><tr>
136 <td><a href="#IrcNetworkWidget.initialize">initialize</a></td>
137 <td>Public method to initialize the widget.</td>
138 </tr><tr>
139 <td><a href="#IrcNetworkWidget.isConnected">isConnected</a></td>
140 <td>Public method to check, if the network is connected.</td>
141 </tr><tr>
142 <td><a href="#IrcNetworkWidget.on_awayButton_clicked">on_awayButton_clicked</a></td>
143 <td>Private slot to toggle the away status.</td>
144 </tr><tr>
145 <td><a href="#IrcNetworkWidget.on_channelCombo_editTextChanged">on_channelCombo_editTextChanged</a></td>
146 <td>Private slot to react upon changes of the channel.</td>
147 </tr><tr>
148 <td><a href="#IrcNetworkWidget.on_connectButton_clicked">on_connectButton_clicked</a></td>
149 <td>Private slot to connect to a network.</td>
150 </tr><tr>
151 <td><a href="#IrcNetworkWidget.on_editButton_clicked">on_editButton_clicked</a></td>
152 <td>Private slot to edit a network.</td>
153 </tr><tr>
154 <td><a href="#IrcNetworkWidget.on_joinButton_clicked">on_joinButton_clicked</a></td>
155 <td>Private slot to join a channel.</td>
156 </tr><tr>
157 <td><a href="#IrcNetworkWidget.on_messages_anchorClicked">on_messages_anchorClicked</a></td>
158 <td>Private slot to open links in the default browser.</td>
159 </tr><tr>
160 <td><a href="#IrcNetworkWidget.on_messages_copyAvailable">on_messages_copyAvailable</a></td>
161 <td>Private slot to react to text selection/deselection of the messages edit.</td>
162 </tr><tr>
163 <td><a href="#IrcNetworkWidget.on_messages_customContextMenuRequested">on_messages_customContextMenuRequested</a></td>
164 <td>Private slot to show the context menu of the messages pane.</td>
165 </tr><tr>
166 <td><a href="#IrcNetworkWidget.on_networkCombo_currentIndexChanged">on_networkCombo_currentIndexChanged</a></td>
167 <td>Private slot to handle selections of a network.</td>
168 </tr><tr>
169 <td><a href="#IrcNetworkWidget.on_nickCombo_currentIndexChanged">on_nickCombo_currentIndexChanged</a></td>
170 <td>Private slot to use another nick name.</td>
171 </tr><tr>
172 <td><a href="#IrcNetworkWidget.setConnected">setConnected</a></td>
173 <td>Public slot to set the connection state.</td>
174 </tr><tr>
175 <td><a href="#IrcNetworkWidget.setNickName">setNickName</a></td>
176 <td>Public slot to set the nick name in use.</td>
177 </tr><tr>
178 <td><a href="#IrcNetworkWidget.setRegistered">setRegistered</a></td>
179 <td>Public slot to set the registered state.</td>
180 </tr>
181 </table>
182 <h3>Static Methods</h3>
183 <table>
184 <tr><td>None</td></tr>
185 </table>
186 <a NAME="IrcNetworkWidget.__init__" ID="IrcNetworkWidget.__init__"></a>
187 <h4>IrcNetworkWidget (Constructor)</h4>
188 <b>IrcNetworkWidget</b>(<i>parent=None</i>)
189 <p>
190 Constructor
191 </p><dl>
192 <dt><i>parent</i></dt>
193 <dd>
194 reference to the parent widget (QWidget)
195 </dd>
196 </dl><a NAME="IrcNetworkWidget.__autoConnect" ID="IrcNetworkWidget.__autoConnect"></a>
197 <h4>IrcNetworkWidget.__autoConnect</h4>
198 <b>__autoConnect</b>(<i></i>)
199 <p>
200 Private method to perform the IRC auto connection.
201 </p><a NAME="IrcNetworkWidget.__clearMessages" ID="IrcNetworkWidget.__clearMessages"></a>
202 <h4>IrcNetworkWidget.__clearMessages</h4>
203 <b>__clearMessages</b>(<i></i>)
204 <p>
205 Private slot to clear the contents of the messages display.
206 </p><a NAME="IrcNetworkWidget.__copyAllMessages" ID="IrcNetworkWidget.__copyAllMessages"></a>
207 <h4>IrcNetworkWidget.__copyAllMessages</h4>
208 <b>__copyAllMessages</b>(<i></i>)
209 <p>
210 Private slot to copy the contents of the messages display to
211 the clipboard.
212 </p><a NAME="IrcNetworkWidget.__copyMessages" ID="IrcNetworkWidget.__copyMessages"></a>
213 <h4>IrcNetworkWidget.__copyMessages</h4>
214 <b>__copyMessages</b>(<i></i>)
215 <p>
216 Private slot to copy the selection of the messages display to
217 the clipboard.
218 </p><a NAME="IrcNetworkWidget.__cutAllMessages" ID="IrcNetworkWidget.__cutAllMessages"></a>
219 <h4>IrcNetworkWidget.__cutAllMessages</h4>
220 <b>__cutAllMessages</b>(<i></i>)
221 <p>
222 Private slot to cut the contents of the messages display to
223 the clipboard.
224 </p><a NAME="IrcNetworkWidget.__initMessagesMenu" ID="IrcNetworkWidget.__initMessagesMenu"></a>
225 <h4>IrcNetworkWidget.__initMessagesMenu</h4>
226 <b>__initMessagesMenu</b>(<i></i>)
227 <p>
228 Private slot to initialize the context menu of the messages pane.
229 </p><a NAME="IrcNetworkWidget.__onlineStateChanged" ID="IrcNetworkWidget.__onlineStateChanged"></a>
230 <h4>IrcNetworkWidget.__onlineStateChanged</h4>
231 <b>__onlineStateChanged</b>(<i>online</i>)
232 <p>
233 Private slot handling online state changes.
234 </p><dl>
235 <dt><i>online</i> (bool)</dt>
236 <dd>
237 online state
238 </dd>
239 </dl><a NAME="IrcNetworkWidget.__refreshNetworks" ID="IrcNetworkWidget.__refreshNetworks"></a>
240 <h4>IrcNetworkWidget.__refreshNetworks</h4>
241 <b>__refreshNetworks</b>(<i></i>)
242 <p>
243 Private slot to refresh all network related widgets.
244 </p><a NAME="IrcNetworkWidget.__saveMessages" ID="IrcNetworkWidget.__saveMessages"></a>
245 <h4>IrcNetworkWidget.__saveMessages</h4>
246 <b>__saveMessages</b>(<i></i>)
247 <p>
248 Private slot to save the contents of the messages display.
249 </p><a NAME="IrcNetworkWidget.addErrorMessage" ID="IrcNetworkWidget.addErrorMessage"></a>
250 <h4>IrcNetworkWidget.addErrorMessage</h4>
251 <b>addErrorMessage</b>(<i>msgType, msg</i>)
252 <p>
253 Public method to add an error message.
254 </p><dl>
255 <dt><i>msgType</i></dt>
256 <dd>
257 txpe of the message (string)
258 </dd><dt><i>msg</i></dt>
259 <dd>
260 message to be added (string)
261 </dd>
262 </dl><a NAME="IrcNetworkWidget.addMessage" ID="IrcNetworkWidget.addMessage"></a>
263 <h4>IrcNetworkWidget.addMessage</h4>
264 <b>addMessage</b>(<i>msg</i>)
265 <p>
266 Public method to add a message.
267 </p><dl>
268 <dt><i>msg</i></dt>
269 <dd>
270 message to be added (string)
271 </dd>
272 </dl><a NAME="IrcNetworkWidget.addServerMessage" ID="IrcNetworkWidget.addServerMessage"></a>
273 <h4>IrcNetworkWidget.addServerMessage</h4>
274 <b>addServerMessage</b>(<i>msgType, msg, filterMsg=True</i>)
275 <p>
276 Public method to add a server message.
277 </p><dl>
278 <dt><i>msgType</i></dt>
279 <dd>
280 txpe of the message (string)
281 </dd><dt><i>msg</i></dt>
282 <dd>
283 message to be added (string)
284 </dd><dt><i>filterMsg=</i></dt>
285 <dd>
286 flag indicating to filter the message (boolean)
287 </dd>
288 </dl><a NAME="IrcNetworkWidget.autoConnect" ID="IrcNetworkWidget.autoConnect"></a>
289 <h4>IrcNetworkWidget.autoConnect</h4>
290 <b>autoConnect</b>(<i></i>)
291 <p>
292 Public method to perform the IRC auto connection.
293 </p><a NAME="IrcNetworkWidget.getNetworkChannels" ID="IrcNetworkWidget.getNetworkChannels"></a>
294 <h4>IrcNetworkWidget.getNetworkChannels</h4>
295 <b>getNetworkChannels</b>(<i></i>)
296 <p>
297 Public method to get the list of channels associated with the
298 selected network.
299 </p><dl>
300 <dt>Returns:</dt>
301 <dd>
302 associated channels (list of IrcChannel)
303 </dd>
304 </dl><a NAME="IrcNetworkWidget.getNickname" ID="IrcNetworkWidget.getNickname"></a>
305 <h4>IrcNetworkWidget.getNickname</h4>
306 <b>getNickname</b>(<i></i>)
307 <p>
308 Public method to get the currently selected nick name.
309 </p><dl>
310 <dt>Returns:</dt>
311 <dd>
312 selected nick name (string)
313 </dd>
314 </dl><a NAME="IrcNetworkWidget.handleAwayCommand" ID="IrcNetworkWidget.handleAwayCommand"></a>
315 <h4>IrcNetworkWidget.handleAwayCommand</h4>
316 <b>handleAwayCommand</b>(<i>awayMessage</i>)
317 <p>
318 Public slot to process an away command.
319 </p><dl>
320 <dt><i>awayMessage</i> (str)</dt>
321 <dd>
322 message to be set for being away
323 </dd>
324 </dl><a NAME="IrcNetworkWidget.initialize" ID="IrcNetworkWidget.initialize"></a>
325 <h4>IrcNetworkWidget.initialize</h4>
326 <b>initialize</b>(<i>manager</i>)
327 <p>
328 Public method to initialize the widget.
329 </p><dl>
330 <dt><i>manager</i></dt>
331 <dd>
332 reference to the network manager (IrcNetworkManager)
333 </dd>
334 </dl><a NAME="IrcNetworkWidget.isConnected" ID="IrcNetworkWidget.isConnected"></a>
335 <h4>IrcNetworkWidget.isConnected</h4>
336 <b>isConnected</b>(<i></i>)
337 <p>
338 Public method to check, if the network is connected.
339 </p><dl>
340 <dt>Returns:</dt>
341 <dd>
342 flag indicating a connected network (boolean)
343 </dd>
344 </dl><a NAME="IrcNetworkWidget.on_awayButton_clicked" ID="IrcNetworkWidget.on_awayButton_clicked"></a>
345 <h4>IrcNetworkWidget.on_awayButton_clicked</h4>
346 <b>on_awayButton_clicked</b>(<i></i>)
347 <p>
348 Private slot to toggle the away status.
349 </p><a NAME="IrcNetworkWidget.on_channelCombo_editTextChanged" ID="IrcNetworkWidget.on_channelCombo_editTextChanged"></a>
350 <h4>IrcNetworkWidget.on_channelCombo_editTextChanged</h4>
351 <b>on_channelCombo_editTextChanged</b>(<i>txt</i>)
352 <p>
353 Private slot to react upon changes of the channel.
354 </p><dl>
355 <dt><i>txt</i></dt>
356 <dd>
357 current text of the channel combo (string)
358 </dd>
359 </dl><a NAME="IrcNetworkWidget.on_connectButton_clicked" ID="IrcNetworkWidget.on_connectButton_clicked"></a>
360 <h4>IrcNetworkWidget.on_connectButton_clicked</h4>
361 <b>on_connectButton_clicked</b>(<i></i>)
362 <p>
363 Private slot to connect to a network.
364 </p><a NAME="IrcNetworkWidget.on_editButton_clicked" ID="IrcNetworkWidget.on_editButton_clicked"></a>
365 <h4>IrcNetworkWidget.on_editButton_clicked</h4>
366 <b>on_editButton_clicked</b>(<i></i>)
367 <p>
368 Private slot to edit a network.
369 </p><a NAME="IrcNetworkWidget.on_joinButton_clicked" ID="IrcNetworkWidget.on_joinButton_clicked"></a>
370 <h4>IrcNetworkWidget.on_joinButton_clicked</h4>
371 <b>on_joinButton_clicked</b>(<i></i>)
372 <p>
373 Private slot to join a channel.
374 </p><a NAME="IrcNetworkWidget.on_messages_anchorClicked" ID="IrcNetworkWidget.on_messages_anchorClicked"></a>
375 <h4>IrcNetworkWidget.on_messages_anchorClicked</h4>
376 <b>on_messages_anchorClicked</b>(<i>url</i>)
377 <p>
378 Private slot to open links in the default browser.
379 </p><dl>
380 <dt><i>url</i></dt>
381 <dd>
382 URL to be opened (QUrl)
383 </dd>
384 </dl><a NAME="IrcNetworkWidget.on_messages_copyAvailable" ID="IrcNetworkWidget.on_messages_copyAvailable"></a>
385 <h4>IrcNetworkWidget.on_messages_copyAvailable</h4>
386 <b>on_messages_copyAvailable</b>(<i>yes</i>)
387 <p>
388 Private slot to react to text selection/deselection of the
389 messages edit.
390 </p><dl>
391 <dt><i>yes</i></dt>
392 <dd>
393 flag signaling the availability of selected text (boolean)
394 </dd>
395 </dl><a NAME="IrcNetworkWidget.on_messages_customContextMenuRequested" ID="IrcNetworkWidget.on_messages_customContextMenuRequested"></a>
396 <h4>IrcNetworkWidget.on_messages_customContextMenuRequested</h4>
397 <b>on_messages_customContextMenuRequested</b>(<i>pos</i>)
398 <p>
399 Private slot to show the context menu of the messages pane.
400 </p><dl>
401 <dt><i>pos</i></dt>
402 <dd>
403 position the menu should be opened at (QPoint)
404 </dd>
405 </dl><a NAME="IrcNetworkWidget.on_networkCombo_currentIndexChanged" ID="IrcNetworkWidget.on_networkCombo_currentIndexChanged"></a>
406 <h4>IrcNetworkWidget.on_networkCombo_currentIndexChanged</h4>
407 <b>on_networkCombo_currentIndexChanged</b>(<i>networkName</i>)
408 <p>
409 Private slot to handle selections of a network.
410 </p><dl>
411 <dt><i>networkName</i></dt>
412 <dd>
413 selected network name (string)
414 </dd>
415 </dl><a NAME="IrcNetworkWidget.on_nickCombo_currentIndexChanged" ID="IrcNetworkWidget.on_nickCombo_currentIndexChanged"></a>
416 <h4>IrcNetworkWidget.on_nickCombo_currentIndexChanged</h4>
417 <b>on_nickCombo_currentIndexChanged</b>(<i>nick=""</i>)
418 <p>
419 Private slot to use another nick name.
420 </p><dl>
421 <dt><i>nick</i></dt>
422 <dd>
423 nick name to use (string)
424 </dd>
425 </dl><a NAME="IrcNetworkWidget.setConnected" ID="IrcNetworkWidget.setConnected"></a>
426 <h4>IrcNetworkWidget.setConnected</h4>
427 <b>setConnected</b>(<i>connected</i>)
428 <p>
429 Public slot to set the connection state.
430 </p><dl>
431 <dt><i>connected</i></dt>
432 <dd>
433 flag indicating the connection state (boolean)
434 </dd>
435 </dl><a NAME="IrcNetworkWidget.setNickName" ID="IrcNetworkWidget.setNickName"></a>
436 <h4>IrcNetworkWidget.setNickName</h4>
437 <b>setNickName</b>(<i>nick</i>)
438 <p>
439 Public slot to set the nick name in use.
440 </p><dl>
441 <dt><i>nick</i></dt>
442 <dd>
443 nick name in use (string)
444 </dd>
445 </dl><a NAME="IrcNetworkWidget.setRegistered" ID="IrcNetworkWidget.setRegistered"></a>
446 <h4>IrcNetworkWidget.setRegistered</h4>
447 <b>setRegistered</b>(<i>registered</i>)
448 <p>
449 Public slot to set the registered state.
450 </p><dl>
451 <dt><i>registered</i></dt>
452 <dd>
453 flag indicating the registration state (boolean)
454 </dd>
455 </dl>
456 <div align="right"><a href="#top">Up</a></div>
457 <hr />
458 </body></html>

Mercurial Repository: eric

eric ide

mercurial