src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgClientPromptDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.HgClientPromptDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgClientPromptDialog</h1>
<p>
Module implementing a prompt dialog for the Mercurial command server.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgClientPromptDialog">HgClientPromptDialog</a></td>
<td>Class implementing a prompt dialog for the Mercurial command server.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="HgClientPromptDialog" ID="HgClientPromptDialog"></a>
<h2>HgClientPromptDialog</h2>
<p>
    Class implementing a prompt dialog for the Mercurial command server.
</p>

<h3>Derived from</h3>
QDialog, Ui_HgClientPromptDialog
<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="#HgClientPromptDialog.__init__">HgClientPromptDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgClientPromptDialog.getInput">getInput</a></td>
<td>Public method to get the user input.</td>
</tr>
<tr>
<td><a href="#HgClientPromptDialog.isPassword">isPassword</a></td>
<td>Public method to check, if the input was a password.</td>
</tr>
<tr>
<td><a href="#HgClientPromptDialog.on_inputEdit_textChanged">on_inputEdit_textChanged</a></td>
<td>Private slot to handle changes of the user input.</td>
</tr>
<tr>
<td><a href="#HgClientPromptDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
<td>Private slot to handle the password checkbox toggled.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="HgClientPromptDialog.__init__" ID="HgClientPromptDialog.__init__"></a>
<h4>HgClientPromptDialog (Constructor)</h4>
<b>HgClientPromptDialog</b>(<i>size, message, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>size</i> (int)</dt>
<dd>
maximum length of the requested input
</dd>
<dt><i>message</i> (str)</dt>
<dd>
message sent by the server
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="HgClientPromptDialog.getInput" ID="HgClientPromptDialog.getInput"></a>
<h4>HgClientPromptDialog.getInput</h4>
<b>getInput</b>(<i></i>)
<p>
        Public method to get the user input.
</p>

<dl>
<dt>Return:</dt>
<dd>
user input
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="HgClientPromptDialog.isPassword" ID="HgClientPromptDialog.isPassword"></a>
<h4>HgClientPromptDialog.isPassword</h4>
<b>isPassword</b>(<i></i>)
<p>
        Public method to check, if the input was a password.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating a password
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="HgClientPromptDialog.on_inputEdit_textChanged" ID="HgClientPromptDialog.on_inputEdit_textChanged"></a>
<h4>HgClientPromptDialog.on_inputEdit_textChanged</h4>
<b>on_inputEdit_textChanged</b>(<i>txt</i>)
<p>
        Private slot to handle changes of the user input.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
text entered by the user
</dd>
</dl>
<a NAME="HgClientPromptDialog.on_passwordCheckBox_toggled" ID="HgClientPromptDialog.on_passwordCheckBox_toggled"></a>
<h4>HgClientPromptDialog.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> (bool)</dt>
<dd>
flag indicating the status of the check box
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>