106 <p> |
106 <p> |
107 Constructor |
107 Constructor |
108 </p> |
108 </p> |
109 <dl> |
109 <dl> |
110 |
110 |
111 <dt><i>vcs</i></dt> |
111 <dt><i>vcs</i> (Git)</dt> |
112 <dd> |
112 <dd> |
113 reference to the vcs object |
113 reference to the vcs object |
114 </dd> |
114 </dd> |
115 <dt><i>parent</i></dt> |
115 <dt><i>parent</i> (QWidget)</dt> |
116 <dd> |
116 <dd> |
117 parent widget (QWidget) |
117 parent widget |
118 </dd> |
118 </dd> |
119 </dl> |
119 </dl> |
120 <a NAME="GitDiffDialog.__generatorFinished" ID="GitDiffDialog.__generatorFinished"></a> |
120 <a NAME="GitDiffDialog.__generatorFinished" ID="GitDiffDialog.__generatorFinished"></a> |
121 <h4>GitDiffDialog.__generatorFinished</h4> |
121 <h4>GitDiffDialog.__generatorFinished</h4> |
122 <b>__generatorFinished</b>(<i></i>) |
122 <b>__generatorFinished</b>(<i></i>) |
131 <p> |
131 <p> |
132 Private method to merge the file separator entries. |
132 Private method to merge the file separator entries. |
133 </p> |
133 </p> |
134 <dl> |
134 <dl> |
135 |
135 |
136 <dt><i>fileSeparators</i></dt> |
136 <dt><i>fileSeparators</i> (list of str)</dt> |
137 <dd> |
137 <dd> |
138 list of file separator entries to be merged |
138 list of file separator entries to be merged |
139 </dd> |
139 </dd> |
140 </dl> |
140 </dl> |
141 <dl> |
141 <dl> |
142 <dt>Return:</dt> |
142 <dt>Return:</dt> |
143 <dd> |
143 <dd> |
144 merged list of file separator entries |
144 merged list of file separator entries |
|
145 </dd> |
|
146 </dl> |
|
147 <dl> |
|
148 <dt>Return Type:</dt> |
|
149 <dd> |
|
150 list of str |
145 </dd> |
151 </dd> |
146 </dl> |
152 </dl> |
147 <a NAME="GitDiffDialog.closeEvent" ID="GitDiffDialog.closeEvent"></a> |
153 <a NAME="GitDiffDialog.closeEvent" ID="GitDiffDialog.closeEvent"></a> |
148 <h4>GitDiffDialog.closeEvent</h4> |
154 <h4>GitDiffDialog.closeEvent</h4> |
149 <b>closeEvent</b>(<i>e</i>) |
155 <b>closeEvent</b>(<i>e</i>) |
151 <p> |
157 <p> |
152 Protected slot implementing a close event handler. |
158 Protected slot implementing a close event handler. |
153 </p> |
159 </p> |
154 <dl> |
160 <dl> |
155 |
161 |
156 <dt><i>e</i></dt> |
162 <dt><i>e</i> (QCloseEvent)</dt> |
157 <dd> |
163 <dd> |
158 close event (QCloseEvent) |
164 close event |
159 </dd> |
165 </dd> |
160 </dl> |
166 </dl> |
161 <a NAME="GitDiffDialog.on_buttonBox_clicked" ID="GitDiffDialog.on_buttonBox_clicked"></a> |
167 <a NAME="GitDiffDialog.on_buttonBox_clicked" ID="GitDiffDialog.on_buttonBox_clicked"></a> |
162 <h4>GitDiffDialog.on_buttonBox_clicked</h4> |
168 <h4>GitDiffDialog.on_buttonBox_clicked</h4> |
163 <b>on_buttonBox_clicked</b>(<i>button</i>) |
169 <b>on_buttonBox_clicked</b>(<i>button</i>) |
165 <p> |
171 <p> |
166 Private slot called by a button of the button box clicked. |
172 Private slot called by a button of the button box clicked. |
167 </p> |
173 </p> |
168 <dl> |
174 <dl> |
169 |
175 |
170 <dt><i>button</i></dt> |
176 <dt><i>button</i> (QAbstractButton)</dt> |
171 <dd> |
177 <dd> |
172 button that was clicked (QAbstractButton) |
178 button that was clicked |
173 </dd> |
179 </dd> |
174 </dl> |
180 </dl> |
175 <a NAME="GitDiffDialog.on_filesCombo_activated" ID="GitDiffDialog.on_filesCombo_activated"></a> |
181 <a NAME="GitDiffDialog.on_filesCombo_activated" ID="GitDiffDialog.on_filesCombo_activated"></a> |
176 <h4>GitDiffDialog.on_filesCombo_activated</h4> |
182 <h4>GitDiffDialog.on_filesCombo_activated</h4> |
177 <b>on_filesCombo_activated</b>(<i>index</i>) |
183 <b>on_filesCombo_activated</b>(<i>index</i>) |
179 <p> |
185 <p> |
180 Private slot to handle the selection of a file. |
186 Private slot to handle the selection of a file. |
181 </p> |
187 </p> |
182 <dl> |
188 <dl> |
183 |
189 |
184 <dt><i>index</i></dt> |
190 <dt><i>index</i> (int)</dt> |
185 <dd> |
191 <dd> |
186 activated row (integer) |
192 activated row |
187 </dd> |
193 </dd> |
188 </dl> |
194 </dl> |
189 <a NAME="GitDiffDialog.on_refreshButton_clicked" ID="GitDiffDialog.on_refreshButton_clicked"></a> |
195 <a NAME="GitDiffDialog.on_refreshButton_clicked" ID="GitDiffDialog.on_refreshButton_clicked"></a> |
190 <h4>GitDiffDialog.on_refreshButton_clicked</h4> |
196 <h4>GitDiffDialog.on_refreshButton_clicked</h4> |
191 <b>on_refreshButton_clicked</b>(<i></i>) |
197 <b>on_refreshButton_clicked</b>(<i></i>) |
211 <p> |
217 <p> |
212 Public slot to start the git diff command. |
218 Public slot to start the git diff command. |
213 </p> |
219 </p> |
214 <dl> |
220 <dl> |
215 |
221 |
216 <dt><i>fn</i></dt> |
222 <dt><i>fn</i> (str)</dt> |
217 <dd> |
223 <dd> |
218 filename to be diffed (string) |
224 filename to be diffed |
219 </dd> |
225 </dd> |
220 <dt><i>versions</i></dt> |
226 <dt><i>versions</i> (list of up to 2 str or None)</dt> |
221 <dd> |
227 <dd> |
222 list of versions to be diffed (list of up to 2 strings |
228 list of versions to be diffed |
223 or None) |
229 </dd> |
224 </dd> |
230 <dt><i>diffMode</i> (str)</dt> |
225 <dt><i>diffMode</i></dt> |
|
226 <dd> |
231 <dd> |
227 indication for the type of diff to be performed ( |
232 indication for the type of diff to be performed ( |
228 'work2repo' compares the working tree with the HEAD commit, |
233 'work2repo' compares the working tree with the HEAD commit, |
229 'work2stage' compares the working tree with the staging area, |
234 'work2stage' compares the working tree with the staging area, |
230 'stage2repo' compares the staging area with the HEAD commit, |
235 'stage2repo' compares the staging area with the HEAD commit, |
231 'work2stage2repo' compares the working tree with the staging area |
236 'work2stage2repo' compares the working tree with the staging area |
232 and the staging area with the HEAD commit, |
237 and the staging area with the HEAD commit, |
233 'stash' shows the diff for a stash) |
238 'stash' shows the diff for a stash) |
234 </dd> |
239 </dd> |
235 <dt><i>stashName</i></dt> |
240 <dt><i>stashName</i> (str)</dt> |
236 <dd> |
241 <dd> |
237 name of the stash to show a diff for (string) |
242 name of the stash to show a diff for |
238 </dd> |
243 </dd> |
239 <dt><i>refreshable</i></dt> |
244 <dt><i>refreshable</i> (bool)</dt> |
240 <dd> |
245 <dd> |
241 flag indicating a refreshable diff (boolean) |
246 flag indicating a refreshable diff |
242 </dd> |
247 </dd> |
243 </dl> |
248 </dl> |
244 <dl> |
249 <dl> |
245 |
250 |
246 <dt>Raises <b>ValueError</b>:</dt> |
251 <dt>Raises <b>ValueError</b>:</dt> |