Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitDiffDialog.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitDiffDialog.html

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

Mercurial Repository: eric

eric ide

mercurial