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

changeset 180
40ac468c2558
parent 178
dd9f0bca5e2f
child 181
4af57f97c1bc
equal deleted inserted replaced
179:09260f69bf37 180:40ac468c2558
24 <p> 24 <p>
25 Module implementing a dialog to browse the log history. 25 Module implementing a dialog to browse the log history.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>COLORNAMES</td></tr><tr><td>COLORS</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#HgLogBrowserDialog">HgLogBrowserDialog</a></td> 34 <td><a href="#HgLogBrowserDialog">HgLogBrowserDialog</a></td>
47 </p> 47 </p>
48 <h3>Derived from</h3> 48 <h3>Derived from</h3>
49 QDialog, Ui_HgLogBrowserDialog 49 QDialog, Ui_HgLogBrowserDialog
50 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
51 <table> 51 <table>
52 <tr><td>None</td></tr> 52 <tr><td>AuthorColumn</td></tr><tr><td>BranchColumn</td></tr><tr><td>DateColumn</td></tr><tr><td>IconColumn</td></tr><tr><td>MessageColumn</td></tr><tr><td>RevisionColumn</td></tr><tr><td>TagsColumn</td></tr>
53 </table> 53 </table>
54 <h3>Methods</h3> 54 <h3>Methods</h3>
55 <table> 55 <table>
56 <tr> 56 <tr>
57 <td><a href="#HgLogBrowserDialog.__init__">HgLogBrowserDialog</a></td> 57 <td><a href="#HgLogBrowserDialog.__init__">HgLogBrowserDialog</a></td>
58 <td>Constructor</td> 58 <td>Constructor</td>
59 </tr><tr> 59 </tr><tr>
60 <td><a href="#HgLogBrowserDialog.__branchColor">__branchColor</a></td>
61 <td>Private method to calculate a color for a given branch name.</td>
62 </tr><tr>
60 <td><a href="#HgLogBrowserDialog.__diffRevisions">__diffRevisions</a></td> 63 <td><a href="#HgLogBrowserDialog.__diffRevisions">__diffRevisions</a></td>
61 <td>Private method to do a diff of two revisions.</td> 64 <td>Private method to do a diff of two revisions.</td>
62 </tr><tr> 65 </tr><tr>
63 <td><a href="#HgLogBrowserDialog.__filterLogs">__filterLogs</a></td> 66 <td><a href="#HgLogBrowserDialog.__filterLogs">__filterLogs</a></td>
64 <td>Private method to filter the log entries.</td> 67 <td>Private method to filter the log entries.</td>
65 </tr><tr> 68 </tr><tr>
66 <td><a href="#HgLogBrowserDialog.__finish">__finish</a></td> 69 <td><a href="#HgLogBrowserDialog.__finish">__finish</a></td>
67 <td>Private slot called when the process finished or the user pressed the button.</td> 70 <td>Private slot called when the process finished or the user pressed the button.</td>
68 </tr><tr> 71 </tr><tr>
72 <td><a href="#HgLogBrowserDialog.__generateEdges">__generateEdges</a></td>
73 <td>Private method to generate edge info for the give data.</td>
74 </tr><tr>
69 <td><a href="#HgLogBrowserDialog.__generateFileItem">__generateFileItem</a></td> 75 <td><a href="#HgLogBrowserDialog.__generateFileItem">__generateFileItem</a></td>
70 <td>Private method to generate a changed files tree entry.</td> 76 <td>Private method to generate a changed files tree entry.</td>
71 </tr><tr> 77 </tr><tr>
78 <td><a href="#HgLogBrowserDialog.__generateIcon">__generateIcon</a></td>
79 <td>Private method to generate an icon containing the revision tree for the given data.</td>
80 </tr><tr>
72 <td><a href="#HgLogBrowserDialog.__generateLogItem">__generateLogItem</a></td> 81 <td><a href="#HgLogBrowserDialog.__generateLogItem">__generateLogItem</a></td>
73 <td>Private method to generate a log tree entry.</td> 82 <td>Private method to generate a log tree entry.</td>
74 </tr><tr> 83 </tr><tr>
84 <td><a href="#HgLogBrowserDialog.__getColor">__getColor</a></td>
85 <td>Private method to get the (rotating) name of the color given an index.</td>
86 </tr><tr>
75 <td><a href="#HgLogBrowserDialog.__getLogEntries">__getLogEntries</a></td> 87 <td><a href="#HgLogBrowserDialog.__getLogEntries">__getLogEntries</a></td>
76 <td>Private method to retrieve log entries from the repository.</td> 88 <td>Private method to retrieve log entries from the repository.</td>
77 </tr><tr> 89 </tr><tr>
78 <td><a href="#HgLogBrowserDialog.__procFinished">__procFinished</a></td> 90 <td><a href="#HgLogBrowserDialog.__procFinished">__procFinished</a></td>
79 <td>Private slot connected to the finished signal.</td> 91 <td>Private slot connected to the finished signal.</td>
94 <td>Private method to resize the log tree columns.</td> 106 <td>Private method to resize the log tree columns.</td>
95 </tr><tr> 107 </tr><tr>
96 <td><a href="#HgLogBrowserDialog.__resortFiles">__resortFiles</a></td> 108 <td><a href="#HgLogBrowserDialog.__resortFiles">__resortFiles</a></td>
97 <td>Private method to resort the changed files tree.</td> 109 <td>Private method to resort the changed files tree.</td>
98 </tr><tr> 110 </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> 111 <td><a href="#HgLogBrowserDialog.closeEvent">closeEvent</a></td>
103 <td>Private slot implementing a close event handler.</td> 112 <td>Private slot implementing a close event handler.</td>
113 </tr><tr>
114 <td><a href="#HgLogBrowserDialog.col2x">col2x</a></td>
115 <td></td>
104 </tr><tr> 116 </tr><tr>
105 <td><a href="#HgLogBrowserDialog.keyPressEvent">keyPressEvent</a></td> 117 <td><a href="#HgLogBrowserDialog.keyPressEvent">keyPressEvent</a></td>
106 <td>Protected slot to handle a key press event.</td> 118 <td>Protected slot to handle a key press event.</td>
107 </tr><tr> 119 </tr><tr>
108 <td><a href="#HgLogBrowserDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 120 <td><a href="#HgLogBrowserDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
165 reference to the vcs object 177 reference to the vcs object
166 </dd><dt><i>parent</i></dt> 178 </dd><dt><i>parent</i></dt>
167 <dd> 179 <dd>
168 parent widget (QWidget) 180 parent widget (QWidget)
169 </dd> 181 </dd>
182 </dl><a NAME="HgLogBrowserDialog.__branchColor" ID="HgLogBrowserDialog.__branchColor"></a>
183 <h4>HgLogBrowserDialog.__branchColor</h4>
184 <b>__branchColor</b>(<i>branchName</i>)
185 <p>
186 Private method to calculate a color for a given branch name.
187 </p><dl>
188 <dt><i>branchName</i></dt>
189 <dd>
190 name of the branch (string)
191 </dd>
192 </dl><dl>
193 <dt>Returns:</dt>
194 <dd>
195 name of the color to use (string)
196 </dd>
170 </dl><a NAME="HgLogBrowserDialog.__diffRevisions" ID="HgLogBrowserDialog.__diffRevisions"></a> 197 </dl><a NAME="HgLogBrowserDialog.__diffRevisions" ID="HgLogBrowserDialog.__diffRevisions"></a>
171 <h4>HgLogBrowserDialog.__diffRevisions</h4> 198 <h4>HgLogBrowserDialog.__diffRevisions</h4>
172 <b>__diffRevisions</b>(<i>rev1, rev2</i>) 199 <b>__diffRevisions</b>(<i>rev1, rev2</i>)
173 <p> 200 <p>
174 Private method to do a diff of two revisions. 201 Private method to do a diff of two revisions.
188 </p><a NAME="HgLogBrowserDialog.__finish" ID="HgLogBrowserDialog.__finish"></a> 215 </p><a NAME="HgLogBrowserDialog.__finish" ID="HgLogBrowserDialog.__finish"></a>
189 <h4>HgLogBrowserDialog.__finish</h4> 216 <h4>HgLogBrowserDialog.__finish</h4>
190 <b>__finish</b>(<i></i>) 217 <b>__finish</b>(<i></i>)
191 <p> 218 <p>
192 Private slot called when the process finished or the user pressed the button. 219 Private slot called when the process finished or the user pressed the button.
193 </p><a NAME="HgLogBrowserDialog.__generateFileItem" ID="HgLogBrowserDialog.__generateFileItem"></a> 220 </p><a NAME="HgLogBrowserDialog.__generateEdges" ID="HgLogBrowserDialog.__generateEdges"></a>
221 <h4>HgLogBrowserDialog.__generateEdges</h4>
222 <b>__generateEdges</b>(<i>rev, parents</i>)
223 <p>
224 Private method to generate edge info for the give data.
225 </p><dl>
226 <dt><i>rev</i></dt>
227 <dd>
228 revision to calculate edge info for (integer)
229 </dd><dt><i>parents</i></dt>
230 <dd>
231 list of parent revisions (list of integers)
232 </dd>
233 </dl><dl>
234 <dt>Returns:</dt>
235 <dd>
236 tuple containing the column and color index for
237 the given node and a list of tuples indicating the edges
238 between the given node and its parents
239 (integer, integer, [(integer, integer, integer), ...])
240 </dd>
241 </dl><a NAME="HgLogBrowserDialog.__generateFileItem" ID="HgLogBrowserDialog.__generateFileItem"></a>
194 <h4>HgLogBrowserDialog.__generateFileItem</h4> 242 <h4>HgLogBrowserDialog.__generateFileItem</h4>
195 <b>__generateFileItem</b>(<i>action, path</i>) 243 <b>__generateFileItem</b>(<i>action, path</i>)
196 <p> 244 <p>
197 Private method to generate a changed files tree entry. 245 Private method to generate a changed files tree entry.
198 </p><dl> 246 </p><dl>
206 </dl><dl> 254 </dl><dl>
207 <dt>Returns:</dt> 255 <dt>Returns:</dt>
208 <dd> 256 <dd>
209 reference to the generated item (QTreeWidgetItem) 257 reference to the generated item (QTreeWidgetItem)
210 </dd> 258 </dd>
259 </dl><a NAME="HgLogBrowserDialog.__generateIcon" ID="HgLogBrowserDialog.__generateIcon"></a>
260 <h4>HgLogBrowserDialog.__generateIcon</h4>
261 <b>__generateIcon</b>(<i>column, color, bottomedges, topedges, dotColor</i>)
262 <p>
263 Private method to generate an icon containing the revision tree for the
264 given data.
265 </p><dl>
266 <dt><i>column</i></dt>
267 <dd>
268 column index of the revision (integer)
269 </dd><dt><i>color</i></dt>
270 <dd>
271 color of the node (integer)
272 </dd><dt><i>bottomedges</i></dt>
273 <dd>
274 list of edges for the bottom of the node
275 (list of tuples of three integers)
276 </dd><dt><i>topedges</i></dt>
277 <dd>
278 list of edges for the top of the node
279 (list of tuples of three integers)
280 </dd><dt><i>dotColor</i></dt>
281 <dd>
282 color to be used for the dot (QColor)
283 </dd>
284 </dl><dl>
285 <dt>Returns:</dt>
286 <dd>
287 icon for the node (QIcon)
288 </dd>
211 </dl><a NAME="HgLogBrowserDialog.__generateLogItem" ID="HgLogBrowserDialog.__generateLogItem"></a> 289 </dl><a NAME="HgLogBrowserDialog.__generateLogItem" ID="HgLogBrowserDialog.__generateLogItem"></a>
212 <h4>HgLogBrowserDialog.__generateLogItem</h4> 290 <h4>HgLogBrowserDialog.__generateLogItem</h4>
213 <b>__generateLogItem</b>(<i>author, date, message, revision, changedPaths</i>) 291 <b>__generateLogItem</b>(<i>author, date, message, revision, changedPaths, parents, branches, tags</i>)
214 <p> 292 <p>
215 Private method to generate a log tree entry. 293 Private method to generate a log tree entry.
216 </p><dl> 294 </p><dl>
217 <dt><i>author</i></dt> 295 <dt><i>author</i></dt>
218 <dd> 296 <dd>
227 <dd> 305 <dd>
228 revision info (string) 306 revision info (string)
229 </dd><dt><i>changedPaths</i></dt> 307 </dd><dt><i>changedPaths</i></dt>
230 <dd> 308 <dd>
231 list of dictionary objects containing 309 list of dictionary objects containing
232 info about the changed files/directories 310 info about the changed files/directories
311 </dd><dt><i>parents</i></dt>
312 <dd>
313 list of parent revisions (list of integers)
314 </dd><dt><i>branches</i></dt>
315 <dd>
316 list of branches (list of strings)
317 </dd><dt><i>tags</i></dt>
318 <dd>
319 list of tags (string)
233 </dd> 320 </dd>
234 </dl><dl> 321 </dl><dl>
235 <dt>Returns:</dt> 322 <dt>Returns:</dt>
236 <dd> 323 <dd>
237 reference to the generated item (QTreeWidgetItem) 324 reference to the generated item (QTreeWidgetItem)
325 </dd>
326 </dl><a NAME="HgLogBrowserDialog.__getColor" ID="HgLogBrowserDialog.__getColor"></a>
327 <h4>HgLogBrowserDialog.__getColor</h4>
328 <b>__getColor</b>(<i>n</i>)
329 <p>
330 Private method to get the (rotating) name of the color given an index.
331 </p><dl>
332 <dt><i>n</i></dt>
333 <dd>
334 color index (integer)
335 </dd>
336 </dl><dl>
337 <dt>Returns:</dt>
338 <dd>
339 color name (string)
238 </dd> 340 </dd>
239 </dl><a NAME="HgLogBrowserDialog.__getLogEntries" ID="HgLogBrowserDialog.__getLogEntries"></a> 341 </dl><a NAME="HgLogBrowserDialog.__getLogEntries" ID="HgLogBrowserDialog.__getLogEntries"></a>
240 <h4>HgLogBrowserDialog.__getLogEntries</h4> 342 <h4>HgLogBrowserDialog.__getLogEntries</h4>
241 <b>__getLogEntries</b>(<i>startRev = None</i>) 343 <b>__getLogEntries</b>(<i>startRev = None</i>)
242 <p> 344 <p>
292 </p><a NAME="HgLogBrowserDialog.__resortFiles" ID="HgLogBrowserDialog.__resortFiles"></a> 394 </p><a NAME="HgLogBrowserDialog.__resortFiles" ID="HgLogBrowserDialog.__resortFiles"></a>
293 <h4>HgLogBrowserDialog.__resortFiles</h4> 395 <h4>HgLogBrowserDialog.__resortFiles</h4>
294 <b>__resortFiles</b>(<i></i>) 396 <b>__resortFiles</b>(<i></i>)
295 <p> 397 <p>
296 Private method to resort the changed files tree. 398 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> 399 </p><a NAME="HgLogBrowserDialog.closeEvent" ID="HgLogBrowserDialog.closeEvent"></a>
303 <h4>HgLogBrowserDialog.closeEvent</h4> 400 <h4>HgLogBrowserDialog.closeEvent</h4>
304 <b>closeEvent</b>(<i>e</i>) 401 <b>closeEvent</b>(<i>e</i>)
305 <p> 402 <p>
306 Private slot implementing a close event handler. 403 Private slot implementing a close event handler.
307 </p><dl> 404 </p><dl>
308 <dt><i>e</i></dt> 405 <dt><i>e</i></dt>
309 <dd> 406 <dd>
310 close event (QCloseEvent) 407 close event (QCloseEvent)
311 </dd> 408 </dd>
312 </dl><a NAME="HgLogBrowserDialog.keyPressEvent" ID="HgLogBrowserDialog.keyPressEvent"></a> 409 </dl><a NAME="HgLogBrowserDialog.col2x" ID="HgLogBrowserDialog.col2x"></a>
410 <h4>HgLogBrowserDialog.col2x</h4>
411 <b>col2x</b>(<i>radius</i>)
412 <a NAME="HgLogBrowserDialog.keyPressEvent" ID="HgLogBrowserDialog.keyPressEvent"></a>
313 <h4>HgLogBrowserDialog.keyPressEvent</h4> 413 <h4>HgLogBrowserDialog.keyPressEvent</h4>
314 <b>keyPressEvent</b>(<i>evt</i>) 414 <b>keyPressEvent</b>(<i>evt</i>)
315 <p> 415 <p>
316 Protected slot to handle a key press event. 416 Protected slot to handle a key press event.
317 </p><dl> 417 </p><dl>

eric ide

mercurial