Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffDialog.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.GitDiffDialog</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.GitDiffDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to show the output of the git 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="#GitDiffDialog">GitDiffDialog</a></td> | |
| 26 <td>Class implementing a dialog to show the output of the git 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="GitDiffDialog" ID="GitDiffDialog"></a> | |
| 37 <h2>GitDiffDialog</h2> | |
| 38 | |
| 39 <p> | |
| 40 Class implementing a dialog to show the output of the git diff command | |
| 41 process. | |
| 42 </p> | |
| 43 <h3>Derived from</h3> | |
| 44 QWidget, Ui_GitDiffDialog | |
| 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="#GitDiffDialog.__init__">GitDiffDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr> | |
| 63 <tr> | |
| 64 <td><a href="#GitDiffDialog.__generatorFinished">__generatorFinished</a></td> | |
| 65 <td>Private slot connected to the finished signal.</td> | |
| 66 </tr> | |
| 67 <tr> | |
| 68 <td><a href="#GitDiffDialog.__mergeFileSeparators">__mergeFileSeparators</a></td> | |
| 69 <td>Private method to merge the file separator entries.</td> | |
| 70 </tr> | |
| 71 <tr> | |
| 72 <td><a href="#GitDiffDialog.closeEvent">closeEvent</a></td> | |
| 73 <td>Protected slot implementing a close event handler.</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#GitDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 77 <td>Private slot called by a button of the button box clicked.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#GitDiffDialog.on_filesCombo_activated">on_filesCombo_activated</a></td> | |
| 81 <td>Private slot to handle the selection of a file.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#GitDiffDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> | |
| 85 <td>Private slot to refresh the display.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#GitDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> | |
| 89 <td>Private slot to handle the Save button press.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#GitDiffDialog.start">start</a></td> | |
| 93 <td>Public slot to start the git diff command.</td> | |
| 94 </tr> | |
| 95 </table> | |
| 96 <h3>Static Methods</h3> | |
| 97 | |
| 98 <table> | |
| 99 <tr><td>None</td></tr> | |
| 100 </table> | |
| 101 | |
| 102 <a NAME="GitDiffDialog.__init__" ID="GitDiffDialog.__init__"></a> | |
| 103 <h4>GitDiffDialog (Constructor)</h4> | |
| 104 <b>GitDiffDialog</b>(<i>vcs, parent=None</i>) | |
| 105 | |
| 106 <p> | |
| 107 Constructor | |
| 108 </p> | |
| 109 <dl> | |
| 110 | |
| 111 <dt><i>vcs</i></dt> | |
| 112 <dd> | |
| 113 reference to the vcs object | |
| 114 </dd> | |
| 115 <dt><i>parent</i></dt> | |
| 116 <dd> | |
| 117 parent widget (QWidget) | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <a NAME="GitDiffDialog.__generatorFinished" ID="GitDiffDialog.__generatorFinished"></a> | |
| 121 <h4>GitDiffDialog.__generatorFinished</h4> | |
| 122 <b>__generatorFinished</b>(<i></i>) | |
| 123 | |
| 124 <p> | |
| 125 Private slot connected to the finished signal. | |
| 126 </p> | |
| 127 <a NAME="GitDiffDialog.__mergeFileSeparators" ID="GitDiffDialog.__mergeFileSeparators"></a> | |
| 128 <h4>GitDiffDialog.__mergeFileSeparators</h4> | |
| 129 <b>__mergeFileSeparators</b>(<i>fileSeparators</i>) | |
| 130 | |
| 131 <p> | |
| 132 Private method to merge the file separator entries. | |
| 133 </p> | |
| 134 <dl> | |
| 135 | |
| 136 <dt><i>fileSeparators</i></dt> | |
| 137 <dd> | |
| 138 list of file separator entries to be merged | |
| 139 </dd> | |
| 140 </dl> | |
| 141 <dl> | |
| 142 <dt>Return:</dt> | |
| 143 <dd> | |
| 144 merged list of file separator entries | |
| 145 </dd> | |
| 146 </dl> | |
| 147 <a NAME="GitDiffDialog.closeEvent" ID="GitDiffDialog.closeEvent"></a> | |
| 148 <h4>GitDiffDialog.closeEvent</h4> | |
| 149 <b>closeEvent</b>(<i>e</i>) | |
| 150 | |
| 151 <p> | |
| 152 Protected slot implementing a close event handler. | |
| 153 </p> | |
| 154 <dl> | |
| 155 | |
| 156 <dt><i>e</i></dt> | |
| 157 <dd> | |
| 158 close event (QCloseEvent) | |
| 159 </dd> | |
| 160 </dl> | |
| 161 <a NAME="GitDiffDialog.on_buttonBox_clicked" ID="GitDiffDialog.on_buttonBox_clicked"></a> | |
| 162 <h4>GitDiffDialog.on_buttonBox_clicked</h4> | |
| 163 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 164 | |
| 165 <p> | |
| 166 Private slot called by a button of the button box clicked. | |
| 167 </p> | |
| 168 <dl> | |
| 169 | |
| 170 <dt><i>button</i></dt> | |
| 171 <dd> | |
| 172 button that was clicked (QAbstractButton) | |
| 173 </dd> | |
| 174 </dl> | |
| 175 <a NAME="GitDiffDialog.on_filesCombo_activated" ID="GitDiffDialog.on_filesCombo_activated"></a> | |
| 176 <h4>GitDiffDialog.on_filesCombo_activated</h4> | |
| 177 <b>on_filesCombo_activated</b>(<i>index</i>) | |
| 178 | |
| 179 <p> | |
| 180 Private slot to handle the selection of a file. | |
| 181 </p> | |
| 182 <dl> | |
| 183 | |
| 184 <dt><i>index</i></dt> | |
| 185 <dd> | |
| 186 activated row (integer) | |
| 187 </dd> | |
| 188 </dl> | |
| 189 <a NAME="GitDiffDialog.on_refreshButton_clicked" ID="GitDiffDialog.on_refreshButton_clicked"></a> | |
| 190 <h4>GitDiffDialog.on_refreshButton_clicked</h4> | |
| 191 <b>on_refreshButton_clicked</b>(<i></i>) | |
| 192 | |
| 193 <p> | |
| 194 Private slot to refresh the display. | |
| 195 </p> | |
| 196 <a NAME="GitDiffDialog.on_saveButton_clicked" ID="GitDiffDialog.on_saveButton_clicked"></a> | |
| 197 <h4>GitDiffDialog.on_saveButton_clicked</h4> | |
| 198 <b>on_saveButton_clicked</b>(<i></i>) | |
| 199 | |
| 200 <p> | |
| 201 Private slot to handle the Save button press. | |
| 202 </p> | |
| 203 <p> | |
| 204 It saves the diff shown in the dialog to a file in the local | |
| 205 filesystem. | |
| 206 </p> | |
| 207 <a NAME="GitDiffDialog.start" ID="GitDiffDialog.start"></a> | |
| 208 <h4>GitDiffDialog.start</h4> | |
| 209 <b>start</b>(<i>fn, versions=None, diffMode="work2repo", stashName="", refreshable=False</i>) | |
| 210 | |
| 211 <p> | |
| 212 Public slot to start the git diff command. | |
| 213 </p> | |
| 214 <dl> | |
| 215 | |
| 216 <dt><i>fn</i></dt> | |
| 217 <dd> | |
| 218 filename to be diffed (string) | |
| 219 </dd> | |
| 220 <dt><i>versions</i></dt> | |
| 221 <dd> | |
| 222 list of versions to be diffed (list of up to 2 strings | |
| 223 or None) | |
| 224 </dd> | |
| 225 <dt><i>diffMode</i></dt> | |
| 226 <dd> | |
| 227 indication for the type of diff to be performed ( | |
| 228 'work2repo' compares the working tree with the HEAD commit, | |
| 229 'work2stage' compares the working tree with the staging area, | |
| 230 'stage2repo' compares the staging area with the HEAD commit, | |
| 231 'work2stage2repo' compares the working tree with the staging area | |
| 232 and the staging area with the HEAD commit, | |
| 233 'stash' shows the diff for a stash) | |
| 234 </dd> | |
| 235 <dt><i>stashName</i></dt> | |
| 236 <dd> | |
| 237 name of the stash to show a diff for (string) | |
| 238 </dd> | |
| 239 <dt><i>refreshable</i></dt> | |
| 240 <dd> | |
| 241 flag indicating a refreshable diff (boolean) | |
| 242 </dd> | |
| 243 </dl> | |
| 244 <dl> | |
| 245 | |
| 246 <dt>Raises <b>ValueError</b>:</dt> | |
| 247 <dd> | |
| 248 raised to indicate a bad value for the 'diffMode' | |
| 249 parameter. | |
| 250 </dd> | |
| 251 </dl> | |
| 252 <div align="right"><a href="#top">Up</a></div> | |
| 253 <hr /> | |
| 254 </body></html> |
