Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Cooperation.ChatWidget.html

eric6/Documentation/Source/eric6.Cooperation.ChatWidget.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.Cooperation.ChatWidget</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.Cooperation.ChatWidget</h1>
23 <p>
24 Module implementing the chat dialog.
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="#ChatWidget">ChatWidget</a></td>
34 <td>Class implementing the chat dialog.</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="ChatWidget" ID="ChatWidget"></a>
43 <h2>ChatWidget</h2>
44 <p>
45 Class implementing the chat dialog.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>cancelEdit()</dt>
49 <dd>
50 emitted to cancel a shared edit session
51 </dd><dt>connected(connected)</dt>
52 <dd>
53 emitted to signal a change of the connected
54 state (bool)
55 </dd><dt>editorCommand(hashStr, filename, message)</dt>
56 <dd>
57 emitted when an editor
58 command has been received (string, string, string)
59 </dd><dt>sendEdit()</dt>
60 <dd>
61 emitted to send a shared edit session
62 </dd><dt>shareEditor(share)</dt>
63 <dd>
64 emitted to signal a share is requested (bool)
65 </dd><dt>startEdit()</dt>
66 <dd>
67 emitted to start a shared edit session
68 </dd>
69 </dl>
70 <h3>Derived from</h3>
71 QWidget, Ui_ChatWidget
72 <h3>Class Attributes</h3>
73 <table>
74 <tr><td>None</td></tr>
75 </table>
76 <h3>Class Methods</h3>
77 <table>
78 <tr><td>None</td></tr>
79 </table>
80 <h3>Methods</h3>
81 <table>
82 <tr>
83 <td><a href="#ChatWidget.__init__">ChatWidget</a></td>
84 <td>Constructor</td>
85 </tr><tr>
86 <td><a href="#ChatWidget.__banKickUser">__banKickUser</a></td>
87 <td>Private slot to ban and kick a user.</td>
88 </tr><tr>
89 <td><a href="#ChatWidget.__banUser">__banUser</a></td>
90 <td>Private slot to ban a user.</td>
91 </tr><tr>
92 <td><a href="#ChatWidget.__clearChat">__clearChat</a></td>
93 <td>Private slot to clear the contents of the chat display.</td>
94 </tr><tr>
95 <td><a href="#ChatWidget.__clearHostsHistory">__clearHostsHistory</a></td>
96 <td>Private slot to clear the hosts history.</td>
97 </tr><tr>
98 <td><a href="#ChatWidget.__copyAllChat">__copyAllChat</a></td>
99 <td>Private slot to copy the contents of the chat display to the clipboard.</td>
100 </tr><tr>
101 <td><a href="#ChatWidget.__copyChat">__copyChat</a></td>
102 <td>Private slot to copy the contents of the chat display to the clipboard.</td>
103 </tr><tr>
104 <td><a href="#ChatWidget.__cutAllChat">__cutAllChat</a></td>
105 <td>Private slot to cut the contents of the chat display to the clipboard.</td>
106 </tr><tr>
107 <td><a href="#ChatWidget.__editorCommandMessage">__editorCommandMessage</a></td>
108 <td>Private slot to handle editor command messages from the client.</td>
109 </tr><tr>
110 <td><a href="#ChatWidget.__getConnectionParameters">__getConnectionParameters</a></td>
111 <td>Private method to determine the connection parameters.</td>
112 </tr><tr>
113 <td><a href="#ChatWidget.__handleMessage">__handleMessage</a></td>
114 <td>Private slot handling the Return key pressed in the message edit.</td>
115 </tr><tr>
116 <td><a href="#ChatWidget.__initChatMenu">__initChatMenu</a></td>
117 <td>Private slot to initialize the chat edit context menu.</td>
118 </tr><tr>
119 <td><a href="#ChatWidget.__initUsersMenu">__initUsersMenu</a></td>
120 <td>Private slot to initialize the users list context menu.</td>
121 </tr><tr>
122 <td><a href="#ChatWidget.__initialConnectionRefused">__initialConnectionRefused</a></td>
123 <td>Private slot to handle the refusal of the initial connection.</td>
124 </tr><tr>
125 <td><a href="#ChatWidget.__kickUser">__kickUser</a></td>
126 <td>Private slot to disconnect a user.</td>
127 </tr><tr>
128 <td><a href="#ChatWidget.__loadHostsHistory">__loadHostsHistory</a></td>
129 <td>Private method to load the recently connected hosts.</td>
130 </tr><tr>
131 <td><a href="#ChatWidget.__newParticipant">__newParticipant</a></td>
132 <td>Private slot handling a new participant joining.</td>
133 </tr><tr>
134 <td><a href="#ChatWidget.__participantLeft">__participantLeft</a></td>
135 <td>Private slot handling a participant leaving the session.</td>
136 </tr><tr>
137 <td><a href="#ChatWidget.__saveChat">__saveChat</a></td>
138 <td>Private slot to save the contents of the chat display.</td>
139 </tr><tr>
140 <td><a href="#ChatWidget.__saveHostsHistory">__saveHostsHistory</a></td>
141 <td>Private method to save the list of recently connected hosts.</td>
142 </tr><tr>
143 <td><a href="#ChatWidget.__setConnected">__setConnected</a></td>
144 <td>Private slot to set the connected state.</td>
145 </tr><tr>
146 <td><a href="#ChatWidget.__setHostsHistory">__setHostsHistory</a></td>
147 <td>Private method to remember the given host as the most recent entry.</td>
148 </tr><tr>
149 <td><a href="#ChatWidget.__showErrorMessage">__showErrorMessage</a></td>
150 <td>Private slot to show an error message.</td>
151 </tr><tr>
152 <td><a href="#ChatWidget.appendMessage">appendMessage</a></td>
153 <td>Public slot to append a message to the display.</td>
154 </tr><tr>
155 <td><a href="#ChatWidget.checkEditorActions">checkEditorActions</a></td>
156 <td>Public slot to set action according to an editor's state.</td>
157 </tr><tr>
158 <td><a href="#ChatWidget.getClient">getClient</a></td>
159 <td>Public method to get a reference to the cooperation client.</td>
160 </tr><tr>
161 <td><a href="#ChatWidget.on_cancelEditButton_clicked">on_cancelEditButton_clicked</a></td>
162 <td>Private slot to cancel a shared edit session.</td>
163 </tr><tr>
164 <td><a href="#ChatWidget.on_chatEdit_copyAvailable">on_chatEdit_copyAvailable</a></td>
165 <td>Private slot to react to text selection/deselection of the chat edit.</td>
166 </tr><tr>
167 <td><a href="#ChatWidget.on_chatEdit_customContextMenuRequested">on_chatEdit_customContextMenuRequested</a></td>
168 <td>Private slot to show the context menu for the chat.</td>
169 </tr><tr>
170 <td><a href="#ChatWidget.on_clearHostsButton_clicked">on_clearHostsButton_clicked</a></td>
171 <td>Private slot to clear the hosts list.</td>
172 </tr><tr>
173 <td><a href="#ChatWidget.on_connectButton_clicked">on_connectButton_clicked</a></td>
174 <td>Private slot initiating the connection.</td>
175 </tr><tr>
176 <td><a href="#ChatWidget.on_hostEdit_editTextChanged">on_hostEdit_editTextChanged</a></td>
177 <td>Private slot handling the entry of a host to connect to.</td>
178 </tr><tr>
179 <td><a href="#ChatWidget.on_sendEditButton_clicked">on_sendEditButton_clicked</a></td>
180 <td>Private slot to end a shared edit session and send the changes.</td>
181 </tr><tr>
182 <td><a href="#ChatWidget.on_serverButton_clicked">on_serverButton_clicked</a></td>
183 <td>Private slot to start the server.</td>
184 </tr><tr>
185 <td><a href="#ChatWidget.on_shareButton_clicked">on_shareButton_clicked</a></td>
186 <td>Private slot to share the current editor.</td>
187 </tr><tr>
188 <td><a href="#ChatWidget.on_startEditButton_clicked">on_startEditButton_clicked</a></td>
189 <td>Private slot to start a shared edit session.</td>
190 </tr><tr>
191 <td><a href="#ChatWidget.on_usersList_customContextMenuRequested">on_usersList_customContextMenuRequested</a></td>
192 <td>Private slot to show the context menu for the users list.</td>
193 </tr><tr>
194 <td><a href="#ChatWidget.preferencesChanged">preferencesChanged</a></td>
195 <td>Public slot to handle a change of preferences.</td>
196 </tr><tr>
197 <td><a href="#ChatWidget.shutdown">shutdown</a></td>
198 <td>Public method to shut down the cooperation system.</td>
199 </tr>
200 </table>
201 <h3>Static Methods</h3>
202 <table>
203 <tr><td>None</td></tr>
204 </table>
205 <a NAME="ChatWidget.__init__" ID="ChatWidget.__init__"></a>
206 <h4>ChatWidget (Constructor)</h4>
207 <b>ChatWidget</b>(<i>ui, port=-1, parent=None</i>)
208 <p>
209 Constructor
210 </p><dl>
211 <dt><i>ui</i></dt>
212 <dd>
213 reference to the user interface object (UserInterface)
214 </dd><dt><i>port</i></dt>
215 <dd>
216 port to be used for the cooperation server (integer)
217 </dd><dt><i>parent</i></dt>
218 <dd>
219 reference to the parent widget (QWidget)
220 </dd>
221 </dl><a NAME="ChatWidget.__banKickUser" ID="ChatWidget.__banKickUser"></a>
222 <h4>ChatWidget.__banKickUser</h4>
223 <b>__banKickUser</b>(<i></i>)
224 <p>
225 Private slot to ban and kick a user.
226 </p><a NAME="ChatWidget.__banUser" ID="ChatWidget.__banUser"></a>
227 <h4>ChatWidget.__banUser</h4>
228 <b>__banUser</b>(<i></i>)
229 <p>
230 Private slot to ban a user.
231 </p><a NAME="ChatWidget.__clearChat" ID="ChatWidget.__clearChat"></a>
232 <h4>ChatWidget.__clearChat</h4>
233 <b>__clearChat</b>(<i></i>)
234 <p>
235 Private slot to clear the contents of the chat display.
236 </p><a NAME="ChatWidget.__clearHostsHistory" ID="ChatWidget.__clearHostsHistory"></a>
237 <h4>ChatWidget.__clearHostsHistory</h4>
238 <b>__clearHostsHistory</b>(<i></i>)
239 <p>
240 Private slot to clear the hosts history.
241 </p><a NAME="ChatWidget.__copyAllChat" ID="ChatWidget.__copyAllChat"></a>
242 <h4>ChatWidget.__copyAllChat</h4>
243 <b>__copyAllChat</b>(<i></i>)
244 <p>
245 Private slot to copy the contents of the chat display to the clipboard.
246 </p><a NAME="ChatWidget.__copyChat" ID="ChatWidget.__copyChat"></a>
247 <h4>ChatWidget.__copyChat</h4>
248 <b>__copyChat</b>(<i></i>)
249 <p>
250 Private slot to copy the contents of the chat display to the clipboard.
251 </p><a NAME="ChatWidget.__cutAllChat" ID="ChatWidget.__cutAllChat"></a>
252 <h4>ChatWidget.__cutAllChat</h4>
253 <b>__cutAllChat</b>(<i></i>)
254 <p>
255 Private slot to cut the contents of the chat display to the clipboard.
256 </p><a NAME="ChatWidget.__editorCommandMessage" ID="ChatWidget.__editorCommandMessage"></a>
257 <h4>ChatWidget.__editorCommandMessage</h4>
258 <b>__editorCommandMessage</b>(<i>hashStr, fileName, message</i>)
259 <p>
260 Private slot to handle editor command messages from the client.
261 </p><dl>
262 <dt><i>hashStr</i></dt>
263 <dd>
264 hash of the project (string)
265 </dd><dt><i>fileName</i></dt>
266 <dd>
267 project relative file name of the editor (string)
268 </dd><dt><i>message</i></dt>
269 <dd>
270 command message (string)
271 </dd>
272 </dl><a NAME="ChatWidget.__getConnectionParameters" ID="ChatWidget.__getConnectionParameters"></a>
273 <h4>ChatWidget.__getConnectionParameters</h4>
274 <b>__getConnectionParameters</b>(<i></i>)
275 <p>
276 Private method to determine the connection parameters.
277 </p><dl>
278 <dt>Returns:</dt>
279 <dd>
280 tuple with hostname and port (string, integer)
281 </dd>
282 </dl><a NAME="ChatWidget.__handleMessage" ID="ChatWidget.__handleMessage"></a>
283 <h4>ChatWidget.__handleMessage</h4>
284 <b>__handleMessage</b>(<i></i>)
285 <p>
286 Private slot handling the Return key pressed in the message edit.
287 </p><a NAME="ChatWidget.__initChatMenu" ID="ChatWidget.__initChatMenu"></a>
288 <h4>ChatWidget.__initChatMenu</h4>
289 <b>__initChatMenu</b>(<i></i>)
290 <p>
291 Private slot to initialize the chat edit context menu.
292 </p><a NAME="ChatWidget.__initUsersMenu" ID="ChatWidget.__initUsersMenu"></a>
293 <h4>ChatWidget.__initUsersMenu</h4>
294 <b>__initUsersMenu</b>(<i></i>)
295 <p>
296 Private slot to initialize the users list context menu.
297 </p><a NAME="ChatWidget.__initialConnectionRefused" ID="ChatWidget.__initialConnectionRefused"></a>
298 <h4>ChatWidget.__initialConnectionRefused</h4>
299 <b>__initialConnectionRefused</b>(<i></i>)
300 <p>
301 Private slot to handle the refusal of the initial connection.
302 </p><a NAME="ChatWidget.__kickUser" ID="ChatWidget.__kickUser"></a>
303 <h4>ChatWidget.__kickUser</h4>
304 <b>__kickUser</b>(<i></i>)
305 <p>
306 Private slot to disconnect a user.
307 </p><a NAME="ChatWidget.__loadHostsHistory" ID="ChatWidget.__loadHostsHistory"></a>
308 <h4>ChatWidget.__loadHostsHistory</h4>
309 <b>__loadHostsHistory</b>(<i></i>)
310 <p>
311 Private method to load the recently connected hosts.
312 </p><a NAME="ChatWidget.__newParticipant" ID="ChatWidget.__newParticipant"></a>
313 <h4>ChatWidget.__newParticipant</h4>
314 <b>__newParticipant</b>(<i>nick</i>)
315 <p>
316 Private slot handling a new participant joining.
317 </p><dl>
318 <dt><i>nick</i></dt>
319 <dd>
320 nick name of the new participant (string)
321 </dd>
322 </dl><a NAME="ChatWidget.__participantLeft" ID="ChatWidget.__participantLeft"></a>
323 <h4>ChatWidget.__participantLeft</h4>
324 <b>__participantLeft</b>(<i>nick</i>)
325 <p>
326 Private slot handling a participant leaving the session.
327 </p><dl>
328 <dt><i>nick</i></dt>
329 <dd>
330 nick name of the participant (string)
331 </dd>
332 </dl><a NAME="ChatWidget.__saveChat" ID="ChatWidget.__saveChat"></a>
333 <h4>ChatWidget.__saveChat</h4>
334 <b>__saveChat</b>(<i></i>)
335 <p>
336 Private slot to save the contents of the chat display.
337 </p><a NAME="ChatWidget.__saveHostsHistory" ID="ChatWidget.__saveHostsHistory"></a>
338 <h4>ChatWidget.__saveHostsHistory</h4>
339 <b>__saveHostsHistory</b>(<i></i>)
340 <p>
341 Private method to save the list of recently connected hosts.
342 </p><a NAME="ChatWidget.__setConnected" ID="ChatWidget.__setConnected"></a>
343 <h4>ChatWidget.__setConnected</h4>
344 <b>__setConnected</b>(<i>connected</i>)
345 <p>
346 Private slot to set the connected state.
347 </p><dl>
348 <dt><i>connected</i></dt>
349 <dd>
350 new connected state (boolean)
351 </dd>
352 </dl><a NAME="ChatWidget.__setHostsHistory" ID="ChatWidget.__setHostsHistory"></a>
353 <h4>ChatWidget.__setHostsHistory</h4>
354 <b>__setHostsHistory</b>(<i>host</i>)
355 <p>
356 Private method to remember the given host as the most recent entry.
357 </p><dl>
358 <dt><i>host</i></dt>
359 <dd>
360 host entry to remember (string)
361 </dd>
362 </dl><a NAME="ChatWidget.__showErrorMessage" ID="ChatWidget.__showErrorMessage"></a>
363 <h4>ChatWidget.__showErrorMessage</h4>
364 <b>__showErrorMessage</b>(<i>message</i>)
365 <p>
366 Private slot to show an error message.
367 </p><dl>
368 <dt><i>message</i></dt>
369 <dd>
370 error message to show (string)
371 </dd>
372 </dl><a NAME="ChatWidget.appendMessage" ID="ChatWidget.appendMessage"></a>
373 <h4>ChatWidget.appendMessage</h4>
374 <b>appendMessage</b>(<i>from_, message</i>)
375 <p>
376 Public slot to append a message to the display.
377 </p><dl>
378 <dt><i>from_</i></dt>
379 <dd>
380 originator of the message (string)
381 </dd><dt><i>message</i></dt>
382 <dd>
383 message to be appended (string)
384 </dd>
385 </dl><a NAME="ChatWidget.checkEditorActions" ID="ChatWidget.checkEditorActions"></a>
386 <h4>ChatWidget.checkEditorActions</h4>
387 <b>checkEditorActions</b>(<i>editor</i>)
388 <p>
389 Public slot to set action according to an editor's state.
390 </p><dl>
391 <dt><i>editor</i></dt>
392 <dd>
393 reference to the editor (Editor)
394 </dd>
395 </dl><a NAME="ChatWidget.getClient" ID="ChatWidget.getClient"></a>
396 <h4>ChatWidget.getClient</h4>
397 <b>getClient</b>(<i></i>)
398 <p>
399 Public method to get a reference to the cooperation client.
400 </p><dl>
401 <dt>Returns:</dt>
402 <dd>
403 reference to the cooperation client (CooperationClient)
404 </dd>
405 </dl><a NAME="ChatWidget.on_cancelEditButton_clicked" ID="ChatWidget.on_cancelEditButton_clicked"></a>
406 <h4>ChatWidget.on_cancelEditButton_clicked</h4>
407 <b>on_cancelEditButton_clicked</b>(<i></i>)
408 <p>
409 Private slot to cancel a shared edit session.
410 </p><a NAME="ChatWidget.on_chatEdit_copyAvailable" ID="ChatWidget.on_chatEdit_copyAvailable"></a>
411 <h4>ChatWidget.on_chatEdit_copyAvailable</h4>
412 <b>on_chatEdit_copyAvailable</b>(<i>yes</i>)
413 <p>
414 Private slot to react to text selection/deselection of the chat edit.
415 </p><dl>
416 <dt><i>yes</i></dt>
417 <dd>
418 flag signaling the availability of selected text (boolean)
419 </dd>
420 </dl><a NAME="ChatWidget.on_chatEdit_customContextMenuRequested" ID="ChatWidget.on_chatEdit_customContextMenuRequested"></a>
421 <h4>ChatWidget.on_chatEdit_customContextMenuRequested</h4>
422 <b>on_chatEdit_customContextMenuRequested</b>(<i>pos</i>)
423 <p>
424 Private slot to show the context menu for the chat.
425 </p><dl>
426 <dt><i>pos</i></dt>
427 <dd>
428 the position of the mouse pointer (QPoint)
429 </dd>
430 </dl><a NAME="ChatWidget.on_clearHostsButton_clicked" ID="ChatWidget.on_clearHostsButton_clicked"></a>
431 <h4>ChatWidget.on_clearHostsButton_clicked</h4>
432 <b>on_clearHostsButton_clicked</b>(<i></i>)
433 <p>
434 Private slot to clear the hosts list.
435 </p><a NAME="ChatWidget.on_connectButton_clicked" ID="ChatWidget.on_connectButton_clicked"></a>
436 <h4>ChatWidget.on_connectButton_clicked</h4>
437 <b>on_connectButton_clicked</b>(<i></i>)
438 <p>
439 Private slot initiating the connection.
440 </p><a NAME="ChatWidget.on_hostEdit_editTextChanged" ID="ChatWidget.on_hostEdit_editTextChanged"></a>
441 <h4>ChatWidget.on_hostEdit_editTextChanged</h4>
442 <b>on_hostEdit_editTextChanged</b>(<i>host</i>)
443 <p>
444 Private slot handling the entry of a host to connect to.
445 </p><dl>
446 <dt><i>host</i></dt>
447 <dd>
448 host to connect to (string)
449 </dd>
450 </dl><a NAME="ChatWidget.on_sendEditButton_clicked" ID="ChatWidget.on_sendEditButton_clicked"></a>
451 <h4>ChatWidget.on_sendEditButton_clicked</h4>
452 <b>on_sendEditButton_clicked</b>(<i></i>)
453 <p>
454 Private slot to end a shared edit session and send the changes.
455 </p><a NAME="ChatWidget.on_serverButton_clicked" ID="ChatWidget.on_serverButton_clicked"></a>
456 <h4>ChatWidget.on_serverButton_clicked</h4>
457 <b>on_serverButton_clicked</b>(<i></i>)
458 <p>
459 Private slot to start the server.
460 </p><a NAME="ChatWidget.on_shareButton_clicked" ID="ChatWidget.on_shareButton_clicked"></a>
461 <h4>ChatWidget.on_shareButton_clicked</h4>
462 <b>on_shareButton_clicked</b>(<i>checked</i>)
463 <p>
464 Private slot to share the current editor.
465 </p><dl>
466 <dt><i>checked</i></dt>
467 <dd>
468 flag indicating the button state (boolean)
469 </dd>
470 </dl><a NAME="ChatWidget.on_startEditButton_clicked" ID="ChatWidget.on_startEditButton_clicked"></a>
471 <h4>ChatWidget.on_startEditButton_clicked</h4>
472 <b>on_startEditButton_clicked</b>(<i>checked</i>)
473 <p>
474 Private slot to start a shared edit session.
475 </p><dl>
476 <dt><i>checked</i></dt>
477 <dd>
478 flag indicating the button state (boolean)
479 </dd>
480 </dl><a NAME="ChatWidget.on_usersList_customContextMenuRequested" ID="ChatWidget.on_usersList_customContextMenuRequested"></a>
481 <h4>ChatWidget.on_usersList_customContextMenuRequested</h4>
482 <b>on_usersList_customContextMenuRequested</b>(<i>pos</i>)
483 <p>
484 Private slot to show the context menu for the users list.
485 </p><dl>
486 <dt><i>pos</i></dt>
487 <dd>
488 the position of the mouse pointer (QPoint)
489 </dd>
490 </dl><a NAME="ChatWidget.preferencesChanged" ID="ChatWidget.preferencesChanged"></a>
491 <h4>ChatWidget.preferencesChanged</h4>
492 <b>preferencesChanged</b>(<i></i>)
493 <p>
494 Public slot to handle a change of preferences.
495 </p><a NAME="ChatWidget.shutdown" ID="ChatWidget.shutdown"></a>
496 <h4>ChatWidget.shutdown</h4>
497 <b>shutdown</b>(<i></i>)
498 <p>
499 Public method to shut down the cooperation system.
500 </p>
501 <div align="right"><a href="#top">Up</a></div>
502 <hr />
503 </body></html>

Mercurial Repository: eric

eric ide

mercurial