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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9534
5ed8445f3b31
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricStringListEditWidget.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,192 @@
+<!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.getList">getList</a></td>
+<td>Public method to get the edited list of strings.</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.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>
+</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></dt>
+<dd>
+reference to the parent widget (QWidget)
+</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 (list of string)
+</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.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></dt>
+<dd>
+list of strings to be edited (list of string)
+</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></dt>
+<dd>
+help text to be set (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial