Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesHeaderDialog.html

<!DOCTYPE html>
<html><head>
<title>eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesHeaderDialog</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.vcsMercurial.QueuesExtension.HgQueuesHeaderDialog</h1>
<p>
Module implementing a dialog to show the commit message of the current patch.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgQueuesHeaderDialog">HgQueuesHeaderDialog</a></td>
<td>Class implementing a dialog to show the commit message of the current patch.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="HgQueuesHeaderDialog" ID="HgQueuesHeaderDialog"></a>
<h2>HgQueuesHeaderDialog</h2>
<p>
    Class implementing a dialog to show the commit message of the current patch.
</p>
<h3>Derived from</h3>
QDialog, Ui_HgQueuesHeaderDialog
<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="#HgQueuesHeaderDialog.__init__">HgQueuesHeaderDialog</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#HgQueuesHeaderDialog.__finish">__finish</a></td>
<td>Private slot called when the process finished or the user pressed the button.</td>
</tr><tr>
<td><a href="#HgQueuesHeaderDialog.__procFinished">__procFinished</a></td>
<td>Private slot connected to the finished signal.</td>
</tr><tr>
<td><a href="#HgQueuesHeaderDialog.__readStderr">__readStderr</a></td>
<td>Private slot to handle the readyReadStderr signal.</td>
</tr><tr>
<td><a href="#HgQueuesHeaderDialog.__readStdout">__readStdout</a></td>
<td>Private slot to handle the readyReadStdout signal.</td>
</tr><tr>
<td><a href="#HgQueuesHeaderDialog.__showError">__showError</a></td>
<td>Private slot to show some error.</td>
</tr><tr>
<td><a href="#HgQueuesHeaderDialog.__showOutput">__showOutput</a></td>
<td>Private slot to show some output.</td>
</tr><tr>
<td><a href="#HgQueuesHeaderDialog.closeEvent">closeEvent</a></td>
<td>Private slot implementing a close event handler.</td>
</tr><tr>
<td><a href="#HgQueuesHeaderDialog.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="#HgQueuesHeaderDialog.start">start</a></td>
<td>Public slot to start the list command.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="HgQueuesHeaderDialog.__init__" ID="HgQueuesHeaderDialog.__init__"></a>
<h4>HgQueuesHeaderDialog (Constructor)</h4>
<b>HgQueuesHeaderDialog</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>
reference to the parent widget (QWidget)
</dd>
</dl><a NAME="HgQueuesHeaderDialog.__finish" ID="HgQueuesHeaderDialog.__finish"></a>
<h4>HgQueuesHeaderDialog.__finish</h4>
<b>__finish</b>(<i></i>)
<p>
        Private slot called when the process finished or the user pressed the button.
</p><a NAME="HgQueuesHeaderDialog.__procFinished" ID="HgQueuesHeaderDialog.__procFinished"></a>
<h4>HgQueuesHeaderDialog.__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="HgQueuesHeaderDialog.__readStderr" ID="HgQueuesHeaderDialog.__readStderr"></a>
<h4>HgQueuesHeaderDialog.__readStderr</h4>
<b>__readStderr</b>(<i></i>)
<p>
        Private slot to handle the readyReadStderr signal.
</p><p>
        It reads the error output of the process and inserts it into the
        error pane.
</p><a NAME="HgQueuesHeaderDialog.__readStdout" ID="HgQueuesHeaderDialog.__readStdout"></a>
<h4>HgQueuesHeaderDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)
<p>
        Private slot to handle the readyReadStdout signal.
</p><p>
        It reads the output of the process, formats it and inserts it into
        the contents pane.
</p><a NAME="HgQueuesHeaderDialog.__showError" ID="HgQueuesHeaderDialog.__showError"></a>
<h4>HgQueuesHeaderDialog.__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="HgQueuesHeaderDialog.__showOutput" ID="HgQueuesHeaderDialog.__showOutput"></a>
<h4>HgQueuesHeaderDialog.__showOutput</h4>
<b>__showOutput</b>(<i>out</i>)
<p>
        Private slot to show some output.
</p><dl>
<dt><i>out</i></dt>
<dd>
output to be shown (string)
</dd>
</dl><a NAME="HgQueuesHeaderDialog.closeEvent" ID="HgQueuesHeaderDialog.closeEvent"></a>
<h4>HgQueuesHeaderDialog.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="HgQueuesHeaderDialog.on_buttonBox_clicked" ID="HgQueuesHeaderDialog.on_buttonBox_clicked"></a>
<h4>HgQueuesHeaderDialog.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="HgQueuesHeaderDialog.start" ID="HgQueuesHeaderDialog.start"></a>
<h4>HgQueuesHeaderDialog.start</h4>
<b>start</b>(<i>path</i>)
<p>
        Public slot to start the list command.
</p><dl>
<dt><i>path</i></dt>
<dd>
name of directory to be listed (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>