--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html Mon Apr 12 18:00:42 2010 +0000 @@ -0,0 +1,448 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>eric5.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog</title> +<style> +body { + background:white; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #4FA4FF; } +h2 { color: white; background: #4FA4FF; } +h3 { color: white; background: #00557F; } +h4 { color: white; background: #00557F; } + +a { color: #AA5500; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog</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="#HgLogBrowserDialog">HgLogBrowserDialog</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="HgLogBrowserDialog" ID="HgLogBrowserDialog"></a> +<h2>HgLogBrowserDialog</h2> +<p> + Class implementing a dialog to browse the log history. +</p> +<h3>Derived from</h3> +QDialog, Ui_HgLogBrowserDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#HgLogBrowserDialog.__init__">HgLogBrowserDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__diffRevisions">__diffRevisions</a></td> +<td>Private method to do a diff of two revisions.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__filterLogs">__filterLogs</a></td> +<td>Private method to filter the log entries.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__finish">__finish</a></td> +<td>Private slot called when the process finished or the user pressed the button.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__generateFileItem">__generateFileItem</a></td> +<td>Private method to generate a changed files tree entry.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__generateLogItem">__generateLogItem</a></td> +<td>Private method to generate a log tree entry.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__getLogEntries">__getLogEntries</a></td> +<td>Private method to retrieve log entries from the repository.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__procFinished">__procFinished</a></td> +<td>Private slot connected to the finished signal.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__processBuffer">__processBuffer</a></td> +<td>Private method to process the buffered output of the svn log command.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__resizeColumnsFiles">__resizeColumnsFiles</a></td> +<td>Private method to resize the changed files tree columns.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__resizeColumnsLog">__resizeColumnsLog</a></td> +<td>Private method to resize the log tree columns.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__resortFiles">__resortFiles</a></td> +<td>Private method to resort the changed files tree.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.__resortLog">__resortLog</a></td> +<td>Private method to resort the log tree.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.closeEvent">closeEvent</a></td> +<td>Private slot implementing a close event handler.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.keyPressEvent">keyPressEvent</a></td> +<td>Protected slot to handle a key press event.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.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="#HgLogBrowserDialog.on_clearRxEditButton_clicked">on_clearRxEditButton_clicked</a></td> +<td>Private slot called by a click of the clear RX edit button.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.on_diffPreviousButton_clicked">on_diffPreviousButton_clicked</a></td> +<td>Private slot to handle the Diff to Previous button.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.on_diffRevisionsButton_clicked">on_diffRevisionsButton_clicked</a></td> +<td>Private slot to handle the Compare Revisions button.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.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="#HgLogBrowserDialog.on_fromDate_dateChanged">on_fromDate_dateChanged</a></td> +<td>Private slot called, when the from date changes.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.on_input_returnPressed">on_input_returnPressed</a></td> +<td>Private slot to handle the press of the return key in the input field.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.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="#HgLogBrowserDialog.on_logTree_itemSelectionChanged">on_logTree_itemSelectionChanged</a></td> +<td>Private slot called, when the selection has changed.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.on_nextButton_clicked">on_nextButton_clicked</a></td> +<td>Private slot to handle the Next button.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> +<td>Private slot to handle the password checkbox toggled.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.on_rxEdit_textChanged">on_rxEdit_textChanged</a></td> +<td>Private slot called, when a filter expression is entered.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> +<td>Private slot to send the input to the merurial process.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.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="#HgLogBrowserDialog.on_toDate_dateChanged">on_toDate_dateChanged</a></td> +<td>Private slot called, when the from date changes.</td> +</tr><tr> +<td><a href="#HgLogBrowserDialog.start">start</a></td> +<td>Public slot to start the svn log command.</td> +</tr> +</table> +<a NAME="HgLogBrowserDialog.__init__" ID="HgLogBrowserDialog.__init__"></a> +<h4>HgLogBrowserDialog (Constructor)</h4> +<b>HgLogBrowserDialog</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="HgLogBrowserDialog.__diffRevisions" ID="HgLogBrowserDialog.__diffRevisions"></a> +<h4>HgLogBrowserDialog.__diffRevisions</h4> +<b>__diffRevisions</b>(<i>rev1, rev2</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> +</dl><a NAME="HgLogBrowserDialog.__filterLogs" ID="HgLogBrowserDialog.__filterLogs"></a> +<h4>HgLogBrowserDialog.__filterLogs</h4> +<b>__filterLogs</b>(<i></i>) +<p> + Private method to filter the log entries. +</p><a NAME="HgLogBrowserDialog.__finish" ID="HgLogBrowserDialog.__finish"></a> +<h4>HgLogBrowserDialog.__finish</h4> +<b>__finish</b>(<i></i>) +<p> + Private slot called when the process finished or the user pressed the button. +</p><a NAME="HgLogBrowserDialog.__generateFileItem" ID="HgLogBrowserDialog.__generateFileItem"></a> +<h4>HgLogBrowserDialog.__generateFileItem</h4> +<b>__generateFileItem</b>(<i>action, path</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> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the generated item (QTreeWidgetItem) +</dd> +</dl><a NAME="HgLogBrowserDialog.__generateLogItem" ID="HgLogBrowserDialog.__generateLogItem"></a> +<h4>HgLogBrowserDialog.__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 (string) +</dd><dt><i>message</i></dt> +<dd> +text of the log message (list of strings) +</dd><dt><i>revision</i></dt> +<dd> +revision info (string) +</dd><dt><i>changedPaths</i></dt> +<dd> +list of dictionary 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="HgLogBrowserDialog.__getLogEntries" ID="HgLogBrowserDialog.__getLogEntries"></a> +<h4>HgLogBrowserDialog.__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="HgLogBrowserDialog.__procFinished" ID="HgLogBrowserDialog.__procFinished"></a> +<h4>HgLogBrowserDialog.__procFinished</h4> +<b>__procFinished</b>(<i>exitCode, exitStatus</i>) +<p> + Private slot connected to the finished signal. +</p><dl> +<dt><i>exitCode</i></dt> +<dd> +exit code of the process (integer) +</dd><dt><i>exitStatus</i></dt> +<dd> +exit status of the process (QProcess.ExitStatus) +</dd> +</dl><a NAME="HgLogBrowserDialog.__processBuffer" ID="HgLogBrowserDialog.__processBuffer"></a> +<h4>HgLogBrowserDialog.__processBuffer</h4> +<b>__processBuffer</b>(<i></i>) +<p> + Private method to process the buffered output of the svn log command. +</p><a NAME="HgLogBrowserDialog.__readStderr" ID="HgLogBrowserDialog.__readStderr"></a> +<h4>HgLogBrowserDialog.__readStderr</h4> +<b>__readStderr</b>(<i></i>) +<p> + Private slot to handle the readyReadStandardError signal. +</p><p> + It reads the error output of the process and inserts it into the + error pane. +</p><a NAME="HgLogBrowserDialog.__readStdout" ID="HgLogBrowserDialog.__readStdout"></a> +<h4>HgLogBrowserDialog.__readStdout</h4> +<b>__readStdout</b>(<i></i>) +<p> + Private slot to handle the readyReadStandardOutput signal. +</p><p> + It reads the output of the process and inserts it into a buffer. +</p><a NAME="HgLogBrowserDialog.__resizeColumnsFiles" ID="HgLogBrowserDialog.__resizeColumnsFiles"></a> +<h4>HgLogBrowserDialog.__resizeColumnsFiles</h4> +<b>__resizeColumnsFiles</b>(<i></i>) +<p> + Private method to resize the changed files tree columns. +</p><a NAME="HgLogBrowserDialog.__resizeColumnsLog" ID="HgLogBrowserDialog.__resizeColumnsLog"></a> +<h4>HgLogBrowserDialog.__resizeColumnsLog</h4> +<b>__resizeColumnsLog</b>(<i></i>) +<p> + Private method to resize the log tree columns. +</p><a NAME="HgLogBrowserDialog.__resortFiles" ID="HgLogBrowserDialog.__resortFiles"></a> +<h4>HgLogBrowserDialog.__resortFiles</h4> +<b>__resortFiles</b>(<i></i>) +<p> + Private method to resort the changed files tree. +</p><a NAME="HgLogBrowserDialog.__resortLog" ID="HgLogBrowserDialog.__resortLog"></a> +<h4>HgLogBrowserDialog.__resortLog</h4> +<b>__resortLog</b>(<i></i>) +<p> + Private method to resort the log tree. +</p><a NAME="HgLogBrowserDialog.closeEvent" ID="HgLogBrowserDialog.closeEvent"></a> +<h4>HgLogBrowserDialog.closeEvent</h4> +<b>closeEvent</b>(<i>e</i>) +<p> + Private slot implementing a close event handler. +</p><dl> +<dt><i>e</i></dt> +<dd> +close event (QCloseEvent) +</dd> +</dl><a NAME="HgLogBrowserDialog.keyPressEvent" ID="HgLogBrowserDialog.keyPressEvent"></a> +<h4>HgLogBrowserDialog.keyPressEvent</h4> +<b>keyPressEvent</b>(<i>evt</i>) +<p> + Protected slot to handle a key press event. +</p><dl> +<dt><i>evt</i></dt> +<dd> +the key press event (QKeyEvent) +</dd> +</dl><a NAME="HgLogBrowserDialog.on_buttonBox_clicked" ID="HgLogBrowserDialog.on_buttonBox_clicked"></a> +<h4>HgLogBrowserDialog.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="HgLogBrowserDialog.on_clearRxEditButton_clicked" ID="HgLogBrowserDialog.on_clearRxEditButton_clicked"></a> +<h4>HgLogBrowserDialog.on_clearRxEditButton_clicked</h4> +<b>on_clearRxEditButton_clicked</b>(<i></i>) +<p> + Private slot called by a click of the clear RX edit button. +</p><a NAME="HgLogBrowserDialog.on_diffPreviousButton_clicked" ID="HgLogBrowserDialog.on_diffPreviousButton_clicked"></a> +<h4>HgLogBrowserDialog.on_diffPreviousButton_clicked</h4> +<b>on_diffPreviousButton_clicked</b>(<i></i>) +<p> + Private slot to handle the Diff to Previous button. +</p><a NAME="HgLogBrowserDialog.on_diffRevisionsButton_clicked" ID="HgLogBrowserDialog.on_diffRevisionsButton_clicked"></a> +<h4>HgLogBrowserDialog.on_diffRevisionsButton_clicked</h4> +<b>on_diffRevisionsButton_clicked</b>(<i></i>) +<p> + Private slot to handle the Compare Revisions button. +</p><a NAME="HgLogBrowserDialog.on_fieldCombo_activated" ID="HgLogBrowserDialog.on_fieldCombo_activated"></a> +<h4>HgLogBrowserDialog.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="HgLogBrowserDialog.on_fromDate_dateChanged" ID="HgLogBrowserDialog.on_fromDate_dateChanged"></a> +<h4>HgLogBrowserDialog.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="HgLogBrowserDialog.on_input_returnPressed" ID="HgLogBrowserDialog.on_input_returnPressed"></a> +<h4>HgLogBrowserDialog.on_input_returnPressed</h4> +<b>on_input_returnPressed</b>(<i></i>) +<p> + Private slot to handle the press of the return key in the input field. +</p><a NAME="HgLogBrowserDialog.on_logTree_currentItemChanged" ID="HgLogBrowserDialog.on_logTree_currentItemChanged"></a> +<h4>HgLogBrowserDialog.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="HgLogBrowserDialog.on_logTree_itemSelectionChanged" ID="HgLogBrowserDialog.on_logTree_itemSelectionChanged"></a> +<h4>HgLogBrowserDialog.on_logTree_itemSelectionChanged</h4> +<b>on_logTree_itemSelectionChanged</b>(<i></i>) +<p> + Private slot called, when the selection has changed. +</p><a NAME="HgLogBrowserDialog.on_nextButton_clicked" ID="HgLogBrowserDialog.on_nextButton_clicked"></a> +<h4>HgLogBrowserDialog.on_nextButton_clicked</h4> +<b>on_nextButton_clicked</b>(<i></i>) +<p> + Private slot to handle the Next button. +</p><a NAME="HgLogBrowserDialog.on_passwordCheckBox_toggled" ID="HgLogBrowserDialog.on_passwordCheckBox_toggled"></a> +<h4>HgLogBrowserDialog.on_passwordCheckBox_toggled</h4> +<b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) +<p> + Private slot to handle the password checkbox toggled. +</p><dl> +<dt><i>isOn</i></dt> +<dd> +flag indicating the status of the check box (boolean) +</dd> +</dl><a NAME="HgLogBrowserDialog.on_rxEdit_textChanged" ID="HgLogBrowserDialog.on_rxEdit_textChanged"></a> +<h4>HgLogBrowserDialog.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="HgLogBrowserDialog.on_sendButton_clicked" ID="HgLogBrowserDialog.on_sendButton_clicked"></a> +<h4>HgLogBrowserDialog.on_sendButton_clicked</h4> +<b>on_sendButton_clicked</b>(<i></i>) +<p> + Private slot to send the input to the merurial process. +</p><a NAME="HgLogBrowserDialog.on_stopCheckBox_clicked" ID="HgLogBrowserDialog.on_stopCheckBox_clicked"></a> +<h4>HgLogBrowserDialog.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><a NAME="HgLogBrowserDialog.on_toDate_dateChanged" ID="HgLogBrowserDialog.on_toDate_dateChanged"></a> +<h4>HgLogBrowserDialog.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="HgLogBrowserDialog.start" ID="HgLogBrowserDialog.start"></a> +<h4>HgLogBrowserDialog.start</h4> +<b>start</b>(<i>fn</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> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file