diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgServeDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgServeDialog.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,215 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.VcsPlugins.vcsMercurial.HgServeDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgServeDialog</h1> + +<p> +Module implementing a dialog for the Mercurial server. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#HgServeDialog">HgServeDialog</a></td> +<td>Class implementing a dialog for the Mercurial server.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="HgServeDialog" ID="HgServeDialog"></a> +<h2>HgServeDialog</h2> + +<p> + Class implementing a dialog for the Mercurial server. +</p> +<h3>Derived from</h3> +EricMainWindow +<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="#HgServeDialog.__init__">HgServeDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#HgServeDialog.__appendText">__appendText</a></td> +<td>Private method to append text to the end.</td> +</tr> +<tr> +<td><a href="#HgServeDialog.__procFinished">__procFinished</a></td> +<td>Private slot connected to the finished signal.</td> +</tr> +<tr> +<td><a href="#HgServeDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal.</td> +</tr> +<tr> +<td><a href="#HgServeDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal.</td> +</tr> +<tr> +<td><a href="#HgServeDialog.__startBrowser">__startBrowser</a></td> +<td>Private slot to start a browser for the served repository.</td> +</tr> +<tr> +<td><a href="#HgServeDialog.__startServer">__startServer</a></td> +<td>Private slot to start the Mercurial server.</td> +</tr> +<tr> +<td><a href="#HgServeDialog.__stopServer">__stopServer</a></td> +<td>Private slot to stop the Mercurial server.</td> +</tr> +<tr> +<td><a href="#HgServeDialog.closeEvent">closeEvent</a></td> +<td>Protected slot implementing a close event handler.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="HgServeDialog.__init__" ID="HgServeDialog.__init__"></a> +<h4>HgServeDialog (Constructor)</h4> +<b>HgServeDialog</b>(<i>vcs, path, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>vcs</i> (Hg)</dt> +<dd> +reference to the vcs object +</dd> +<dt><i>path</i> (str)</dt> +<dd> +path of the repository to serve +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="HgServeDialog.__appendText" ID="HgServeDialog.__appendText"></a> +<h4>HgServeDialog.__appendText</h4> +<b>__appendText</b>(<i>txt, error=False</i>) + +<p> + Private method to append text to the end. +</p> +<dl> + +<dt><i>txt</i> (str)</dt> +<dd> +text to insert +</dd> +<dt><i>error</i> (bool)</dt> +<dd> +flag indicating to insert error text +</dd> +</dl> +<a NAME="HgServeDialog.__procFinished" ID="HgServeDialog.__procFinished"></a> +<h4>HgServeDialog.__procFinished</h4> +<b>__procFinished</b>(<i>exitCode, exitStatus</i>) + +<p> + Private slot connected to the finished signal. +</p> +<dl> + +<dt><i>exitCode</i> (int)</dt> +<dd> +exit code of the process +</dd> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> +<dd> +exit status of the process +</dd> +</dl> +<a NAME="HgServeDialog.__readStderr" ID="HgServeDialog.__readStderr"></a> +<h4>HgServeDialog.__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 log. +</p> +<a NAME="HgServeDialog.__readStdout" ID="HgServeDialog.__readStdout"></a> +<h4>HgServeDialog.__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 the log. +</p> +<a NAME="HgServeDialog.__startBrowser" ID="HgServeDialog.__startBrowser"></a> +<h4>HgServeDialog.__startBrowser</h4> +<b>__startBrowser</b>(<i></i>) + +<p> + Private slot to start a browser for the served repository. +</p> +<a NAME="HgServeDialog.__startServer" ID="HgServeDialog.__startServer"></a> +<h4>HgServeDialog.__startServer</h4> +<b>__startServer</b>(<i></i>) + +<p> + Private slot to start the Mercurial server. +</p> +<a NAME="HgServeDialog.__stopServer" ID="HgServeDialog.__stopServer"></a> +<h4>HgServeDialog.__stopServer</h4> +<b>__stopServer</b>(<i></i>) + +<p> + Private slot to stop the Mercurial server. +</p> +<a NAME="HgServeDialog.closeEvent" ID="HgServeDialog.closeEvent"></a> +<h4>HgServeDialog.closeEvent</h4> +<b>closeEvent</b>(<i>e</i>) + +<p> + Protected slot implementing a close event handler. +</p> +<dl> + +<dt><i>e</i> (QCloseEvent)</dt> +<dd> +close event +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file