Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog.html
Documentation/Source/eric6.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog.html
- changeset 3673
- e26d7d0c1088
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog</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.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to show the output of the ericapi process. | |
| 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="#EricapiExecDialog">EricapiExecDialog</a></td> | |
| 34 <td>Class implementing a dialog to show the output of the ericapi process.</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="EricapiExecDialog" ID="EricapiExecDialog"></a> | |
| 43 <h2>EricapiExecDialog</h2> | |
| 44 <p> | |
| 45 Class implementing a dialog to show the output of the ericapi process. | |
| 46 </p><p> | |
| 47 This class starts a QProcess and displays a dialog that | |
| 48 shows the output of the documentation command process. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 QDialog, Ui_EricapiExecDialog | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#EricapiExecDialog.__init__">EricapiExecDialog</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#EricapiExecDialog.__finish">__finish</a></td> | |
| 67 <td>Private slot called when the process finished.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#EricapiExecDialog.__readStderr">__readStderr</a></td> | |
| 70 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#EricapiExecDialog.__readStdout">__readStdout</a></td> | |
| 73 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#EricapiExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 76 <td>Private slot called by a button of the button box clicked.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#EricapiExecDialog.start">start</a></td> | |
| 79 <td>Public slot to start the ericapi command.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <h3>Static Methods</h3> | |
| 83 <table> | |
| 84 <tr><td>None</td></tr> | |
| 85 </table> | |
| 86 <a NAME="EricapiExecDialog.__init__" ID="EricapiExecDialog.__init__"></a> | |
| 87 <h4>EricapiExecDialog (Constructor)</h4> | |
| 88 <b>EricapiExecDialog</b>(<i>cmdname, parent=None</i>) | |
| 89 <p> | |
| 90 Constructor | |
| 91 </p><dl> | |
| 92 <dt><i>cmdname</i></dt> | |
| 93 <dd> | |
| 94 name of the ericapi generator (string) | |
| 95 </dd><dt><i>parent</i></dt> | |
| 96 <dd> | |
| 97 parent widget of this dialog (QWidget) | |
| 98 </dd> | |
| 99 </dl><a NAME="EricapiExecDialog.__finish" ID="EricapiExecDialog.__finish"></a> | |
| 100 <h4>EricapiExecDialog.__finish</h4> | |
| 101 <b>__finish</b>(<i></i>) | |
| 102 <p> | |
| 103 Private slot called when the process finished. | |
| 104 </p><p> | |
| 105 It is called when the process finished or | |
| 106 the user pressed the button. | |
| 107 </p><a NAME="EricapiExecDialog.__readStderr" ID="EricapiExecDialog.__readStderr"></a> | |
| 108 <h4>EricapiExecDialog.__readStderr</h4> | |
| 109 <b>__readStderr</b>(<i></i>) | |
| 110 <p> | |
| 111 Private slot to handle the readyReadStandardError signal. | |
| 112 </p><p> | |
| 113 It reads the error output of the process and inserts it into the | |
| 114 error pane. | |
| 115 </p><a NAME="EricapiExecDialog.__readStdout" ID="EricapiExecDialog.__readStdout"></a> | |
| 116 <h4>EricapiExecDialog.__readStdout</h4> | |
| 117 <b>__readStdout</b>(<i></i>) | |
| 118 <p> | |
| 119 Private slot to handle the readyReadStandardOutput signal. | |
| 120 </p><p> | |
| 121 It reads the output of the process, formats it and inserts it into | |
| 122 the contents pane. | |
| 123 </p><a NAME="EricapiExecDialog.on_buttonBox_clicked" ID="EricapiExecDialog.on_buttonBox_clicked"></a> | |
| 124 <h4>EricapiExecDialog.on_buttonBox_clicked</h4> | |
| 125 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 126 <p> | |
| 127 Private slot called by a button of the button box clicked. | |
| 128 </p><dl> | |
| 129 <dt><i>button</i></dt> | |
| 130 <dd> | |
| 131 button that was clicked (QAbstractButton) | |
| 132 </dd> | |
| 133 </dl><a NAME="EricapiExecDialog.start" ID="EricapiExecDialog.start"></a> | |
| 134 <h4>EricapiExecDialog.start</h4> | |
| 135 <b>start</b>(<i>args, fn</i>) | |
| 136 <p> | |
| 137 Public slot to start the ericapi command. | |
| 138 </p><dl> | |
| 139 <dt><i>args</i></dt> | |
| 140 <dd> | |
| 141 commandline arguments for ericapi program (list of strings) | |
| 142 </dd><dt><i>fn</i></dt> | |
| 143 <dd> | |
| 144 filename or dirname to be processed by ericapi program | |
| 145 (string) | |
| 146 </dd> | |
| 147 </dl><dl> | |
| 148 <dt>Returns:</dt> | |
| 149 <dd> | |
| 150 flag indicating the successful start of the process (boolean) | |
| 151 </dd> | |
| 152 </dl> | |
| 153 <div align="right"><a href="#top">Up</a></div> | |
| 154 <hr /> | |
| 155 </body></html> |
