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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgUserConfigHostMinimumProtocolDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgUserConfigHostMinimumProtocolDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter the minimum protocol for a host.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#HgUserConfigHostMinimumProtocolDialog">HgUserConfigHostMinimumProtocolDialog</a></td>
25 <td>Class implementing a dialog to enter the minimum protocol for a host.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="HgUserConfigHostMinimumProtocolDialog" ID="HgUserConfigHostMinimumProtocolDialog"></a>
36 <h2>HgUserConfigHostMinimumProtocolDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter the minimum protocol for a host.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_HgUserConfigHostMinimumProtocolDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#HgUserConfigHostMinimumProtocolDialog.__init__">HgUserConfigHostMinimumProtocolDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#HgUserConfigHostMinimumProtocolDialog.__updateOkButton">__updateOkButton</a></td>
63 <td>Private method to update the status of the Ok button.</td>
64 </tr>
65 <tr>
66 <td><a href="#HgUserConfigHostMinimumProtocolDialog.getData">getData</a></td>
67 <td>Public method to retrieve the data.</td>
68 </tr>
69 <tr>
70 <td><a href="#HgUserConfigHostMinimumProtocolDialog.on_hostEdit_textChanged">on_hostEdit_textChanged</a></td>
71 <td>Private slot to handle changes of the host edit.</td>
72 </tr>
73 <tr>
74 <td><a href="#HgUserConfigHostMinimumProtocolDialog.on_minimumProtocolComboBox_currentIndexChanged">on_minimumProtocolComboBox_currentIndexChanged</a></td>
75 <td>Private slot to handle the selection of a minimum protocol.</td>
76 </tr>
77 </table>
78 <h3>Static Methods</h3>
79
80 <table>
81 <tr><td>None</td></tr>
82 </table>
83
84 <a NAME="HgUserConfigHostMinimumProtocolDialog.__init__" ID="HgUserConfigHostMinimumProtocolDialog.__init__"></a>
85 <h4>HgUserConfigHostMinimumProtocolDialog (Constructor)</h4>
86 <b>HgUserConfigHostMinimumProtocolDialog</b>(<i>allowedProtocols, parent=None, host="", protocol=""</i>)
87
88 <p>
89 Constructor
90 </p>
91 <dl>
92
93 <dt><i>allowedProtocols</i> (dict)</dt>
94 <dd>
95 dictionary containing the allowed protocols
96 with the value as key and the display string as value
97 </dd>
98 <dt><i>parent</i> (QWidget)</dt>
99 <dd>
100 reference to the parent widget
101 </dd>
102 <dt><i>host</i> (str)</dt>
103 <dd>
104 host name
105 </dd>
106 <dt><i>protocol</i> (str)</dt>
107 <dd>
108 name of the minimum protocol for the host
109 </dd>
110 </dl>
111 <a NAME="HgUserConfigHostMinimumProtocolDialog.__updateOkButton" ID="HgUserConfigHostMinimumProtocolDialog.__updateOkButton"></a>
112 <h4>HgUserConfigHostMinimumProtocolDialog.__updateOkButton</h4>
113 <b>__updateOkButton</b>(<i></i>)
114
115 <p>
116 Private method to update the status of the Ok button.
117 </p>
118 <a NAME="HgUserConfigHostMinimumProtocolDialog.getData" ID="HgUserConfigHostMinimumProtocolDialog.getData"></a>
119 <h4>HgUserConfigHostMinimumProtocolDialog.getData</h4>
120 <b>getData</b>(<i></i>)
121
122 <p>
123 Public method to retrieve the data.
124 </p>
125 <dl>
126 <dt>Return:</dt>
127 <dd>
128 tuple containig the host name and the minimum protocol
129 </dd>
130 </dl>
131 <dl>
132 <dt>Return Type:</dt>
133 <dd>
134 tuple of two str
135 </dd>
136 </dl>
137 <a NAME="HgUserConfigHostMinimumProtocolDialog.on_hostEdit_textChanged" ID="HgUserConfigHostMinimumProtocolDialog.on_hostEdit_textChanged"></a>
138 <h4>HgUserConfigHostMinimumProtocolDialog.on_hostEdit_textChanged</h4>
139 <b>on_hostEdit_textChanged</b>(<i>txt</i>)
140
141 <p>
142 Private slot to handle changes of the host edit.
143 </p>
144 <dl>
145
146 <dt><i>txt</i> (str)</dt>
147 <dd>
148 current text
149 </dd>
150 </dl>
151 <a NAME="HgUserConfigHostMinimumProtocolDialog.on_minimumProtocolComboBox_currentIndexChanged" ID="HgUserConfigHostMinimumProtocolDialog.on_minimumProtocolComboBox_currentIndexChanged"></a>
152 <h4>HgUserConfigHostMinimumProtocolDialog.on_minimumProtocolComboBox_currentIndexChanged</h4>
153 <b>on_minimumProtocolComboBox_currentIndexChanged</b>(<i>index</i>)
154
155 <p>
156 Private slot to handle the selection of a minimum protocol.
157 </p>
158 <dl>
159
160 <dt><i>index</i> (int)</dt>
161 <dd>
162 index of the selected entry
163 </dd>
164 </dl>
165 <div align="right"><a href="#top">Up</a></div>
166 <hr />
167 </body></html>

eric ide

mercurial