Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Cooperation.ChatWidget.html
src/eric7/Documentation/Source/eric7.Cooperation.ChatWidget.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10423
- 299802979277
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Cooperation.ChatWidget</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Cooperation.ChatWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the chat dialog. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#ChatWidget">ChatWidget</a></td> | |
| 25 <td>Class implementing the chat dialog.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="ChatWidget" ID="ChatWidget"></a> | |
| 36 <h2>ChatWidget</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the chat dialog. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>cancelEdit()</dt> | |
| 45 <dd> | |
| 46 emitted to cancel a shared edit session | |
| 47 </dd> | |
| 48 <dt>connected(connected)</dt> | |
| 49 <dd> | |
| 50 emitted to signal a change of the connected | |
| 51 state (bool) | |
| 52 </dd> | |
| 53 <dt>editorCommand(hashStr, filename, message)</dt> | |
| 54 <dd> | |
| 55 emitted when an editor | |
| 56 command has been received (string, string, string) | |
| 57 </dd> | |
| 58 <dt>sendEdit()</dt> | |
| 59 <dd> | |
| 60 emitted to send a shared edit session | |
| 61 </dd> | |
| 62 <dt>shareEditor(share)</dt> | |
| 63 <dd> | |
| 64 emitted to signal a share is requested (bool) | |
| 65 </dd> | |
| 66 <dt>startEdit()</dt> | |
| 67 <dd> | |
| 68 emitted to start a shared edit session | |
| 69 </dd> | |
| 70 </dl> | |
| 71 <h3>Derived from</h3> | |
| 72 QWidget, Ui_ChatWidget | |
| 73 <h3>Class Attributes</h3> | |
| 74 | |
| 75 <table> | |
| 76 <tr><td>None</td></tr> | |
| 77 </table> | |
| 78 <h3>Class Methods</h3> | |
| 79 | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 <h3>Methods</h3> | |
| 84 | |
| 85 <table> | |
| 86 | |
| 87 <tr> | |
| 88 <td><a href="#ChatWidget.__init__">ChatWidget</a></td> | |
| 89 <td>Constructor</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#ChatWidget.__banKickUser">__banKickUser</a></td> | |
| 93 <td>Private slot to ban and kick a user.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#ChatWidget.__banUser">__banUser</a></td> | |
| 97 <td>Private slot to ban a user.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#ChatWidget.__clearChat">__clearChat</a></td> | |
| 101 <td>Private slot to clear the contents of the chat display.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#ChatWidget.__clearHostsHistory">__clearHostsHistory</a></td> | |
| 105 <td>Private slot to clear the hosts history.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#ChatWidget.__copyAllChat">__copyAllChat</a></td> | |
| 109 <td>Private slot to copy the contents of the chat display to the clipboard.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#ChatWidget.__copyChat">__copyChat</a></td> | |
| 113 <td>Private slot to copy the contents of the chat display to the clipboard.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#ChatWidget.__cutAllChat">__cutAllChat</a></td> | |
| 117 <td>Private slot to cut the contents of the chat display to the clipboard.</td> | |
| 118 </tr> | |
| 119 <tr> | |
| 120 <td><a href="#ChatWidget.__editorCommandMessage">__editorCommandMessage</a></td> | |
| 121 <td>Private slot to handle editor command messages from the client.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 124 <td><a href="#ChatWidget.__getConnectionParameters">__getConnectionParameters</a></td> | |
| 125 <td>Private method to determine the connection parameters.</td> | |
| 126 </tr> | |
| 127 <tr> | |
| 128 <td><a href="#ChatWidget.__handleMessage">__handleMessage</a></td> | |
| 129 <td>Private slot handling the Return key pressed in the message edit.</td> | |
| 130 </tr> | |
| 131 <tr> | |
| 132 <td><a href="#ChatWidget.__initChatMenu">__initChatMenu</a></td> | |
| 133 <td>Private slot to initialize the chat edit context menu.</td> | |
| 134 </tr> | |
| 135 <tr> | |
| 136 <td><a href="#ChatWidget.__initUsersMenu">__initUsersMenu</a></td> | |
| 137 <td>Private slot to initialize the users list context menu.</td> | |
| 138 </tr> | |
| 139 <tr> | |
| 140 <td><a href="#ChatWidget.__initialConnectionRefused">__initialConnectionRefused</a></td> | |
| 141 <td>Private slot to handle the refusal of the initial connection.</td> | |
| 142 </tr> | |
| 143 <tr> | |
| 144 <td><a href="#ChatWidget.__kickUser">__kickUser</a></td> | |
| 145 <td>Private slot to disconnect a user.</td> | |
| 146 </tr> | |
| 147 <tr> | |
| 148 <td><a href="#ChatWidget.__loadHostsHistory">__loadHostsHistory</a></td> | |
| 149 <td>Private method to load the recently connected hosts.</td> | |
| 150 </tr> | |
| 151 <tr> | |
| 152 <td><a href="#ChatWidget.__newParticipant">__newParticipant</a></td> | |
| 153 <td>Private slot handling a new participant joining.</td> | |
| 154 </tr> | |
| 155 <tr> | |
| 156 <td><a href="#ChatWidget.__participantLeft">__participantLeft</a></td> | |
| 157 <td>Private slot handling a participant leaving the session.</td> | |
| 158 </tr> | |
| 159 <tr> | |
| 160 <td><a href="#ChatWidget.__saveChat">__saveChat</a></td> | |
| 161 <td>Private slot to save the contents of the chat display.</td> | |
| 162 </tr> | |
| 163 <tr> | |
| 164 <td><a href="#ChatWidget.__saveHostsHistory">__saveHostsHistory</a></td> | |
| 165 <td>Private method to save the list of recently connected hosts.</td> | |
| 166 </tr> | |
| 167 <tr> | |
| 168 <td><a href="#ChatWidget.__setConnected">__setConnected</a></td> | |
| 169 <td>Private slot to set the connected state.</td> | |
| 170 </tr> | |
| 171 <tr> | |
| 172 <td><a href="#ChatWidget.__setHostsHistory">__setHostsHistory</a></td> | |
| 173 <td>Private method to remember the given host as the most recent entry.</td> | |
| 174 </tr> | |
| 175 <tr> | |
| 176 <td><a href="#ChatWidget.__showErrorMessage">__showErrorMessage</a></td> | |
| 177 <td>Private slot to show an error message.</td> | |
| 178 </tr> | |
| 179 <tr> | |
| 180 <td><a href="#ChatWidget.appendMessage">appendMessage</a></td> | |
| 181 <td>Public slot to append a message to the display.</td> | |
| 182 </tr> | |
| 183 <tr> | |
| 184 <td><a href="#ChatWidget.checkEditorActions">checkEditorActions</a></td> | |
| 185 <td>Public slot to set action according to an editor's state.</td> | |
| 186 </tr> | |
| 187 <tr> | |
| 188 <td><a href="#ChatWidget.getClient">getClient</a></td> | |
| 189 <td>Public method to get a reference to the cooperation client.</td> | |
| 190 </tr> | |
| 191 <tr> | |
| 192 <td><a href="#ChatWidget.on_cancelEditButton_clicked">on_cancelEditButton_clicked</a></td> | |
| 193 <td>Private slot to cancel a shared edit session.</td> | |
| 194 </tr> | |
| 195 <tr> | |
| 196 <td><a href="#ChatWidget.on_chatEdit_copyAvailable">on_chatEdit_copyAvailable</a></td> | |
| 197 <td>Private slot to react to text selection/deselection of the chat edit.</td> | |
| 198 </tr> | |
| 199 <tr> | |
| 200 <td><a href="#ChatWidget.on_chatEdit_customContextMenuRequested">on_chatEdit_customContextMenuRequested</a></td> | |
| 201 <td>Private slot to show the context menu for the chat.</td> | |
| 202 </tr> | |
| 203 <tr> | |
| 204 <td><a href="#ChatWidget.on_clearHostsButton_clicked">on_clearHostsButton_clicked</a></td> | |
| 205 <td>Private slot to clear the hosts list.</td> | |
| 206 </tr> | |
| 207 <tr> | |
| 208 <td><a href="#ChatWidget.on_connectButton_clicked">on_connectButton_clicked</a></td> | |
| 209 <td>Private slot initiating the connection.</td> | |
| 210 </tr> | |
| 211 <tr> | |
| 212 <td><a href="#ChatWidget.on_hostEdit_editTextChanged">on_hostEdit_editTextChanged</a></td> | |
| 213 <td>Private slot handling the entry of a host to connect to.</td> | |
| 214 </tr> | |
| 215 <tr> | |
| 216 <td><a href="#ChatWidget.on_sendEditButton_clicked">on_sendEditButton_clicked</a></td> | |
| 217 <td>Private slot to end a shared edit session and send the changes.</td> | |
| 218 </tr> | |
| 219 <tr> | |
| 220 <td><a href="#ChatWidget.on_serverButton_clicked">on_serverButton_clicked</a></td> | |
| 221 <td>Private slot to start the server.</td> | |
| 222 </tr> | |
| 223 <tr> | |
| 224 <td><a href="#ChatWidget.on_shareButton_clicked">on_shareButton_clicked</a></td> | |
| 225 <td>Private slot to share the current editor.</td> | |
| 226 </tr> | |
| 227 <tr> | |
| 228 <td><a href="#ChatWidget.on_startEditButton_clicked">on_startEditButton_clicked</a></td> | |
| 229 <td>Private slot to start a shared edit session.</td> | |
| 230 </tr> | |
| 231 <tr> | |
| 232 <td><a href="#ChatWidget.on_usersList_customContextMenuRequested">on_usersList_customContextMenuRequested</a></td> | |
| 233 <td>Private slot to show the context menu for the users list.</td> | |
| 234 </tr> | |
| 235 <tr> | |
| 236 <td><a href="#ChatWidget.preferencesChanged">preferencesChanged</a></td> | |
| 237 <td>Public slot to handle a change of preferences.</td> | |
| 238 </tr> | |
| 239 <tr> | |
| 240 <td><a href="#ChatWidget.shutdown">shutdown</a></td> | |
| 241 <td>Public method to shut down the cooperation system.</td> | |
| 242 </tr> | |
| 243 </table> | |
| 244 <h3>Static Methods</h3> | |
| 245 | |
| 246 <table> | |
| 247 <tr><td>None</td></tr> | |
| 248 </table> | |
| 249 | |
| 250 <a NAME="ChatWidget.__init__" ID="ChatWidget.__init__"></a> | |
| 251 <h4>ChatWidget (Constructor)</h4> | |
| 252 <b>ChatWidget</b>(<i>ui, port=-1, parent=None</i>) | |
| 253 | |
| 254 <p> | |
| 255 Constructor | |
| 256 </p> | |
| 257 <dl> | |
| 258 | |
| 259 <dt><i>ui</i></dt> | |
| 260 <dd> | |
| 261 reference to the user interface object (UserInterface) | |
| 262 </dd> | |
| 263 <dt><i>port</i></dt> | |
| 264 <dd> | |
| 265 port to be used for the cooperation server (integer) | |
| 266 </dd> | |
| 267 <dt><i>parent</i></dt> | |
| 268 <dd> | |
| 269 reference to the parent widget (QWidget) | |
| 270 </dd> | |
| 271 </dl> | |
| 272 <a NAME="ChatWidget.__banKickUser" ID="ChatWidget.__banKickUser"></a> | |
| 273 <h4>ChatWidget.__banKickUser</h4> | |
| 274 <b>__banKickUser</b>(<i></i>) | |
| 275 | |
| 276 <p> | |
| 277 Private slot to ban and kick a user. | |
| 278 </p> | |
| 279 <a NAME="ChatWidget.__banUser" ID="ChatWidget.__banUser"></a> | |
| 280 <h4>ChatWidget.__banUser</h4> | |
| 281 <b>__banUser</b>(<i></i>) | |
| 282 | |
| 283 <p> | |
| 284 Private slot to ban a user. | |
| 285 </p> | |
| 286 <a NAME="ChatWidget.__clearChat" ID="ChatWidget.__clearChat"></a> | |
| 287 <h4>ChatWidget.__clearChat</h4> | |
| 288 <b>__clearChat</b>(<i></i>) | |
| 289 | |
| 290 <p> | |
| 291 Private slot to clear the contents of the chat display. | |
| 292 </p> | |
| 293 <a NAME="ChatWidget.__clearHostsHistory" ID="ChatWidget.__clearHostsHistory"></a> | |
| 294 <h4>ChatWidget.__clearHostsHistory</h4> | |
| 295 <b>__clearHostsHistory</b>(<i></i>) | |
| 296 | |
| 297 <p> | |
| 298 Private slot to clear the hosts history. | |
| 299 </p> | |
| 300 <a NAME="ChatWidget.__copyAllChat" ID="ChatWidget.__copyAllChat"></a> | |
| 301 <h4>ChatWidget.__copyAllChat</h4> | |
| 302 <b>__copyAllChat</b>(<i></i>) | |
| 303 | |
| 304 <p> | |
| 305 Private slot to copy the contents of the chat display to the clipboard. | |
| 306 </p> | |
| 307 <a NAME="ChatWidget.__copyChat" ID="ChatWidget.__copyChat"></a> | |
| 308 <h4>ChatWidget.__copyChat</h4> | |
| 309 <b>__copyChat</b>(<i></i>) | |
| 310 | |
| 311 <p> | |
| 312 Private slot to copy the contents of the chat display to the clipboard. | |
| 313 </p> | |
| 314 <a NAME="ChatWidget.__cutAllChat" ID="ChatWidget.__cutAllChat"></a> | |
| 315 <h4>ChatWidget.__cutAllChat</h4> | |
| 316 <b>__cutAllChat</b>(<i></i>) | |
| 317 | |
| 318 <p> | |
| 319 Private slot to cut the contents of the chat display to the clipboard. | |
| 320 </p> | |
| 321 <a NAME="ChatWidget.__editorCommandMessage" ID="ChatWidget.__editorCommandMessage"></a> | |
| 322 <h4>ChatWidget.__editorCommandMessage</h4> | |
| 323 <b>__editorCommandMessage</b>(<i>hashStr, fileName, message</i>) | |
| 324 | |
| 325 <p> | |
| 326 Private slot to handle editor command messages from the client. | |
| 327 </p> | |
| 328 <dl> | |
| 329 | |
| 330 <dt><i>hashStr</i></dt> | |
| 331 <dd> | |
| 332 hash of the project (string) | |
| 333 </dd> | |
| 334 <dt><i>fileName</i></dt> | |
| 335 <dd> | |
| 336 project relative file name of the editor (string) | |
| 337 </dd> | |
| 338 <dt><i>message</i></dt> | |
| 339 <dd> | |
| 340 command message (string) | |
| 341 </dd> | |
| 342 </dl> | |
| 343 <a NAME="ChatWidget.__getConnectionParameters" ID="ChatWidget.__getConnectionParameters"></a> | |
| 344 <h4>ChatWidget.__getConnectionParameters</h4> | |
| 345 <b>__getConnectionParameters</b>(<i></i>) | |
| 346 | |
| 347 <p> | |
| 348 Private method to determine the connection parameters. | |
| 349 </p> | |
| 350 <dl> | |
| 351 <dt>Return:</dt> | |
| 352 <dd> | |
| 353 tuple with hostname and port (string, integer) | |
| 354 </dd> | |
| 355 </dl> | |
| 356 <a NAME="ChatWidget.__handleMessage" ID="ChatWidget.__handleMessage"></a> | |
| 357 <h4>ChatWidget.__handleMessage</h4> | |
| 358 <b>__handleMessage</b>(<i></i>) | |
| 359 | |
| 360 <p> | |
| 361 Private slot handling the Return key pressed in the message edit. | |
| 362 </p> | |
| 363 <a NAME="ChatWidget.__initChatMenu" ID="ChatWidget.__initChatMenu"></a> | |
| 364 <h4>ChatWidget.__initChatMenu</h4> | |
| 365 <b>__initChatMenu</b>(<i></i>) | |
| 366 | |
| 367 <p> | |
| 368 Private slot to initialize the chat edit context menu. | |
| 369 </p> | |
| 370 <a NAME="ChatWidget.__initUsersMenu" ID="ChatWidget.__initUsersMenu"></a> | |
| 371 <h4>ChatWidget.__initUsersMenu</h4> | |
| 372 <b>__initUsersMenu</b>(<i></i>) | |
| 373 | |
| 374 <p> | |
| 375 Private slot to initialize the users list context menu. | |
| 376 </p> | |
| 377 <a NAME="ChatWidget.__initialConnectionRefused" ID="ChatWidget.__initialConnectionRefused"></a> | |
| 378 <h4>ChatWidget.__initialConnectionRefused</h4> | |
| 379 <b>__initialConnectionRefused</b>(<i></i>) | |
| 380 | |
| 381 <p> | |
| 382 Private slot to handle the refusal of the initial connection. | |
| 383 </p> | |
| 384 <a NAME="ChatWidget.__kickUser" ID="ChatWidget.__kickUser"></a> | |
| 385 <h4>ChatWidget.__kickUser</h4> | |
| 386 <b>__kickUser</b>(<i></i>) | |
| 387 | |
| 388 <p> | |
| 389 Private slot to disconnect a user. | |
| 390 </p> | |
| 391 <a NAME="ChatWidget.__loadHostsHistory" ID="ChatWidget.__loadHostsHistory"></a> | |
| 392 <h4>ChatWidget.__loadHostsHistory</h4> | |
| 393 <b>__loadHostsHistory</b>(<i></i>) | |
| 394 | |
| 395 <p> | |
| 396 Private method to load the recently connected hosts. | |
| 397 </p> | |
| 398 <a NAME="ChatWidget.__newParticipant" ID="ChatWidget.__newParticipant"></a> | |
| 399 <h4>ChatWidget.__newParticipant</h4> | |
| 400 <b>__newParticipant</b>(<i>nick</i>) | |
| 401 | |
| 402 <p> | |
| 403 Private slot handling a new participant joining. | |
| 404 </p> | |
| 405 <dl> | |
| 406 | |
| 407 <dt><i>nick</i></dt> | |
| 408 <dd> | |
| 409 nick name of the new participant (string) | |
| 410 </dd> | |
| 411 </dl> | |
| 412 <a NAME="ChatWidget.__participantLeft" ID="ChatWidget.__participantLeft"></a> | |
| 413 <h4>ChatWidget.__participantLeft</h4> | |
| 414 <b>__participantLeft</b>(<i>nick</i>) | |
| 415 | |
| 416 <p> | |
| 417 Private slot handling a participant leaving the session. | |
| 418 </p> | |
| 419 <dl> | |
| 420 | |
| 421 <dt><i>nick</i></dt> | |
| 422 <dd> | |
| 423 nick name of the participant (string) | |
| 424 </dd> | |
| 425 </dl> | |
| 426 <a NAME="ChatWidget.__saveChat" ID="ChatWidget.__saveChat"></a> | |
| 427 <h4>ChatWidget.__saveChat</h4> | |
| 428 <b>__saveChat</b>(<i></i>) | |
| 429 | |
| 430 <p> | |
| 431 Private slot to save the contents of the chat display. | |
| 432 </p> | |
| 433 <a NAME="ChatWidget.__saveHostsHistory" ID="ChatWidget.__saveHostsHistory"></a> | |
| 434 <h4>ChatWidget.__saveHostsHistory</h4> | |
| 435 <b>__saveHostsHistory</b>(<i></i>) | |
| 436 | |
| 437 <p> | |
| 438 Private method to save the list of recently connected hosts. | |
| 439 </p> | |
| 440 <a NAME="ChatWidget.__setConnected" ID="ChatWidget.__setConnected"></a> | |
| 441 <h4>ChatWidget.__setConnected</h4> | |
| 442 <b>__setConnected</b>(<i>connected</i>) | |
| 443 | |
| 444 <p> | |
| 445 Private slot to set the connected state. | |
| 446 </p> | |
| 447 <dl> | |
| 448 | |
| 449 <dt><i>connected</i></dt> | |
| 450 <dd> | |
| 451 new connected state (boolean) | |
| 452 </dd> | |
| 453 </dl> | |
| 454 <a NAME="ChatWidget.__setHostsHistory" ID="ChatWidget.__setHostsHistory"></a> | |
| 455 <h4>ChatWidget.__setHostsHistory</h4> | |
| 456 <b>__setHostsHistory</b>(<i>host</i>) | |
| 457 | |
| 458 <p> | |
| 459 Private method to remember the given host as the most recent entry. | |
| 460 </p> | |
| 461 <dl> | |
| 462 | |
| 463 <dt><i>host</i></dt> | |
| 464 <dd> | |
| 465 host entry to remember (string) | |
| 466 </dd> | |
| 467 </dl> | |
| 468 <a NAME="ChatWidget.__showErrorMessage" ID="ChatWidget.__showErrorMessage"></a> | |
| 469 <h4>ChatWidget.__showErrorMessage</h4> | |
| 470 <b>__showErrorMessage</b>(<i>message</i>) | |
| 471 | |
| 472 <p> | |
| 473 Private slot to show an error message. | |
| 474 </p> | |
| 475 <dl> | |
| 476 | |
| 477 <dt><i>message</i></dt> | |
| 478 <dd> | |
| 479 error message to show (string) | |
| 480 </dd> | |
| 481 </dl> | |
| 482 <a NAME="ChatWidget.appendMessage" ID="ChatWidget.appendMessage"></a> | |
| 483 <h4>ChatWidget.appendMessage</h4> | |
| 484 <b>appendMessage</b>(<i>from_, message</i>) | |
| 485 | |
| 486 <p> | |
| 487 Public slot to append a message to the display. | |
| 488 </p> | |
| 489 <dl> | |
| 490 | |
| 491 <dt><i>from_</i></dt> | |
| 492 <dd> | |
| 493 originator of the message (string) | |
| 494 </dd> | |
| 495 <dt><i>message</i></dt> | |
| 496 <dd> | |
| 497 message to be appended (string) | |
| 498 </dd> | |
| 499 </dl> | |
| 500 <a NAME="ChatWidget.checkEditorActions" ID="ChatWidget.checkEditorActions"></a> | |
| 501 <h4>ChatWidget.checkEditorActions</h4> | |
| 502 <b>checkEditorActions</b>(<i>editor</i>) | |
| 503 | |
| 504 <p> | |
| 505 Public slot to set action according to an editor's state. | |
| 506 </p> | |
| 507 <dl> | |
| 508 | |
| 509 <dt><i>editor</i></dt> | |
| 510 <dd> | |
| 511 reference to the editor (Editor) | |
| 512 </dd> | |
| 513 </dl> | |
| 514 <a NAME="ChatWidget.getClient" ID="ChatWidget.getClient"></a> | |
| 515 <h4>ChatWidget.getClient</h4> | |
| 516 <b>getClient</b>(<i></i>) | |
| 517 | |
| 518 <p> | |
| 519 Public method to get a reference to the cooperation client. | |
| 520 </p> | |
| 521 <dl> | |
| 522 <dt>Return:</dt> | |
| 523 <dd> | |
| 524 reference to the cooperation client (CooperationClient) | |
| 525 </dd> | |
| 526 </dl> | |
| 527 <a NAME="ChatWidget.on_cancelEditButton_clicked" ID="ChatWidget.on_cancelEditButton_clicked"></a> | |
| 528 <h4>ChatWidget.on_cancelEditButton_clicked</h4> | |
| 529 <b>on_cancelEditButton_clicked</b>(<i></i>) | |
| 530 | |
| 531 <p> | |
| 532 Private slot to cancel a shared edit session. | |
| 533 </p> | |
| 534 <a NAME="ChatWidget.on_chatEdit_copyAvailable" ID="ChatWidget.on_chatEdit_copyAvailable"></a> | |
| 535 <h4>ChatWidget.on_chatEdit_copyAvailable</h4> | |
| 536 <b>on_chatEdit_copyAvailable</b>(<i>yes</i>) | |
| 537 | |
| 538 <p> | |
| 539 Private slot to react to text selection/deselection of the chat edit. | |
| 540 </p> | |
| 541 <dl> | |
| 542 | |
| 543 <dt><i>yes</i></dt> | |
| 544 <dd> | |
| 545 flag signaling the availability of selected text (boolean) | |
| 546 </dd> | |
| 547 </dl> | |
| 548 <a NAME="ChatWidget.on_chatEdit_customContextMenuRequested" ID="ChatWidget.on_chatEdit_customContextMenuRequested"></a> | |
| 549 <h4>ChatWidget.on_chatEdit_customContextMenuRequested</h4> | |
| 550 <b>on_chatEdit_customContextMenuRequested</b>(<i>pos</i>) | |
| 551 | |
| 552 <p> | |
| 553 Private slot to show the context menu for the chat. | |
| 554 </p> | |
| 555 <dl> | |
| 556 | |
| 557 <dt><i>pos</i></dt> | |
| 558 <dd> | |
| 559 the position of the mouse pointer (QPoint) | |
| 560 </dd> | |
| 561 </dl> | |
| 562 <a NAME="ChatWidget.on_clearHostsButton_clicked" ID="ChatWidget.on_clearHostsButton_clicked"></a> | |
| 563 <h4>ChatWidget.on_clearHostsButton_clicked</h4> | |
| 564 <b>on_clearHostsButton_clicked</b>(<i></i>) | |
| 565 | |
| 566 <p> | |
| 567 Private slot to clear the hosts list. | |
| 568 </p> | |
| 569 <a NAME="ChatWidget.on_connectButton_clicked" ID="ChatWidget.on_connectButton_clicked"></a> | |
| 570 <h4>ChatWidget.on_connectButton_clicked</h4> | |
| 571 <b>on_connectButton_clicked</b>(<i></i>) | |
| 572 | |
| 573 <p> | |
| 574 Private slot initiating the connection. | |
| 575 </p> | |
| 576 <a NAME="ChatWidget.on_hostEdit_editTextChanged" ID="ChatWidget.on_hostEdit_editTextChanged"></a> | |
| 577 <h4>ChatWidget.on_hostEdit_editTextChanged</h4> | |
| 578 <b>on_hostEdit_editTextChanged</b>(<i>host</i>) | |
| 579 | |
| 580 <p> | |
| 581 Private slot handling the entry of a host to connect to. | |
| 582 </p> | |
| 583 <dl> | |
| 584 | |
| 585 <dt><i>host</i></dt> | |
| 586 <dd> | |
| 587 host to connect to (string) | |
| 588 </dd> | |
| 589 </dl> | |
| 590 <a NAME="ChatWidget.on_sendEditButton_clicked" ID="ChatWidget.on_sendEditButton_clicked"></a> | |
| 591 <h4>ChatWidget.on_sendEditButton_clicked</h4> | |
| 592 <b>on_sendEditButton_clicked</b>(<i></i>) | |
| 593 | |
| 594 <p> | |
| 595 Private slot to end a shared edit session and send the changes. | |
| 596 </p> | |
| 597 <a NAME="ChatWidget.on_serverButton_clicked" ID="ChatWidget.on_serverButton_clicked"></a> | |
| 598 <h4>ChatWidget.on_serverButton_clicked</h4> | |
| 599 <b>on_serverButton_clicked</b>(<i></i>) | |
| 600 | |
| 601 <p> | |
| 602 Private slot to start the server. | |
| 603 </p> | |
| 604 <a NAME="ChatWidget.on_shareButton_clicked" ID="ChatWidget.on_shareButton_clicked"></a> | |
| 605 <h4>ChatWidget.on_shareButton_clicked</h4> | |
| 606 <b>on_shareButton_clicked</b>(<i>checked</i>) | |
| 607 | |
| 608 <p> | |
| 609 Private slot to share the current editor. | |
| 610 </p> | |
| 611 <dl> | |
| 612 | |
| 613 <dt><i>checked</i></dt> | |
| 614 <dd> | |
| 615 flag indicating the button state (boolean) | |
| 616 </dd> | |
| 617 </dl> | |
| 618 <a NAME="ChatWidget.on_startEditButton_clicked" ID="ChatWidget.on_startEditButton_clicked"></a> | |
| 619 <h4>ChatWidget.on_startEditButton_clicked</h4> | |
| 620 <b>on_startEditButton_clicked</b>(<i>checked</i>) | |
| 621 | |
| 622 <p> | |
| 623 Private slot to start a shared edit session. | |
| 624 </p> | |
| 625 <dl> | |
| 626 | |
| 627 <dt><i>checked</i></dt> | |
| 628 <dd> | |
| 629 flag indicating the button state (boolean) | |
| 630 </dd> | |
| 631 </dl> | |
| 632 <a NAME="ChatWidget.on_usersList_customContextMenuRequested" ID="ChatWidget.on_usersList_customContextMenuRequested"></a> | |
| 633 <h4>ChatWidget.on_usersList_customContextMenuRequested</h4> | |
| 634 <b>on_usersList_customContextMenuRequested</b>(<i>pos</i>) | |
| 635 | |
| 636 <p> | |
| 637 Private slot to show the context menu for the users list. | |
| 638 </p> | |
| 639 <dl> | |
| 640 | |
| 641 <dt><i>pos</i></dt> | |
| 642 <dd> | |
| 643 the position of the mouse pointer (QPoint) | |
| 644 </dd> | |
| 645 </dl> | |
| 646 <a NAME="ChatWidget.preferencesChanged" ID="ChatWidget.preferencesChanged"></a> | |
| 647 <h4>ChatWidget.preferencesChanged</h4> | |
| 648 <b>preferencesChanged</b>(<i></i>) | |
| 649 | |
| 650 <p> | |
| 651 Public slot to handle a change of preferences. | |
| 652 </p> | |
| 653 <a NAME="ChatWidget.shutdown" ID="ChatWidget.shutdown"></a> | |
| 654 <h4>ChatWidget.shutdown</h4> | |
| 655 <b>shutdown</b>(<i></i>) | |
| 656 | |
| 657 <p> | |
| 658 Public method to shut down the cooperation system. | |
| 659 </p> | |
| 660 <div align="right"><a href="#top">Up</a></div> | |
| 661 <hr /> | |
| 662 </body></html> |
