Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDiffDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDiffDialog.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.vcsSubversion.SvnDiffDialog</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.vcsSubversion.SvnDiffDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to show the output of the svn diff command | |
| 13 process. | |
| 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="#SvnDiffDialog">SvnDiffDialog</a></td> | |
| 26 <td>Class implementing a dialog to show the output of the svn diff command process.</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="SvnDiffDialog" ID="SvnDiffDialog"></a> | |
| 37 <h2>SvnDiffDialog</h2> | |
| 38 | |
| 39 <p> | |
| 40 Class implementing a dialog to show the output of the svn diff command | |
| 41 process. | |
| 42 </p> | |
| 43 <h3>Derived from</h3> | |
| 44 QWidget, Ui_SvnDiffDialog | |
| 45 <h3>Class Attributes</h3> | |
| 46 | |
| 47 <table> | |
| 48 <tr><td>None</td></tr> | |
| 49 </table> | |
| 50 <h3>Class Methods</h3> | |
| 51 | |
| 52 <table> | |
| 53 <tr><td>None</td></tr> | |
| 54 </table> | |
| 55 <h3>Methods</h3> | |
| 56 | |
| 57 <table> | |
| 58 | |
| 59 <tr> | |
| 60 <td><a href="#SvnDiffDialog.__init__">SvnDiffDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr> | |
| 63 <tr> | |
| 64 <td><a href="#SvnDiffDialog.__appendText">__appendText</a></td> | |
| 65 <td>Private method to append text to the end of the contents pane.</td> | |
| 66 </tr> | |
| 67 <tr> | |
| 68 <td><a href="#SvnDiffDialog.__extractFileName">__extractFileName</a></td> | |
| 69 <td>Private method to extract the file name out of a file separator line.</td> | |
| 70 </tr> | |
| 71 <tr> | |
| 72 <td><a href="#SvnDiffDialog.__getVersionArg">__getVersionArg</a></td> | |
| 73 <td>Private method to get a svn revision argument for the given revision.</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#SvnDiffDialog.__procFinished">__procFinished</a></td> | |
| 77 <td>Private slot connected to the finished signal.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#SvnDiffDialog.__processFileLine">__processFileLine</a></td> | |
| 81 <td>Private slot to process a line giving the old/new file.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#SvnDiffDialog.__readStderr">__readStderr</a></td> | |
| 85 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#SvnDiffDialog.__readStdout">__readStdout</a></td> | |
| 89 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#SvnDiffDialog.closeEvent">closeEvent</a></td> | |
| 93 <td>Protected slot implementing a close event handler.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#SvnDiffDialog.keyPressEvent">keyPressEvent</a></td> | |
| 97 <td>Protected slot to handle a key press event.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#SvnDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 101 <td>Private slot called by a button of the button box clicked.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#SvnDiffDialog.on_filesCombo_activated">on_filesCombo_activated</a></td> | |
| 105 <td>Private slot to handle the selection of a file.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#SvnDiffDialog.on_input_returnPressed">on_input_returnPressed</a></td> | |
| 109 <td>Private slot to handle the press of the return key in the input field.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#SvnDiffDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> | |
| 113 <td>Private slot to handle the password checkbox toggled.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#SvnDiffDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> | |
| 117 <td>Private slot to refresh the display.</td> | |
| 118 </tr> | |
| 119 <tr> | |
| 120 <td><a href="#SvnDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> | |
| 121 <td>Private slot to handle the Save button press.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 124 <td><a href="#SvnDiffDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 125 <td>Private slot to send the input to the subversion process.</td> | |
| 126 </tr> | |
| 127 <tr> | |
| 128 <td><a href="#SvnDiffDialog.start">start</a></td> | |
| 129 <td>Public slot to start the svn diff command.</td> | |
| 130 </tr> | |
| 131 </table> | |
| 132 <h3>Static Methods</h3> | |
| 133 | |
| 134 <table> | |
| 135 <tr><td>None</td></tr> | |
| 136 </table> | |
| 137 | |
| 138 <a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a> | |
| 139 <h4>SvnDiffDialog (Constructor)</h4> | |
| 140 <b>SvnDiffDialog</b>(<i>vcs, parent=None</i>) | |
| 141 | |
| 142 <p> | |
| 143 Constructor | |
| 144 </p> | |
| 145 <dl> | |
| 146 | |
| 147 <dt><i>vcs</i></dt> | |
| 148 <dd> | |
| 149 reference to the vcs object | |
| 150 </dd> | |
| 151 <dt><i>parent</i></dt> | |
| 152 <dd> | |
| 153 parent widget (QWidget) | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a> | |
| 157 <h4>SvnDiffDialog.__appendText</h4> | |
| 158 <b>__appendText</b>(<i>txt</i>) | |
| 159 | |
| 160 <p> | |
| 161 Private method to append text to the end of the contents pane. | |
| 162 </p> | |
| 163 <dl> | |
| 164 | |
| 165 <dt><i>txt</i></dt> | |
| 166 <dd> | |
| 167 text to insert (string) | |
| 168 </dd> | |
| 169 </dl> | |
| 170 <a NAME="SvnDiffDialog.__extractFileName" ID="SvnDiffDialog.__extractFileName"></a> | |
| 171 <h4>SvnDiffDialog.__extractFileName</h4> | |
| 172 <b>__extractFileName</b>(<i>line</i>) | |
| 173 | |
| 174 <p> | |
| 175 Private method to extract the file name out of a file separator line. | |
| 176 </p> | |
| 177 <dl> | |
| 178 | |
| 179 <dt><i>line</i></dt> | |
| 180 <dd> | |
| 181 line to be processed (string) | |
| 182 </dd> | |
| 183 </dl> | |
| 184 <dl> | |
| 185 <dt>Return:</dt> | |
| 186 <dd> | |
| 187 extracted file name (string) | |
| 188 </dd> | |
| 189 </dl> | |
| 190 <a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a> | |
| 191 <h4>SvnDiffDialog.__getVersionArg</h4> | |
| 192 <b>__getVersionArg</b>(<i>version</i>) | |
| 193 | |
| 194 <p> | |
| 195 Private method to get a svn revision argument for the given revision. | |
| 196 </p> | |
| 197 <dl> | |
| 198 | |
| 199 <dt><i>version</i></dt> | |
| 200 <dd> | |
| 201 revision (integer or string) | |
| 202 </dd> | |
| 203 </dl> | |
| 204 <dl> | |
| 205 <dt>Return:</dt> | |
| 206 <dd> | |
| 207 version argument (string) | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <a NAME="SvnDiffDialog.__procFinished" ID="SvnDiffDialog.__procFinished"></a> | |
| 211 <h4>SvnDiffDialog.__procFinished</h4> | |
| 212 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 213 | |
| 214 <p> | |
| 215 Private slot connected to the finished signal. | |
| 216 </p> | |
| 217 <dl> | |
| 218 | |
| 219 <dt><i>exitCode</i></dt> | |
| 220 <dd> | |
| 221 exit code of the process (integer) | |
| 222 </dd> | |
| 223 <dt><i>exitStatus</i></dt> | |
| 224 <dd> | |
| 225 exit status of the process (QProcess.ExitStatus) | |
| 226 </dd> | |
| 227 </dl> | |
| 228 <a NAME="SvnDiffDialog.__processFileLine" ID="SvnDiffDialog.__processFileLine"></a> | |
| 229 <h4>SvnDiffDialog.__processFileLine</h4> | |
| 230 <b>__processFileLine</b>(<i>line</i>) | |
| 231 | |
| 232 <p> | |
| 233 Private slot to process a line giving the old/new file. | |
| 234 </p> | |
| 235 <dl> | |
| 236 | |
| 237 <dt><i>line</i></dt> | |
| 238 <dd> | |
| 239 line to be processed (string) | |
| 240 </dd> | |
| 241 </dl> | |
| 242 <a NAME="SvnDiffDialog.__readStderr" ID="SvnDiffDialog.__readStderr"></a> | |
| 243 <h4>SvnDiffDialog.__readStderr</h4> | |
| 244 <b>__readStderr</b>(<i></i>) | |
| 245 | |
| 246 <p> | |
| 247 Private slot to handle the readyReadStandardError signal. | |
| 248 </p> | |
| 249 <p> | |
| 250 It reads the error output of the process and inserts it into the | |
| 251 error pane. | |
| 252 </p> | |
| 253 <a NAME="SvnDiffDialog.__readStdout" ID="SvnDiffDialog.__readStdout"></a> | |
| 254 <h4>SvnDiffDialog.__readStdout</h4> | |
| 255 <b>__readStdout</b>(<i></i>) | |
| 256 | |
| 257 <p> | |
| 258 Private slot to handle the readyReadStandardOutput signal. | |
| 259 </p> | |
| 260 <p> | |
| 261 It reads the output of the process, formats it and inserts it into | |
| 262 the contents pane. | |
| 263 </p> | |
| 264 <a NAME="SvnDiffDialog.closeEvent" ID="SvnDiffDialog.closeEvent"></a> | |
| 265 <h4>SvnDiffDialog.closeEvent</h4> | |
| 266 <b>closeEvent</b>(<i>e</i>) | |
| 267 | |
| 268 <p> | |
| 269 Protected slot implementing a close event handler. | |
| 270 </p> | |
| 271 <dl> | |
| 272 | |
| 273 <dt><i>e</i></dt> | |
| 274 <dd> | |
| 275 close event (QCloseEvent) | |
| 276 </dd> | |
| 277 </dl> | |
| 278 <a NAME="SvnDiffDialog.keyPressEvent" ID="SvnDiffDialog.keyPressEvent"></a> | |
| 279 <h4>SvnDiffDialog.keyPressEvent</h4> | |
| 280 <b>keyPressEvent</b>(<i>evt</i>) | |
| 281 | |
| 282 <p> | |
| 283 Protected slot to handle a key press event. | |
| 284 </p> | |
| 285 <dl> | |
| 286 | |
| 287 <dt><i>evt</i></dt> | |
| 288 <dd> | |
| 289 the key press event (QKeyEvent) | |
| 290 </dd> | |
| 291 </dl> | |
| 292 <a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a> | |
| 293 <h4>SvnDiffDialog.on_buttonBox_clicked</h4> | |
| 294 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 295 | |
| 296 <p> | |
| 297 Private slot called by a button of the button box clicked. | |
| 298 </p> | |
| 299 <dl> | |
| 300 | |
| 301 <dt><i>button</i></dt> | |
| 302 <dd> | |
| 303 button that was clicked (QAbstractButton) | |
| 304 </dd> | |
| 305 </dl> | |
| 306 <a NAME="SvnDiffDialog.on_filesCombo_activated" ID="SvnDiffDialog.on_filesCombo_activated"></a> | |
| 307 <h4>SvnDiffDialog.on_filesCombo_activated</h4> | |
| 308 <b>on_filesCombo_activated</b>(<i>index</i>) | |
| 309 | |
| 310 <p> | |
| 311 Private slot to handle the selection of a file. | |
| 312 </p> | |
| 313 <dl> | |
| 314 | |
| 315 <dt><i>index</i></dt> | |
| 316 <dd> | |
| 317 activated row (integer) | |
| 318 </dd> | |
| 319 </dl> | |
| 320 <a NAME="SvnDiffDialog.on_input_returnPressed" ID="SvnDiffDialog.on_input_returnPressed"></a> | |
| 321 <h4>SvnDiffDialog.on_input_returnPressed</h4> | |
| 322 <b>on_input_returnPressed</b>(<i></i>) | |
| 323 | |
| 324 <p> | |
| 325 Private slot to handle the press of the return key in the input field. | |
| 326 </p> | |
| 327 <a NAME="SvnDiffDialog.on_passwordCheckBox_toggled" ID="SvnDiffDialog.on_passwordCheckBox_toggled"></a> | |
| 328 <h4>SvnDiffDialog.on_passwordCheckBox_toggled</h4> | |
| 329 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) | |
| 330 | |
| 331 <p> | |
| 332 Private slot to handle the password checkbox toggled. | |
| 333 </p> | |
| 334 <dl> | |
| 335 | |
| 336 <dt><i>isOn</i></dt> | |
| 337 <dd> | |
| 338 flag indicating the status of the check box (boolean) | |
| 339 </dd> | |
| 340 </dl> | |
| 341 <a NAME="SvnDiffDialog.on_refreshButton_clicked" ID="SvnDiffDialog.on_refreshButton_clicked"></a> | |
| 342 <h4>SvnDiffDialog.on_refreshButton_clicked</h4> | |
| 343 <b>on_refreshButton_clicked</b>(<i></i>) | |
| 344 | |
| 345 <p> | |
| 346 Private slot to refresh the display. | |
| 347 </p> | |
| 348 <a NAME="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a> | |
| 349 <h4>SvnDiffDialog.on_saveButton_clicked</h4> | |
| 350 <b>on_saveButton_clicked</b>(<i></i>) | |
| 351 | |
| 352 <p> | |
| 353 Private slot to handle the Save button press. | |
| 354 </p> | |
| 355 <p> | |
| 356 It saves the diff shown in the dialog to a file in the local | |
| 357 filesystem. | |
| 358 </p> | |
| 359 <a NAME="SvnDiffDialog.on_sendButton_clicked" ID="SvnDiffDialog.on_sendButton_clicked"></a> | |
| 360 <h4>SvnDiffDialog.on_sendButton_clicked</h4> | |
| 361 <b>on_sendButton_clicked</b>(<i></i>) | |
| 362 | |
| 363 <p> | |
| 364 Private slot to send the input to the subversion process. | |
| 365 </p> | |
| 366 <a NAME="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a> | |
| 367 <h4>SvnDiffDialog.start</h4> | |
| 368 <b>start</b>(<i>fn, versions=None, urls=None, summary=False, refreshable=False</i>) | |
| 369 | |
| 370 <p> | |
| 371 Public slot to start the svn diff command. | |
| 372 </p> | |
| 373 <dl> | |
| 374 | |
| 375 <dt><i>fn</i></dt> | |
| 376 <dd> | |
| 377 filename to be diffed (string) | |
| 378 </dd> | |
| 379 <dt><i>versions</i></dt> | |
| 380 <dd> | |
| 381 list of versions to be diffed (list of up to 2 strings | |
| 382 or None) | |
| 383 </dd> | |
| 384 <dt><i>urls</i></dt> | |
| 385 <dd> | |
| 386 list of repository URLs (list of 2 strings) | |
| 387 </dd> | |
| 388 <dt><i>summary</i></dt> | |
| 389 <dd> | |
| 390 flag indicating a summarizing diff | |
| 391 (only valid for URL diffs) (boolean) | |
| 392 </dd> | |
| 393 <dt><i>refreshable</i></dt> | |
| 394 <dd> | |
| 395 flag indicating a refreshable diff (boolean) | |
| 396 </dd> | |
| 397 </dl> | |
| 398 <div align="right"><a href="#top">Up</a></div> | |
| 399 <hr /> | |
| 400 </body></html> |
