--- a/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgLogDialog.html Fri Jan 27 19:18:52 2017 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,275 +0,0 @@
-<!DOCTYPE html>
-<html><head>
-<title>eric6.Plugins.VcsPlugins.vcsMercurial.HgLogDialog</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>eric6.Plugins.VcsPlugins.vcsMercurial.HgLogDialog</h1>
-<p>
-Module implementing a dialog to show the output of the hg log command process.
-</p>
-<h3>Global Attributes</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Classes</h3>
-<table>
-<tr>
-<td><a href="#HgLogDialog">HgLogDialog</a></td>
-<td>Class implementing a dialog to show the output of the hg log command process.</td>
-</tr>
-</table>
-<h3>Functions</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<hr /><hr />
-<a NAME="HgLogDialog" ID="HgLogDialog"></a>
-<h2>HgLogDialog</h2>
-<p>
- Class implementing a dialog to show the output of the hg log command
- process.
-</p><p>
- The dialog is nonmodal. Clicking a link in the upper text pane shows
- a diff of the revisions.
-</p>
-<h3>Derived from</h3>
-QWidget, Ui_HgLogDialog
-<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="#HgLogDialog.__init__">HgLogDialog</a></td>
-<td>Constructor</td>
-</tr><tr>
-<td><a href="#HgLogDialog.__finish">__finish</a></td>
-<td>Private slot called when the process finished or the user pressed the button.</td>
-</tr><tr>
-<td><a href="#HgLogDialog.__getParents">__getParents</a></td>
-<td>Private method to get the parents of the currently viewed file/directory.</td>
-</tr><tr>
-<td><a href="#HgLogDialog.__procFinished">__procFinished</a></td>
-<td>Private slot connected to the finished signal.</td>
-</tr><tr>
-<td><a href="#HgLogDialog.__processOutputLine">__processOutputLine</a></td>
-<td>Private method to process the lines of output.</td>
-</tr><tr>
-<td><a href="#HgLogDialog.__readStderr">__readStderr</a></td>
-<td>Private slot to handle the readyReadStandardError signal.</td>
-</tr><tr>
-<td><a href="#HgLogDialog.__readStdout">__readStdout</a></td>
-<td>Private slot to handle the readyReadStandardOutput signal.</td>
-</tr><tr>
-<td><a href="#HgLogDialog.__showError">__showError</a></td>
-<td>Private slot to show some error.</td>
-</tr><tr>
-<td><a href="#HgLogDialog.__sourceChanged">__sourceChanged</a></td>
-<td>Private slot to handle the sourceChanged signal of the contents pane.</td>
-</tr><tr>
-<td><a href="#HgLogDialog.closeEvent">closeEvent</a></td>
-<td>Protected slot implementing a close event handler.</td>
-</tr><tr>
-<td><a href="#HgLogDialog.keyPressEvent">keyPressEvent</a></td>
-<td>Protected slot to handle a key press event.</td>
-</tr><tr>
-<td><a href="#HgLogDialog.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="#HgLogDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
-<td>Private slot to handle the password checkbox toggled.</td>
-</tr><tr>
-<td><a href="#HgLogDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
-<td>Private slot to send the input to the hg process.</td>
-</tr><tr>
-<td><a href="#HgLogDialog.start">start</a></td>
-<td>Public slot to start the hg log command.</td>
-</tr>
-</table>
-<h3>Static Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<a NAME="HgLogDialog.__init__" ID="HgLogDialog.__init__"></a>
-<h4>HgLogDialog (Constructor)</h4>
-<b>HgLogDialog</b>(<i>vcs, mode="log", bundle=None, isFile=False, parent=None</i>)
-<p>
- Constructor
-</p><dl>
-<dt><i>vcs</i></dt>
-<dd>
-reference to the vcs object
-</dd><dt><i>mode</i></dt>
-<dd>
-mode of the dialog (string; one of log, incoming, outgoing)
-</dd><dt><i>bundle</i></dt>
-<dd>
-name of a bundle file (string)
-</dd><dt><i>isFile</i></dt>
-<dd>
-flag indicating log for a file is to be shown (boolean)
-</dd><dt><i>parent</i></dt>
-<dd>
-parent widget (QWidget)
-</dd>
-</dl><a NAME="HgLogDialog.__finish" ID="HgLogDialog.__finish"></a>
-<h4>HgLogDialog.__finish</h4>
-<b>__finish</b>(<i></i>)
-<p>
- Private slot called when the process finished or the user pressed
- the button.
-</p><a NAME="HgLogDialog.__getParents" ID="HgLogDialog.__getParents"></a>
-<h4>HgLogDialog.__getParents</h4>
-<b>__getParents</b>(<i>rev</i>)
-<p>
- Private method to get the parents of the currently viewed
- file/directory.
-</p><dl>
-<dt><i>rev</i></dt>
-<dd>
-revision number to get parents for (string)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-list of parent revisions (list of strings)
-</dd>
-</dl><a NAME="HgLogDialog.__procFinished" ID="HgLogDialog.__procFinished"></a>
-<h4>HgLogDialog.__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="HgLogDialog.__processOutputLine" ID="HgLogDialog.__processOutputLine"></a>
-<h4>HgLogDialog.__processOutputLine</h4>
-<b>__processOutputLine</b>(<i>line</i>)
-<p>
- Private method to process the lines of output.
-</p><dl>
-<dt><i>line</i></dt>
-<dd>
-output line to be processed (string)
-</dd>
-</dl><a NAME="HgLogDialog.__readStderr" ID="HgLogDialog.__readStderr"></a>
-<h4>HgLogDialog.__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="HgLogDialog.__readStdout" ID="HgLogDialog.__readStdout"></a>
-<h4>HgLogDialog.__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="HgLogDialog.__showError" ID="HgLogDialog.__showError"></a>
-<h4>HgLogDialog.__showError</h4>
-<b>__showError</b>(<i>out</i>)
-<p>
- Private slot to show some error.
-</p><dl>
-<dt><i>out</i></dt>
-<dd>
-error to be shown (string)
-</dd>
-</dl><a NAME="HgLogDialog.__sourceChanged" ID="HgLogDialog.__sourceChanged"></a>
-<h4>HgLogDialog.__sourceChanged</h4>
-<b>__sourceChanged</b>(<i>url</i>)
-<p>
- Private slot to handle the sourceChanged signal of the contents pane.
-</p><dl>
-<dt><i>url</i></dt>
-<dd>
-the url that was clicked (QUrl)
-</dd>
-</dl><a NAME="HgLogDialog.closeEvent" ID="HgLogDialog.closeEvent"></a>
-<h4>HgLogDialog.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="HgLogDialog.keyPressEvent" ID="HgLogDialog.keyPressEvent"></a>
-<h4>HgLogDialog.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="HgLogDialog.on_input_returnPressed" ID="HgLogDialog.on_input_returnPressed"></a>
-<h4>HgLogDialog.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="HgLogDialog.on_passwordCheckBox_toggled" ID="HgLogDialog.on_passwordCheckBox_toggled"></a>
-<h4>HgLogDialog.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="HgLogDialog.on_sendButton_clicked" ID="HgLogDialog.on_sendButton_clicked"></a>
-<h4>HgLogDialog.on_sendButton_clicked</h4>
-<b>on_sendButton_clicked</b>(<i></i>)
-<p>
- Private slot to send the input to the hg process.
-</p><a NAME="HgLogDialog.start" ID="HgLogDialog.start"></a>
-<h4>HgLogDialog.start</h4>
-<b>start</b>(<i>fn, noEntries=0, revisions=None</i>)
-<p>
- Public slot to start the hg log command.
-</p><dl>
-<dt><i>fn</i></dt>
-<dd>
-filename to show the log for (string)
-</dd><dt><i>noEntries</i></dt>
-<dd>
-number of entries to show (integer)
-</dd><dt><i>revisions</i></dt>
-<dd>
-revisions to show log for (list of strings)
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr />
-</body></html>
\ No newline at end of file
