Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html

changeset 178
dd9f0bca5e2f
child 180
40ac468c2558
equal deleted inserted replaced
177:c822ccc4d138 178:dd9f0bca5e2f
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>eric5.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog</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>eric5.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog</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="#HgLogBrowserDialog">HgLogBrowserDialog</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="HgLogBrowserDialog" ID="HgLogBrowserDialog"></a>
44 <h2>HgLogBrowserDialog</h2>
45 <p>
46 Class implementing a dialog to browse the log history.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_HgLogBrowserDialog
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="#HgLogBrowserDialog.__init__">HgLogBrowserDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#HgLogBrowserDialog.__diffRevisions">__diffRevisions</a></td>
61 <td>Private method to do a diff of two revisions.</td>
62 </tr><tr>
63 <td><a href="#HgLogBrowserDialog.__filterLogs">__filterLogs</a></td>
64 <td>Private method to filter the log entries.</td>
65 </tr><tr>
66 <td><a href="#HgLogBrowserDialog.__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="#HgLogBrowserDialog.__generateFileItem">__generateFileItem</a></td>
70 <td>Private method to generate a changed files tree entry.</td>
71 </tr><tr>
72 <td><a href="#HgLogBrowserDialog.__generateLogItem">__generateLogItem</a></td>
73 <td>Private method to generate a log tree entry.</td>
74 </tr><tr>
75 <td><a href="#HgLogBrowserDialog.__getLogEntries">__getLogEntries</a></td>
76 <td>Private method to retrieve log entries from the repository.</td>
77 </tr><tr>
78 <td><a href="#HgLogBrowserDialog.__procFinished">__procFinished</a></td>
79 <td>Private slot connected to the finished signal.</td>
80 </tr><tr>
81 <td><a href="#HgLogBrowserDialog.__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="#HgLogBrowserDialog.__readStderr">__readStderr</a></td>
85 <td>Private slot to handle the readyReadStandardError signal.</td>
86 </tr><tr>
87 <td><a href="#HgLogBrowserDialog.__readStdout">__readStdout</a></td>
88 <td>Private slot to handle the readyReadStandardOutput signal.</td>
89 </tr><tr>
90 <td><a href="#HgLogBrowserDialog.__resizeColumnsFiles">__resizeColumnsFiles</a></td>
91 <td>Private method to resize the changed files tree columns.</td>
92 </tr><tr>
93 <td><a href="#HgLogBrowserDialog.__resizeColumnsLog">__resizeColumnsLog</a></td>
94 <td>Private method to resize the log tree columns.</td>
95 </tr><tr>
96 <td><a href="#HgLogBrowserDialog.__resortFiles">__resortFiles</a></td>
97 <td>Private method to resort the changed files tree.</td>
98 </tr><tr>
99 <td><a href="#HgLogBrowserDialog.__resortLog">__resortLog</a></td>
100 <td>Private method to resort the log tree.</td>
101 </tr><tr>
102 <td><a href="#HgLogBrowserDialog.closeEvent">closeEvent</a></td>
103 <td>Private slot implementing a close event handler.</td>
104 </tr><tr>
105 <td><a href="#HgLogBrowserDialog.keyPressEvent">keyPressEvent</a></td>
106 <td>Protected slot to handle a key press event.</td>
107 </tr><tr>
108 <td><a href="#HgLogBrowserDialog.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="#HgLogBrowserDialog.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="#HgLogBrowserDialog.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="#HgLogBrowserDialog.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="#HgLogBrowserDialog.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="#HgLogBrowserDialog.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="#HgLogBrowserDialog.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="#HgLogBrowserDialog.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="#HgLogBrowserDialog.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="#HgLogBrowserDialog.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="#HgLogBrowserDialog.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="#HgLogBrowserDialog.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="#HgLogBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
145 <td>Private slot to send the input to the merurial process.</td>
146 </tr><tr>
147 <td><a href="#HgLogBrowserDialog.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="#HgLogBrowserDialog.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="#HgLogBrowserDialog.start">start</a></td>
154 <td>Public slot to start the svn log command.</td>
155 </tr>
156 </table>
157 <a NAME="HgLogBrowserDialog.__init__" ID="HgLogBrowserDialog.__init__"></a>
158 <h4>HgLogBrowserDialog (Constructor)</h4>
159 <b>HgLogBrowserDialog</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="HgLogBrowserDialog.__diffRevisions" ID="HgLogBrowserDialog.__diffRevisions"></a>
171 <h4>HgLogBrowserDialog.__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="HgLogBrowserDialog.__filterLogs" ID="HgLogBrowserDialog.__filterLogs"></a>
184 <h4>HgLogBrowserDialog.__filterLogs</h4>
185 <b>__filterLogs</b>(<i></i>)
186 <p>
187 Private method to filter the log entries.
188 </p><a NAME="HgLogBrowserDialog.__finish" ID="HgLogBrowserDialog.__finish"></a>
189 <h4>HgLogBrowserDialog.__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="HgLogBrowserDialog.__generateFileItem" ID="HgLogBrowserDialog.__generateFileItem"></a>
194 <h4>HgLogBrowserDialog.__generateFileItem</h4>
195 <b>__generateFileItem</b>(<i>action, path</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>
206 </dl><dl>
207 <dt>Returns:</dt>
208 <dd>
209 reference to the generated item (QTreeWidgetItem)
210 </dd>
211 </dl><a NAME="HgLogBrowserDialog.__generateLogItem" ID="HgLogBrowserDialog.__generateLogItem"></a>
212 <h4>HgLogBrowserDialog.__generateLogItem</h4>
213 <b>__generateLogItem</b>(<i>author, date, message, revision, changedPaths</i>)
214 <p>
215 Private method to generate a log tree entry.
216 </p><dl>
217 <dt><i>author</i></dt>
218 <dd>
219 author info (string)
220 </dd><dt><i>date</i></dt>
221 <dd>
222 date info (string)
223 </dd><dt><i>message</i></dt>
224 <dd>
225 text of the log message (list of strings)
226 </dd><dt><i>revision</i></dt>
227 <dd>
228 revision info (string)
229 </dd><dt><i>changedPaths</i></dt>
230 <dd>
231 list of dictionary objects containing
232 info about the changed files/directories
233 </dd>
234 </dl><dl>
235 <dt>Returns:</dt>
236 <dd>
237 reference to the generated item (QTreeWidgetItem)
238 </dd>
239 </dl><a NAME="HgLogBrowserDialog.__getLogEntries" ID="HgLogBrowserDialog.__getLogEntries"></a>
240 <h4>HgLogBrowserDialog.__getLogEntries</h4>
241 <b>__getLogEntries</b>(<i>startRev = None</i>)
242 <p>
243 Private method to retrieve log entries from the repository.
244 </p><dl>
245 <dt><i>startRev</i></dt>
246 <dd>
247 revision number to start from (integer, string)
248 </dd>
249 </dl><a NAME="HgLogBrowserDialog.__procFinished" ID="HgLogBrowserDialog.__procFinished"></a>
250 <h4>HgLogBrowserDialog.__procFinished</h4>
251 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
252 <p>
253 Private slot connected to the finished signal.
254 </p><dl>
255 <dt><i>exitCode</i></dt>
256 <dd>
257 exit code of the process (integer)
258 </dd><dt><i>exitStatus</i></dt>
259 <dd>
260 exit status of the process (QProcess.ExitStatus)
261 </dd>
262 </dl><a NAME="HgLogBrowserDialog.__processBuffer" ID="HgLogBrowserDialog.__processBuffer"></a>
263 <h4>HgLogBrowserDialog.__processBuffer</h4>
264 <b>__processBuffer</b>(<i></i>)
265 <p>
266 Private method to process the buffered output of the svn log command.
267 </p><a NAME="HgLogBrowserDialog.__readStderr" ID="HgLogBrowserDialog.__readStderr"></a>
268 <h4>HgLogBrowserDialog.__readStderr</h4>
269 <b>__readStderr</b>(<i></i>)
270 <p>
271 Private slot to handle the readyReadStandardError signal.
272 </p><p>
273 It reads the error output of the process and inserts it into the
274 error pane.
275 </p><a NAME="HgLogBrowserDialog.__readStdout" ID="HgLogBrowserDialog.__readStdout"></a>
276 <h4>HgLogBrowserDialog.__readStdout</h4>
277 <b>__readStdout</b>(<i></i>)
278 <p>
279 Private slot to handle the readyReadStandardOutput signal.
280 </p><p>
281 It reads the output of the process and inserts it into a buffer.
282 </p><a NAME="HgLogBrowserDialog.__resizeColumnsFiles" ID="HgLogBrowserDialog.__resizeColumnsFiles"></a>
283 <h4>HgLogBrowserDialog.__resizeColumnsFiles</h4>
284 <b>__resizeColumnsFiles</b>(<i></i>)
285 <p>
286 Private method to resize the changed files tree columns.
287 </p><a NAME="HgLogBrowserDialog.__resizeColumnsLog" ID="HgLogBrowserDialog.__resizeColumnsLog"></a>
288 <h4>HgLogBrowserDialog.__resizeColumnsLog</h4>
289 <b>__resizeColumnsLog</b>(<i></i>)
290 <p>
291 Private method to resize the log tree columns.
292 </p><a NAME="HgLogBrowserDialog.__resortFiles" ID="HgLogBrowserDialog.__resortFiles"></a>
293 <h4>HgLogBrowserDialog.__resortFiles</h4>
294 <b>__resortFiles</b>(<i></i>)
295 <p>
296 Private method to resort the changed files tree.
297 </p><a NAME="HgLogBrowserDialog.__resortLog" ID="HgLogBrowserDialog.__resortLog"></a>
298 <h4>HgLogBrowserDialog.__resortLog</h4>
299 <b>__resortLog</b>(<i></i>)
300 <p>
301 Private method to resort the log tree.
302 </p><a NAME="HgLogBrowserDialog.closeEvent" ID="HgLogBrowserDialog.closeEvent"></a>
303 <h4>HgLogBrowserDialog.closeEvent</h4>
304 <b>closeEvent</b>(<i>e</i>)
305 <p>
306 Private slot implementing a close event handler.
307 </p><dl>
308 <dt><i>e</i></dt>
309 <dd>
310 close event (QCloseEvent)
311 </dd>
312 </dl><a NAME="HgLogBrowserDialog.keyPressEvent" ID="HgLogBrowserDialog.keyPressEvent"></a>
313 <h4>HgLogBrowserDialog.keyPressEvent</h4>
314 <b>keyPressEvent</b>(<i>evt</i>)
315 <p>
316 Protected slot to handle a key press event.
317 </p><dl>
318 <dt><i>evt</i></dt>
319 <dd>
320 the key press event (QKeyEvent)
321 </dd>
322 </dl><a NAME="HgLogBrowserDialog.on_buttonBox_clicked" ID="HgLogBrowserDialog.on_buttonBox_clicked"></a>
323 <h4>HgLogBrowserDialog.on_buttonBox_clicked</h4>
324 <b>on_buttonBox_clicked</b>(<i>button</i>)
325 <p>
326 Private slot called by a button of the button box clicked.
327 </p><dl>
328 <dt><i>button</i></dt>
329 <dd>
330 button that was clicked (QAbstractButton)
331 </dd>
332 </dl><a NAME="HgLogBrowserDialog.on_clearRxEditButton_clicked" ID="HgLogBrowserDialog.on_clearRxEditButton_clicked"></a>
333 <h4>HgLogBrowserDialog.on_clearRxEditButton_clicked</h4>
334 <b>on_clearRxEditButton_clicked</b>(<i></i>)
335 <p>
336 Private slot called by a click of the clear RX edit button.
337 </p><a NAME="HgLogBrowserDialog.on_diffPreviousButton_clicked" ID="HgLogBrowserDialog.on_diffPreviousButton_clicked"></a>
338 <h4>HgLogBrowserDialog.on_diffPreviousButton_clicked</h4>
339 <b>on_diffPreviousButton_clicked</b>(<i></i>)
340 <p>
341 Private slot to handle the Diff to Previous button.
342 </p><a NAME="HgLogBrowserDialog.on_diffRevisionsButton_clicked" ID="HgLogBrowserDialog.on_diffRevisionsButton_clicked"></a>
343 <h4>HgLogBrowserDialog.on_diffRevisionsButton_clicked</h4>
344 <b>on_diffRevisionsButton_clicked</b>(<i></i>)
345 <p>
346 Private slot to handle the Compare Revisions button.
347 </p><a NAME="HgLogBrowserDialog.on_fieldCombo_activated" ID="HgLogBrowserDialog.on_fieldCombo_activated"></a>
348 <h4>HgLogBrowserDialog.on_fieldCombo_activated</h4>
349 <b>on_fieldCombo_activated</b>(<i>txt</i>)
350 <p>
351 Private slot called, when a new filter field is selected.
352 </p><dl>
353 <dt><i>txt</i></dt>
354 <dd>
355 text of the selected field (string)
356 </dd>
357 </dl><a NAME="HgLogBrowserDialog.on_fromDate_dateChanged" ID="HgLogBrowserDialog.on_fromDate_dateChanged"></a>
358 <h4>HgLogBrowserDialog.on_fromDate_dateChanged</h4>
359 <b>on_fromDate_dateChanged</b>(<i>date</i>)
360 <p>
361 Private slot called, when the from date changes.
362 </p><dl>
363 <dt><i>date</i></dt>
364 <dd>
365 new date (QDate)
366 </dd>
367 </dl><a NAME="HgLogBrowserDialog.on_input_returnPressed" ID="HgLogBrowserDialog.on_input_returnPressed"></a>
368 <h4>HgLogBrowserDialog.on_input_returnPressed</h4>
369 <b>on_input_returnPressed</b>(<i></i>)
370 <p>
371 Private slot to handle the press of the return key in the input field.
372 </p><a NAME="HgLogBrowserDialog.on_logTree_currentItemChanged" ID="HgLogBrowserDialog.on_logTree_currentItemChanged"></a>
373 <h4>HgLogBrowserDialog.on_logTree_currentItemChanged</h4>
374 <b>on_logTree_currentItemChanged</b>(<i>current, previous</i>)
375 <p>
376 Private slot called, when the current item of the log tree changes.
377 </p><dl>
378 <dt><i>current</i></dt>
379 <dd>
380 reference to the new current item (QTreeWidgetItem)
381 </dd><dt><i>previous</i></dt>
382 <dd>
383 reference to the old current item (QTreeWidgetItem)
384 </dd>
385 </dl><a NAME="HgLogBrowserDialog.on_logTree_itemSelectionChanged" ID="HgLogBrowserDialog.on_logTree_itemSelectionChanged"></a>
386 <h4>HgLogBrowserDialog.on_logTree_itemSelectionChanged</h4>
387 <b>on_logTree_itemSelectionChanged</b>(<i></i>)
388 <p>
389 Private slot called, when the selection has changed.
390 </p><a NAME="HgLogBrowserDialog.on_nextButton_clicked" ID="HgLogBrowserDialog.on_nextButton_clicked"></a>
391 <h4>HgLogBrowserDialog.on_nextButton_clicked</h4>
392 <b>on_nextButton_clicked</b>(<i></i>)
393 <p>
394 Private slot to handle the Next button.
395 </p><a NAME="HgLogBrowserDialog.on_passwordCheckBox_toggled" ID="HgLogBrowserDialog.on_passwordCheckBox_toggled"></a>
396 <h4>HgLogBrowserDialog.on_passwordCheckBox_toggled</h4>
397 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
398 <p>
399 Private slot to handle the password checkbox toggled.
400 </p><dl>
401 <dt><i>isOn</i></dt>
402 <dd>
403 flag indicating the status of the check box (boolean)
404 </dd>
405 </dl><a NAME="HgLogBrowserDialog.on_rxEdit_textChanged" ID="HgLogBrowserDialog.on_rxEdit_textChanged"></a>
406 <h4>HgLogBrowserDialog.on_rxEdit_textChanged</h4>
407 <b>on_rxEdit_textChanged</b>(<i>txt</i>)
408 <p>
409 Private slot called, when a filter expression is entered.
410 </p><dl>
411 <dt><i>txt</i></dt>
412 <dd>
413 filter expression (string)
414 </dd>
415 </dl><a NAME="HgLogBrowserDialog.on_sendButton_clicked" ID="HgLogBrowserDialog.on_sendButton_clicked"></a>
416 <h4>HgLogBrowserDialog.on_sendButton_clicked</h4>
417 <b>on_sendButton_clicked</b>(<i></i>)
418 <p>
419 Private slot to send the input to the merurial process.
420 </p><a NAME="HgLogBrowserDialog.on_stopCheckBox_clicked" ID="HgLogBrowserDialog.on_stopCheckBox_clicked"></a>
421 <h4>HgLogBrowserDialog.on_stopCheckBox_clicked</h4>
422 <b>on_stopCheckBox_clicked</b>(<i>checked</i>)
423 <p>
424 Private slot called, when the stop on copy/move checkbox is clicked
425 </p><a NAME="HgLogBrowserDialog.on_toDate_dateChanged" ID="HgLogBrowserDialog.on_toDate_dateChanged"></a>
426 <h4>HgLogBrowserDialog.on_toDate_dateChanged</h4>
427 <b>on_toDate_dateChanged</b>(<i>date</i>)
428 <p>
429 Private slot called, when the from date changes.
430 </p><dl>
431 <dt><i>date</i></dt>
432 <dd>
433 new date (QDate)
434 </dd>
435 </dl><a NAME="HgLogBrowserDialog.start" ID="HgLogBrowserDialog.start"></a>
436 <h4>HgLogBrowserDialog.start</h4>
437 <b>start</b>(<i>fn</i>)
438 <p>
439 Public slot to start the svn log command.
440 </p><dl>
441 <dt><i>fn</i></dt>
442 <dd>
443 filename to show the log for (string)
444 </dd>
445 </dl>
446 <div align="right"><a href="#top">Up</a></div>
447 <hr />
448 </body></html>

eric ide

mercurial