Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial