Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.RemoteServerInterface.EricServerInterface.html
src/eric7/Documentation/Source/eric7.RemoteServerInterface.EricServerInterface.html
- branch
- eric7
- changeset 10784
- 521fd465b048
- child 10958
- 79842be466d3
equal
deleted
inserted
replaced
| 10783:ccf28bec1227 | 10784:521fd465b048 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.RemoteServerInterface.EricServerInterface</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.RemoteServerInterface.EricServerInterface</h1> | |
| 10 <p> | |
| 11 Module implementing the interface to the eric remote server. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>None</td></tr> | |
| 17 </table> | |
| 18 | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#EricServerInterface">EricServerInterface</a></td> | |
| 23 <td>Class implementing the interface to the eric remote server.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 | |
| 27 <h3>Functions</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 | |
| 32 <hr /> | |
| 33 <hr /> | |
| 34 <a NAME="EricServerInterface" ID="EricServerInterface"></a> | |
| 35 <h2>EricServerInterface</h2> | |
| 36 <p> | |
| 37 Class implementing the interface to the eric remote server. | |
| 38 </p> | |
| 39 | |
| 40 <h3>Signals</h3> | |
| 41 <dl> | |
| 42 | |
| 43 <dt>aboutToDisconnect()</dt> | |
| 44 <dd> | |
| 45 emitted just befor the remote server is disconnected | |
| 46 </dd> | |
| 47 <dt>connectionStateChanged(state:bool)</dt> | |
| 48 <dd> | |
| 49 emitted to indicate a change of the | |
| 50 connection state | |
| 51 </dd> | |
| 52 <dt>remoteCoverageReply(request:str, params:dict)</dt> | |
| 53 <dd> | |
| 54 emitted to deliver the reply | |
| 55 of a remote server code coverage request | |
| 56 </dd> | |
| 57 <dt>remoteDebuggerReply(request:str, params:dict)</dt> | |
| 58 <dd> | |
| 59 emitted to deliver the reply | |
| 60 of a remote server debugger request | |
| 61 </dd> | |
| 62 <dt>remoteEchoReply(request:str, params:dict)</dt> | |
| 63 <dd> | |
| 64 emitted to deliver the reply of | |
| 65 a remote server echo request | |
| 66 </dd> | |
| 67 <dt>remoteEditorConfig(request:str, params:dict)</dt> | |
| 68 <dd> | |
| 69 emitted to deliver the reply | |
| 70 of a remote server editor config request | |
| 71 </dd> | |
| 72 <dt>remoteFileSystemReply(request:str, params:dict)</dt> | |
| 73 <dd> | |
| 74 emitted to deliver the | |
| 75 reply of a remote server file system request | |
| 76 </dd> | |
| 77 <dt>remoteProjectReply(request:str, params:dict)</dt> | |
| 78 <dd> | |
| 79 emitted to deliver the reply | |
| 80 of a remote server project related request | |
| 81 </dd> | |
| 82 <dt>remoteReply(category:int, request:str, params:dict)</dt> | |
| 83 <dd> | |
| 84 emitted to deliver the | |
| 85 reply of an unknown category | |
| 86 </dd> | |
| 87 <dt>remoteServerReply(request:str, params:dict)</dt> | |
| 88 <dd> | |
| 89 emitted to deliver the reply | |
| 90 of a remote server control request | |
| 91 </dd> | |
| 92 <dt>showMenu(name:str, menu:QMenu)</dt> | |
| 93 <dd> | |
| 94 emitted when a menu is about to be shown. | |
| 95 The name of the menu and a reference to the menu are given. | |
| 96 </dd> | |
| 97 </dl> | |
| 98 <h3>Derived from</h3> | |
| 99 QObject | |
| 100 <h3>Class Attributes</h3> | |
| 101 <table> | |
| 102 <tr><td>None</td></tr> | |
| 103 </table> | |
| 104 | |
| 105 <h3>Class Methods</h3> | |
| 106 <table> | |
| 107 <tr><td>None</td></tr> | |
| 108 </table> | |
| 109 | |
| 110 <h3>Methods</h3> | |
| 111 <table> | |
| 112 <tr> | |
| 113 <td><a href="#EricServerInterface.__init__">EricServerInterface</a></td> | |
| 114 <td>Constructor</td> | |
| 115 </tr> | |
| 116 <tr> | |
| 117 <td><a href="#EricServerInterface.__connectToServer">__connectToServer</a></td> | |
| 118 <td>Private slot to connect to a remote eric-ide server.</td> | |
| 119 </tr> | |
| 120 <tr> | |
| 121 <td><a href="#EricServerInterface.__connectionStateChanged">__connectionStateChanged</a></td> | |
| 122 <td>Private slot to handle the connection state change.</td> | |
| 123 </tr> | |
| 124 <tr> | |
| 125 <td><a href="#EricServerInterface.__createCoverageInterface">__createCoverageInterface</a></td> | |
| 126 <td>Private method to create and register the 'Coverage' eric-ide server interface.</td> | |
| 127 </tr> | |
| 128 <tr> | |
| 129 <td><a href="#EricServerInterface.__createDebuggerInterface">__createDebuggerInterface</a></td> | |
| 130 <td>Private method to create and register the 'Debugger' eric-ide server interface.</td> | |
| 131 </tr> | |
| 132 <tr> | |
| 133 <td><a href="#EricServerInterface.__createEditorConfigInterface">__createEditorConfigInterface</a></td> | |
| 134 <td>Private method to create and register the 'EditorConfig' eric-ide server interface.</td> | |
| 135 </tr> | |
| 136 <tr> | |
| 137 <td><a href="#EricServerInterface.__createFilesystemInterface">__createFilesystemInterface</a></td> | |
| 138 <td>Private method to create and register the 'Filesystem' eric-ide server interface.</td> | |
| 139 </tr> | |
| 140 <tr> | |
| 141 <td><a href="#EricServerInterface.__handleDisconnect">__handleDisconnect</a></td> | |
| 142 <td>Private slot handling a disconnect of the client.</td> | |
| 143 </tr> | |
| 144 <tr> | |
| 145 <td><a href="#EricServerInterface.__handleServerError">__handleServerError</a></td> | |
| 146 <td>Private method handling server error replies.</td> | |
| 147 </tr> | |
| 148 <tr> | |
| 149 <td><a href="#EricServerInterface.__handleServerVersionReply">__handleServerVersionReply</a></td> | |
| 150 <td>Private method to handle the reply of a 'Version' request.</td> | |
| 151 </tr> | |
| 152 <tr> | |
| 153 <td><a href="#EricServerInterface.__manageServerProfiles">__manageServerProfiles</a></td> | |
| 154 <td>Private slot to show a dialog to manage the eric-ide server connection profiles.</td> | |
| 155 </tr> | |
| 156 <tr> | |
| 157 <td><a href="#EricServerInterface.__receiveJson">__receiveJson</a></td> | |
| 158 <td>Private slot handling received data from the eric remote server.</td> | |
| 159 </tr> | |
| 160 <tr> | |
| 161 <td><a href="#EricServerInterface.__serverProfileTriggered">__serverProfileTriggered</a></td> | |
| 162 <td>Private slot to handle the selection of a remote server connection.</td> | |
| 163 </tr> | |
| 164 <tr> | |
| 165 <td><a href="#EricServerInterface.__showEricServerMenu">__showEricServerMenu</a></td> | |
| 166 <td>Private slot to display the server menu.</td> | |
| 167 </tr> | |
| 168 <tr> | |
| 169 <td><a href="#EricServerInterface.__showServerProfilesMenu">__showServerProfilesMenu</a></td> | |
| 170 <td>Private slot to prepare the eric server profiles menu.</td> | |
| 171 </tr> | |
| 172 <tr> | |
| 173 <td><a href="#EricServerInterface.__shutdownServer">__shutdownServer</a></td> | |
| 174 <td>Private slot to shut down the currently connected eric-ide server.</td> | |
| 175 </tr> | |
| 176 <tr> | |
| 177 <td><a href="#EricServerInterface.connectToServer">connectToServer</a></td> | |
| 178 <td>Public method to connect to the given host and port.</td> | |
| 179 </tr> | |
| 180 <tr> | |
| 181 <td><a href="#EricServerInterface.disconnectFromServer">disconnectFromServer</a></td> | |
| 182 <td>Public method to disconnect from the eric remote server.</td> | |
| 183 </tr> | |
| 184 <tr> | |
| 185 <td><a href="#EricServerInterface.getHost">getHost</a></td> | |
| 186 <td>Public method to get the connected host as "host name:port".</td> | |
| 187 </tr> | |
| 188 <tr> | |
| 189 <td><a href="#EricServerInterface.getHostName">getHostName</a></td> | |
| 190 <td>Public method to get the name of the connected host.</td> | |
| 191 </tr> | |
| 192 <tr> | |
| 193 <td><a href="#EricServerInterface.getServiceInterface">getServiceInterface</a></td> | |
| 194 <td>Public method to get a references to a specific service interface by service name.</td> | |
| 195 </tr> | |
| 196 <tr> | |
| 197 <td><a href="#EricServerInterface.initActions">initActions</a></td> | |
| 198 <td>Public slot to initialize the eric-ide server actions.</td> | |
| 199 </tr> | |
| 200 <tr> | |
| 201 <td><a href="#EricServerInterface.initMenu">initMenu</a></td> | |
| 202 <td>Public slot to initialize the eric-ide server menu.</td> | |
| 203 </tr> | |
| 204 <tr> | |
| 205 <td><a href="#EricServerInterface.initToolbar">initToolbar</a></td> | |
| 206 <td>Public slot to initialize the eric-ide server toolbar.</td> | |
| 207 </tr> | |
| 208 <tr> | |
| 209 <td><a href="#EricServerInterface.isServerConnected">isServerConnected</a></td> | |
| 210 <td>Public method to check, if a connection to an eric-ide server has been established.</td> | |
| 211 </tr> | |
| 212 <tr> | |
| 213 <td><a href="#EricServerInterface.sendJson">sendJson</a></td> | |
| 214 <td>Public method to send a single command to a client.</td> | |
| 215 </tr> | |
| 216 <tr> | |
| 217 <td><a href="#EricServerInterface.serverVersions">serverVersions</a></td> | |
| 218 <td>Public slot to request the eric-ide version of the server.</td> | |
| 219 </tr> | |
| 220 <tr> | |
| 221 <td><a href="#EricServerInterface.shutdownServer">shutdownServer</a></td> | |
| 222 <td>Public method shutdown the currebtly connected eric-ide remote server.</td> | |
| 223 </tr> | |
| 224 </table> | |
| 225 | |
| 226 <h3>Static Methods</h3> | |
| 227 <table> | |
| 228 <tr><td>None</td></tr> | |
| 229 </table> | |
| 230 | |
| 231 | |
| 232 <a NAME="EricServerInterface.__init__" ID="EricServerInterface.__init__"></a> | |
| 233 <h4>EricServerInterface (Constructor)</h4> | |
| 234 <b>EricServerInterface</b>(<i>parent=None</i>) | |
| 235 <p> | |
| 236 Constructor | |
| 237 </p> | |
| 238 | |
| 239 <dl> | |
| 240 | |
| 241 <dt><i>parent</i> (QObject (optional))</dt> | |
| 242 <dd> | |
| 243 reference to the parent object (defaults to None) | |
| 244 </dd> | |
| 245 </dl> | |
| 246 <a NAME="EricServerInterface.__connectToServer" ID="EricServerInterface.__connectToServer"></a> | |
| 247 <h4>EricServerInterface.__connectToServer</h4> | |
| 248 <b>__connectToServer</b>(<i></i>) | |
| 249 <p> | |
| 250 Private slot to connect to a remote eric-ide server. | |
| 251 </p> | |
| 252 | |
| 253 <a NAME="EricServerInterface.__connectionStateChanged" ID="EricServerInterface.__connectionStateChanged"></a> | |
| 254 <h4>EricServerInterface.__connectionStateChanged</h4> | |
| 255 <b>__connectionStateChanged</b>(<i>connected</i>) | |
| 256 <p> | |
| 257 Private slot to handle the connection state change. | |
| 258 </p> | |
| 259 | |
| 260 <dl> | |
| 261 | |
| 262 <dt><i>connected</i> (bool)</dt> | |
| 263 <dd> | |
| 264 flag indicating the connection state | |
| 265 </dd> | |
| 266 </dl> | |
| 267 <a NAME="EricServerInterface.__createCoverageInterface" ID="EricServerInterface.__createCoverageInterface"></a> | |
| 268 <h4>EricServerInterface.__createCoverageInterface</h4> | |
| 269 <b>__createCoverageInterface</b>(<i></i>) | |
| 270 <p> | |
| 271 Private method to create and register the 'Coverage' eric-ide server interface. | |
| 272 </p> | |
| 273 | |
| 274 <a NAME="EricServerInterface.__createDebuggerInterface" ID="EricServerInterface.__createDebuggerInterface"></a> | |
| 275 <h4>EricServerInterface.__createDebuggerInterface</h4> | |
| 276 <b>__createDebuggerInterface</b>(<i></i>) | |
| 277 <p> | |
| 278 Private method to create and register the 'Debugger' eric-ide server interface. | |
| 279 </p> | |
| 280 | |
| 281 <a NAME="EricServerInterface.__createEditorConfigInterface" ID="EricServerInterface.__createEditorConfigInterface"></a> | |
| 282 <h4>EricServerInterface.__createEditorConfigInterface</h4> | |
| 283 <b>__createEditorConfigInterface</b>(<i></i>) | |
| 284 <p> | |
| 285 Private method to create and register the 'EditorConfig' eric-ide server | |
| 286 interface. | |
| 287 </p> | |
| 288 | |
| 289 <a NAME="EricServerInterface.__createFilesystemInterface" ID="EricServerInterface.__createFilesystemInterface"></a> | |
| 290 <h4>EricServerInterface.__createFilesystemInterface</h4> | |
| 291 <b>__createFilesystemInterface</b>(<i></i>) | |
| 292 <p> | |
| 293 Private method to create and register the 'Filesystem' eric-ide server | |
| 294 interface. | |
| 295 </p> | |
| 296 | |
| 297 <a NAME="EricServerInterface.__handleDisconnect" ID="EricServerInterface.__handleDisconnect"></a> | |
| 298 <h4>EricServerInterface.__handleDisconnect</h4> | |
| 299 <b>__handleDisconnect</b>(<i></i>) | |
| 300 <p> | |
| 301 Private slot handling a disconnect of the client. | |
| 302 </p> | |
| 303 | |
| 304 <a NAME="EricServerInterface.__handleServerError" ID="EricServerInterface.__handleServerError"></a> | |
| 305 <h4>EricServerInterface.__handleServerError</h4> | |
| 306 <b>__handleServerError</b>(<i>reply, params</i>) | |
| 307 <p> | |
| 308 Private method handling server error replies. | |
| 309 </p> | |
| 310 | |
| 311 <dl> | |
| 312 | |
| 313 <dt><i>reply</i> (str)</dt> | |
| 314 <dd> | |
| 315 name of the error reply | |
| 316 </dd> | |
| 317 <dt><i>params</i> (dict)</dt> | |
| 318 <dd> | |
| 319 dictionary containing the specific reply data | |
| 320 </dd> | |
| 321 </dl> | |
| 322 <a NAME="EricServerInterface.__handleServerVersionReply" ID="EricServerInterface.__handleServerVersionReply"></a> | |
| 323 <h4>EricServerInterface.__handleServerVersionReply</h4> | |
| 324 <b>__handleServerVersionReply</b>(<i>reply, params</i>) | |
| 325 <p> | |
| 326 Private method to handle the reply of a 'Version' request. | |
| 327 </p> | |
| 328 | |
| 329 <dl> | |
| 330 | |
| 331 <dt><i>reply</i> (str)</dt> | |
| 332 <dd> | |
| 333 name of the eric-ide server reply | |
| 334 </dd> | |
| 335 <dt><i>params</i> (dict)</dt> | |
| 336 <dd> | |
| 337 dictionary containing the reply data | |
| 338 </dd> | |
| 339 </dl> | |
| 340 <dl> | |
| 341 | |
| 342 <dt>Raises <b>ValueError</b>:</dt> | |
| 343 <dd> | |
| 344 raised in case of an unsupported reply | |
| 345 </dd> | |
| 346 </dl> | |
| 347 <a NAME="EricServerInterface.__manageServerProfiles" ID="EricServerInterface.__manageServerProfiles"></a> | |
| 348 <h4>EricServerInterface.__manageServerProfiles</h4> | |
| 349 <b>__manageServerProfiles</b>(<i></i>) | |
| 350 <p> | |
| 351 Private slot to show a dialog to manage the eric-ide server connection | |
| 352 profiles. | |
| 353 </p> | |
| 354 | |
| 355 <a NAME="EricServerInterface.__receiveJson" ID="EricServerInterface.__receiveJson"></a> | |
| 356 <h4>EricServerInterface.__receiveJson</h4> | |
| 357 <b>__receiveJson</b>(<i></i>) | |
| 358 <p> | |
| 359 Private slot handling received data from the eric remote server. | |
| 360 </p> | |
| 361 | |
| 362 <a NAME="EricServerInterface.__serverProfileTriggered" ID="EricServerInterface.__serverProfileTriggered"></a> | |
| 363 <h4>EricServerInterface.__serverProfileTriggered</h4> | |
| 364 <b>__serverProfileTriggered</b>(<i>act</i>) | |
| 365 <p> | |
| 366 Private slot to handle the selection of a remote server connection. | |
| 367 </p> | |
| 368 | |
| 369 <dl> | |
| 370 | |
| 371 <dt><i>act</i> (QAction)</dt> | |
| 372 <dd> | |
| 373 reference to the triggered profile action | |
| 374 </dd> | |
| 375 </dl> | |
| 376 <a NAME="EricServerInterface.__showEricServerMenu" ID="EricServerInterface.__showEricServerMenu"></a> | |
| 377 <h4>EricServerInterface.__showEricServerMenu</h4> | |
| 378 <b>__showEricServerMenu</b>(<i></i>) | |
| 379 <p> | |
| 380 Private slot to display the server menu. | |
| 381 </p> | |
| 382 | |
| 383 <a NAME="EricServerInterface.__showServerProfilesMenu" ID="EricServerInterface.__showServerProfilesMenu"></a> | |
| 384 <h4>EricServerInterface.__showServerProfilesMenu</h4> | |
| 385 <b>__showServerProfilesMenu</b>(<i></i>) | |
| 386 <p> | |
| 387 Private slot to prepare the eric server profiles menu. | |
| 388 </p> | |
| 389 | |
| 390 <a NAME="EricServerInterface.__shutdownServer" ID="EricServerInterface.__shutdownServer"></a> | |
| 391 <h4>EricServerInterface.__shutdownServer</h4> | |
| 392 <b>__shutdownServer</b>(<i></i>) | |
| 393 <p> | |
| 394 Private slot to shut down the currently connected eric-ide server. | |
| 395 </p> | |
| 396 | |
| 397 <a NAME="EricServerInterface.connectToServer" ID="EricServerInterface.connectToServer"></a> | |
| 398 <h4>EricServerInterface.connectToServer</h4> | |
| 399 <b>connectToServer</b>(<i>host, port=None, timeout=None</i>) | |
| 400 <p> | |
| 401 Public method to connect to the given host and port. | |
| 402 </p> | |
| 403 | |
| 404 <dl> | |
| 405 | |
| 406 <dt><i>host</i> (str)</dt> | |
| 407 <dd> | |
| 408 host name or IP address of the eric remote server | |
| 409 </dd> | |
| 410 <dt><i>port</i> (int (optional))</dt> | |
| 411 <dd> | |
| 412 port number to connect to (defaults to None) | |
| 413 </dd> | |
| 414 <dt><i>timeout</i> (int (optional))</dt> | |
| 415 <dd> | |
| 416 timeout im seconds for the connection attempt | |
| 417 (defaults to None) | |
| 418 </dd> | |
| 419 </dl> | |
| 420 <dl> | |
| 421 <dt>Return:</dt> | |
| 422 <dd> | |
| 423 flag indicating success | |
| 424 </dd> | |
| 425 </dl> | |
| 426 <dl> | |
| 427 <dt>Return Type:</dt> | |
| 428 <dd> | |
| 429 bool | |
| 430 </dd> | |
| 431 </dl> | |
| 432 <a NAME="EricServerInterface.disconnectFromServer" ID="EricServerInterface.disconnectFromServer"></a> | |
| 433 <h4>EricServerInterface.disconnectFromServer</h4> | |
| 434 <b>disconnectFromServer</b>(<i></i>) | |
| 435 <p> | |
| 436 Public method to disconnect from the eric remote server. | |
| 437 </p> | |
| 438 | |
| 439 <a NAME="EricServerInterface.getHost" ID="EricServerInterface.getHost"></a> | |
| 440 <h4>EricServerInterface.getHost</h4> | |
| 441 <b>getHost</b>(<i></i>) | |
| 442 <p> | |
| 443 Public method to get the connected host as "host name:port". | |
| 444 </p> | |
| 445 | |
| 446 <dl> | |
| 447 <dt>Return:</dt> | |
| 448 <dd> | |
| 449 connected host as "host name:port" or an empty string, if there is no | |
| 450 valid connection | |
| 451 </dd> | |
| 452 </dl> | |
| 453 <dl> | |
| 454 <dt>Return Type:</dt> | |
| 455 <dd> | |
| 456 str | |
| 457 </dd> | |
| 458 </dl> | |
| 459 <a NAME="EricServerInterface.getHostName" ID="EricServerInterface.getHostName"></a> | |
| 460 <h4>EricServerInterface.getHostName</h4> | |
| 461 <b>getHostName</b>(<i></i>) | |
| 462 <p> | |
| 463 Public method to get the name of the connected host. | |
| 464 </p> | |
| 465 | |
| 466 <dl> | |
| 467 <dt>Return:</dt> | |
| 468 <dd> | |
| 469 name of the connected host or an empty string, if there is no | |
| 470 valid connection | |
| 471 </dd> | |
| 472 </dl> | |
| 473 <dl> | |
| 474 <dt>Return Type:</dt> | |
| 475 <dd> | |
| 476 str | |
| 477 </dd> | |
| 478 </dl> | |
| 479 <a NAME="EricServerInterface.getServiceInterface" ID="EricServerInterface.getServiceInterface"></a> | |
| 480 <h4>EricServerInterface.getServiceInterface</h4> | |
| 481 <b>getServiceInterface</b>(<i>name</i>) | |
| 482 <p> | |
| 483 Public method to get a references to a specific service interface by | |
| 484 service name. | |
| 485 </p> | |
| 486 | |
| 487 <dl> | |
| 488 | |
| 489 <dt><i>name</i> (str)</dt> | |
| 490 <dd> | |
| 491 service name | |
| 492 </dd> | |
| 493 </dl> | |
| 494 <dl> | |
| 495 <dt>Return:</dt> | |
| 496 <dd> | |
| 497 reference to the service interface | |
| 498 </dd> | |
| 499 </dl> | |
| 500 <dl> | |
| 501 <dt>Return Type:</dt> | |
| 502 <dd> | |
| 503 QObject | |
| 504 </dd> | |
| 505 </dl> | |
| 506 <dl> | |
| 507 | |
| 508 <dt>Raises <b>ValueError</b>:</dt> | |
| 509 <dd> | |
| 510 raised to indicate an unsupported server interface | |
| 511 was requested | |
| 512 </dd> | |
| 513 </dl> | |
| 514 <a NAME="EricServerInterface.initActions" ID="EricServerInterface.initActions"></a> | |
| 515 <h4>EricServerInterface.initActions</h4> | |
| 516 <b>initActions</b>(<i></i>) | |
| 517 <p> | |
| 518 Public slot to initialize the eric-ide server actions. | |
| 519 </p> | |
| 520 | |
| 521 <a NAME="EricServerInterface.initMenu" ID="EricServerInterface.initMenu"></a> | |
| 522 <h4>EricServerInterface.initMenu</h4> | |
| 523 <b>initMenu</b>(<i></i>) | |
| 524 <p> | |
| 525 Public slot to initialize the eric-ide server menu. | |
| 526 </p> | |
| 527 | |
| 528 <dl> | |
| 529 <dt>Return:</dt> | |
| 530 <dd> | |
| 531 the menu generated | |
| 532 </dd> | |
| 533 </dl> | |
| 534 <dl> | |
| 535 <dt>Return Type:</dt> | |
| 536 <dd> | |
| 537 QMenu | |
| 538 </dd> | |
| 539 </dl> | |
| 540 <a NAME="EricServerInterface.initToolbar" ID="EricServerInterface.initToolbar"></a> | |
| 541 <h4>EricServerInterface.initToolbar</h4> | |
| 542 <b>initToolbar</b>(<i>toolbarManager</i>) | |
| 543 <p> | |
| 544 Public slot to initialize the eric-ide server toolbar. | |
| 545 </p> | |
| 546 | |
| 547 <dl> | |
| 548 | |
| 549 <dt><i>toolbarManager</i> (EricToolBarManager)</dt> | |
| 550 <dd> | |
| 551 reference to a toolbar manager object | |
| 552 </dd> | |
| 553 </dl> | |
| 554 <dl> | |
| 555 <dt>Return:</dt> | |
| 556 <dd> | |
| 557 the toolbar generated | |
| 558 </dd> | |
| 559 </dl> | |
| 560 <dl> | |
| 561 <dt>Return Type:</dt> | |
| 562 <dd> | |
| 563 QToolBar | |
| 564 </dd> | |
| 565 </dl> | |
| 566 <a NAME="EricServerInterface.isServerConnected" ID="EricServerInterface.isServerConnected"></a> | |
| 567 <h4>EricServerInterface.isServerConnected</h4> | |
| 568 <b>isServerConnected</b>(<i></i>) | |
| 569 <p> | |
| 570 Public method to check, if a connection to an eric-ide server has been | |
| 571 established. | |
| 572 </p> | |
| 573 | |
| 574 <dl> | |
| 575 <dt>Return:</dt> | |
| 576 <dd> | |
| 577 flag indicating the interface connection state | |
| 578 </dd> | |
| 579 </dl> | |
| 580 <dl> | |
| 581 <dt>Return Type:</dt> | |
| 582 <dd> | |
| 583 bool | |
| 584 </dd> | |
| 585 </dl> | |
| 586 <a NAME="EricServerInterface.sendJson" ID="EricServerInterface.sendJson"></a> | |
| 587 <h4>EricServerInterface.sendJson</h4> | |
| 588 <b>sendJson</b>(<i>category, request, params, callback=None, flush=False</i>) | |
| 589 <p> | |
| 590 Public method to send a single command to a client. | |
| 591 </p> | |
| 592 | |
| 593 <dl> | |
| 594 | |
| 595 <dt><i>category</i> (EricRequestCategory)</dt> | |
| 596 <dd> | |
| 597 service category | |
| 598 </dd> | |
| 599 <dt><i>request</i> (str)</dt> | |
| 600 <dd> | |
| 601 request name to be sent | |
| 602 </dd> | |
| 603 <dt><i>params</i> (dict)</dt> | |
| 604 <dd> | |
| 605 dictionary of named parameters for the request | |
| 606 </dd> | |
| 607 <dt><i>callback</i> (function (optional))</dt> | |
| 608 <dd> | |
| 609 callback function for the reply from the eric remote server | |
| 610 (defaults to None) | |
| 611 </dd> | |
| 612 <dt><i>flush</i> (bool (optional))</dt> | |
| 613 <dd> | |
| 614 flag indicating to flush the data to the socket | |
| 615 (defaults to False) | |
| 616 </dd> | |
| 617 </dl> | |
| 618 <a NAME="EricServerInterface.serverVersions" ID="EricServerInterface.serverVersions"></a> | |
| 619 <h4>EricServerInterface.serverVersions</h4> | |
| 620 <b>serverVersions</b>(<i></i>) | |
| 621 <p> | |
| 622 Public slot to request the eric-ide version of the server. | |
| 623 </p> | |
| 624 | |
| 625 <a NAME="EricServerInterface.shutdownServer" ID="EricServerInterface.shutdownServer"></a> | |
| 626 <h4>EricServerInterface.shutdownServer</h4> | |
| 627 <b>shutdownServer</b>(<i></i>) | |
| 628 <p> | |
| 629 Public method shutdown the currebtly connected eric-ide remote server. | |
| 630 </p> | |
| 631 | |
| 632 <div align="right"><a href="#top">Up</a></div> | |
| 633 <hr /> | |
| 634 </body></html> |
