Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog.html
src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10437
- 2f70ca07f0af
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog</h1> | 9 <h1>eric7.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a dialog to show the output of the ericapi process. | 11 Module implementing a dialog to show the output of the ericapi process. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 20 <table> |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#EricapiExecDialog">EricapiExecDialog</a></td> | 22 <td><a href="#EricapiExecDialog">EricapiExecDialog</a></td> |
| 25 <td>Class implementing a dialog to show the output of the ericapi process.</td> | 23 <td>Class implementing a dialog to show the output of the ericapi process.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="EricapiExecDialog" ID="EricapiExecDialog"></a> | 34 <a NAME="EricapiExecDialog" ID="EricapiExecDialog"></a> |
| 36 <h2>EricapiExecDialog</h2> | 35 <h2>EricapiExecDialog</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing a dialog to show the output of the ericapi process. | 37 Class implementing a dialog to show the output of the ericapi process. |
| 40 </p> | 38 </p> |
| 41 <p> | 39 <p> |
| 42 This class starts a QProcess and displays a dialog that | 40 This class starts a QProcess and displays a dialog that |
| 43 shows the output of the documentation command process. | 41 shows the output of the documentation command process. |
| 44 </p> | 42 </p> |
| 43 | |
| 45 <h3>Signals</h3> | 44 <h3>Signals</h3> |
| 46 <dl> | 45 <dl> |
| 47 | 46 |
| 48 <dt>processFinished()</dt> | 47 <dt>processFinished()</dt> |
| 49 <dd> | 48 <dd> |
| 51 </dd> | 50 </dd> |
| 52 </dl> | 51 </dl> |
| 53 <h3>Derived from</h3> | 52 <h3>Derived from</h3> |
| 54 QDialog, Ui_EricapiExecDialog | 53 QDialog, Ui_EricapiExecDialog |
| 55 <h3>Class Attributes</h3> | 54 <h3>Class Attributes</h3> |
| 56 | |
| 57 <table> | 55 <table> |
| 58 <tr><td>None</td></tr> | 56 <tr><td>None</td></tr> |
| 59 </table> | 57 </table> |
| 58 | |
| 60 <h3>Class Methods</h3> | 59 <h3>Class Methods</h3> |
| 61 | |
| 62 <table> | 60 <table> |
| 63 <tr><td>None</td></tr> | 61 <tr><td>None</td></tr> |
| 64 </table> | 62 </table> |
| 63 | |
| 65 <h3>Methods</h3> | 64 <h3>Methods</h3> |
| 66 | |
| 67 <table> | 65 <table> |
| 68 | |
| 69 <tr> | 66 <tr> |
| 70 <td><a href="#EricapiExecDialog.__init__">EricapiExecDialog</a></td> | 67 <td><a href="#EricapiExecDialog.__init__">EricapiExecDialog</a></td> |
| 71 <td>Constructor</td> | 68 <td>Constructor</td> |
| 72 </tr> | 69 </tr> |
| 73 <tr> | 70 <tr> |
| 89 <tr> | 86 <tr> |
| 90 <td><a href="#EricapiExecDialog.start">start</a></td> | 87 <td><a href="#EricapiExecDialog.start">start</a></td> |
| 91 <td>Public slot to start the ericapi command.</td> | 88 <td>Public slot to start the ericapi command.</td> |
| 92 </tr> | 89 </tr> |
| 93 </table> | 90 </table> |
| 91 | |
| 94 <h3>Static Methods</h3> | 92 <h3>Static Methods</h3> |
| 95 | |
| 96 <table> | 93 <table> |
| 97 <tr><td>None</td></tr> | 94 <tr><td>None</td></tr> |
| 98 </table> | 95 </table> |
| 99 | 96 |
| 97 | |
| 100 <a NAME="EricapiExecDialog.__init__" ID="EricapiExecDialog.__init__"></a> | 98 <a NAME="EricapiExecDialog.__init__" ID="EricapiExecDialog.__init__"></a> |
| 101 <h4>EricapiExecDialog (Constructor)</h4> | 99 <h4>EricapiExecDialog (Constructor)</h4> |
| 102 <b>EricapiExecDialog</b>(<i>cmdname, parent=None</i>) | 100 <b>EricapiExecDialog</b>(<i>cmdname, parent=None</i>) |
| 103 | |
| 104 <p> | 101 <p> |
| 105 Constructor | 102 Constructor |
| 106 </p> | 103 </p> |
| 104 | |
| 107 <dl> | 105 <dl> |
| 108 | 106 |
| 109 <dt><i>cmdname</i> (str)</dt> | 107 <dt><i>cmdname</i> (str)</dt> |
| 110 <dd> | 108 <dd> |
| 111 name of the ericapi generator | 109 name of the ericapi generator |
| 116 </dd> | 114 </dd> |
| 117 </dl> | 115 </dl> |
| 118 <a NAME="EricapiExecDialog.__finish" ID="EricapiExecDialog.__finish"></a> | 116 <a NAME="EricapiExecDialog.__finish" ID="EricapiExecDialog.__finish"></a> |
| 119 <h4>EricapiExecDialog.__finish</h4> | 117 <h4>EricapiExecDialog.__finish</h4> |
| 120 <b>__finish</b>(<i></i>) | 118 <b>__finish</b>(<i></i>) |
| 121 | |
| 122 <p> | 119 <p> |
| 123 Private slot called when the process finished. | 120 Private slot called when the process finished. |
| 124 </p> | 121 </p> |
| 125 <p> | 122 <p> |
| 126 It is called when the process finished or | 123 It is called when the process finished or |
| 127 the user pressed the button. | 124 the user pressed the button. |
| 128 </p> | 125 </p> |
| 126 | |
| 129 <a NAME="EricapiExecDialog.__readStderr" ID="EricapiExecDialog.__readStderr"></a> | 127 <a NAME="EricapiExecDialog.__readStderr" ID="EricapiExecDialog.__readStderr"></a> |
| 130 <h4>EricapiExecDialog.__readStderr</h4> | 128 <h4>EricapiExecDialog.__readStderr</h4> |
| 131 <b>__readStderr</b>(<i></i>) | 129 <b>__readStderr</b>(<i></i>) |
| 132 | |
| 133 <p> | 130 <p> |
| 134 Private slot to handle the readyReadStandardError signal. | 131 Private slot to handle the readyReadStandardError signal. |
| 135 </p> | 132 </p> |
| 136 <p> | 133 <p> |
| 137 It reads the error output of the process and inserts it into the | 134 It reads the error output of the process and inserts it into the |
| 138 error pane. | 135 error pane. |
| 139 </p> | 136 </p> |
| 137 | |
| 140 <a NAME="EricapiExecDialog.__readStdout" ID="EricapiExecDialog.__readStdout"></a> | 138 <a NAME="EricapiExecDialog.__readStdout" ID="EricapiExecDialog.__readStdout"></a> |
| 141 <h4>EricapiExecDialog.__readStdout</h4> | 139 <h4>EricapiExecDialog.__readStdout</h4> |
| 142 <b>__readStdout</b>(<i></i>) | 140 <b>__readStdout</b>(<i></i>) |
| 143 | |
| 144 <p> | 141 <p> |
| 145 Private slot to handle the readyReadStandardOutput signal. | 142 Private slot to handle the readyReadStandardOutput signal. |
| 146 </p> | 143 </p> |
| 147 <p> | 144 <p> |
| 148 It reads the output of the process, formats it and inserts it into | 145 It reads the output of the process, formats it and inserts it into |
| 149 the contents pane. | 146 the contents pane. |
| 150 </p> | 147 </p> |
| 148 | |
| 151 <a NAME="EricapiExecDialog.on_buttonBox_clicked" ID="EricapiExecDialog.on_buttonBox_clicked"></a> | 149 <a NAME="EricapiExecDialog.on_buttonBox_clicked" ID="EricapiExecDialog.on_buttonBox_clicked"></a> |
| 152 <h4>EricapiExecDialog.on_buttonBox_clicked</h4> | 150 <h4>EricapiExecDialog.on_buttonBox_clicked</h4> |
| 153 <b>on_buttonBox_clicked</b>(<i>button</i>) | 151 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 154 | |
| 155 <p> | 152 <p> |
| 156 Private slot called by a button of the button box clicked. | 153 Private slot called by a button of the button box clicked. |
| 157 </p> | 154 </p> |
| 155 | |
| 158 <dl> | 156 <dl> |
| 159 | 157 |
| 160 <dt><i>button</i> (QAbstractButton)</dt> | 158 <dt><i>button</i> (QAbstractButton)</dt> |
| 161 <dd> | 159 <dd> |
| 162 button that was clicked | 160 button that was clicked |
| 163 </dd> | 161 </dd> |
| 164 </dl> | 162 </dl> |
| 165 <a NAME="EricapiExecDialog.start" ID="EricapiExecDialog.start"></a> | 163 <a NAME="EricapiExecDialog.start" ID="EricapiExecDialog.start"></a> |
| 166 <h4>EricapiExecDialog.start</h4> | 164 <h4>EricapiExecDialog.start</h4> |
| 167 <b>start</b>(<i>args, fn</i>) | 165 <b>start</b>(<i>args, fn</i>) |
| 168 | |
| 169 <p> | 166 <p> |
| 170 Public slot to start the ericapi command. | 167 Public slot to start the ericapi command. |
| 171 </p> | 168 </p> |
| 169 | |
| 172 <dl> | 170 <dl> |
| 173 | 171 |
| 174 <dt><i>args</i> (list of str)</dt> | 172 <dt><i>args</i> (list of str)</dt> |
| 175 <dd> | 173 <dd> |
| 176 commandline arguments for ericapi program | 174 commandline arguments for ericapi program |
