Mercurial Repositories > eric / file comparison

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

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

changeset 3673
e26d7d0c1088
child 4630
7b0e38956b5c
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
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)</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.__clearMessages">__clearMessages</a></td>
89 <td>Private slot to clear the contents of the messages display.</td>
90 </tr><tr>
91 <td><a href="#IrcNetworkWidget.__copyAllMessages">__copyAllMessages</a></td>
92 <td>Private slot to copy the contents of the messages display to the clipboard.</td>
93 </tr><tr>
94 <td><a href="#IrcNetworkWidget.__copyMessages">__copyMessages</a></td>
95 <td>Private slot to copy the selection of the messages display to the clipboard.</td>
96 </tr><tr>
97 <td><a href="#IrcNetworkWidget.__cutAllMessages">__cutAllMessages</a></td>
98 <td>Private slot to cut the contents of the messages display to the clipboard.</td>
99 </tr><tr>
100 <td><a href="#IrcNetworkWidget.__initMessagesMenu">__initMessagesMenu</a></td>
101 <td>Private slot to initialize the context menu of the messages pane.</td>
102 </tr><tr>
103 <td><a href="#IrcNetworkWidget.__refreshNetworks">__refreshNetworks</a></td>
104 <td>Private slot to refresh all network related widgets.</td>
105 </tr><tr>
106 <td><a href="#IrcNetworkWidget.__saveMessages">__saveMessages</a></td>
107 <td>Private slot to save the contents of the messages display.</td>
108 </tr><tr>
109 <td><a href="#IrcNetworkWidget.addErrorMessage">addErrorMessage</a></td>
110 <td>Public method to add an error message.</td>
111 </tr><tr>
112 <td><a href="#IrcNetworkWidget.addMessage">addMessage</a></td>
113 <td>Public method to add a message.</td>
114 </tr><tr>
115 <td><a href="#IrcNetworkWidget.addServerMessage">addServerMessage</a></td>
116 <td>Public method to add a server message.</td>
117 </tr><tr>
118 <td><a href="#IrcNetworkWidget.autoConnect">autoConnect</a></td>
119 <td>Public method to perform the IRC auto connection.</td>
120 </tr><tr>
121 <td><a href="#IrcNetworkWidget.getNetworkChannels">getNetworkChannels</a></td>
122 <td>Public method to get the list of channels associated with the selected network.</td>
123 </tr><tr>
124 <td><a href="#IrcNetworkWidget.getNickname">getNickname</a></td>
125 <td>Public method to get the currently selected nick name.</td>
126 </tr><tr>
127 <td><a href="#IrcNetworkWidget.initialize">initialize</a></td>
128 <td>Public method to initialize the widget.</td>
129 </tr><tr>
130 <td><a href="#IrcNetworkWidget.isConnected">isConnected</a></td>
131 <td>Public method to check, if the network is connected.</td>
132 </tr><tr>
133 <td><a href="#IrcNetworkWidget.on_awayButton_clicked">on_awayButton_clicked</a></td>
134 <td>Private slot to toggle the away status.</td>
135 </tr><tr>
136 <td><a href="#IrcNetworkWidget.on_channelCombo_editTextChanged">on_channelCombo_editTextChanged</a></td>
137 <td>Private slot to react upon changes of the channel.</td>
138 </tr><tr>
139 <td><a href="#IrcNetworkWidget.on_connectButton_clicked">on_connectButton_clicked</a></td>
140 <td>Private slot to connect to a network.</td>
141 </tr><tr>
142 <td><a href="#IrcNetworkWidget.on_editButton_clicked">on_editButton_clicked</a></td>
143 <td>Private slot to edit a network.</td>
144 </tr><tr>
145 <td><a href="#IrcNetworkWidget.on_joinButton_clicked">on_joinButton_clicked</a></td>
146 <td>Private slot to join a channel.</td>
147 </tr><tr>
148 <td><a href="#IrcNetworkWidget.on_messages_anchorClicked">on_messages_anchorClicked</a></td>
149 <td>Private slot to open links in the default browser.</td>
150 </tr><tr>
151 <td><a href="#IrcNetworkWidget.on_messages_copyAvailable">on_messages_copyAvailable</a></td>
152 <td>Private slot to react to text selection/deselection of the messages edit.</td>
153 </tr><tr>
154 <td><a href="#IrcNetworkWidget.on_messages_customContextMenuRequested">on_messages_customContextMenuRequested</a></td>
155 <td>Private slot to show the context menu of the messages pane.</td>
156 </tr><tr>
157 <td><a href="#IrcNetworkWidget.on_networkCombo_currentIndexChanged">on_networkCombo_currentIndexChanged</a></td>
158 <td>Private slot to handle selections of a network.</td>
159 </tr><tr>
160 <td><a href="#IrcNetworkWidget.on_nickCombo_currentIndexChanged">on_nickCombo_currentIndexChanged</a></td>
161 <td>Private slot to use another nick name.</td>
162 </tr><tr>
163 <td><a href="#IrcNetworkWidget.setConnected">setConnected</a></td>
164 <td>Public slot to set the connection state.</td>
165 </tr><tr>
166 <td><a href="#IrcNetworkWidget.setNickName">setNickName</a></td>
167 <td>Public slot to set the nick name in use.</td>
168 </tr><tr>
169 <td><a href="#IrcNetworkWidget.setRegistered">setRegistered</a></td>
170 <td>Public slot to set the registered state.</td>
171 </tr>
172 </table>
173 <h3>Static Methods</h3>
174 <table>
175 <tr><td>None</td></tr>
176 </table>
177 <a NAME="IrcNetworkWidget.__init__" ID="IrcNetworkWidget.__init__"></a>
178 <h4>IrcNetworkWidget (Constructor)</h4>
179 <b>IrcNetworkWidget</b>(<i>parent=None</i>)
180 <p>
181 Constructor
182 </p><dl>
183 <dt><i>parent</i></dt>
184 <dd>
185 reference to the parent widget (QWidget)
186 </dd>
187 </dl><a NAME="IrcNetworkWidget.__clearMessages" ID="IrcNetworkWidget.__clearMessages"></a>
188 <h4>IrcNetworkWidget.__clearMessages</h4>
189 <b>__clearMessages</b>(<i></i>)
190 <p>
191 Private slot to clear the contents of the messages display.
192 </p><a NAME="IrcNetworkWidget.__copyAllMessages" ID="IrcNetworkWidget.__copyAllMessages"></a>
193 <h4>IrcNetworkWidget.__copyAllMessages</h4>
194 <b>__copyAllMessages</b>(<i></i>)
195 <p>
196 Private slot to copy the contents of the messages display to
197 the clipboard.
198 </p><a NAME="IrcNetworkWidget.__copyMessages" ID="IrcNetworkWidget.__copyMessages"></a>
199 <h4>IrcNetworkWidget.__copyMessages</h4>
200 <b>__copyMessages</b>(<i></i>)
201 <p>
202 Private slot to copy the selection of the messages display to
203 the clipboard.
204 </p><a NAME="IrcNetworkWidget.__cutAllMessages" ID="IrcNetworkWidget.__cutAllMessages"></a>
205 <h4>IrcNetworkWidget.__cutAllMessages</h4>
206 <b>__cutAllMessages</b>(<i></i>)
207 <p>
208 Private slot to cut the contents of the messages display to
209 the clipboard.
210 </p><a NAME="IrcNetworkWidget.__initMessagesMenu" ID="IrcNetworkWidget.__initMessagesMenu"></a>
211 <h4>IrcNetworkWidget.__initMessagesMenu</h4>
212 <b>__initMessagesMenu</b>(<i></i>)
213 <p>
214 Private slot to initialize the context menu of the messages pane.
215 </p><a NAME="IrcNetworkWidget.__refreshNetworks" ID="IrcNetworkWidget.__refreshNetworks"></a>
216 <h4>IrcNetworkWidget.__refreshNetworks</h4>
217 <b>__refreshNetworks</b>(<i></i>)
218 <p>
219 Private slot to refresh all network related widgets.
220 </p><a NAME="IrcNetworkWidget.__saveMessages" ID="IrcNetworkWidget.__saveMessages"></a>
221 <h4>IrcNetworkWidget.__saveMessages</h4>
222 <b>__saveMessages</b>(<i></i>)
223 <p>
224 Private slot to save the contents of the messages display.
225 </p><a NAME="IrcNetworkWidget.addErrorMessage" ID="IrcNetworkWidget.addErrorMessage"></a>
226 <h4>IrcNetworkWidget.addErrorMessage</h4>
227 <b>addErrorMessage</b>(<i>msgType, msg</i>)
228 <p>
229 Public method to add an error message.
230 </p><dl>
231 <dt><i>msgType</i></dt>
232 <dd>
233 txpe of the message (string)
234 </dd><dt><i>msg</i></dt>
235 <dd>
236 message to be added (string)
237 </dd>
238 </dl><a NAME="IrcNetworkWidget.addMessage" ID="IrcNetworkWidget.addMessage"></a>
239 <h4>IrcNetworkWidget.addMessage</h4>
240 <b>addMessage</b>(<i>msg</i>)
241 <p>
242 Public method to add a message.
243 </p><dl>
244 <dt><i>msg</i></dt>
245 <dd>
246 message to be added (string)
247 </dd>
248 </dl><a NAME="IrcNetworkWidget.addServerMessage" ID="IrcNetworkWidget.addServerMessage"></a>
249 <h4>IrcNetworkWidget.addServerMessage</h4>
250 <b>addServerMessage</b>(<i>msgType, msg, filterMsg=True</i>)
251 <p>
252 Public method to add a server message.
253 </p><dl>
254 <dt><i>msgType</i></dt>
255 <dd>
256 txpe of the message (string)
257 </dd><dt><i>msg</i></dt>
258 <dd>
259 message to be added (string)
260 </dd><dt><i>filterMsg=</i></dt>
261 <dd>
262 flag indicating to filter the message (boolean)
263 </dd>
264 </dl><a NAME="IrcNetworkWidget.autoConnect" ID="IrcNetworkWidget.autoConnect"></a>
265 <h4>IrcNetworkWidget.autoConnect</h4>
266 <b>autoConnect</b>(<i></i>)
267 <p>
268 Public method to perform the IRC auto connection.
269 </p><a NAME="IrcNetworkWidget.getNetworkChannels" ID="IrcNetworkWidget.getNetworkChannels"></a>
270 <h4>IrcNetworkWidget.getNetworkChannels</h4>
271 <b>getNetworkChannels</b>(<i></i>)
272 <p>
273 Public method to get the list of channels associated with the
274 selected network.
275 </p><dl>
276 <dt>Returns:</dt>
277 <dd>
278 associated channels (list of IrcChannel)
279 </dd>
280 </dl><a NAME="IrcNetworkWidget.getNickname" ID="IrcNetworkWidget.getNickname"></a>
281 <h4>IrcNetworkWidget.getNickname</h4>
282 <b>getNickname</b>(<i></i>)
283 <p>
284 Public method to get the currently selected nick name.
285 </p><dl>
286 <dt>Returns:</dt>
287 <dd>
288 selected nick name (string)
289 </dd>
290 </dl><a NAME="IrcNetworkWidget.initialize" ID="IrcNetworkWidget.initialize"></a>
291 <h4>IrcNetworkWidget.initialize</h4>
292 <b>initialize</b>(<i>manager</i>)
293 <p>
294 Public method to initialize the widget.
295 </p><dl>
296 <dt><i>manager</i></dt>
297 <dd>
298 reference to the network manager (IrcNetworkManager)
299 </dd>
300 </dl><a NAME="IrcNetworkWidget.isConnected" ID="IrcNetworkWidget.isConnected"></a>
301 <h4>IrcNetworkWidget.isConnected</h4>
302 <b>isConnected</b>(<i></i>)
303 <p>
304 Public method to check, if the network is connected.
305 </p><dl>
306 <dt>Returns:</dt>
307 <dd>
308 flag indicating a connected network (boolean)
309 </dd>
310 </dl><a NAME="IrcNetworkWidget.on_awayButton_clicked" ID="IrcNetworkWidget.on_awayButton_clicked"></a>
311 <h4>IrcNetworkWidget.on_awayButton_clicked</h4>
312 <b>on_awayButton_clicked</b>(<i></i>)
313 <p>
314 Private slot to toggle the away status.
315 </p><a NAME="IrcNetworkWidget.on_channelCombo_editTextChanged" ID="IrcNetworkWidget.on_channelCombo_editTextChanged"></a>
316 <h4>IrcNetworkWidget.on_channelCombo_editTextChanged</h4>
317 <b>on_channelCombo_editTextChanged</b>(<i>txt</i>)
318 <p>
319 Private slot to react upon changes of the channel.
320 </p><dl>
321 <dt><i>txt</i></dt>
322 <dd>
323 current text of the channel combo (string)
324 </dd>
325 </dl><a NAME="IrcNetworkWidget.on_connectButton_clicked" ID="IrcNetworkWidget.on_connectButton_clicked"></a>
326 <h4>IrcNetworkWidget.on_connectButton_clicked</h4>
327 <b>on_connectButton_clicked</b>(<i></i>)
328 <p>
329 Private slot to connect to a network.
330 </p><a NAME="IrcNetworkWidget.on_editButton_clicked" ID="IrcNetworkWidget.on_editButton_clicked"></a>
331 <h4>IrcNetworkWidget.on_editButton_clicked</h4>
332 <b>on_editButton_clicked</b>(<i></i>)
333 <p>
334 Private slot to edit a network.
335 </p><a NAME="IrcNetworkWidget.on_joinButton_clicked" ID="IrcNetworkWidget.on_joinButton_clicked"></a>
336 <h4>IrcNetworkWidget.on_joinButton_clicked</h4>
337 <b>on_joinButton_clicked</b>(<i></i>)
338 <p>
339 Private slot to join a channel.
340 </p><a NAME="IrcNetworkWidget.on_messages_anchorClicked" ID="IrcNetworkWidget.on_messages_anchorClicked"></a>
341 <h4>IrcNetworkWidget.on_messages_anchorClicked</h4>
342 <b>on_messages_anchorClicked</b>(<i>url</i>)
343 <p>
344 Private slot to open links in the default browser.
345 </p><dl>
346 <dt><i>url</i></dt>
347 <dd>
348 URL to be opened (QUrl)
349 </dd>
350 </dl><a NAME="IrcNetworkWidget.on_messages_copyAvailable" ID="IrcNetworkWidget.on_messages_copyAvailable"></a>
351 <h4>IrcNetworkWidget.on_messages_copyAvailable</h4>
352 <b>on_messages_copyAvailable</b>(<i>yes</i>)
353 <p>
354 Private slot to react to text selection/deselection of the
355 messages edit.
356 </p><dl>
357 <dt><i>yes</i></dt>
358 <dd>
359 flag signaling the availability of selected text (boolean)
360 </dd>
361 </dl><a NAME="IrcNetworkWidget.on_messages_customContextMenuRequested" ID="IrcNetworkWidget.on_messages_customContextMenuRequested"></a>
362 <h4>IrcNetworkWidget.on_messages_customContextMenuRequested</h4>
363 <b>on_messages_customContextMenuRequested</b>(<i>pos</i>)
364 <p>
365 Private slot to show the context menu of the messages pane.
366 </p><dl>
367 <dt><i>pos</i></dt>
368 <dd>
369 position the menu should be opened at (QPoint)
370 </dd>
371 </dl><a NAME="IrcNetworkWidget.on_networkCombo_currentIndexChanged" ID="IrcNetworkWidget.on_networkCombo_currentIndexChanged"></a>
372 <h4>IrcNetworkWidget.on_networkCombo_currentIndexChanged</h4>
373 <b>on_networkCombo_currentIndexChanged</b>(<i>networkName</i>)
374 <p>
375 Private slot to handle selections of a network.
376 </p><dl>
377 <dt><i>networkName</i></dt>
378 <dd>
379 selected network name (string)
380 </dd>
381 </dl><a NAME="IrcNetworkWidget.on_nickCombo_currentIndexChanged" ID="IrcNetworkWidget.on_nickCombo_currentIndexChanged"></a>
382 <h4>IrcNetworkWidget.on_nickCombo_currentIndexChanged</h4>
383 <b>on_nickCombo_currentIndexChanged</b>(<i>nick=""</i>)
384 <p>
385 Private slot to use another nick name.
386 </p><dl>
387 <dt><i>nick</i></dt>
388 <dd>
389 nick name to use (string)
390 </dd>
391 </dl><a NAME="IrcNetworkWidget.setConnected" ID="IrcNetworkWidget.setConnected"></a>
392 <h4>IrcNetworkWidget.setConnected</h4>
393 <b>setConnected</b>(<i>connected</i>)
394 <p>
395 Public slot to set the connection state.
396 </p><dl>
397 <dt><i>connected</i></dt>
398 <dd>
399 flag indicating the connection state (boolean)
400 </dd>
401 </dl><a NAME="IrcNetworkWidget.setNickName" ID="IrcNetworkWidget.setNickName"></a>
402 <h4>IrcNetworkWidget.setNickName</h4>
403 <b>setNickName</b>(<i>nick</i>)
404 <p>
405 Public slot to set the nick name in use.
406 </p><dl>
407 <dt><i>nick</i></dt>
408 <dd>
409 nick name in use (string)
410 </dd>
411 </dl><a NAME="IrcNetworkWidget.setRegistered" ID="IrcNetworkWidget.setRegistered"></a>
412 <h4>IrcNetworkWidget.setRegistered</h4>
413 <b>setRegistered</b>(<i>registered</i>)
414 <p>
415 Public slot to set the registered state.
416 </p><dl>
417 <dt><i>registered</i></dt>
418 <dd>
419 flag indicating the registration state (boolean)
420 </dd>
421 </dl>
422 <div align="right"><a href="#top">Up</a></div>
423 <hr />
424 </body></html>

Mercurial Repository: eric

eric ide

mercurial