Mercurial Repositories > eric / file comparison

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

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

changeset 2266
f885a0bc2ccc
child 2367
78f6c8193d37
equal deleted inserted replaced
2265:72e6f479987b 2266:f885a0bc2ccc
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Network.IRC.IrcNetworkWidget</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Network.IRC.IrcNetworkWidget</h1>
24 <p>
25 Module implementing the network part of the IRC widget.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#IrcNetworkWidget">IrcNetworkWidget</a></td>
35 <td>Class implementing the network part of the IRC widget.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="IrcNetworkWidget" ID="IrcNetworkWidget"></a>
44 <h2>IrcNetworkWidget</h2>
45 <p>
46 Class implementing the network part of the IRC widget.
47 </p><h3>Signals</h3>
48 <dl>
49 <dt>autoConnected()</dt>
50 <dd>
51 emitted after an automatic connection was initiated
52 </dd><dt>away(bool)</dt>
53 <dd>
54 emitted to indicate the away status
55 </dd><dt>connectNetwork(str,bool)</dt>
56 <dd>
57 emitted to connect or disconnect from 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.__cutMessages">__cutMessages</a></td>
101 <td>Private slot to cut the selection 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.__refreshNetworks">__refreshNetworks</a></td>
107 <td>Private slot to refresh all network related widgets.</td>
108 </tr><tr>
109 <td><a href="#IrcNetworkWidget.__saveMessages">__saveMessages</a></td>
110 <td>Private slot to save the contents of the messages display.</td>
111 </tr><tr>
112 <td><a href="#IrcNetworkWidget.addErrorMessage">addErrorMessage</a></td>
113 <td>Public method to add an error message.</td>
114 </tr><tr>
115 <td><a href="#IrcNetworkWidget.addMessage">addMessage</a></td>
116 <td>Public method to add a message.</td>
117 </tr><tr>
118 <td><a href="#IrcNetworkWidget.addServerMessage">addServerMessage</a></td>
119 <td>Public method to add a server message.</td>
120 </tr><tr>
121 <td><a href="#IrcNetworkWidget.autoConnect">autoConnect</a></td>
122 <td>Public method to perform the IRC auto connection.</td>
123 </tr><tr>
124 <td><a href="#IrcNetworkWidget.getNetworkChannels">getNetworkChannels</a></td>
125 <td>Public method to get the list of channels associated with the selected network.</td>
126 </tr><tr>
127 <td><a href="#IrcNetworkWidget.getNickname">getNickname</a></td>
128 <td>Public method to get the currently selected nick name.</td>
129 </tr><tr>
130 <td><a href="#IrcNetworkWidget.initialize">initialize</a></td>
131 <td>Public method to initialize the widget.</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_copyAvailable">on_messages_copyAvailable</a></td>
149 <td>Private slot to react to text selection/deselection of the messages edit.</td>
150 </tr><tr>
151 <td><a href="#IrcNetworkWidget.on_messages_customContextMenuRequested">on_messages_customContextMenuRequested</a></td>
152 <td>Private slot to show the context menu of the messages pane.</td>
153 </tr><tr>
154 <td><a href="#IrcNetworkWidget.on_networkCombo_currentIndexChanged">on_networkCombo_currentIndexChanged</a></td>
155 <td>Private slot to handle selections of a network.</td>
156 </tr><tr>
157 <td><a href="#IrcNetworkWidget.on_nickCombo_currentIndexChanged">on_nickCombo_currentIndexChanged</a></td>
158 <td>Private slot to use another nick name.</td>
159 </tr><tr>
160 <td><a href="#IrcNetworkWidget.setConnected">setConnected</a></td>
161 <td>Public slot to set the connection state.</td>
162 </tr><tr>
163 <td><a href="#IrcNetworkWidget.setNickName">setNickName</a></td>
164 <td>Public slot to set the nick name in use.</td>
165 </tr><tr>
166 <td><a href="#IrcNetworkWidget.setRegistered">setRegistered</a></td>
167 <td>Public slot to set the registered state.</td>
168 </tr>
169 </table>
170 <h3>Static Methods</h3>
171 <table>
172 <tr><td>None</td></tr>
173 </table>
174 <a NAME="IrcNetworkWidget.__init__" ID="IrcNetworkWidget.__init__"></a>
175 <h4>IrcNetworkWidget (Constructor)</h4>
176 <b>IrcNetworkWidget</b>(<i>parent=None</i>)
177 <p>
178 Constructor
179 </p><dl>
180 <dt><i>parent</i></dt>
181 <dd>
182 reference to the parent widget (QWidget)
183 </dd>
184 </dl><a NAME="IrcNetworkWidget.__clearMessages" ID="IrcNetworkWidget.__clearMessages"></a>
185 <h4>IrcNetworkWidget.__clearMessages</h4>
186 <b>__clearMessages</b>(<i></i>)
187 <p>
188 Private slot to clear the contents of the messages display.
189 </p><a NAME="IrcNetworkWidget.__copyAllMessages" ID="IrcNetworkWidget.__copyAllMessages"></a>
190 <h4>IrcNetworkWidget.__copyAllMessages</h4>
191 <b>__copyAllMessages</b>(<i></i>)
192 <p>
193 Private slot to copy the contents of the messages display to the clipboard.
194 </p><a NAME="IrcNetworkWidget.__copyMessages" ID="IrcNetworkWidget.__copyMessages"></a>
195 <h4>IrcNetworkWidget.__copyMessages</h4>
196 <b>__copyMessages</b>(<i></i>)
197 <p>
198 Private slot to copy the selection of the messages display to the clipboard.
199 </p><a NAME="IrcNetworkWidget.__cutAllMessages" ID="IrcNetworkWidget.__cutAllMessages"></a>
200 <h4>IrcNetworkWidget.__cutAllMessages</h4>
201 <b>__cutAllMessages</b>(<i></i>)
202 <p>
203 Private slot to cut the contents of the messages display to the clipboard.
204 </p><a NAME="IrcNetworkWidget.__cutMessages" ID="IrcNetworkWidget.__cutMessages"></a>
205 <h4>IrcNetworkWidget.__cutMessages</h4>
206 <b>__cutMessages</b>(<i></i>)
207 <p>
208 Private slot to cut the selection of the messages display to the clipboard.
209 </p><a NAME="IrcNetworkWidget.__initMessagesMenu" ID="IrcNetworkWidget.__initMessagesMenu"></a>
210 <h4>IrcNetworkWidget.__initMessagesMenu</h4>
211 <b>__initMessagesMenu</b>(<i></i>)
212 <p>
213 Private slot to initialize the context menu of the messages pane.
214 </p><a NAME="IrcNetworkWidget.__refreshNetworks" ID="IrcNetworkWidget.__refreshNetworks"></a>
215 <h4>IrcNetworkWidget.__refreshNetworks</h4>
216 <b>__refreshNetworks</b>(<i></i>)
217 <p>
218 Private slot to refresh all network related widgets.
219 </p><a NAME="IrcNetworkWidget.__saveMessages" ID="IrcNetworkWidget.__saveMessages"></a>
220 <h4>IrcNetworkWidget.__saveMessages</h4>
221 <b>__saveMessages</b>(<i></i>)
222 <p>
223 Private slot to save the contents of the messages display.
224 </p><a NAME="IrcNetworkWidget.addErrorMessage" ID="IrcNetworkWidget.addErrorMessage"></a>
225 <h4>IrcNetworkWidget.addErrorMessage</h4>
226 <b>addErrorMessage</b>(<i>msgType, msg</i>)
227 <p>
228 Public method to add an error message.
229 </p><dl>
230 <dt><i>msgType</i></dt>
231 <dd>
232 txpe of the message (string)
233 </dd><dt><i>msg</i></dt>
234 <dd>
235 message to be added (string)
236 </dd>
237 </dl><a NAME="IrcNetworkWidget.addMessage" ID="IrcNetworkWidget.addMessage"></a>
238 <h4>IrcNetworkWidget.addMessage</h4>
239 <b>addMessage</b>(<i>msg</i>)
240 <p>
241 Public method to add a message.
242 </p><dl>
243 <dt><i>msg</i></dt>
244 <dd>
245 message to be added (string)
246 </dd>
247 </dl><a NAME="IrcNetworkWidget.addServerMessage" ID="IrcNetworkWidget.addServerMessage"></a>
248 <h4>IrcNetworkWidget.addServerMessage</h4>
249 <b>addServerMessage</b>(<i>msgType, msg, filterMsg=True</i>)
250 <p>
251 Public method to add a server message.
252 </p><dl>
253 <dt><i>msgType</i></dt>
254 <dd>
255 txpe of the message (string)
256 </dd><dt><i>msg</i></dt>
257 <dd>
258 message to be added (string)
259 </dd><dt><i>filterMsg=</i></dt>
260 <dd>
261 flag indicating to filter the message (boolean)
262 </dd>
263 </dl><a NAME="IrcNetworkWidget.autoConnect" ID="IrcNetworkWidget.autoConnect"></a>
264 <h4>IrcNetworkWidget.autoConnect</h4>
265 <b>autoConnect</b>(<i></i>)
266 <p>
267 Public method to perform the IRC auto connection.
268 </p><a NAME="IrcNetworkWidget.getNetworkChannels" ID="IrcNetworkWidget.getNetworkChannels"></a>
269 <h4>IrcNetworkWidget.getNetworkChannels</h4>
270 <b>getNetworkChannels</b>(<i></i>)
271 <p>
272 Public method to get the list of channels associated with the
273 selected network.
274 </p><dl>
275 <dt>Returns:</dt>
276 <dd>
277 associated channels (list of IrcChannel)
278 </dd>
279 </dl><a NAME="IrcNetworkWidget.getNickname" ID="IrcNetworkWidget.getNickname"></a>
280 <h4>IrcNetworkWidget.getNickname</h4>
281 <b>getNickname</b>(<i></i>)
282 <p>
283 Public method to get the currently selected nick name.
284 </p><dl>
285 <dt>Returns:</dt>
286 <dd>
287 selected nick name (string)
288 </dd>
289 </dl><a NAME="IrcNetworkWidget.initialize" ID="IrcNetworkWidget.initialize"></a>
290 <h4>IrcNetworkWidget.initialize</h4>
291 <b>initialize</b>(<i>manager</i>)
292 <p>
293 Public method to initialize the widget.
294 </p><dl>
295 <dt><i>manager</i></dt>
296 <dd>
297 reference to the network manager (IrcNetworkManager)
298 </dd>
299 </dl><a NAME="IrcNetworkWidget.on_awayButton_clicked" ID="IrcNetworkWidget.on_awayButton_clicked"></a>
300 <h4>IrcNetworkWidget.on_awayButton_clicked</h4>
301 <b>on_awayButton_clicked</b>(<i></i>)
302 <p>
303 Private slot to toggle the away status.
304 </p><a NAME="IrcNetworkWidget.on_channelCombo_editTextChanged" ID="IrcNetworkWidget.on_channelCombo_editTextChanged"></a>
305 <h4>IrcNetworkWidget.on_channelCombo_editTextChanged</h4>
306 <b>on_channelCombo_editTextChanged</b>(<i>txt</i>)
307 <p>
308 Private slot to react upon changes of the channel.
309 </p><dl>
310 <dt><i>txt</i></dt>
311 <dd>
312 current text of the channel combo (string)
313 </dd>
314 </dl><a NAME="IrcNetworkWidget.on_connectButton_clicked" ID="IrcNetworkWidget.on_connectButton_clicked"></a>
315 <h4>IrcNetworkWidget.on_connectButton_clicked</h4>
316 <b>on_connectButton_clicked</b>(<i></i>)
317 <p>
318 Private slot to connect to a network.
319 </p><a NAME="IrcNetworkWidget.on_editButton_clicked" ID="IrcNetworkWidget.on_editButton_clicked"></a>
320 <h4>IrcNetworkWidget.on_editButton_clicked</h4>
321 <b>on_editButton_clicked</b>(<i></i>)
322 <p>
323 Private slot to edit a network.
324 </p><a NAME="IrcNetworkWidget.on_joinButton_clicked" ID="IrcNetworkWidget.on_joinButton_clicked"></a>
325 <h4>IrcNetworkWidget.on_joinButton_clicked</h4>
326 <b>on_joinButton_clicked</b>(<i></i>)
327 <p>
328 Private slot to join a channel.
329 </p><a NAME="IrcNetworkWidget.on_messages_copyAvailable" ID="IrcNetworkWidget.on_messages_copyAvailable"></a>
330 <h4>IrcNetworkWidget.on_messages_copyAvailable</h4>
331 <b>on_messages_copyAvailable</b>(<i>yes</i>)
332 <p>
333 Private slot to react to text selection/deselection of the messages edit.
334 </p><dl>
335 <dt><i>yes</i></dt>
336 <dd>
337 flag signaling the availability of selected text (boolean)
338 </dd>
339 </dl><a NAME="IrcNetworkWidget.on_messages_customContextMenuRequested" ID="IrcNetworkWidget.on_messages_customContextMenuRequested"></a>
340 <h4>IrcNetworkWidget.on_messages_customContextMenuRequested</h4>
341 <b>on_messages_customContextMenuRequested</b>(<i>pos</i>)
342 <p>
343 Private slot to show the context menu of the messages pane.
344 </p><a NAME="IrcNetworkWidget.on_networkCombo_currentIndexChanged" ID="IrcNetworkWidget.on_networkCombo_currentIndexChanged"></a>
345 <h4>IrcNetworkWidget.on_networkCombo_currentIndexChanged</h4>
346 <b>on_networkCombo_currentIndexChanged</b>(<i>networkName</i>)
347 <p>
348 Private slot to handle selections of a network.
349 </p><dl>
350 <dt><i>networkName</i></dt>
351 <dd>
352 selected network name (string)
353 </dd>
354 </dl><a NAME="IrcNetworkWidget.on_nickCombo_currentIndexChanged" ID="IrcNetworkWidget.on_nickCombo_currentIndexChanged"></a>
355 <h4>IrcNetworkWidget.on_nickCombo_currentIndexChanged</h4>
356 <b>on_nickCombo_currentIndexChanged</b>(<i>nick=""</i>)
357 <p>
358 Private slot to use another nick name.
359 </p><dl>
360 <dt><i>nick</i></dt>
361 <dd>
362 nick name to use (string)
363 </dd>
364 </dl><a NAME="IrcNetworkWidget.setConnected" ID="IrcNetworkWidget.setConnected"></a>
365 <h4>IrcNetworkWidget.setConnected</h4>
366 <b>setConnected</b>(<i>connected</i>)
367 <p>
368 Public slot to set the connection state.
369 </p><dl>
370 <dt><i>connected</i></dt>
371 <dd>
372 flag indicating the connection state (boolean)
373 </dd>
374 </dl><a NAME="IrcNetworkWidget.setNickName" ID="IrcNetworkWidget.setNickName"></a>
375 <h4>IrcNetworkWidget.setNickName</h4>
376 <b>setNickName</b>(<i>nick</i>)
377 <p>
378 Public slot to set the nick name in use.
379 </p><dl>
380 <dt><i>nick</i></dt>
381 <dd>
382 nick name in use (string)
383 </dd>
384 </dl><a NAME="IrcNetworkWidget.setRegistered" ID="IrcNetworkWidget.setRegistered"></a>
385 <h4>IrcNetworkWidget.setRegistered</h4>
386 <b>setRegistered</b>(<i>registered</i>)
387 <p>
388 Public slot to set the registered state.
389 </p><dl>
390 <dt><i>connected</i></dt>
391 <dd>
392 flag indicating the connection state (boolean)
393 </dd>
394 </dl>
395 <div align="right"><a href="#top">Up</a></div>
396 <hr />
397 </body></html>

Mercurial Repository: eric

eric ide

mercurial