Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10438
- 4cd7e5a8b3cf
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitDialog</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.Plugins.VcsPlugins.vcsGit.GitDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog starting a process and showing its output. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#GitDialog">GitDialog</a></td> | |
| 25 <td>Class implementing a dialog starting a process and showing its output.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="GitDialog" ID="GitDialog"></a> | |
| 36 <h2>GitDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog starting a process and showing its output. | |
| 40 </p> | |
| 41 <p> | |
| 42 It starts a QProcess and displays a dialog that | |
| 43 shows the output of the process. The dialog is modal, | |
| 44 which causes a synchronized execution of the process. | |
| 45 </p> | |
| 46 <h3>Derived from</h3> | |
| 47 QDialog, Ui_GitDialog | |
| 48 <h3>Class Attributes</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 | |
| 60 <table> | |
| 61 | |
| 62 <tr> | |
| 63 <td><a href="#GitDialog.__init__">GitDialog</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#GitDialog.__finish">__finish</a></td> | |
| 68 <td>Private slot called when the process finished or the user pressed the button.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#GitDialog.__procFinished">__procFinished</a></td> | |
| 72 <td>Private slot connected to the finished signal.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#GitDialog.__readStderr">__readStderr</a></td> | |
| 76 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#GitDialog.__readStdout">__readStdout</a></td> | |
| 80 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#GitDialog.__showError">__showError</a></td> | |
| 84 <td>Private slot to show some error.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#GitDialog.__showOutput">__showOutput</a></td> | |
| 88 <td>Private slot to show some output.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#GitDialog.hasAddOrDelete">hasAddOrDelete</a></td> | |
| 92 <td>Public method to check, if the last action contained an add or delete.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#GitDialog.keyPressEvent">keyPressEvent</a></td> | |
| 96 <td>Protected slot to handle a key press event.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#GitDialog.normalExit">normalExit</a></td> | |
| 100 <td>Public method to check for a normal process termination.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#GitDialog.normalExitWithoutErrors">normalExitWithoutErrors</a></td> | |
| 104 <td>Public method to check for a normal process termination without error messages.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#GitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 108 <td>Private slot called by a button of the button box clicked.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#GitDialog.on_input_returnPressed">on_input_returnPressed</a></td> | |
| 112 <td>Private slot to handle the press of the return key in the input field.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#GitDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> | |
| 116 <td>Private slot to handle the password checkbox toggled.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 119 <td><a href="#GitDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 120 <td>Private slot to send the input to the git process.</td> | |
| 121 </tr> | |
| 122 <tr> | |
| 123 <td><a href="#GitDialog.startProcess">startProcess</a></td> | |
| 124 <td>Public slot used to start the process.</td> | |
| 125 </tr> | |
| 126 </table> | |
| 127 <h3>Static Methods</h3> | |
| 128 | |
| 129 <table> | |
| 130 <tr><td>None</td></tr> | |
| 131 </table> | |
| 132 | |
| 133 <a NAME="GitDialog.__init__" ID="GitDialog.__init__"></a> | |
| 134 <h4>GitDialog (Constructor)</h4> | |
| 135 <b>GitDialog</b>(<i>text, git=None, parent=None</i>) | |
| 136 | |
| 137 <p> | |
| 138 Constructor | |
| 139 </p> | |
| 140 <dl> | |
| 141 | |
| 142 <dt><i>text</i></dt> | |
| 143 <dd> | |
| 144 text to be shown by the label (string) | |
| 145 </dd> | |
| 146 <dt><i>git</i></dt> | |
| 147 <dd> | |
| 148 reference to the Git interface object (Git) | |
| 149 </dd> | |
| 150 <dt><i>parent</i></dt> | |
| 151 <dd> | |
| 152 parent widget (QWidget) | |
| 153 </dd> | |
| 154 </dl> | |
| 155 <a NAME="GitDialog.__finish" ID="GitDialog.__finish"></a> | |
| 156 <h4>GitDialog.__finish</h4> | |
| 157 <b>__finish</b>(<i></i>) | |
| 158 | |
| 159 <p> | |
| 160 Private slot called when the process finished or the user pressed | |
| 161 the button. | |
| 162 </p> | |
| 163 <a NAME="GitDialog.__procFinished" ID="GitDialog.__procFinished"></a> | |
| 164 <h4>GitDialog.__procFinished</h4> | |
| 165 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 166 | |
| 167 <p> | |
| 168 Private slot connected to the finished signal. | |
| 169 </p> | |
| 170 <dl> | |
| 171 | |
| 172 <dt><i>exitCode</i></dt> | |
| 173 <dd> | |
| 174 exit code of the process (integer) | |
| 175 </dd> | |
| 176 <dt><i>exitStatus</i></dt> | |
| 177 <dd> | |
| 178 exit status of the process (QProcess.ExitStatus) | |
| 179 </dd> | |
| 180 </dl> | |
| 181 <a NAME="GitDialog.__readStderr" ID="GitDialog.__readStderr"></a> | |
| 182 <h4>GitDialog.__readStderr</h4> | |
| 183 <b>__readStderr</b>(<i></i>) | |
| 184 | |
| 185 <p> | |
| 186 Private slot to handle the readyReadStandardError signal. | |
| 187 </p> | |
| 188 <p> | |
| 189 It reads the error output of the process and inserts it into the | |
| 190 error pane. | |
| 191 </p> | |
| 192 <a NAME="GitDialog.__readStdout" ID="GitDialog.__readStdout"></a> | |
| 193 <h4>GitDialog.__readStdout</h4> | |
| 194 <b>__readStdout</b>(<i></i>) | |
| 195 | |
| 196 <p> | |
| 197 Private slot to handle the readyReadStandardOutput signal. | |
| 198 </p> | |
| 199 <p> | |
| 200 It reads the output of the process, formats it and inserts it into | |
| 201 the contents pane. | |
| 202 </p> | |
| 203 <a NAME="GitDialog.__showError" ID="GitDialog.__showError"></a> | |
| 204 <h4>GitDialog.__showError</h4> | |
| 205 <b>__showError</b>(<i>out</i>) | |
| 206 | |
| 207 <p> | |
| 208 Private slot to show some error. | |
| 209 </p> | |
| 210 <dl> | |
| 211 | |
| 212 <dt><i>out</i></dt> | |
| 213 <dd> | |
| 214 error to be shown (string) | |
| 215 </dd> | |
| 216 </dl> | |
| 217 <a NAME="GitDialog.__showOutput" ID="GitDialog.__showOutput"></a> | |
| 218 <h4>GitDialog.__showOutput</h4> | |
| 219 <b>__showOutput</b>(<i>out</i>) | |
| 220 | |
| 221 <p> | |
| 222 Private slot to show some output. | |
| 223 </p> | |
| 224 <dl> | |
| 225 | |
| 226 <dt><i>out</i></dt> | |
| 227 <dd> | |
| 228 output to be shown (string) | |
| 229 </dd> | |
| 230 </dl> | |
| 231 <a NAME="GitDialog.hasAddOrDelete" ID="GitDialog.hasAddOrDelete"></a> | |
| 232 <h4>GitDialog.hasAddOrDelete</h4> | |
| 233 <b>hasAddOrDelete</b>(<i></i>) | |
| 234 | |
| 235 <p> | |
| 236 Public method to check, if the last action contained an add or delete. | |
| 237 </p> | |
| 238 <dl> | |
| 239 <dt>Return:</dt> | |
| 240 <dd> | |
| 241 flag indicating the presence of an add or delete (boolean) | |
| 242 </dd> | |
| 243 </dl> | |
| 244 <a NAME="GitDialog.keyPressEvent" ID="GitDialog.keyPressEvent"></a> | |
| 245 <h4>GitDialog.keyPressEvent</h4> | |
| 246 <b>keyPressEvent</b>(<i>evt</i>) | |
| 247 | |
| 248 <p> | |
| 249 Protected slot to handle a key press event. | |
| 250 </p> | |
| 251 <dl> | |
| 252 | |
| 253 <dt><i>evt</i></dt> | |
| 254 <dd> | |
| 255 the key press event (QKeyEvent) | |
| 256 </dd> | |
| 257 </dl> | |
| 258 <a NAME="GitDialog.normalExit" ID="GitDialog.normalExit"></a> | |
| 259 <h4>GitDialog.normalExit</h4> | |
| 260 <b>normalExit</b>(<i></i>) | |
| 261 | |
| 262 <p> | |
| 263 Public method to check for a normal process termination. | |
| 264 </p> | |
| 265 <dl> | |
| 266 <dt>Return:</dt> | |
| 267 <dd> | |
| 268 flag indicating normal process termination (boolean) | |
| 269 </dd> | |
| 270 </dl> | |
| 271 <a NAME="GitDialog.normalExitWithoutErrors" ID="GitDialog.normalExitWithoutErrors"></a> | |
| 272 <h4>GitDialog.normalExitWithoutErrors</h4> | |
| 273 <b>normalExitWithoutErrors</b>(<i></i>) | |
| 274 | |
| 275 <p> | |
| 276 Public method to check for a normal process termination without | |
| 277 error messages. | |
| 278 </p> | |
| 279 <dl> | |
| 280 <dt>Return:</dt> | |
| 281 <dd> | |
| 282 flag indicating normal process termination (boolean) | |
| 283 </dd> | |
| 284 </dl> | |
| 285 <a NAME="GitDialog.on_buttonBox_clicked" ID="GitDialog.on_buttonBox_clicked"></a> | |
| 286 <h4>GitDialog.on_buttonBox_clicked</h4> | |
| 287 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 288 | |
| 289 <p> | |
| 290 Private slot called by a button of the button box clicked. | |
| 291 </p> | |
| 292 <dl> | |
| 293 | |
| 294 <dt><i>button</i></dt> | |
| 295 <dd> | |
| 296 button that was clicked (QAbstractButton) | |
| 297 </dd> | |
| 298 </dl> | |
| 299 <a NAME="GitDialog.on_input_returnPressed" ID="GitDialog.on_input_returnPressed"></a> | |
| 300 <h4>GitDialog.on_input_returnPressed</h4> | |
| 301 <b>on_input_returnPressed</b>(<i></i>) | |
| 302 | |
| 303 <p> | |
| 304 Private slot to handle the press of the return key in the input field. | |
| 305 </p> | |
| 306 <a NAME="GitDialog.on_passwordCheckBox_toggled" ID="GitDialog.on_passwordCheckBox_toggled"></a> | |
| 307 <h4>GitDialog.on_passwordCheckBox_toggled</h4> | |
| 308 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) | |
| 309 | |
| 310 <p> | |
| 311 Private slot to handle the password checkbox toggled. | |
| 312 </p> | |
| 313 <dl> | |
| 314 | |
| 315 <dt><i>isOn</i></dt> | |
| 316 <dd> | |
| 317 flag indicating the status of the check box (boolean) | |
| 318 </dd> | |
| 319 </dl> | |
| 320 <a NAME="GitDialog.on_sendButton_clicked" ID="GitDialog.on_sendButton_clicked"></a> | |
| 321 <h4>GitDialog.on_sendButton_clicked</h4> | |
| 322 <b>on_sendButton_clicked</b>(<i></i>) | |
| 323 | |
| 324 <p> | |
| 325 Private slot to send the input to the git process. | |
| 326 </p> | |
| 327 <a NAME="GitDialog.startProcess" ID="GitDialog.startProcess"></a> | |
| 328 <h4>GitDialog.startProcess</h4> | |
| 329 <b>startProcess</b>(<i>args, workingDir=None, showArgs=True, environment=None</i>) | |
| 330 | |
| 331 <p> | |
| 332 Public slot used to start the process. | |
| 333 </p> | |
| 334 <dl> | |
| 335 | |
| 336 <dt><i>args</i></dt> | |
| 337 <dd> | |
| 338 list of arguments for the process (list of strings) | |
| 339 </dd> | |
| 340 <dt><i>workingDir</i></dt> | |
| 341 <dd> | |
| 342 working directory for the process (string) | |
| 343 </dd> | |
| 344 <dt><i>showArgs</i></dt> | |
| 345 <dd> | |
| 346 flag indicating to show the arguments (boolean) | |
| 347 </dd> | |
| 348 <dt><i>environment</i></dt> | |
| 349 <dd> | |
| 350 dictionary of environment settings to add | |
| 351 or change for the git process (dict of string and string) | |
| 352 </dd> | |
| 353 </dl> | |
| 354 <dl> | |
| 355 <dt>Return:</dt> | |
| 356 <dd> | |
| 357 flag indicating a successful start of the process (boolean) | |
| 358 </dd> | |
| 359 </dl> | |
| 360 <div align="right"><a href="#top">Up</a></div> | |
| 361 <hr /> | |
| 362 </body></html> |
