Sun, 18 May 2014 14:13:09 +0200
Corrected a bunch of source docu issues.
<!DOCTYPE html> <html><head> <title>eric5.Plugins.VcsPlugins.vcsPySvn.SvnLogBrowserDialog</title> <meta charset="UTF-8"> <style> body { background: #EDECE6; margin: 0em 1em 10em 1em; color: black; } h1 { color: white; background: #85774A; } h2 { color: white; background: #85774A; } h3 { color: white; background: #9D936E; } h4 { color: white; background: #9D936E; } a { color: #BA6D36; } </style> </head> <body><a NAME="top" ID="top"></a> <h1>eric5.Plugins.VcsPlugins.vcsPySvn.SvnLogBrowserDialog</h1> <p> Module implementing a dialog to browse the log history. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#SvnLogBrowserDialog">SvnLogBrowserDialog</a></td> <td>Class implementing a dialog to browse the log history.</td> </tr> </table> <h3>Functions</h3> <table> <tr><td>None</td></tr> </table> <hr /><hr /> <a NAME="SvnLogBrowserDialog" ID="SvnLogBrowserDialog"></a> <h2>SvnLogBrowserDialog</h2> <p> Class implementing a dialog to browse the log history. </p> <h3>Derived from</h3> QWidget, SvnDialogMixin, Ui_SvnLogBrowserDialog <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#SvnLogBrowserDialog.__init__">SvnLogBrowserDialog</a></td> <td>Constructor</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__diffRevisions">__diffRevisions</a></td> <td>Private method to do a diff of two revisions.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__filterLogs">__filterLogs</a></td> <td>Private method to filter the log entries.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__finish">__finish</a></td> <td>Private slot called when the user pressed the button.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__generateFileItem">__generateFileItem</a></td> <td>Private method to generate a changed files tree entry.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__generateLogItem">__generateLogItem</a></td> <td>Private method to generate a log tree entry.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__getLogEntries">__getLogEntries</a></td> <td>Private method to retrieve log entries from the repository.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__initData">__initData</a></td> <td>Private method to (re-)initialize some data.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__resetUI">__resetUI</a></td> <td>Private method to reset the user interface.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__resizeColumnsFiles">__resizeColumnsFiles</a></td> <td>Private method to resize the changed files tree columns.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__resizeColumnsLog">__resizeColumnsLog</a></td> <td>Private method to resize the log tree columns.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__resortFiles">__resortFiles</a></td> <td>Private method to resort the changed files tree.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__resortLog">__resortLog</a></td> <td>Private method to resort the log tree.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.__showError">__showError</a></td> <td>Private slot to show an error message.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog._reset">_reset</a></td> <td>Protected method to reset the internal state of the dialog.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.closeEvent">closeEvent</a></td> <td>Protected slot implementing a close event handler.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> <td>Private slot called by a button of the button box clicked.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_diffPreviousButton_clicked">on_diffPreviousButton_clicked</a></td> <td>Private slot to handle the Diff to Previous button.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_diffRevisionsButton_clicked">on_diffRevisionsButton_clicked</a></td> <td>Private slot to handle the Compare Revisions button.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_fieldCombo_activated">on_fieldCombo_activated</a></td> <td>Private slot called, when a new filter field is selected.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_fromDate_dateChanged">on_fromDate_dateChanged</a></td> <td>Private slot called, when the from date changes.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_logTree_currentItemChanged">on_logTree_currentItemChanged</a></td> <td>Private slot called, when the current item of the log tree changes.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_logTree_itemSelectionChanged">on_logTree_itemSelectionChanged</a></td> <td>Private slot called, when the selection has changed.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_nextButton_clicked">on_nextButton_clicked</a></td> <td>Private slot to handle the Next button.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_rxEdit_textChanged">on_rxEdit_textChanged</a></td> <td>Private slot called, when a filter expression is entered.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_stopCheckBox_clicked">on_stopCheckBox_clicked</a></td> <td>Private slot called, when the stop on copy/move checkbox is clicked.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.on_toDate_dateChanged">on_toDate_dateChanged</a></td> <td>Private slot called, when the from date changes.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.show">show</a></td> <td>Public slot to show the dialog.</td> </tr><tr> <td><a href="#SvnLogBrowserDialog.start">start</a></td> <td>Public slot to start the svn log command.</td> </tr> </table> <h3>Static Methods</h3> <table> <tr><td>None</td></tr> </table> <a NAME="SvnLogBrowserDialog.__init__" ID="SvnLogBrowserDialog.__init__"></a> <h4>SvnLogBrowserDialog (Constructor)</h4> <b>SvnLogBrowserDialog</b>(<i>vcs, parent=None</i>) <p> Constructor </p><dl> <dt><i>vcs</i></dt> <dd> reference to the vcs object </dd><dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> </dl><a NAME="SvnLogBrowserDialog.__diffRevisions" ID="SvnLogBrowserDialog.__diffRevisions"></a> <h4>SvnLogBrowserDialog.__diffRevisions</h4> <b>__diffRevisions</b>(<i>rev1, rev2, peg_rev</i>) <p> Private method to do a diff of two revisions. </p><dl> <dt><i>rev1</i></dt> <dd> first revision number (integer) </dd><dt><i>rev2</i></dt> <dd> second revision number (integer) </dd><dt><i>peg_rev</i></dt> <dd> revision number to use as a reference (integer) </dd> </dl><a NAME="SvnLogBrowserDialog.__filterLogs" ID="SvnLogBrowserDialog.__filterLogs"></a> <h4>SvnLogBrowserDialog.__filterLogs</h4> <b>__filterLogs</b>(<i></i>) <p> Private method to filter the log entries. </p><a NAME="SvnLogBrowserDialog.__finish" ID="SvnLogBrowserDialog.__finish"></a> <h4>SvnLogBrowserDialog.__finish</h4> <b>__finish</b>(<i></i>) <p> Private slot called when the user pressed the button. </p><a NAME="SvnLogBrowserDialog.__generateFileItem" ID="SvnLogBrowserDialog.__generateFileItem"></a> <h4>SvnLogBrowserDialog.__generateFileItem</h4> <b>__generateFileItem</b>(<i>action, path, copyFrom, copyRev</i>) <p> Private method to generate a changed files tree entry. </p><dl> <dt><i>action</i></dt> <dd> indicator for the change action ("A", "D" or "M") </dd><dt><i>path</i></dt> <dd> path of the file in the repository (string) </dd><dt><i>copyFrom</i></dt> <dd> path the file was copied from (None, string) </dd><dt><i>copyRev</i></dt> <dd> revision the file was copied from (None, string) </dd> </dl><dl> <dt>Returns:</dt> <dd> reference to the generated item (QTreeWidgetItem) </dd> </dl><a NAME="SvnLogBrowserDialog.__generateLogItem" ID="SvnLogBrowserDialog.__generateLogItem"></a> <h4>SvnLogBrowserDialog.__generateLogItem</h4> <b>__generateLogItem</b>(<i>author, date, message, revision, changedPaths</i>) <p> Private method to generate a log tree entry. </p><dl> <dt><i>author</i></dt> <dd> author info (string) </dd><dt><i>date</i></dt> <dd> date info (integer) </dd><dt><i>message</i></dt> <dd> text of the log message (string) </dd><dt><i>revision</i></dt> <dd> revision info (string or pysvn.opt_revision_kind) </dd><dt><i>changedPaths</i></dt> <dd> list of pysvn dictionary like objects containing info about the changed files/directories </dd> </dl><dl> <dt>Returns:</dt> <dd> reference to the generated item (QTreeWidgetItem) </dd> </dl><a NAME="SvnLogBrowserDialog.__getLogEntries" ID="SvnLogBrowserDialog.__getLogEntries"></a> <h4>SvnLogBrowserDialog.__getLogEntries</h4> <b>__getLogEntries</b>(<i>startRev=None</i>) <p> Private method to retrieve log entries from the repository. </p><dl> <dt><i>startRev</i></dt> <dd> revision number to start from (integer, string) </dd> </dl><a NAME="SvnLogBrowserDialog.__initData" ID="SvnLogBrowserDialog.__initData"></a> <h4>SvnLogBrowserDialog.__initData</h4> <b>__initData</b>(<i></i>) <p> Private method to (re-)initialize some data. </p><a NAME="SvnLogBrowserDialog.__resetUI" ID="SvnLogBrowserDialog.__resetUI"></a> <h4>SvnLogBrowserDialog.__resetUI</h4> <b>__resetUI</b>(<i></i>) <p> Private method to reset the user interface. </p><a NAME="SvnLogBrowserDialog.__resizeColumnsFiles" ID="SvnLogBrowserDialog.__resizeColumnsFiles"></a> <h4>SvnLogBrowserDialog.__resizeColumnsFiles</h4> <b>__resizeColumnsFiles</b>(<i></i>) <p> Private method to resize the changed files tree columns. </p><a NAME="SvnLogBrowserDialog.__resizeColumnsLog" ID="SvnLogBrowserDialog.__resizeColumnsLog"></a> <h4>SvnLogBrowserDialog.__resizeColumnsLog</h4> <b>__resizeColumnsLog</b>(<i></i>) <p> Private method to resize the log tree columns. </p><a NAME="SvnLogBrowserDialog.__resortFiles" ID="SvnLogBrowserDialog.__resortFiles"></a> <h4>SvnLogBrowserDialog.__resortFiles</h4> <b>__resortFiles</b>(<i></i>) <p> Private method to resort the changed files tree. </p><a NAME="SvnLogBrowserDialog.__resortLog" ID="SvnLogBrowserDialog.__resortLog"></a> <h4>SvnLogBrowserDialog.__resortLog</h4> <b>__resortLog</b>(<i></i>) <p> Private method to resort the log tree. </p><a NAME="SvnLogBrowserDialog.__showError" ID="SvnLogBrowserDialog.__showError"></a> <h4>SvnLogBrowserDialog.__showError</h4> <b>__showError</b>(<i>msg</i>) <p> Private slot to show an error message. </p><dl> <dt><i>msg</i></dt> <dd> error message to show (string) </dd> </dl><a NAME="SvnLogBrowserDialog._reset" ID="SvnLogBrowserDialog._reset"></a> <h4>SvnLogBrowserDialog._reset</h4> <b>_reset</b>(<i></i>) <p> Protected method to reset the internal state of the dialog. </p><a NAME="SvnLogBrowserDialog.closeEvent" ID="SvnLogBrowserDialog.closeEvent"></a> <h4>SvnLogBrowserDialog.closeEvent</h4> <b>closeEvent</b>(<i>e</i>) <p> Protected slot implementing a close event handler. </p><dl> <dt><i>e</i></dt> <dd> close event (QCloseEvent) </dd> </dl><a NAME="SvnLogBrowserDialog.on_buttonBox_clicked" ID="SvnLogBrowserDialog.on_buttonBox_clicked"></a> <h4>SvnLogBrowserDialog.on_buttonBox_clicked</h4> <b>on_buttonBox_clicked</b>(<i>button</i>) <p> Private slot called by a button of the button box clicked. </p><dl> <dt><i>button</i></dt> <dd> button that was clicked (QAbstractButton) </dd> </dl><a NAME="SvnLogBrowserDialog.on_diffPreviousButton_clicked" ID="SvnLogBrowserDialog.on_diffPreviousButton_clicked"></a> <h4>SvnLogBrowserDialog.on_diffPreviousButton_clicked</h4> <b>on_diffPreviousButton_clicked</b>(<i></i>) <p> Private slot to handle the Diff to Previous button. </p><a NAME="SvnLogBrowserDialog.on_diffRevisionsButton_clicked" ID="SvnLogBrowserDialog.on_diffRevisionsButton_clicked"></a> <h4>SvnLogBrowserDialog.on_diffRevisionsButton_clicked</h4> <b>on_diffRevisionsButton_clicked</b>(<i></i>) <p> Private slot to handle the Compare Revisions button. </p><a NAME="SvnLogBrowserDialog.on_fieldCombo_activated" ID="SvnLogBrowserDialog.on_fieldCombo_activated"></a> <h4>SvnLogBrowserDialog.on_fieldCombo_activated</h4> <b>on_fieldCombo_activated</b>(<i>txt</i>) <p> Private slot called, when a new filter field is selected. </p><dl> <dt><i>txt</i></dt> <dd> text of the selected field (string) </dd> </dl><a NAME="SvnLogBrowserDialog.on_fromDate_dateChanged" ID="SvnLogBrowserDialog.on_fromDate_dateChanged"></a> <h4>SvnLogBrowserDialog.on_fromDate_dateChanged</h4> <b>on_fromDate_dateChanged</b>(<i>date</i>) <p> Private slot called, when the from date changes. </p><dl> <dt><i>date</i></dt> <dd> new date (QDate) </dd> </dl><a NAME="SvnLogBrowserDialog.on_logTree_currentItemChanged" ID="SvnLogBrowserDialog.on_logTree_currentItemChanged"></a> <h4>SvnLogBrowserDialog.on_logTree_currentItemChanged</h4> <b>on_logTree_currentItemChanged</b>(<i>current, previous</i>) <p> Private slot called, when the current item of the log tree changes. </p><dl> <dt><i>current</i></dt> <dd> reference to the new current item (QTreeWidgetItem) </dd><dt><i>previous</i></dt> <dd> reference to the old current item (QTreeWidgetItem) </dd> </dl><a NAME="SvnLogBrowserDialog.on_logTree_itemSelectionChanged" ID="SvnLogBrowserDialog.on_logTree_itemSelectionChanged"></a> <h4>SvnLogBrowserDialog.on_logTree_itemSelectionChanged</h4> <b>on_logTree_itemSelectionChanged</b>(<i></i>) <p> Private slot called, when the selection has changed. </p><a NAME="SvnLogBrowserDialog.on_nextButton_clicked" ID="SvnLogBrowserDialog.on_nextButton_clicked"></a> <h4>SvnLogBrowserDialog.on_nextButton_clicked</h4> <b>on_nextButton_clicked</b>(<i></i>) <p> Private slot to handle the Next button. </p><a NAME="SvnLogBrowserDialog.on_rxEdit_textChanged" ID="SvnLogBrowserDialog.on_rxEdit_textChanged"></a> <h4>SvnLogBrowserDialog.on_rxEdit_textChanged</h4> <b>on_rxEdit_textChanged</b>(<i>txt</i>) <p> Private slot called, when a filter expression is entered. </p><dl> <dt><i>txt</i></dt> <dd> filter expression (string) </dd> </dl><a NAME="SvnLogBrowserDialog.on_stopCheckBox_clicked" ID="SvnLogBrowserDialog.on_stopCheckBox_clicked"></a> <h4>SvnLogBrowserDialog.on_stopCheckBox_clicked</h4> <b>on_stopCheckBox_clicked</b>(<i>checked</i>) <p> Private slot called, when the stop on copy/move checkbox is clicked. </p><dl> <dt><i>checked</i></dt> <dd> flag indicating the check box state (boolean) </dd> </dl><a NAME="SvnLogBrowserDialog.on_toDate_dateChanged" ID="SvnLogBrowserDialog.on_toDate_dateChanged"></a> <h4>SvnLogBrowserDialog.on_toDate_dateChanged</h4> <b>on_toDate_dateChanged</b>(<i>date</i>) <p> Private slot called, when the from date changes. </p><dl> <dt><i>date</i></dt> <dd> new date (QDate) </dd> </dl><a NAME="SvnLogBrowserDialog.show" ID="SvnLogBrowserDialog.show"></a> <h4>SvnLogBrowserDialog.show</h4> <b>show</b>(<i></i>) <p> Public slot to show the dialog. </p><a NAME="SvnLogBrowserDialog.start" ID="SvnLogBrowserDialog.start"></a> <h4>SvnLogBrowserDialog.start</h4> <b>start</b>(<i>fn, isFile=False</i>) <p> Public slot to start the svn log command. </p><dl> <dt><i>fn</i></dt> <dd> filename to show the log for (string) </dd><dt><i>isFile=</i></dt> <dd> flag indicating log for a file is to be shown (boolean) </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>