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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricTextInputDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,261 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.EricWidgets.EricTextInputDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.EricWidgets.EricTextInputDialog</h1>
+
+<p>
+Module implementing a dialog to enter some text.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#EricTextInputDialog">EricTextInputDialog</a></td>
+<td>Class implementing a dialog to enter some text.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#getText">getText</a></td>
+<td>Function to get create a dialog to enter some text and return it.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="EricTextInputDialog" ID="EricTextInputDialog"></a>
+<h2>EricTextInputDialog</h2>
+
+<p>
+    Class implementing a dialog to enter some text.
+</p>
+<h3>Derived from</h3>
+QDialog
+<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="#EricTextInputDialog.__init__">EricTextInputDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EricTextInputDialog.labelText">labelText</a></td>
+<td>Public method to get the current label text.</td>
+</tr>
+<tr>
+<td><a href="#EricTextInputDialog.setLabelText">setLabelText</a></td>
+<td>Public method to set the label text.</td>
+</tr>
+<tr>
+<td><a href="#EricTextInputDialog.setTextEchoMode">setTextEchoMode</a></td>
+<td>Public method to set the echo mode of the line edit.</td>
+</tr>
+<tr>
+<td><a href="#EricTextInputDialog.setTextValue">setTextValue</a></td>
+<td>Public method to set the text of the line edit.</td>
+</tr>
+<tr>
+<td><a href="#EricTextInputDialog.textEchoMode">textEchoMode</a></td>
+<td>Public method to get the current echo mode of the line edit.</td>
+</tr>
+<tr>
+<td><a href="#EricTextInputDialog.textValue">textValue</a></td>
+<td>Public method to get the text of the line edit.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="EricTextInputDialog.__init__" ID="EricTextInputDialog.__init__"></a>
+<h4>EricTextInputDialog (Constructor)</h4>
+<b>EricTextInputDialog</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="EricTextInputDialog.labelText" ID="EricTextInputDialog.labelText"></a>
+<h4>EricTextInputDialog.labelText</h4>
+<b>labelText</b>(<i></i>)
+
+<p>
+        Public method to get the current label text.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+current label text
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="EricTextInputDialog.setLabelText" ID="EricTextInputDialog.setLabelText"></a>
+<h4>EricTextInputDialog.setLabelText</h4>
+<b>setLabelText</b>(<i>text</i>)
+
+<p>
+        Public method to set the label text.
+</p>
+<dl>
+
+<dt><i>text</i> (str)</dt>
+<dd>
+label text
+</dd>
+</dl>
+<a NAME="EricTextInputDialog.setTextEchoMode" ID="EricTextInputDialog.setTextEchoMode"></a>
+<h4>EricTextInputDialog.setTextEchoMode</h4>
+<b>setTextEchoMode</b>(<i>echoMode</i>)
+
+<p>
+        Public method to set the echo mode of the line edit.
+</p>
+<dl>
+
+<dt><i>echoMode</i> (QLineEdit.EchoMode)</dt>
+<dd>
+echo mode of the line edit
+</dd>
+</dl>
+<a NAME="EricTextInputDialog.setTextValue" ID="EricTextInputDialog.setTextValue"></a>
+<h4>EricTextInputDialog.setTextValue</h4>
+<b>setTextValue</b>(<i>text</i>)
+
+<p>
+        Public method to set the text of the line edit.
+</p>
+<dl>
+
+<dt><i>text</i> (str)</dt>
+<dd>
+text for the line edit
+</dd>
+</dl>
+<a NAME="EricTextInputDialog.textEchoMode" ID="EricTextInputDialog.textEchoMode"></a>
+<h4>EricTextInputDialog.textEchoMode</h4>
+<b>textEchoMode</b>(<i></i>)
+
+<p>
+        Public method to get the current echo mode of the line edit.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+echo mode of the line edit
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QLineEdit.EchoMode
+</dd>
+</dl>
+<a NAME="EricTextInputDialog.textValue" ID="EricTextInputDialog.textValue"></a>
+<h4>EricTextInputDialog.textValue</h4>
+<b>textValue</b>(<i></i>)
+
+<p>
+        Public method to get the text of the line edit.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+text of the line edit
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getText" ID="getText"></a>
+<h2>getText</h2>
+<b>getText</b>(<i>parent, title, label, mode=QLineEdit.EchoMode.Normal, text="", minimumWidth=300</i>)
+
+<p>
+    Function to get create a dialog to enter some text and return it.
+</p>
+<dl>
+
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+<dt><i>title</i> (str)</dt>
+<dd>
+title of the dialog
+</dd>
+<dt><i>label</i> (str)</dt>
+<dd>
+label of the dialog
+</dd>
+<dt><i>mode</i> (QLineEdit.EchoMode)</dt>
+<dd>
+echo mode of the line edit
+</dd>
+<dt><i>text</i> (str)</dt>
+<dd>
+initial text of the line edit
+</dd>
+<dt><i>minimumWidth</i> (int)</dt>
+<dd>
+minimum width of the dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating the dialog was accepted and the
+        entered text
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial