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