Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Project.ProjectProtocolsBrowser.html
eric7/Documentation/Source/eric7.Project.ProjectProtocolsBrowser.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Project.ProjectProtocolsBrowser</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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.Project.ProjectProtocolsBrowser</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the a class used to display the protocols (protobuf) part | |
| 27 of the project. | |
| 28 </p> | |
| 29 <h3>Global Attributes</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Classes</h3> | |
| 35 | |
| 36 <table> | |
| 37 | |
| 38 <tr> | |
| 39 <td><a href="#ProjectProtocolsBrowser">ProjectProtocolsBrowser</a></td> | |
| 40 <td>A class used to display the protocols (protobuf) part of the project.</td> | |
| 41 </tr> | |
| 42 </table> | |
| 43 <h3>Functions</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <hr /> | |
| 49 <hr /> | |
| 50 <a NAME="ProjectProtocolsBrowser" ID="ProjectProtocolsBrowser"></a> | |
| 51 <h2>ProjectProtocolsBrowser</h2> | |
| 52 | |
| 53 <p> | |
| 54 A class used to display the protocols (protobuf) part of the project. | |
| 55 </p> | |
| 56 <h3>Signals</h3> | |
| 57 <dl> | |
| 58 | |
| 59 <dt>appendStderr(str)</dt> | |
| 60 <dd> | |
| 61 emitted after something was received from | |
| 62 a QProcess on stderr | |
| 63 </dd> | |
| 64 <dt>appendStdout(str)</dt> | |
| 65 <dd> | |
| 66 emitted after something was received from | |
| 67 a QProcess on stdout | |
| 68 </dd> | |
| 69 <dt>showMenu(str, QMenu)</dt> | |
| 70 <dd> | |
| 71 emitted when a menu is about to be shown. | |
| 72 The name of the menu and a reference to the menu are given. | |
| 73 </dd> | |
| 74 </dl> | |
| 75 <h3>Derived from</h3> | |
| 76 ProjectBaseBrowser | |
| 77 <h3>Class Attributes</h3> | |
| 78 | |
| 79 <table> | |
| 80 <tr><td>None</td></tr> | |
| 81 </table> | |
| 82 <h3>Class Methods</h3> | |
| 83 | |
| 84 <table> | |
| 85 <tr><td>None</td></tr> | |
| 86 </table> | |
| 87 <h3>Methods</h3> | |
| 88 | |
| 89 <table> | |
| 90 | |
| 91 <tr> | |
| 92 <td><a href="#ProjectProtocolsBrowser.__init__">ProjectProtocolsBrowser</a></td> | |
| 93 <td>Constructor</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#ProjectProtocolsBrowser.__addProtocolFiles">__addProtocolFiles</a></td> | |
| 97 <td>Private method to add protocol files to the project.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#ProjectProtocolsBrowser.__addProtocolsDirectory">__addProtocolsDirectory</a></td> | |
| 101 <td>Private method to add protocol files of a directory to the project.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#ProjectProtocolsBrowser.__compileAllProtocols">__compileAllProtocols</a></td> | |
| 105 <td>Private method to compile all protocols to Python.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#ProjectProtocolsBrowser.__compileProto">__compileProto</a></td> | |
| 109 <td>Private method to compile a .proto file to Python.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#ProjectProtocolsBrowser.__compileProtoDone">__compileProtoDone</a></td> | |
| 113 <td>Private slot to handle the finished signal of the protoc process.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#ProjectProtocolsBrowser.__compileProtocol">__compileProtocol</a></td> | |
| 117 <td>Private method to compile a protocol to Python.</td> | |
| 118 </tr> | |
| 119 <tr> | |
| 120 <td><a href="#ProjectProtocolsBrowser.__compileSelectedProtocols">__compileSelectedProtocols</a></td> | |
| 121 <td>Private method to compile selected protocols to Python.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 124 <td><a href="#ProjectProtocolsBrowser.__configureProtobuf">__configureProtobuf</a></td> | |
| 125 <td>Private method to open the configuration dialog.</td> | |
| 126 </tr> | |
| 127 <tr> | |
| 128 <td><a href="#ProjectProtocolsBrowser.__deleteFile">__deleteFile</a></td> | |
| 129 <td>Private method to delete files from the project.</td> | |
| 130 </tr> | |
| 131 <tr> | |
| 132 <td><a href="#ProjectProtocolsBrowser.__getCompilerCommand">__getCompilerCommand</a></td> | |
| 133 <td>Private method to get the compiler command.</td> | |
| 134 </tr> | |
| 135 <tr> | |
| 136 <td><a href="#ProjectProtocolsBrowser.__readStderr">__readStderr</a></td> | |
| 137 <td>Private slot to handle the readyReadStandardError signal of the protoc process.</td> | |
| 138 </tr> | |
| 139 <tr> | |
| 140 <td><a href="#ProjectProtocolsBrowser.__readStdout">__readStdout</a></td> | |
| 141 <td>Private slot to handle the readyReadStandardOutput signal of the protoc process.</td> | |
| 142 </tr> | |
| 143 <tr> | |
| 144 <td><a href="#ProjectProtocolsBrowser.__showContextMenu">__showContextMenu</a></td> | |
| 145 <td>Private slot called by the menu aboutToShow signal.</td> | |
| 146 </tr> | |
| 147 <tr> | |
| 148 <td><a href="#ProjectProtocolsBrowser.__showContextMenuBack">__showContextMenuBack</a></td> | |
| 149 <td>Private slot called by the backMenu aboutToShow signal.</td> | |
| 150 </tr> | |
| 151 <tr> | |
| 152 <td><a href="#ProjectProtocolsBrowser.__showContextMenuDir">__showContextMenuDir</a></td> | |
| 153 <td>Private slot called by the dirMenu aboutToShow signal.</td> | |
| 154 </tr> | |
| 155 <tr> | |
| 156 <td><a href="#ProjectProtocolsBrowser.__showContextMenuDirMulti">__showContextMenuDirMulti</a></td> | |
| 157 <td>Private slot called by the dirMultiMenu aboutToShow signal.</td> | |
| 158 </tr> | |
| 159 <tr> | |
| 160 <td><a href="#ProjectProtocolsBrowser.__showContextMenuMulti">__showContextMenuMulti</a></td> | |
| 161 <td>Private slot called by the multiMenu aboutToShow signal.</td> | |
| 162 </tr> | |
| 163 <tr> | |
| 164 <td><a href="#ProjectProtocolsBrowser._contextMenuRequested">_contextMenuRequested</a></td> | |
| 165 <td>Protected slot to show the context menu.</td> | |
| 166 </tr> | |
| 167 <tr> | |
| 168 <td><a href="#ProjectProtocolsBrowser._createPopupMenus">_createPopupMenus</a></td> | |
| 169 <td>Protected overloaded method to generate the popup menu.</td> | |
| 170 </tr> | |
| 171 <tr> | |
| 172 <td><a href="#ProjectProtocolsBrowser._openItem">_openItem</a></td> | |
| 173 <td>Protected slot to handle the open popup menu entry.</td> | |
| 174 </tr> | |
| 175 </table> | |
| 176 <h3>Static Methods</h3> | |
| 177 | |
| 178 <table> | |
| 179 <tr><td>None</td></tr> | |
| 180 </table> | |
| 181 | |
| 182 <a NAME="ProjectProtocolsBrowser.__init__" ID="ProjectProtocolsBrowser.__init__"></a> | |
| 183 <h4>ProjectProtocolsBrowser (Constructor)</h4> | |
| 184 <b>ProjectProtocolsBrowser</b>(<i>project, parent=None</i>) | |
| 185 | |
| 186 <p> | |
| 187 Constructor | |
| 188 </p> | |
| 189 <dl> | |
| 190 | |
| 191 <dt><i>project</i> (Project)</dt> | |
| 192 <dd> | |
| 193 reference to the project object | |
| 194 </dd> | |
| 195 <dt><i>parent</i> (QWidget)</dt> | |
| 196 <dd> | |
| 197 parent widget of this browser | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <a NAME="ProjectProtocolsBrowser.__addProtocolFiles" ID="ProjectProtocolsBrowser.__addProtocolFiles"></a> | |
| 201 <h4>ProjectProtocolsBrowser.__addProtocolFiles</h4> | |
| 202 <b>__addProtocolFiles</b>(<i></i>) | |
| 203 | |
| 204 <p> | |
| 205 Private method to add protocol files to the project. | |
| 206 </p> | |
| 207 <a NAME="ProjectProtocolsBrowser.__addProtocolsDirectory" ID="ProjectProtocolsBrowser.__addProtocolsDirectory"></a> | |
| 208 <h4>ProjectProtocolsBrowser.__addProtocolsDirectory</h4> | |
| 209 <b>__addProtocolsDirectory</b>(<i></i>) | |
| 210 | |
| 211 <p> | |
| 212 Private method to add protocol files of a directory to the project. | |
| 213 </p> | |
| 214 <a NAME="ProjectProtocolsBrowser.__compileAllProtocols" ID="ProjectProtocolsBrowser.__compileAllProtocols"></a> | |
| 215 <h4>ProjectProtocolsBrowser.__compileAllProtocols</h4> | |
| 216 <b>__compileAllProtocols</b>(<i>grpc=False</i>) | |
| 217 | |
| 218 <p> | |
| 219 Private method to compile all protocols to Python. | |
| 220 </p> | |
| 221 <dl> | |
| 222 | |
| 223 <dt><i>grpc</i> (bool)</dt> | |
| 224 <dd> | |
| 225 flag indicating to compile as gRPC files | |
| 226 </dd> | |
| 227 </dl> | |
| 228 <a NAME="ProjectProtocolsBrowser.__compileProto" ID="ProjectProtocolsBrowser.__compileProto"></a> | |
| 229 <h4>ProjectProtocolsBrowser.__compileProto</h4> | |
| 230 <b>__compileProto</b>(<i>fn, noDialog=False, progress=None, grpc=False</i>) | |
| 231 | |
| 232 <p> | |
| 233 Private method to compile a .proto file to Python. | |
| 234 </p> | |
| 235 <dl> | |
| 236 | |
| 237 <dt><i>fn</i> (str)</dt> | |
| 238 <dd> | |
| 239 filename of the .proto file to be compiled | |
| 240 </dd> | |
| 241 <dt><i>noDialog</i> (bool)</dt> | |
| 242 <dd> | |
| 243 flag indicating silent operations | |
| 244 </dd> | |
| 245 <dt><i>progress</i> (EricProgressDialog)</dt> | |
| 246 <dd> | |
| 247 reference to the progress dialog | |
| 248 </dd> | |
| 249 <dt><i>grpc</i> (bool)</dt> | |
| 250 <dd> | |
| 251 flag indicating to compile as gRPC files | |
| 252 </dd> | |
| 253 </dl> | |
| 254 <dl> | |
| 255 <dt>Return:</dt> | |
| 256 <dd> | |
| 257 reference to the compile process | |
| 258 </dd> | |
| 259 </dl> | |
| 260 <dl> | |
| 261 <dt>Return Type:</dt> | |
| 262 <dd> | |
| 263 QProcess | |
| 264 </dd> | |
| 265 </dl> | |
| 266 <a NAME="ProjectProtocolsBrowser.__compileProtoDone" ID="ProjectProtocolsBrowser.__compileProtoDone"></a> | |
| 267 <h4>ProjectProtocolsBrowser.__compileProtoDone</h4> | |
| 268 <b>__compileProtoDone</b>(<i>exitCode, exitStatus, grpc</i>) | |
| 269 | |
| 270 <p> | |
| 271 Private slot to handle the finished signal of the protoc process. | |
| 272 </p> | |
| 273 <dl> | |
| 274 | |
| 275 <dt><i>exitCode</i> (int)</dt> | |
| 276 <dd> | |
| 277 exit code of the process | |
| 278 </dd> | |
| 279 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> | |
| 280 <dd> | |
| 281 exit status of the process | |
| 282 </dd> | |
| 283 <dt><i>grpc</i> (bool)</dt> | |
| 284 <dd> | |
| 285 flag indicating to compile as gRPC files | |
| 286 </dd> | |
| 287 </dl> | |
| 288 <a NAME="ProjectProtocolsBrowser.__compileProtocol" ID="ProjectProtocolsBrowser.__compileProtocol"></a> | |
| 289 <h4>ProjectProtocolsBrowser.__compileProtocol</h4> | |
| 290 <b>__compileProtocol</b>(<i>grpc=False</i>) | |
| 291 | |
| 292 <p> | |
| 293 Private method to compile a protocol to Python. | |
| 294 </p> | |
| 295 <dl> | |
| 296 | |
| 297 <dt><i>grpc</i> (bool)</dt> | |
| 298 <dd> | |
| 299 flag indicating to compile as gRPC files | |
| 300 </dd> | |
| 301 </dl> | |
| 302 <a NAME="ProjectProtocolsBrowser.__compileSelectedProtocols" ID="ProjectProtocolsBrowser.__compileSelectedProtocols"></a> | |
| 303 <h4>ProjectProtocolsBrowser.__compileSelectedProtocols</h4> | |
| 304 <b>__compileSelectedProtocols</b>(<i>grpc=False</i>) | |
| 305 | |
| 306 <p> | |
| 307 Private method to compile selected protocols to Python. | |
| 308 </p> | |
| 309 <dl> | |
| 310 | |
| 311 <dt><i>grpc</i> (bool)</dt> | |
| 312 <dd> | |
| 313 flag indicating to compile as gRPC files | |
| 314 </dd> | |
| 315 </dl> | |
| 316 <a NAME="ProjectProtocolsBrowser.__configureProtobuf" ID="ProjectProtocolsBrowser.__configureProtobuf"></a> | |
| 317 <h4>ProjectProtocolsBrowser.__configureProtobuf</h4> | |
| 318 <b>__configureProtobuf</b>(<i></i>) | |
| 319 | |
| 320 <p> | |
| 321 Private method to open the configuration dialog. | |
| 322 </p> | |
| 323 <a NAME="ProjectProtocolsBrowser.__deleteFile" ID="ProjectProtocolsBrowser.__deleteFile"></a> | |
| 324 <h4>ProjectProtocolsBrowser.__deleteFile</h4> | |
| 325 <b>__deleteFile</b>(<i></i>) | |
| 326 | |
| 327 <p> | |
| 328 Private method to delete files from the project. | |
| 329 </p> | |
| 330 <a NAME="ProjectProtocolsBrowser.__getCompilerCommand" ID="ProjectProtocolsBrowser.__getCompilerCommand"></a> | |
| 331 <h4>ProjectProtocolsBrowser.__getCompilerCommand</h4> | |
| 332 <b>__getCompilerCommand</b>(<i>grpc</i>) | |
| 333 | |
| 334 <p> | |
| 335 Private method to get the compiler command. | |
| 336 </p> | |
| 337 <dl> | |
| 338 | |
| 339 <dt><i>grpc</i> (bool)</dt> | |
| 340 <dd> | |
| 341 flag indicating to get a gRPC command | |
| 342 </dd> | |
| 343 </dl> | |
| 344 <dl> | |
| 345 <dt>Return:</dt> | |
| 346 <dd> | |
| 347 tuple giving the executable and its parameter list | |
| 348 </dd> | |
| 349 </dl> | |
| 350 <dl> | |
| 351 <dt>Return Type:</dt> | |
| 352 <dd> | |
| 353 tuple of (str, list of str) | |
| 354 </dd> | |
| 355 </dl> | |
| 356 <a NAME="ProjectProtocolsBrowser.__readStderr" ID="ProjectProtocolsBrowser.__readStderr"></a> | |
| 357 <h4>ProjectProtocolsBrowser.__readStderr</h4> | |
| 358 <b>__readStderr</b>(<i></i>) | |
| 359 | |
| 360 <p> | |
| 361 Private slot to handle the readyReadStandardError signal of the | |
| 362 protoc process. | |
| 363 </p> | |
| 364 <a NAME="ProjectProtocolsBrowser.__readStdout" ID="ProjectProtocolsBrowser.__readStdout"></a> | |
| 365 <h4>ProjectProtocolsBrowser.__readStdout</h4> | |
| 366 <b>__readStdout</b>(<i></i>) | |
| 367 | |
| 368 <p> | |
| 369 Private slot to handle the readyReadStandardOutput signal of the | |
| 370 protoc process. | |
| 371 </p> | |
| 372 <a NAME="ProjectProtocolsBrowser.__showContextMenu" ID="ProjectProtocolsBrowser.__showContextMenu"></a> | |
| 373 <h4>ProjectProtocolsBrowser.__showContextMenu</h4> | |
| 374 <b>__showContextMenu</b>(<i></i>) | |
| 375 | |
| 376 <p> | |
| 377 Private slot called by the menu aboutToShow signal. | |
| 378 </p> | |
| 379 <a NAME="ProjectProtocolsBrowser.__showContextMenuBack" ID="ProjectProtocolsBrowser.__showContextMenuBack"></a> | |
| 380 <h4>ProjectProtocolsBrowser.__showContextMenuBack</h4> | |
| 381 <b>__showContextMenuBack</b>(<i></i>) | |
| 382 | |
| 383 <p> | |
| 384 Private slot called by the backMenu aboutToShow signal. | |
| 385 </p> | |
| 386 <a NAME="ProjectProtocolsBrowser.__showContextMenuDir" ID="ProjectProtocolsBrowser.__showContextMenuDir"></a> | |
| 387 <h4>ProjectProtocolsBrowser.__showContextMenuDir</h4> | |
| 388 <b>__showContextMenuDir</b>(<i></i>) | |
| 389 | |
| 390 <p> | |
| 391 Private slot called by the dirMenu aboutToShow signal. | |
| 392 </p> | |
| 393 <a NAME="ProjectProtocolsBrowser.__showContextMenuDirMulti" ID="ProjectProtocolsBrowser.__showContextMenuDirMulti"></a> | |
| 394 <h4>ProjectProtocolsBrowser.__showContextMenuDirMulti</h4> | |
| 395 <b>__showContextMenuDirMulti</b>(<i></i>) | |
| 396 | |
| 397 <p> | |
| 398 Private slot called by the dirMultiMenu aboutToShow signal. | |
| 399 </p> | |
| 400 <a NAME="ProjectProtocolsBrowser.__showContextMenuMulti" ID="ProjectProtocolsBrowser.__showContextMenuMulti"></a> | |
| 401 <h4>ProjectProtocolsBrowser.__showContextMenuMulti</h4> | |
| 402 <b>__showContextMenuMulti</b>(<i></i>) | |
| 403 | |
| 404 <p> | |
| 405 Private slot called by the multiMenu aboutToShow signal. | |
| 406 </p> | |
| 407 <a NAME="ProjectProtocolsBrowser._contextMenuRequested" ID="ProjectProtocolsBrowser._contextMenuRequested"></a> | |
| 408 <h4>ProjectProtocolsBrowser._contextMenuRequested</h4> | |
| 409 <b>_contextMenuRequested</b>(<i>coord</i>) | |
| 410 | |
| 411 <p> | |
| 412 Protected slot to show the context menu. | |
| 413 </p> | |
| 414 <dl> | |
| 415 | |
| 416 <dt><i>coord</i></dt> | |
| 417 <dd> | |
| 418 the position of the mouse pointer (QPoint) | |
| 419 </dd> | |
| 420 </dl> | |
| 421 <a NAME="ProjectProtocolsBrowser._createPopupMenus" ID="ProjectProtocolsBrowser._createPopupMenus"></a> | |
| 422 <h4>ProjectProtocolsBrowser._createPopupMenus</h4> | |
| 423 <b>_createPopupMenus</b>(<i></i>) | |
| 424 | |
| 425 <p> | |
| 426 Protected overloaded method to generate the popup menu. | |
| 427 </p> | |
| 428 <a NAME="ProjectProtocolsBrowser._openItem" ID="ProjectProtocolsBrowser._openItem"></a> | |
| 429 <h4>ProjectProtocolsBrowser._openItem</h4> | |
| 430 <b>_openItem</b>(<i></i>) | |
| 431 | |
| 432 <p> | |
| 433 Protected slot to handle the open popup menu entry. | |
| 434 </p> | |
| 435 <div align="right"><a href="#top">Up</a></div> | |
| 436 <hr /> | |
| 437 </body></html> |
