--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgClientPromptDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgClientPromptDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,122 +18,160 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.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 /> +<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> +</tr> +<tr> <td><a href="#HgClientPromptDialog.getInput">getInput</a></td> <td>Public method to get the user input.</td> -</tr><tr> +</tr> +<tr> <td><a href="#HgClientPromptDialog.isPassword">isPassword</a></td> <td>Public method to check, if the input was a password.</td> -</tr><tr> +</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> +</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> +</p> +<dl> + <dt><i>size</i></dt> <dd> maximum length of the requested input (integer) -</dd><dt><i>message</i></dt> +</dd> +<dt><i>message</i></dt> <dd> message sent by the server (string) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="HgClientPromptDialog.getInput" ID="HgClientPromptDialog.getInput"></a> +</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> +</p> +<dl> <dt>Returns:</dt> <dd> user input (string) </dd> -</dl><a NAME="HgClientPromptDialog.isPassword" ID="HgClientPromptDialog.isPassword"></a> +</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> +</p> +<dl> <dt>Returns:</dt> <dd> flag indicating a password </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="HgClientPromptDialog.on_inputEdit_textChanged" ID="HgClientPromptDialog.on_inputEdit_textChanged"></a> +</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> +</p> +<dl> + <dt><i>txt</i></dt> <dd> text entered by the user (string) </dd> -</dl><a NAME="HgClientPromptDialog.on_passwordCheckBox_toggled" ID="HgClientPromptDialog.on_passwordCheckBox_toggled"></a> +</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> +</p> +<dl> + <dt><i>isOn</i></dt> <dd> flag indicating the status of the check box (boolean)