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

<!DOCTYPE html>
<html><head>
<title>eric7.EricWidgets.EricStringListEditWidget</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricStringListEditWidget</h1>
<p>
Module implementing a dialog to edit a list of strings.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#EricStringListEditWidget">EricStringListEditWidget</a></td>
<td>Class implementing a dialog to edit a list of strings.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="EricStringListEditWidget" ID="EricStringListEditWidget"></a>
<h2>EricStringListEditWidget</h2>
<p>
    Class implementing a dialog to edit a list of strings.
</p>

<h3>Signals</h3>
<dl>

<dt>setToDefault()</dt>
<dd>
emitted to request the default list of values
</dd>
</dl>
<h3>Derived from</h3>
QWidget, Ui_EricStringListEditWidget
<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="#EricStringListEditWidget.__init__">EricStringListEditWidget</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricStringListEditWidget.count">count</a></td>
<td>Public method to get the number of entries of the list.</td>
</tr>
<tr>
<td><a href="#EricStringListEditWidget.getList">getList</a></td>
<td>Public method to get the edited list of strings.</td>
</tr>
<tr>
<td><a href="#EricStringListEditWidget.isListEmpty">isListEmpty</a></td>
<td>Public method to check, if the list is empty.</td>
</tr>
<tr>
<td><a href="#EricStringListEditWidget.on_addButton_clicked">on_addButton_clicked</a></td>
<td>Private slot to add an entry to the list.</td>
</tr>
<tr>
<td><a href="#EricStringListEditWidget.on_resetButton_clicked">on_resetButton_clicked</a></td>
<td>Private slot to reset the list to its initial value.</td>
</tr>
<tr>
<td><a href="#EricStringListEditWidget.setAddVisible">setAddVisible</a></td>
<td>Public method to show or hide the add button.</td>
</tr>
<tr>
<td><a href="#EricStringListEditWidget.setDefaultVisible">setDefaultVisible</a></td>
<td>Public method to show or hide the default button.</td>
</tr>
<tr>
<td><a href="#EricStringListEditWidget.setList">setList</a></td>
<td>Public method to set the list of strings to be edited.</td>
</tr>
<tr>
<td><a href="#EricStringListEditWidget.setListWhatsThis">setListWhatsThis</a></td>
<td>Public method to set a what's that help text for the string list.</td>
</tr>
<tr>
<td><a href="#EricStringListEditWidget.setResetVisible">setResetVisible</a></td>
<td>Public method to show or hide the reset button.</td>
</tr>
</table>

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


<a NAME="EricStringListEditWidget.__init__" ID="EricStringListEditWidget.__init__"></a>
<h4>EricStringListEditWidget (Constructor)</h4>
<b>EricStringListEditWidget</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="EricStringListEditWidget.count" ID="EricStringListEditWidget.count"></a>
<h4>EricStringListEditWidget.count</h4>
<b>count</b>(<i></i>)
<p>
        Public method to get the number of entries of the list.
</p>

<dl>
<dt>Return:</dt>
<dd>
number of list entries
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<a NAME="EricStringListEditWidget.getList" ID="EricStringListEditWidget.getList"></a>
<h4>EricStringListEditWidget.getList</h4>
<b>getList</b>(<i></i>)
<p>
        Public method to get the edited list of strings.
</p>

<dl>
<dt>Return:</dt>
<dd>
edited list of string
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<a NAME="EricStringListEditWidget.isListEmpty" ID="EricStringListEditWidget.isListEmpty"></a>
<h4>EricStringListEditWidget.isListEmpty</h4>
<b>isListEmpty</b>(<i></i>)
<p>
        Public method to check, if the list is empty.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating an empty list
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="EricStringListEditWidget.on_addButton_clicked" ID="EricStringListEditWidget.on_addButton_clicked"></a>
<h4>EricStringListEditWidget.on_addButton_clicked</h4>
<b>on_addButton_clicked</b>(<i></i>)
<p>
        Private slot to add an entry to the list.
</p>

<a NAME="EricStringListEditWidget.on_resetButton_clicked" ID="EricStringListEditWidget.on_resetButton_clicked"></a>
<h4>EricStringListEditWidget.on_resetButton_clicked</h4>
<b>on_resetButton_clicked</b>(<i></i>)
<p>
        Private slot to reset the list to its initial value.
</p>

<a NAME="EricStringListEditWidget.setAddVisible" ID="EricStringListEditWidget.setAddVisible"></a>
<h4>EricStringListEditWidget.setAddVisible</h4>
<b>setAddVisible</b>(<i>visible</i>)
<p>
        Public method to show or hide the add button.
</p>

<dl>

<dt><i>visible</i> (bool)</dt>
<dd>
flag indicating the visibility of the add button
</dd>
</dl>
<a NAME="EricStringListEditWidget.setDefaultVisible" ID="EricStringListEditWidget.setDefaultVisible"></a>
<h4>EricStringListEditWidget.setDefaultVisible</h4>
<b>setDefaultVisible</b>(<i>visible</i>)
<p>
        Public method to show or hide the default button.
</p>

<dl>

<dt><i>visible</i> (bool)</dt>
<dd>
flag indicating the visibility of the default button
</dd>
</dl>
<a NAME="EricStringListEditWidget.setList" ID="EricStringListEditWidget.setList"></a>
<h4>EricStringListEditWidget.setList</h4>
<b>setList</b>(<i>stringList</i>)
<p>
        Public method to set the list of strings to be edited.
</p>

<dl>

<dt><i>stringList</i> (list of str)</dt>
<dd>
list of strings to be edited
</dd>
</dl>
<a NAME="EricStringListEditWidget.setListWhatsThis" ID="EricStringListEditWidget.setListWhatsThis"></a>
<h4>EricStringListEditWidget.setListWhatsThis</h4>
<b>setListWhatsThis</b>(<i>txt</i>)
<p>
        Public method to set a what's that help text for the string list.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
help text to be set
</dd>
</dl>
<a NAME="EricStringListEditWidget.setResetVisible" ID="EricStringListEditWidget.setResetVisible"></a>
<h4>EricStringListEditWidget.setResetVisible</h4>
<b>setResetVisible</b>(<i>visible</i>)
<p>
        Public method to show or hide the reset button.
</p>

<dl>

<dt><i>visible</i> (bool)</dt>
<dd>
flag indicating the visibility of the reset button
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>