Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.EricCore.EricProcess.html
src/eric7/Documentation/Source/eric7.EricCore.EricProcess.html
- branch
- eric7
- changeset 10919
- 4e4c8ee38c45
equal
deleted
inserted
replaced
| 10918:056bd087096f | 10919:4e4c8ee38c45 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.EricCore.EricProcess</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.EricCore.EricProcess</h1> | |
| 10 <p> | |
| 11 Module implementing a QProcess derived class with a timeout and convenience signals. | |
| 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="#EricProcess">EricProcess</a></td> | |
| 23 <td>Class implementing a QProcess derived class with a timeout and convenience signals succeeded and failed.</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="EricProcess" ID="EricProcess"></a> | |
| 35 <h2>EricProcess</h2> | |
| 36 <p> | |
| 37 Class implementing a QProcess derived class with a timeout and convenience signals | |
| 38 succeeded and failed. | |
| 39 </p> | |
| 40 | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>failed()</dt> | |
| 45 <dd> | |
| 46 emitted to indicate a process failure | |
| 47 </dd> | |
| 48 <dt>succeeded()</dt> | |
| 49 <dd> | |
| 50 emitted to indicate that the process finished successfully | |
| 51 </dd> | |
| 52 <dt>timeout()</dt> | |
| 53 <dd> | |
| 54 emitted to indicate the expiry of the configured timeout value | |
| 55 </dd> | |
| 56 </dl> | |
| 57 <h3>Derived from</h3> | |
| 58 QProcess | |
| 59 <h3>Class Attributes</h3> | |
| 60 <table> | |
| 61 <tr><td>None</td></tr> | |
| 62 </table> | |
| 63 | |
| 64 <h3>Class Methods</h3> | |
| 65 <table> | |
| 66 <tr><td>None</td></tr> | |
| 67 </table> | |
| 68 | |
| 69 <h3>Methods</h3> | |
| 70 <table> | |
| 71 <tr> | |
| 72 <td><a href="#EricProcess.__init__">EricProcess</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#EricProcess.__finished">__finished</a></td> | |
| 77 <td>Private slot handling the end of the process.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#EricProcess.__started">__started</a></td> | |
| 81 <td>Private slot handling the process start.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#EricProcess.__timeout">__timeout</a></td> | |
| 85 <td>Private slot to handle the timer interval exoiration.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#EricProcess.timedOut">timedOut</a></td> | |
| 89 <td>Public method to test, if the process timed out.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#EricProcess.timeoutInterval">timeoutInterval</a></td> | |
| 93 <td>Public method to get the process timeout interval.</td> | |
| 94 </tr> | |
| 95 </table> | |
| 96 | |
| 97 <h3>Static Methods</h3> | |
| 98 <table> | |
| 99 <tr><td>None</td></tr> | |
| 100 </table> | |
| 101 | |
| 102 | |
| 103 <a NAME="EricProcess.__init__" ID="EricProcess.__init__"></a> | |
| 104 <h4>EricProcess (Constructor)</h4> | |
| 105 <b>EricProcess</b>(<i>timeout=30000, parent=None</i>) | |
| 106 <p> | |
| 107 Constructor | |
| 108 </p> | |
| 109 | |
| 110 <dl> | |
| 111 | |
| 112 <dt><i>timeout</i> (int (optional))</dt> | |
| 113 <dd> | |
| 114 timeout value in milliseconds. If the process does not finish | |
| 115 within this interval, it is killed. (defaults to 30000) | |
| 116 </dd> | |
| 117 <dt><i>parent</i> (QObject (optional))</dt> | |
| 118 <dd> | |
| 119 reference to the parent object (defaults to None) | |
| 120 </dd> | |
| 121 </dl> | |
| 122 <a NAME="EricProcess.__finished" ID="EricProcess.__finished"></a> | |
| 123 <h4>EricProcess.__finished</h4> | |
| 124 <b>__finished</b>(<i>exitCode, exitStatus</i>) | |
| 125 <p> | |
| 126 Private slot handling the end of the process. | |
| 127 </p> | |
| 128 | |
| 129 <dl> | |
| 130 | |
| 131 <dt><i>exitCode</i> (int)</dt> | |
| 132 <dd> | |
| 133 exit code of the process (0 = success) | |
| 134 </dd> | |
| 135 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> | |
| 136 <dd> | |
| 137 exit status of the process | |
| 138 </dd> | |
| 139 </dl> | |
| 140 <a NAME="EricProcess.__started" ID="EricProcess.__started"></a> | |
| 141 <h4>EricProcess.__started</h4> | |
| 142 <b>__started</b>(<i></i>) | |
| 143 <p> | |
| 144 Private slot handling the process start. | |
| 145 </p> | |
| 146 | |
| 147 <a NAME="EricProcess.__timeout" ID="EricProcess.__timeout"></a> | |
| 148 <h4>EricProcess.__timeout</h4> | |
| 149 <b>__timeout</b>(<i></i>) | |
| 150 <p> | |
| 151 Private slot to handle the timer interval exoiration. | |
| 152 </p> | |
| 153 | |
| 154 <a NAME="EricProcess.timedOut" ID="EricProcess.timedOut"></a> | |
| 155 <h4>EricProcess.timedOut</h4> | |
| 156 <b>timedOut</b>(<i></i>) | |
| 157 <p> | |
| 158 Public method to test, if the process timed out. | |
| 159 </p> | |
| 160 | |
| 161 <dl> | |
| 162 <dt>Return:</dt> | |
| 163 <dd> | |
| 164 flag indicating a timeout | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <dl> | |
| 168 <dt>Return Type:</dt> | |
| 169 <dd> | |
| 170 bool | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <a NAME="EricProcess.timeoutInterval" ID="EricProcess.timeoutInterval"></a> | |
| 174 <h4>EricProcess.timeoutInterval</h4> | |
| 175 <b>timeoutInterval</b>(<i></i>) | |
| 176 <p> | |
| 177 Public method to get the process timeout interval. | |
| 178 </p> | |
| 179 | |
| 180 <dl> | |
| 181 <dt>Return:</dt> | |
| 182 <dd> | |
| 183 process timeout interval in milliseconds | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <dl> | |
| 187 <dt>Return Type:</dt> | |
| 188 <dd> | |
| 189 int | |
| 190 </dd> | |
| 191 </dl> | |
| 192 <div align="right"><a href="#top">Up</a></div> | |
| 193 <hr /> | |
| 194 </body></html> |
