Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitDiffDialog.html
Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitDiffDialog.html
- changeset 6020
- baf6da1ae288
equal
deleted
inserted
replaced
| 6019:58ecdaf0b789 | 6020:baf6da1ae288 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitDiffDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitDiffDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to show the output of the git diff command | |
| 25 process. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#GitDiffDialog">GitDiffDialog</a></td> | |
| 35 <td>Class implementing a dialog to show the output of the git diff command process.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="GitDiffDialog" ID="GitDiffDialog"></a> | |
| 44 <h2>GitDiffDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog to show the output of the git diff command | |
| 47 process. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 QWidget, Ui_GitDiffDialog | |
| 51 <h3>Class Attributes</h3> | |
| 52 <table> | |
| 53 <tr><td>None</td></tr> | |
| 54 </table> | |
| 55 <h3>Class Methods</h3> | |
| 56 <table> | |
| 57 <tr><td>None</td></tr> | |
| 58 </table> | |
| 59 <h3>Methods</h3> | |
| 60 <table> | |
| 61 <tr> | |
| 62 <td><a href="#GitDiffDialog.__init__">GitDiffDialog</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr><tr> | |
| 65 <td><a href="#GitDiffDialog.__generatorFinished">__generatorFinished</a></td> | |
| 66 <td>Private slot connected to the finished signal.</td> | |
| 67 </tr><tr> | |
| 68 <td><a href="#GitDiffDialog.__mergeFileSeparators">__mergeFileSeparators</a></td> | |
| 69 <td>Private method to merge the file separator entries.</td> | |
| 70 </tr><tr> | |
| 71 <td><a href="#GitDiffDialog.closeEvent">closeEvent</a></td> | |
| 72 <td>Protected slot implementing a close event handler.</td> | |
| 73 </tr><tr> | |
| 74 <td><a href="#GitDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 75 <td>Private slot called by a button of the button box clicked.</td> | |
| 76 </tr><tr> | |
| 77 <td><a href="#GitDiffDialog.on_filesCombo_activated">on_filesCombo_activated</a></td> | |
| 78 <td>Private slot to handle the selection of a file.</td> | |
| 79 </tr><tr> | |
| 80 <td><a href="#GitDiffDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> | |
| 81 <td>Private slot to refresh the display.</td> | |
| 82 </tr><tr> | |
| 83 <td><a href="#GitDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> | |
| 84 <td>Private slot to handle the Save button press.</td> | |
| 85 </tr><tr> | |
| 86 <td><a href="#GitDiffDialog.start">start</a></td> | |
| 87 <td>Public slot to start the git diff command.</td> | |
| 88 </tr> | |
| 89 </table> | |
| 90 <h3>Static Methods</h3> | |
| 91 <table> | |
| 92 <tr><td>None</td></tr> | |
| 93 </table> | |
| 94 <a NAME="GitDiffDialog.__init__" ID="GitDiffDialog.__init__"></a> | |
| 95 <h4>GitDiffDialog (Constructor)</h4> | |
| 96 <b>GitDiffDialog</b>(<i>vcs, parent=None</i>) | |
| 97 <p> | |
| 98 Constructor | |
| 99 </p><dl> | |
| 100 <dt><i>vcs</i></dt> | |
| 101 <dd> | |
| 102 reference to the vcs object | |
| 103 </dd><dt><i>parent</i></dt> | |
| 104 <dd> | |
| 105 parent widget (QWidget) | |
| 106 </dd> | |
| 107 </dl><a NAME="GitDiffDialog.__generatorFinished" ID="GitDiffDialog.__generatorFinished"></a> | |
| 108 <h4>GitDiffDialog.__generatorFinished</h4> | |
| 109 <b>__generatorFinished</b>(<i></i>) | |
| 110 <p> | |
| 111 Private slot connected to the finished signal. | |
| 112 </p><a NAME="GitDiffDialog.__mergeFileSeparators" ID="GitDiffDialog.__mergeFileSeparators"></a> | |
| 113 <h4>GitDiffDialog.__mergeFileSeparators</h4> | |
| 114 <b>__mergeFileSeparators</b>(<i>fileSeparators</i>) | |
| 115 <p> | |
| 116 Private method to merge the file separator entries. | |
| 117 </p><dl> | |
| 118 <dt><i>fileSeparators</i></dt> | |
| 119 <dd> | |
| 120 list of file separator entries to be merged | |
| 121 </dd> | |
| 122 </dl><dl> | |
| 123 <dt>Returns:</dt> | |
| 124 <dd> | |
| 125 merged list of file separator entries | |
| 126 </dd> | |
| 127 </dl><a NAME="GitDiffDialog.closeEvent" ID="GitDiffDialog.closeEvent"></a> | |
| 128 <h4>GitDiffDialog.closeEvent</h4> | |
| 129 <b>closeEvent</b>(<i>e</i>) | |
| 130 <p> | |
| 131 Protected slot implementing a close event handler. | |
| 132 </p><dl> | |
| 133 <dt><i>e</i></dt> | |
| 134 <dd> | |
| 135 close event (QCloseEvent) | |
| 136 </dd> | |
| 137 </dl><a NAME="GitDiffDialog.on_buttonBox_clicked" ID="GitDiffDialog.on_buttonBox_clicked"></a> | |
| 138 <h4>GitDiffDialog.on_buttonBox_clicked</h4> | |
| 139 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 140 <p> | |
| 141 Private slot called by a button of the button box clicked. | |
| 142 </p><dl> | |
| 143 <dt><i>button</i></dt> | |
| 144 <dd> | |
| 145 button that was clicked (QAbstractButton) | |
| 146 </dd> | |
| 147 </dl><a NAME="GitDiffDialog.on_filesCombo_activated" ID="GitDiffDialog.on_filesCombo_activated"></a> | |
| 148 <h4>GitDiffDialog.on_filesCombo_activated</h4> | |
| 149 <b>on_filesCombo_activated</b>(<i>index</i>) | |
| 150 <p> | |
| 151 Private slot to handle the selection of a file. | |
| 152 </p><dl> | |
| 153 <dt><i>index</i></dt> | |
| 154 <dd> | |
| 155 activated row (integer) | |
| 156 </dd> | |
| 157 </dl><a NAME="GitDiffDialog.on_refreshButton_clicked" ID="GitDiffDialog.on_refreshButton_clicked"></a> | |
| 158 <h4>GitDiffDialog.on_refreshButton_clicked</h4> | |
| 159 <b>on_refreshButton_clicked</b>(<i></i>) | |
| 160 <p> | |
| 161 Private slot to refresh the display. | |
| 162 </p><a NAME="GitDiffDialog.on_saveButton_clicked" ID="GitDiffDialog.on_saveButton_clicked"></a> | |
| 163 <h4>GitDiffDialog.on_saveButton_clicked</h4> | |
| 164 <b>on_saveButton_clicked</b>(<i></i>) | |
| 165 <p> | |
| 166 Private slot to handle the Save button press. | |
| 167 </p><p> | |
| 168 It saves the diff shown in the dialog to a file in the local | |
| 169 filesystem. | |
| 170 </p><a NAME="GitDiffDialog.start" ID="GitDiffDialog.start"></a> | |
| 171 <h4>GitDiffDialog.start</h4> | |
| 172 <b>start</b>(<i>fn, versions=None, diffMode="work2repo", stashName="", refreshable=False</i>) | |
| 173 <p> | |
| 174 Public slot to start the git diff command. | |
| 175 </p><dl> | |
| 176 <dt><i>fn</i></dt> | |
| 177 <dd> | |
| 178 filename to be diffed (string) | |
| 179 </dd><dt><i>versions</i></dt> | |
| 180 <dd> | |
| 181 list of versions to be diffed (list of up to 2 strings | |
| 182 or None) | |
| 183 </dd><dt><i>diffMode</i></dt> | |
| 184 <dd> | |
| 185 indication for the type of diff to be performed ( | |
| 186 'work2repo' compares the working tree with the HEAD commit, | |
| 187 'work2stage' compares the working tree with the staging area, | |
| 188 'stage2repo' compares the staging area with the HEAD commit, | |
| 189 'work2stage2repo' compares the working tree with the staging area | |
| 190 and the staging area with the HEAD commit, | |
| 191 'stash' shows the diff for a stash) | |
| 192 </dd><dt><i>stashName</i></dt> | |
| 193 <dd> | |
| 194 name of the stash to show a diff for (string) | |
| 195 </dd><dt><i>refreshable</i></dt> | |
| 196 <dd> | |
| 197 flag indicating a refreshable diff (boolean) | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <div align="right"><a href="#top">Up</a></div> | |
| 201 <hr /> | |
| 202 </body></html> |
