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

<!DOCTYPE html>
<html><head>
<title>eric7.EricNetwork.EricIPv4InputWidget</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricNetwork.EricIPv4InputWidget</h1>
<p>
Module implementing a widget to enter an IPv4 address.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#EricIPv4InputWidget">EricIPv4InputWidget</a></td>
<td>Class implementing a widget to enter an IPv4 address.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="EricIPv4InputWidget" ID="EricIPv4InputWidget"></a>
<h2>EricIPv4InputWidget</h2>
<p>
    Class implementing a widget to enter an IPv4 address.
</p>

<h3>Signals</h3>
<dl>

<dt>addressChanged()</dt>
<dd>
emitted to indicate a change of the entered IPv4 address
</dd>
</dl>
<h3>Derived from</h3>
QWidget, Ui_EricIPv4InputWidget
<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="#EricIPv4InputWidget.__init__">EricIPv4InputWidget</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricIPv4InputWidget.__clear">__clear</a></td>
<td>Private slot to handle the clear button press.</td>
</tr>
<tr>
<td><a href="#EricIPv4InputWidget.address">address</a></td>
<td>Public method to get the IPv4 address as an ipaddress.IPv4Address object.</td>
</tr>
<tr>
<td><a href="#EricIPv4InputWidget.clear">clear</a></td>
<td>Public slot to clear the input fields.</td>
</tr>
<tr>
<td><a href="#EricIPv4InputWidget.eventFilter">eventFilter</a></td>
<td>Public method to filter pressing '.' to give focus to the next input field.</td>
</tr>
<tr>
<td><a href="#EricIPv4InputWidget.hasAcceptableInput">hasAcceptableInput</a></td>
<td>Public method to check, if the input is acceptable.</td>
</tr>
<tr>
<td><a href="#EricIPv4InputWidget.setAddress">setAddress</a></td>
<td>Public method to set the IPv4 address given an ipaddress.IPv4Address object.</td>
</tr>
<tr>
<td><a href="#EricIPv4InputWidget.setText">setText</a></td>
<td>Public method to set the IPv4 address given a string.</td>
</tr>
<tr>
<td><a href="#EricIPv4InputWidget.text">text</a></td>
<td>Public method to get the IPv4 address as a string.</td>
</tr>
</table>

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


<a NAME="EricIPv4InputWidget.__init__" ID="EricIPv4InputWidget.__init__"></a>
<h4>EricIPv4InputWidget (Constructor)</h4>
<b>EricIPv4InputWidget</b>(<i>parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="EricIPv4InputWidget.__clear" ID="EricIPv4InputWidget.__clear"></a>
<h4>EricIPv4InputWidget.__clear</h4>
<b>__clear</b>(<i></i>)
<p>
        Private slot to handle the clear button press.
</p>

<a NAME="EricIPv4InputWidget.address" ID="EricIPv4InputWidget.address"></a>
<h4>EricIPv4InputWidget.address</h4>
<b>address</b>(<i></i>)
<p>
        Public method to get the IPv4 address as an ipaddress.IPv4Address object.
</p>

<dl>
<dt>Return:</dt>
<dd>
IPv4 address
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
ipaddress.IPv4Address
</dd>
</dl>
<dl>

<dt>Raises <b>ValueError</b>:</dt>
<dd>
raised to indicate an invalid IPv4 address
</dd>
</dl>
<a NAME="EricIPv4InputWidget.clear" ID="EricIPv4InputWidget.clear"></a>
<h4>EricIPv4InputWidget.clear</h4>
<b>clear</b>(<i></i>)
<p>
        Public slot to clear the input fields.
</p>

<a NAME="EricIPv4InputWidget.eventFilter" ID="EricIPv4InputWidget.eventFilter"></a>
<h4>EricIPv4InputWidget.eventFilter</h4>
<b>eventFilter</b>(<i>obj, evt</i>)
<p>
        Public method to filter pressing '.' to give focus to the next input field.
</p>

<dl>

<dt><i>obj</i> (QObject)</dt>
<dd>
reference to the object
</dd>
<dt><i>evt</i> (QEvent)</dt>
<dd>
reference to the event object
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating, that the event was handled
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="EricIPv4InputWidget.hasAcceptableInput" ID="EricIPv4InputWidget.hasAcceptableInput"></a>
<h4>EricIPv4InputWidget.hasAcceptableInput</h4>
<b>hasAcceptableInput</b>(<i></i>)
<p>
        Public method to check, if the input is acceptable.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating acceptable input
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="EricIPv4InputWidget.setAddress" ID="EricIPv4InputWidget.setAddress"></a>
<h4>EricIPv4InputWidget.setAddress</h4>
<b>setAddress</b>(<i>address</i>)
<p>
        Public method to set the IPv4 address given an ipaddress.IPv4Address object.
</p>

<dl>

<dt><i>address</i> (ipaddress.IPv4Address)</dt>
<dd>
IPv4 address
</dd>
</dl>
<dl>

<dt>Raises <b>ValueError</b>:</dt>
<dd>
raised to indicate an invalid IPv4 address
</dd>
</dl>
<a NAME="EricIPv4InputWidget.setText" ID="EricIPv4InputWidget.setText"></a>
<h4>EricIPv4InputWidget.setText</h4>
<b>setText</b>(<i>address</i>)
<p>
        Public method to set the IPv4 address given a string.
</p>
<p>
        Note: If an invalid address is given, the input is cleared.
</p>

<dl>

<dt><i>address</i> (str)</dt>
<dd>
IPv4 address
</dd>
</dl>
<a NAME="EricIPv4InputWidget.text" ID="EricIPv4InputWidget.text"></a>
<h4>EricIPv4InputWidget.text</h4>
<b>text</b>(<i></i>)
<p>
        Public method to get the IPv4 address as a string.
</p>

<dl>
<dt>Return:</dt>
<dd>
IPv4 address
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>