--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgServeDialog.html Sat May 29 17:52:59 2010 +0200
@@ -0,0 +1,169 @@
+<?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.HgServeDialog</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.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>
+QMainWindow
+<h3>Class Attributes</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>Public 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>Private slot implementing a close event handler.</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></dt>
+<dd>
+reference to the vcs object
+</dd><dt><i>path</i></dt>
+<dd>
+path of the repository to serve (string)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="HgServeDialog.__appendText" ID="HgServeDialog.__appendText"></a>
+<h4>HgServeDialog.__appendText</h4>
+<b>__appendText</b>(<i>txt, error = False</i>)
+<p>
+ Public method to append text to the end.
+</p><dl>
+<dt><i>txt</i></dt>
+<dd>
+text to insert (string)
+</dd><dt><i>error</i></dt>
+<dd>
+flag indicating to insert error text (boolean)
+</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></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="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>
+ Private slot implementing a close event handler.
+</p><dl>
+<dt><i>e</i></dt>
+<dd>
+close event (QCloseEvent)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
