src/eric7/Documentation/Source/eric7.EricNetwork.EricIPv4InputWidget.html

branch
eric7
changeset 10479
856476537696
parent 10035
3a423b723a99
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.EricNetwork.EricIPv4InputWidget</h1> 9 <h1>eric7.EricNetwork.EricIPv4InputWidget</h1>
10
11 <p> 10 <p>
12 Module implementing a widget to enter an IPv4 address. 11 Module implementing a widget to enter an IPv4 address.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#EricIPv4InputWidget">EricIPv4InputWidget</a></td> 22 <td><a href="#EricIPv4InputWidget">EricIPv4InputWidget</a></td>
25 <td>Class implementing a widget to enter an IPv4 address.</td> 23 <td>Class implementing a widget to enter an IPv4 address.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="EricIPv4InputWidget" ID="EricIPv4InputWidget"></a> 34 <a NAME="EricIPv4InputWidget" ID="EricIPv4InputWidget"></a>
36 <h2>EricIPv4InputWidget</h2> 35 <h2>EricIPv4InputWidget</h2>
37
38 <p> 36 <p>
39 Class implementing a widget to enter an IPv4 address. 37 Class implementing a widget to enter an IPv4 address.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>addressChanged()</dt> 43 <dt>addressChanged()</dt>
45 <dd> 44 <dd>
47 </dd> 46 </dd>
48 </dl> 47 </dl>
49 <h3>Derived from</h3> 48 <h3>Derived from</h3>
50 QWidget, Ui_EricIPv4InputWidget 49 QWidget, Ui_EricIPv4InputWidget
51 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
52 51 <table>
53 <table> 52 <tr><td>None</td></tr>
54 <tr><td>None</td></tr> 53 </table>
55 </table> 54
56 <h3>Class Methods</h3> 55 <h3>Class Methods</h3>
57 56 <table>
58 <table> 57 <tr><td>None</td></tr>
59 <tr><td>None</td></tr> 58 </table>
60 </table> 59
61 <h3>Methods</h3> 60 <h3>Methods</h3>
62 61 <table>
63 <table>
64
65 <tr> 62 <tr>
66 <td><a href="#EricIPv4InputWidget.__init__">EricIPv4InputWidget</a></td> 63 <td><a href="#EricIPv4InputWidget.__init__">EricIPv4InputWidget</a></td>
67 <td>Constructor</td> 64 <td>Constructor</td>
68 </tr> 65 </tr>
69 <tr> 66 <tr>
97 <tr> 94 <tr>
98 <td><a href="#EricIPv4InputWidget.text">text</a></td> 95 <td><a href="#EricIPv4InputWidget.text">text</a></td>
99 <td>Public method to get the IPv4 address as a string.</td> 96 <td>Public method to get the IPv4 address as a string.</td>
100 </tr> 97 </tr>
101 </table> 98 </table>
99
102 <h3>Static Methods</h3> 100 <h3>Static Methods</h3>
103 101 <table>
104 <table> 102 <tr><td>None</td></tr>
105 <tr><td>None</td></tr> 103 </table>
106 </table> 104
107 105
108 <a NAME="EricIPv4InputWidget.__init__" ID="EricIPv4InputWidget.__init__"></a> 106 <a NAME="EricIPv4InputWidget.__init__" ID="EricIPv4InputWidget.__init__"></a>
109 <h4>EricIPv4InputWidget (Constructor)</h4> 107 <h4>EricIPv4InputWidget (Constructor)</h4>
110 <b>EricIPv4InputWidget</b>(<i>parent=None</i>) 108 <b>EricIPv4InputWidget</b>(<i>parent=None</i>)
111
112 <p> 109 <p>
113 Constructor 110 Constructor
114 </p> 111 </p>
112
115 <dl> 113 <dl>
116 114
117 <dt><i>parent</i> (QWidget (optional))</dt> 115 <dt><i>parent</i> (QWidget (optional))</dt>
118 <dd> 116 <dd>
119 reference to the parent widget (defaults to None) 117 reference to the parent widget (defaults to None)
120 </dd> 118 </dd>
121 </dl> 119 </dl>
122 <a NAME="EricIPv4InputWidget.__clear" ID="EricIPv4InputWidget.__clear"></a> 120 <a NAME="EricIPv4InputWidget.__clear" ID="EricIPv4InputWidget.__clear"></a>
123 <h4>EricIPv4InputWidget.__clear</h4> 121 <h4>EricIPv4InputWidget.__clear</h4>
124 <b>__clear</b>(<i></i>) 122 <b>__clear</b>(<i></i>)
125
126 <p> 123 <p>
127 Private slot to handle the clear button press. 124 Private slot to handle the clear button press.
128 </p> 125 </p>
126
129 <a NAME="EricIPv4InputWidget.address" ID="EricIPv4InputWidget.address"></a> 127 <a NAME="EricIPv4InputWidget.address" ID="EricIPv4InputWidget.address"></a>
130 <h4>EricIPv4InputWidget.address</h4> 128 <h4>EricIPv4InputWidget.address</h4>
131 <b>address</b>(<i></i>) 129 <b>address</b>(<i></i>)
132
133 <p> 130 <p>
134 Public method to get the IPv4 address as an ipaddress.IPv4Address object. 131 Public method to get the IPv4 address as an ipaddress.IPv4Address object.
135 </p> 132 </p>
133
136 <dl> 134 <dl>
137 <dt>Return:</dt> 135 <dt>Return:</dt>
138 <dd> 136 <dd>
139 IPv4 address 137 IPv4 address
140 </dd> 138 </dd>
153 </dd> 151 </dd>
154 </dl> 152 </dl>
155 <a NAME="EricIPv4InputWidget.clear" ID="EricIPv4InputWidget.clear"></a> 153 <a NAME="EricIPv4InputWidget.clear" ID="EricIPv4InputWidget.clear"></a>
156 <h4>EricIPv4InputWidget.clear</h4> 154 <h4>EricIPv4InputWidget.clear</h4>
157 <b>clear</b>(<i></i>) 155 <b>clear</b>(<i></i>)
158
159 <p> 156 <p>
160 Public slot to clear the input fields. 157 Public slot to clear the input fields.
161 </p> 158 </p>
159
162 <a NAME="EricIPv4InputWidget.eventFilter" ID="EricIPv4InputWidget.eventFilter"></a> 160 <a NAME="EricIPv4InputWidget.eventFilter" ID="EricIPv4InputWidget.eventFilter"></a>
163 <h4>EricIPv4InputWidget.eventFilter</h4> 161 <h4>EricIPv4InputWidget.eventFilter</h4>
164 <b>eventFilter</b>(<i>obj, evt</i>) 162 <b>eventFilter</b>(<i>obj, evt</i>)
165
166 <p> 163 <p>
167 Public method to filter pressing '.' to give focus to the next input field. 164 Public method to filter pressing '.' to give focus to the next input field.
168 </p> 165 </p>
166
169 <dl> 167 <dl>
170 168
171 <dt><i>obj</i> (QObject)</dt> 169 <dt><i>obj</i> (QObject)</dt>
172 <dd> 170 <dd>
173 reference to the object 171 reference to the object
190 </dd> 188 </dd>
191 </dl> 189 </dl>
192 <a NAME="EricIPv4InputWidget.hasAcceptableInput" ID="EricIPv4InputWidget.hasAcceptableInput"></a> 190 <a NAME="EricIPv4InputWidget.hasAcceptableInput" ID="EricIPv4InputWidget.hasAcceptableInput"></a>
193 <h4>EricIPv4InputWidget.hasAcceptableInput</h4> 191 <h4>EricIPv4InputWidget.hasAcceptableInput</h4>
194 <b>hasAcceptableInput</b>(<i></i>) 192 <b>hasAcceptableInput</b>(<i></i>)
195
196 <p> 193 <p>
197 Public method to check, if the input is acceptable. 194 Public method to check, if the input is acceptable.
198 </p> 195 </p>
196
199 <dl> 197 <dl>
200 <dt>Return:</dt> 198 <dt>Return:</dt>
201 <dd> 199 <dd>
202 flag indicating acceptable input 200 flag indicating acceptable input
203 </dd> 201 </dd>
209 </dd> 207 </dd>
210 </dl> 208 </dl>
211 <a NAME="EricIPv4InputWidget.setAddress" ID="EricIPv4InputWidget.setAddress"></a> 209 <a NAME="EricIPv4InputWidget.setAddress" ID="EricIPv4InputWidget.setAddress"></a>
212 <h4>EricIPv4InputWidget.setAddress</h4> 210 <h4>EricIPv4InputWidget.setAddress</h4>
213 <b>setAddress</b>(<i>address</i>) 211 <b>setAddress</b>(<i>address</i>)
214
215 <p> 212 <p>
216 Public method to set the IPv4 address given an ipaddress.IPv4Address object. 213 Public method to set the IPv4 address given an ipaddress.IPv4Address object.
217 </p> 214 </p>
215
218 <dl> 216 <dl>
219 217
220 <dt><i>address</i> (ipaddress.IPv4Address)</dt> 218 <dt><i>address</i> (ipaddress.IPv4Address)</dt>
221 <dd> 219 <dd>
222 IPv4 address 220 IPv4 address
230 </dd> 228 </dd>
231 </dl> 229 </dl>
232 <a NAME="EricIPv4InputWidget.setText" ID="EricIPv4InputWidget.setText"></a> 230 <a NAME="EricIPv4InputWidget.setText" ID="EricIPv4InputWidget.setText"></a>
233 <h4>EricIPv4InputWidget.setText</h4> 231 <h4>EricIPv4InputWidget.setText</h4>
234 <b>setText</b>(<i>address</i>) 232 <b>setText</b>(<i>address</i>)
235
236 <p> 233 <p>
237 Public method to set the IPv4 address given a string. 234 Public method to set the IPv4 address given a string.
238 </p> 235 </p>
239 <p> 236 <p>
240 Note: If an invalid address is given, the input is cleared. 237 Note: If an invalid address is given, the input is cleared.
241 </p> 238 </p>
239
242 <dl> 240 <dl>
243 241
244 <dt><i>address</i> (str)</dt> 242 <dt><i>address</i> (str)</dt>
245 <dd> 243 <dd>
246 IPv4 address 244 IPv4 address
247 </dd> 245 </dd>
248 </dl> 246 </dl>
249 <a NAME="EricIPv4InputWidget.text" ID="EricIPv4InputWidget.text"></a> 247 <a NAME="EricIPv4InputWidget.text" ID="EricIPv4InputWidget.text"></a>
250 <h4>EricIPv4InputWidget.text</h4> 248 <h4>EricIPv4InputWidget.text</h4>
251 <b>text</b>(<i></i>) 249 <b>text</b>(<i></i>)
252
253 <p> 250 <p>
254 Public method to get the IPv4 address as a string. 251 Public method to get the IPv4 address as a string.
255 </p> 252 </p>
253
256 <dl> 254 <dl>
257 <dt>Return:</dt> 255 <dt>Return:</dt>
258 <dd> 256 <dd>
259 IPv4 address 257 IPv4 address
260 </dd> 258 </dd>

eric ide

mercurial