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

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.HgUserConfigHostMinimumProtocolDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgUserConfigHostMinimumProtocolDialog</h1>
<p>
Module implementing a dialog to enter the minimum protocol for a host.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgUserConfigHostMinimumProtocolDialog">HgUserConfigHostMinimumProtocolDialog</a></td>
<td>Class implementing a dialog to enter the minimum protocol for a host.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="HgUserConfigHostMinimumProtocolDialog" ID="HgUserConfigHostMinimumProtocolDialog"></a>
<h2>HgUserConfigHostMinimumProtocolDialog</h2>
<p>
    Class implementing a dialog to enter the minimum protocol for a host.
</p>

<h3>Derived from</h3>
QDialog, Ui_HgUserConfigHostMinimumProtocolDialog
<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="#HgUserConfigHostMinimumProtocolDialog.__init__">HgUserConfigHostMinimumProtocolDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgUserConfigHostMinimumProtocolDialog.__updateOkButton">__updateOkButton</a></td>
<td>Private method to update the status of the Ok button.</td>
</tr>
<tr>
<td><a href="#HgUserConfigHostMinimumProtocolDialog.getData">getData</a></td>
<td>Public method to retrieve the data.</td>
</tr>
<tr>
<td><a href="#HgUserConfigHostMinimumProtocolDialog.on_hostEdit_textChanged">on_hostEdit_textChanged</a></td>
<td>Private slot to handle changes of the host edit.</td>
</tr>
<tr>
<td><a href="#HgUserConfigHostMinimumProtocolDialog.on_minimumProtocolComboBox_currentIndexChanged">on_minimumProtocolComboBox_currentIndexChanged</a></td>
<td>Private slot to handle the selection of a minimum protocol.</td>
</tr>
</table>

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


<a NAME="HgUserConfigHostMinimumProtocolDialog.__init__" ID="HgUserConfigHostMinimumProtocolDialog.__init__"></a>
<h4>HgUserConfigHostMinimumProtocolDialog (Constructor)</h4>
<b>HgUserConfigHostMinimumProtocolDialog</b>(<i>allowedProtocols, parent=None, host="", protocol=""</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>allowedProtocols</i> (dict)</dt>
<dd>
dictionary containing the allowed protocols
            with the value as key and the display string as value
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
<dt><i>host</i> (str)</dt>
<dd>
host name
</dd>
<dt><i>protocol</i> (str)</dt>
<dd>
name of the minimum protocol for the host
</dd>
</dl>
<a NAME="HgUserConfigHostMinimumProtocolDialog.__updateOkButton" ID="HgUserConfigHostMinimumProtocolDialog.__updateOkButton"></a>
<h4>HgUserConfigHostMinimumProtocolDialog.__updateOkButton</h4>
<b>__updateOkButton</b>(<i></i>)
<p>
        Private method to update the status of the Ok button.
</p>

<a NAME="HgUserConfigHostMinimumProtocolDialog.getData" ID="HgUserConfigHostMinimumProtocolDialog.getData"></a>
<h4>HgUserConfigHostMinimumProtocolDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to retrieve the data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containig the host name and the minimum protocol
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of two str
</dd>
</dl>
<a NAME="HgUserConfigHostMinimumProtocolDialog.on_hostEdit_textChanged" ID="HgUserConfigHostMinimumProtocolDialog.on_hostEdit_textChanged"></a>
<h4>HgUserConfigHostMinimumProtocolDialog.on_hostEdit_textChanged</h4>
<b>on_hostEdit_textChanged</b>(<i>_txt</i>)
<p>
        Private slot to handle changes of the host edit.
</p>

<dl>

<dt><i>_txt</i> (str)</dt>
<dd>
current text (unused)
</dd>
</dl>
<a NAME="HgUserConfigHostMinimumProtocolDialog.on_minimumProtocolComboBox_currentIndexChanged" ID="HgUserConfigHostMinimumProtocolDialog.on_minimumProtocolComboBox_currentIndexChanged"></a>
<h4>HgUserConfigHostMinimumProtocolDialog.on_minimumProtocolComboBox_currentIndexChanged</h4>
<b>on_minimumProtocolComboBox_currentIndexChanged</b>(<i>index</i>)
<p>
        Private slot to handle the selection of a minimum protocol.
</p>

<dl>

<dt><i>index</i> (int)</dt>
<dd>
index of the selected entry
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>