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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9097
213951c41dcd
child 10479
856476537696
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricPlainTextDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,130 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.EricWidgets.EricPlainTextDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.EricWidgets.EricPlainTextDialog</h1>
+
+<p>
+Module implementing a dialog to show some plain text.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#EricPlainTextDialog">EricPlainTextDialog</a></td>
+<td>Class implementing a dialog to show some plain text.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="EricPlainTextDialog" ID="EricPlainTextDialog"></a>
+<h2>EricPlainTextDialog</h2>
+
+<p>
+    Class implementing a dialog to show some plain text.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_EricPlainTextDialog
+<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="#EricPlainTextDialog.__init__">EricPlainTextDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EricPlainTextDialog.on_copyButton_clicked">on_copyButton_clicked</a></td>
+<td>Private slot to copy the text to the clipboard.</td>
+</tr>
+<tr>
+<td><a href="#EricPlainTextDialog.toPlainText">toPlainText</a></td>
+<td>Public method to get the plain text.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="EricPlainTextDialog.__init__" ID="EricPlainTextDialog.__init__"></a>
+<h4>EricPlainTextDialog (Constructor)</h4>
+<b>EricPlainTextDialog</b>(<i>title="", text="", readOnly=True, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>title</i> (str (optional))</dt>
+<dd>
+title of the dialog (defaults to "")
+</dd>
+<dt><i>text</i> (str (optional))</dt>
+<dd>
+text to be shown (defaults to "")
+</dd>
+<dt><i>readOnly</i> (bool (optional))</dt>
+<dd>
+flag indicating a read-only dialog (defaults to True)
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="EricPlainTextDialog.on_copyButton_clicked" ID="EricPlainTextDialog.on_copyButton_clicked"></a>
+<h4>EricPlainTextDialog.on_copyButton_clicked</h4>
+<b>on_copyButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to copy the text to the clipboard.
+</p>
+<a NAME="EricPlainTextDialog.toPlainText" ID="EricPlainTextDialog.toPlainText"></a>
+<h4>EricPlainTextDialog.toPlainText</h4>
+<b>toPlainText</b>(<i></i>)
+
+<p>
+        Public method to get the plain text.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+contents of the plain text edit
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial