src/eric7/Documentation/Source/eric7.EricWidgets.EricLineEdit.html

<!DOCTYPE html>
<html><head>
<title>eric7.EricWidgets.EricLineEdit</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricLineEdit</h1>
<p>
Module implementing specialized line edits.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#EricClearableLineEdit">EricClearableLineEdit</a></td>
<td>Class implementing a line edit widget showing some inactive text and a clear button, if it has some contents.</td>
</tr>
<tr>
<td><a href="#EricLineEdit">EricLineEdit</a></td>
<td>Class implementing a line edit widget showing some inactive text.</td>
</tr>
<tr>
<td><a href="#EricLineEditSide">EricLineEditSide</a></td>
<td>Class defining the line edit sides.</td>
</tr>
<tr>
<td><a href="#EricLineEditSideWidget">EricLineEditSideWidget</a></td>
<td>Class implementing the side widgets for the line edit class.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="EricClearableLineEdit" ID="EricClearableLineEdit"></a>
<h2>EricClearableLineEdit</h2>
<p>
    Class implementing a line edit widget showing some inactive text and a
    clear button, if it has some contents.
</p>

<h3>Derived from</h3>
EricLineEdit
<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="#EricClearableLineEdit.__init__">EricClearableLineEdit</a></td>
<td>Constructor</td>
</tr>
</table>

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


<a NAME="EricClearableLineEdit.__init__" ID="EricClearableLineEdit.__init__"></a>
<h4>EricClearableLineEdit (Constructor)</h4>
<b>EricClearableLineEdit</b>(<i>parent=None, placeholderText="", side=EricLineEditSide.RIGHT</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
<dt><i>placeholderText</i> (str)</dt>
<dd>
text to be shown on inactivity
</dd>
<dt><i>side</i> (EricLineEditSide)</dt>
<dd>
side the clear button should be shown at
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="EricLineEdit" ID="EricLineEdit"></a>
<h2>EricLineEdit</h2>
<p>
    Class implementing a line edit widget showing some inactive text.
</p>

<h3>Derived from</h3>
QLineEdit
<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="#EricLineEdit.__init__">EricLineEdit</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricLineEdit._updateTextMargins">_updateTextMargins</a></td>
<td>Protected slot to update the text margins.</td>
</tr>
<tr>
<td><a href="#EricLineEdit.addWidget">addWidget</a></td>
<td>Public method to add a widget to a side.</td>
</tr>
<tr>
<td><a href="#EricLineEdit.event">event</a></td>
<td>Public method to handle events.</td>
</tr>
<tr>
<td><a href="#EricLineEdit.leftMargin">leftMargin</a></td>
<td>Public method to get the size of the left margin.</td>
</tr>
<tr>
<td><a href="#EricLineEdit.removeWidget">removeWidget</a></td>
<td>Public method to remove a widget from a side.</td>
</tr>
<tr>
<td><a href="#EricLineEdit.setLeftMargin">setLeftMargin</a></td>
<td>Public method to set the left margin.</td>
</tr>
<tr>
<td><a href="#EricLineEdit.setWidgetSpacing">setWidgetSpacing</a></td>
<td>Public method to set the side widget spacing.</td>
</tr>
<tr>
<td><a href="#EricLineEdit.textMargin">textMargin</a></td>
<td>Public method to get the text margin for a side.</td>
</tr>
<tr>
<td><a href="#EricLineEdit.widgetSpacing">widgetSpacing</a></td>
<td>Public method to get the side widget spacing.</td>
</tr>
</table>

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


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

<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
<dt><i>placeholderText</i> (str)</dt>
<dd>
text to be shown on inactivity
</dd>
</dl>
<a NAME="EricLineEdit._updateTextMargins" ID="EricLineEdit._updateTextMargins"></a>
<h4>EricLineEdit._updateTextMargins</h4>
<b>_updateTextMargins</b>(<i></i>)
<p>
        Protected slot to update the text margins.
</p>

<a NAME="EricLineEdit.addWidget" ID="EricLineEdit.addWidget"></a>
<h4>EricLineEdit.addWidget</h4>
<b>addWidget</b>(<i>widget, position</i>)
<p>
        Public method to add a widget to a side.
</p>

<dl>

<dt><i>widget</i> (QWidget)</dt>
<dd>
reference to the widget to add
</dd>
<dt><i>position</i> (EricLineEditSide)</dt>
<dd>
position to add to
</dd>
</dl>
<a NAME="EricLineEdit.event" ID="EricLineEdit.event"></a>
<h4>EricLineEdit.event</h4>
<b>event</b>(<i>evt</i>)
<p>
        Public method to handle events.
</p>

<dl>

<dt><i>evt</i> (QEvent)</dt>
<dd>
reference to the event
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating, whether the event was recognized
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="EricLineEdit.leftMargin" ID="EricLineEdit.leftMargin"></a>
<h4>EricLineEdit.leftMargin</h4>
<b>leftMargin</b>(<i></i>)
<p>
        Public method to get the size of the left margin.
</p>

<dl>
<dt>Return:</dt>
<dd>
left margin in pixel
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<a NAME="EricLineEdit.removeWidget" ID="EricLineEdit.removeWidget"></a>
<h4>EricLineEdit.removeWidget</h4>
<b>removeWidget</b>(<i>widget</i>)
<p>
        Public method to remove a widget from a side.
</p>

<dl>

<dt><i>widget</i> (QWidget)</dt>
<dd>
reference to the widget to remove
</dd>
</dl>
<a NAME="EricLineEdit.setLeftMargin" ID="EricLineEdit.setLeftMargin"></a>
<h4>EricLineEdit.setLeftMargin</h4>
<b>setLeftMargin</b>(<i>margin</i>)
<p>
        Public method to set the left margin.
</p>

<dl>

<dt><i>margin</i> (int)</dt>
<dd>
left margin in pixel
</dd>
</dl>
<a NAME="EricLineEdit.setWidgetSpacing" ID="EricLineEdit.setWidgetSpacing"></a>
<h4>EricLineEdit.setWidgetSpacing</h4>
<b>setWidgetSpacing</b>(<i>spacing</i>)
<p>
        Public method to set the side widget spacing.
</p>

<dl>

<dt><i>spacing</i> (int)</dt>
<dd>
side widget spacing
</dd>
</dl>
<a NAME="EricLineEdit.textMargin" ID="EricLineEdit.textMargin"></a>
<h4>EricLineEdit.textMargin</h4>
<b>textMargin</b>(<i>position</i>)
<p>
        Public method to get the text margin for a side.
</p>

<dl>

<dt><i>position</i> (EricLineEditSide)</dt>
<dd>
side to get margin for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
text margin
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<a NAME="EricLineEdit.widgetSpacing" ID="EricLineEdit.widgetSpacing"></a>
<h4>EricLineEdit.widgetSpacing</h4>
<b>widgetSpacing</b>(<i></i>)
<p>
        Public method to get the side widget spacing.
</p>

<dl>
<dt>Return:</dt>
<dd>
side widget spacing
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="EricLineEditSide" ID="EricLineEditSide"></a>
<h2>EricLineEditSide</h2>
<p>
    Class defining the line edit sides.
</p>

<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
<table>
<tr><td>LEFT</td></tr>
<tr><td>RIGHT</td></tr>
</table>

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

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

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


<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="EricLineEditSideWidget" ID="EricLineEditSideWidget"></a>
<h2>EricLineEditSideWidget</h2>
<p>
    Class implementing the side widgets for the line edit class.
</p>

<h3>Signals</h3>
<dl>

<dt>sizeHintChanged()</dt>
<dd>
emitted to indicate a change of the size hint
</dd>
</dl>
<h3>Derived from</h3>
QWidget
<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="#EricLineEditSideWidget.__init__">EricLineEditSideWidget</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricLineEditSideWidget.event">event</a></td>
<td>Public method to handle events.</td>
</tr>
</table>

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


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

<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="EricLineEditSideWidget.event" ID="EricLineEditSideWidget.event"></a>
<h4>EricLineEditSideWidget.event</h4>
<b>event</b>(<i>evt</i>)
<p>
        Public method to handle events.
</p>

<dl>

<dt><i>evt</i> (QEvent)</dt>
<dd>
reference to the event
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating, whether the event was recognized
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>