Documentation/Source/eric4.Plugins.VcsPlugins.vcsSubversion.SvnLogBrowserDialog.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Plugins.VcsPlugins.vcsSubversion.SvnLogBrowserDialog</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Plugins.VcsPlugins.vcsSubversion.SvnLogBrowserDialog</h1>
24 <p>
25 Module implementing a dialog to browse the log history.
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="#SvnLogBrowserDialog">SvnLogBrowserDialog</a></td>
35 <td>Class implementing a dialog to browse the log history.</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="SvnLogBrowserDialog" ID="SvnLogBrowserDialog"></a>
44 <h2>SvnLogBrowserDialog</h2>
45 <p>
46 Class implementing a dialog to browse the log history.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_SvnLogBrowserDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#SvnLogBrowserDialog.__init__">SvnLogBrowserDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#SvnLogBrowserDialog.__diffRevisions">__diffRevisions</a></td>
61 <td>Private method to do a diff of two revisions.</td>
62 </tr><tr>
63 <td><a href="#SvnLogBrowserDialog.__filterLogs">__filterLogs</a></td>
64 <td>Private method to filter the log entries.</td>
65 </tr><tr>
66 <td><a href="#SvnLogBrowserDialog.__finish">__finish</a></td>
67 <td>Private slot called when the process finished or the user pressed the button.</td>
68 </tr><tr>
69 <td><a href="#SvnLogBrowserDialog.__generateFileItem">__generateFileItem</a></td>
70 <td>Private method to generate a changed files tree entry.</td>
71 </tr><tr>
72 <td><a href="#SvnLogBrowserDialog.__generateLogItem">__generateLogItem</a></td>
73 <td>Private method to generate a log tree entry.</td>
74 </tr><tr>
75 <td><a href="#SvnLogBrowserDialog.__getLogEntries">__getLogEntries</a></td>
76 <td>Private method to retrieve log entries from the repository.</td>
77 </tr><tr>
78 <td><a href="#SvnLogBrowserDialog.__procFinished">__procFinished</a></td>
79 <td>Private slot connected to the finished signal.</td>
80 </tr><tr>
81 <td><a href="#SvnLogBrowserDialog.__processBuffer">__processBuffer</a></td>
82 <td>Private method to process the buffered output of the svn log command.</td>
83 </tr><tr>
84 <td><a href="#SvnLogBrowserDialog.__readStderr">__readStderr</a></td>
85 <td>Private slot to handle the readyReadStandardError signal.</td>
86 </tr><tr>
87 <td><a href="#SvnLogBrowserDialog.__readStdout">__readStdout</a></td>
88 <td>Private slot to handle the readyReadStandardOutput signal.</td>
89 </tr><tr>
90 <td><a href="#SvnLogBrowserDialog.__resizeColumnsFiles">__resizeColumnsFiles</a></td>
91 <td>Private method to resize the changed files tree columns.</td>
92 </tr><tr>
93 <td><a href="#SvnLogBrowserDialog.__resizeColumnsLog">__resizeColumnsLog</a></td>
94 <td>Private method to resize the log tree columns.</td>
95 </tr><tr>
96 <td><a href="#SvnLogBrowserDialog.__resortFiles">__resortFiles</a></td>
97 <td>Private method to resort the changed files tree.</td>
98 </tr><tr>
99 <td><a href="#SvnLogBrowserDialog.__resortLog">__resortLog</a></td>
100 <td>Private method to resort the log tree.</td>
101 </tr><tr>
102 <td><a href="#SvnLogBrowserDialog.closeEvent">closeEvent</a></td>
103 <td>Private slot implementing a close event handler.</td>
104 </tr><tr>
105 <td><a href="#SvnLogBrowserDialog.keyPressEvent">keyPressEvent</a></td>
106 <td>Protected slot to handle a key press event.</td>
107 </tr><tr>
108 <td><a href="#SvnLogBrowserDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
109 <td>Private slot called by a button of the button box clicked.</td>
110 </tr><tr>
111 <td><a href="#SvnLogBrowserDialog.on_clearRxEditButton_clicked">on_clearRxEditButton_clicked</a></td>
112 <td>Private slot called by a click of the clear RX edit button.</td>
113 </tr><tr>
114 <td><a href="#SvnLogBrowserDialog.on_diffPreviousButton_clicked">on_diffPreviousButton_clicked</a></td>
115 <td>Private slot to handle the Diff to Previous button.</td>
116 </tr><tr>
117 <td><a href="#SvnLogBrowserDialog.on_diffRevisionsButton_clicked">on_diffRevisionsButton_clicked</a></td>
118 <td>Private slot to handle the Compare Revisions button.</td>
119 </tr><tr>
120 <td><a href="#SvnLogBrowserDialog.on_fieldCombo_activated">on_fieldCombo_activated</a></td>
121 <td>Private slot called, when a new filter field is selected.</td>
122 </tr><tr>
123 <td><a href="#SvnLogBrowserDialog.on_fromDate_dateChanged">on_fromDate_dateChanged</a></td>
124 <td>Private slot called, when the from date changes.</td>
125 </tr><tr>
126 <td><a href="#SvnLogBrowserDialog.on_input_returnPressed">on_input_returnPressed</a></td>
127 <td>Private slot to handle the press of the return key in the input field.</td>
128 </tr><tr>
129 <td><a href="#SvnLogBrowserDialog.on_logTree_currentItemChanged">on_logTree_currentItemChanged</a></td>
130 <td>Private slot called, when the current item of the log tree changes.</td>
131 </tr><tr>
132 <td><a href="#SvnLogBrowserDialog.on_logTree_itemSelectionChanged">on_logTree_itemSelectionChanged</a></td>
133 <td>Private slot called, when the selection has changed.</td>
134 </tr><tr>
135 <td><a href="#SvnLogBrowserDialog.on_nextButton_clicked">on_nextButton_clicked</a></td>
136 <td>Private slot to handle the Next button.</td>
137 </tr><tr>
138 <td><a href="#SvnLogBrowserDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
139 <td>Private slot to handle the password checkbox toggled.</td>
140 </tr><tr>
141 <td><a href="#SvnLogBrowserDialog.on_rxEdit_textChanged">on_rxEdit_textChanged</a></td>
142 <td>Private slot called, when a filter expression is entered.</td>
143 </tr><tr>
144 <td><a href="#SvnLogBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
145 <td>Private slot to send the input to the subversion process.</td>
146 </tr><tr>
147 <td><a href="#SvnLogBrowserDialog.on_stopCheckBox_clicked">on_stopCheckBox_clicked</a></td>
148 <td>Private slot called, when the stop on copy/move checkbox is clicked</td>
149 </tr><tr>
150 <td><a href="#SvnLogBrowserDialog.on_toDate_dateChanged">on_toDate_dateChanged</a></td>
151 <td>Private slot called, when the from date changes.</td>
152 </tr><tr>
153 <td><a href="#SvnLogBrowserDialog.start">start</a></td>
154 <td>Public slot to start the svn log command.</td>
155 </tr>
156 </table>
157 <a NAME="SvnLogBrowserDialog.__init__" ID="SvnLogBrowserDialog.__init__"></a>
158 <h4>SvnLogBrowserDialog (Constructor)</h4>
159 <b>SvnLogBrowserDialog</b>(<i>vcs, parent = None</i>)
160 <p>
161 Constructor
162 </p><dl>
163 <dt><i>vcs</i></dt>
164 <dd>
165 reference to the vcs object
166 </dd><dt><i>parent</i></dt>
167 <dd>
168 parent widget (QWidget)
169 </dd>
170 </dl><a NAME="SvnLogBrowserDialog.__diffRevisions" ID="SvnLogBrowserDialog.__diffRevisions"></a>
171 <h4>SvnLogBrowserDialog.__diffRevisions</h4>
172 <b>__diffRevisions</b>(<i>rev1, rev2</i>)
173 <p>
174 Private method to do a diff of two revisions.
175 </p><dl>
176 <dt><i>rev1</i></dt>
177 <dd>
178 first revision number (integer)
179 </dd><dt><i>rev2</i></dt>
180 <dd>
181 second revision number (integer)
182 </dd>
183 </dl><a NAME="SvnLogBrowserDialog.__filterLogs" ID="SvnLogBrowserDialog.__filterLogs"></a>
184 <h4>SvnLogBrowserDialog.__filterLogs</h4>
185 <b>__filterLogs</b>(<i></i>)
186 <p>
187 Private method to filter the log entries.
188 </p><a NAME="SvnLogBrowserDialog.__finish" ID="SvnLogBrowserDialog.__finish"></a>
189 <h4>SvnLogBrowserDialog.__finish</h4>
190 <b>__finish</b>(<i></i>)
191 <p>
192 Private slot called when the process finished or the user pressed the button.
193 </p><a NAME="SvnLogBrowserDialog.__generateFileItem" ID="SvnLogBrowserDialog.__generateFileItem"></a>
194 <h4>SvnLogBrowserDialog.__generateFileItem</h4>
195 <b>__generateFileItem</b>(<i>action, path, copyFrom, copyRev</i>)
196 <p>
197 Private method to generate a changed files tree entry.
198 </p><dl>
199 <dt><i>action</i></dt>
200 <dd>
201 indicator for the change action ("A", "D" or "M")
202 </dd><dt><i>path</i></dt>
203 <dd>
204 path of the file in the repository (string)
205 </dd><dt><i>copyFrom</i></dt>
206 <dd>
207 path the file was copied from (None, string)
208 </dd><dt><i>copyRev</i></dt>
209 <dd>
210 revision the file was copied from (None, string)
211 </dd>
212 </dl><dl>
213 <dt>Returns:</dt>
214 <dd>
215 reference to the generated item (QTreeWidgetItem)
216 </dd>
217 </dl><a NAME="SvnLogBrowserDialog.__generateLogItem" ID="SvnLogBrowserDialog.__generateLogItem"></a>
218 <h4>SvnLogBrowserDialog.__generateLogItem</h4>
219 <b>__generateLogItem</b>(<i>author, date, message, revision, changedPaths</i>)
220 <p>
221 Private method to generate a log tree entry.
222 </p><dl>
223 <dt><i>author</i></dt>
224 <dd>
225 author info (string)
226 </dd><dt><i>date</i></dt>
227 <dd>
228 date info (string)
229 </dd><dt><i>message</i></dt>
230 <dd>
231 text of the log message (list of strings)
232 </dd><dt><i>revision</i></dt>
233 <dd>
234 revision info (string)
235 </dd><dt><i>changedPaths</i></dt>
236 <dd>
237 list of dictionary objects containing
238 info about the changed files/directories
239 </dd>
240 </dl><dl>
241 <dt>Returns:</dt>
242 <dd>
243 reference to the generated item (QTreeWidgetItem)
244 </dd>
245 </dl><a NAME="SvnLogBrowserDialog.__getLogEntries" ID="SvnLogBrowserDialog.__getLogEntries"></a>
246 <h4>SvnLogBrowserDialog.__getLogEntries</h4>
247 <b>__getLogEntries</b>(<i>startRev = None</i>)
248 <p>
249 Private method to retrieve log entries from the repository.
250 </p><dl>
251 <dt><i>startRev</i></dt>
252 <dd>
253 revision number to start from (integer, string)
254 </dd>
255 </dl><a NAME="SvnLogBrowserDialog.__procFinished" ID="SvnLogBrowserDialog.__procFinished"></a>
256 <h4>SvnLogBrowserDialog.__procFinished</h4>
257 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
258 <p>
259 Private slot connected to the finished signal.
260 </p><dl>
261 <dt><i>exitCode</i></dt>
262 <dd>
263 exit code of the process (integer)
264 </dd><dt><i>exitStatus</i></dt>
265 <dd>
266 exit status of the process (QProcess.ExitStatus)
267 </dd>
268 </dl><a NAME="SvnLogBrowserDialog.__processBuffer" ID="SvnLogBrowserDialog.__processBuffer"></a>
269 <h4>SvnLogBrowserDialog.__processBuffer</h4>
270 <b>__processBuffer</b>(<i></i>)
271 <p>
272 Private method to process the buffered output of the svn log command.
273 </p><a NAME="SvnLogBrowserDialog.__readStderr" ID="SvnLogBrowserDialog.__readStderr"></a>
274 <h4>SvnLogBrowserDialog.__readStderr</h4>
275 <b>__readStderr</b>(<i></i>)
276 <p>
277 Private slot to handle the readyReadStandardError signal.
278 </p><p>
279 It reads the error output of the process and inserts it into the
280 error pane.
281 </p><a NAME="SvnLogBrowserDialog.__readStdout" ID="SvnLogBrowserDialog.__readStdout"></a>
282 <h4>SvnLogBrowserDialog.__readStdout</h4>
283 <b>__readStdout</b>(<i></i>)
284 <p>
285 Private slot to handle the readyReadStandardOutput signal.
286 </p><p>
287 It reads the output of the process and inserts it into a buffer.
288 </p><a NAME="SvnLogBrowserDialog.__resizeColumnsFiles" ID="SvnLogBrowserDialog.__resizeColumnsFiles"></a>
289 <h4>SvnLogBrowserDialog.__resizeColumnsFiles</h4>
290 <b>__resizeColumnsFiles</b>(<i></i>)
291 <p>
292 Private method to resize the changed files tree columns.
293 </p><a NAME="SvnLogBrowserDialog.__resizeColumnsLog" ID="SvnLogBrowserDialog.__resizeColumnsLog"></a>
294 <h4>SvnLogBrowserDialog.__resizeColumnsLog</h4>
295 <b>__resizeColumnsLog</b>(<i></i>)
296 <p>
297 Private method to resize the log tree columns.
298 </p><a NAME="SvnLogBrowserDialog.__resortFiles" ID="SvnLogBrowserDialog.__resortFiles"></a>
299 <h4>SvnLogBrowserDialog.__resortFiles</h4>
300 <b>__resortFiles</b>(<i></i>)
301 <p>
302 Private method to resort the changed files tree.
303 </p><a NAME="SvnLogBrowserDialog.__resortLog" ID="SvnLogBrowserDialog.__resortLog"></a>
304 <h4>SvnLogBrowserDialog.__resortLog</h4>
305 <b>__resortLog</b>(<i></i>)
306 <p>
307 Private method to resort the log tree.
308 </p><a NAME="SvnLogBrowserDialog.closeEvent" ID="SvnLogBrowserDialog.closeEvent"></a>
309 <h4>SvnLogBrowserDialog.closeEvent</h4>
310 <b>closeEvent</b>(<i>e</i>)
311 <p>
312 Private slot implementing a close event handler.
313 </p><dl>
314 <dt><i>e</i></dt>
315 <dd>
316 close event (QCloseEvent)
317 </dd>
318 </dl><a NAME="SvnLogBrowserDialog.keyPressEvent" ID="SvnLogBrowserDialog.keyPressEvent"></a>
319 <h4>SvnLogBrowserDialog.keyPressEvent</h4>
320 <b>keyPressEvent</b>(<i>evt</i>)
321 <p>
322 Protected slot to handle a key press event.
323 </p><dl>
324 <dt><i>evt</i></dt>
325 <dd>
326 the key press event (QKeyEvent)
327 </dd>
328 </dl><a NAME="SvnLogBrowserDialog.on_buttonBox_clicked" ID="SvnLogBrowserDialog.on_buttonBox_clicked"></a>
329 <h4>SvnLogBrowserDialog.on_buttonBox_clicked</h4>
330 <b>on_buttonBox_clicked</b>(<i>button</i>)
331 <p>
332 Private slot called by a button of the button box clicked.
333 </p><dl>
334 <dt><i>button</i></dt>
335 <dd>
336 button that was clicked (QAbstractButton)
337 </dd>
338 </dl><a NAME="SvnLogBrowserDialog.on_clearRxEditButton_clicked" ID="SvnLogBrowserDialog.on_clearRxEditButton_clicked"></a>
339 <h4>SvnLogBrowserDialog.on_clearRxEditButton_clicked</h4>
340 <b>on_clearRxEditButton_clicked</b>(<i></i>)
341 <p>
342 Private slot called by a click of the clear RX edit button.
343 </p><a NAME="SvnLogBrowserDialog.on_diffPreviousButton_clicked" ID="SvnLogBrowserDialog.on_diffPreviousButton_clicked"></a>
344 <h4>SvnLogBrowserDialog.on_diffPreviousButton_clicked</h4>
345 <b>on_diffPreviousButton_clicked</b>(<i></i>)
346 <p>
347 Private slot to handle the Diff to Previous button.
348 </p><a NAME="SvnLogBrowserDialog.on_diffRevisionsButton_clicked" ID="SvnLogBrowserDialog.on_diffRevisionsButton_clicked"></a>
349 <h4>SvnLogBrowserDialog.on_diffRevisionsButton_clicked</h4>
350 <b>on_diffRevisionsButton_clicked</b>(<i></i>)
351 <p>
352 Private slot to handle the Compare Revisions button.
353 </p><a NAME="SvnLogBrowserDialog.on_fieldCombo_activated" ID="SvnLogBrowserDialog.on_fieldCombo_activated"></a>
354 <h4>SvnLogBrowserDialog.on_fieldCombo_activated</h4>
355 <b>on_fieldCombo_activated</b>(<i>txt</i>)
356 <p>
357 Private slot called, when a new filter field is selected.
358 </p><dl>
359 <dt><i>txt</i></dt>
360 <dd>
361 text of the selected field (QString)
362 </dd>
363 </dl><a NAME="SvnLogBrowserDialog.on_fromDate_dateChanged" ID="SvnLogBrowserDialog.on_fromDate_dateChanged"></a>
364 <h4>SvnLogBrowserDialog.on_fromDate_dateChanged</h4>
365 <b>on_fromDate_dateChanged</b>(<i>date</i>)
366 <p>
367 Private slot called, when the from date changes.
368 </p><dl>
369 <dt><i>date</i></dt>
370 <dd>
371 new date (QDate)
372 </dd>
373 </dl><a NAME="SvnLogBrowserDialog.on_input_returnPressed" ID="SvnLogBrowserDialog.on_input_returnPressed"></a>
374 <h4>SvnLogBrowserDialog.on_input_returnPressed</h4>
375 <b>on_input_returnPressed</b>(<i></i>)
376 <p>
377 Private slot to handle the press of the return key in the input field.
378 </p><a NAME="SvnLogBrowserDialog.on_logTree_currentItemChanged" ID="SvnLogBrowserDialog.on_logTree_currentItemChanged"></a>
379 <h4>SvnLogBrowserDialog.on_logTree_currentItemChanged</h4>
380 <b>on_logTree_currentItemChanged</b>(<i>current, previous</i>)
381 <p>
382 Private slot called, when the current item of the log tree changes.
383 </p><dl>
384 <dt><i>current</i></dt>
385 <dd>
386 reference to the new current item (QTreeWidgetItem)
387 </dd><dt><i>previous</i></dt>
388 <dd>
389 reference to the old current item (QTreeWidgetItem)
390 </dd>
391 </dl><a NAME="SvnLogBrowserDialog.on_logTree_itemSelectionChanged" ID="SvnLogBrowserDialog.on_logTree_itemSelectionChanged"></a>
392 <h4>SvnLogBrowserDialog.on_logTree_itemSelectionChanged</h4>
393 <b>on_logTree_itemSelectionChanged</b>(<i></i>)
394 <p>
395 Private slot called, when the selection has changed.
396 </p><a NAME="SvnLogBrowserDialog.on_nextButton_clicked" ID="SvnLogBrowserDialog.on_nextButton_clicked"></a>
397 <h4>SvnLogBrowserDialog.on_nextButton_clicked</h4>
398 <b>on_nextButton_clicked</b>(<i></i>)
399 <p>
400 Private slot to handle the Next button.
401 </p><a NAME="SvnLogBrowserDialog.on_passwordCheckBox_toggled" ID="SvnLogBrowserDialog.on_passwordCheckBox_toggled"></a>
402 <h4>SvnLogBrowserDialog.on_passwordCheckBox_toggled</h4>
403 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
404 <p>
405 Private slot to handle the password checkbox toggled.
406 </p><dl>
407 <dt><i>isOn</i></dt>
408 <dd>
409 flag indicating the status of the check box (boolean)
410 </dd>
411 </dl><a NAME="SvnLogBrowserDialog.on_rxEdit_textChanged" ID="SvnLogBrowserDialog.on_rxEdit_textChanged"></a>
412 <h4>SvnLogBrowserDialog.on_rxEdit_textChanged</h4>
413 <b>on_rxEdit_textChanged</b>(<i>txt</i>)
414 <p>
415 Private slot called, when a filter expression is entered.
416 </p><dl>
417 <dt><i>txt</i></dt>
418 <dd>
419 filter expression (string)
420 </dd>
421 </dl><a NAME="SvnLogBrowserDialog.on_sendButton_clicked" ID="SvnLogBrowserDialog.on_sendButton_clicked"></a>
422 <h4>SvnLogBrowserDialog.on_sendButton_clicked</h4>
423 <b>on_sendButton_clicked</b>(<i></i>)
424 <p>
425 Private slot to send the input to the subversion process.
426 </p><a NAME="SvnLogBrowserDialog.on_stopCheckBox_clicked" ID="SvnLogBrowserDialog.on_stopCheckBox_clicked"></a>
427 <h4>SvnLogBrowserDialog.on_stopCheckBox_clicked</h4>
428 <b>on_stopCheckBox_clicked</b>(<i>checked</i>)
429 <p>
430 Private slot called, when the stop on copy/move checkbox is clicked
431 </p><a NAME="SvnLogBrowserDialog.on_toDate_dateChanged" ID="SvnLogBrowserDialog.on_toDate_dateChanged"></a>
432 <h4>SvnLogBrowserDialog.on_toDate_dateChanged</h4>
433 <b>on_toDate_dateChanged</b>(<i>date</i>)
434 <p>
435 Private slot called, when the from date changes.
436 </p><dl>
437 <dt><i>date</i></dt>
438 <dd>
439 new date (QDate)
440 </dd>
441 </dl><a NAME="SvnLogBrowserDialog.start" ID="SvnLogBrowserDialog.start"></a>
442 <h4>SvnLogBrowserDialog.start</h4>
443 <b>start</b>(<i>fn</i>)
444 <p>
445 Public slot to start the svn log command.
446 </p><dl>
447 <dt><i>fn</i></dt>
448 <dd>
449 filename to show the log for (string)
450 </dd>
451 </dl>
452 <div align="right"><a href="#top">Up</a></div>
453 <hr />
454 </body></html>

eric ide

mercurial