|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.EricWidgets.EricPlainTextDialog</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.EricWidgets.EricPlainTextDialog</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a dialog to show some plain text. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#EricPlainTextDialog">EricPlainTextDialog</a></td> |
|
25 <td>Class implementing a dialog to show some plain text.</td> |
|
26 </tr> |
|
27 </table> |
|
28 <h3>Functions</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="EricPlainTextDialog" ID="EricPlainTextDialog"></a> |
|
36 <h2>EricPlainTextDialog</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing a dialog to show some plain text. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 QDialog, Ui_EricPlainTextDialog |
|
43 <h3>Class Attributes</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>None</td></tr> |
|
47 </table> |
|
48 <h3>Class Methods</h3> |
|
49 |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Methods</h3> |
|
54 |
|
55 <table> |
|
56 |
|
57 <tr> |
|
58 <td><a href="#EricPlainTextDialog.__init__">EricPlainTextDialog</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#EricPlainTextDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> |
|
63 <td>Private slot to copy the text to the clipboard.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#EricPlainTextDialog.toPlainText">toPlainText</a></td> |
|
67 <td>Public method to get the plain text.</td> |
|
68 </tr> |
|
69 </table> |
|
70 <h3>Static Methods</h3> |
|
71 |
|
72 <table> |
|
73 <tr><td>None</td></tr> |
|
74 </table> |
|
75 |
|
76 <a NAME="EricPlainTextDialog.__init__" ID="EricPlainTextDialog.__init__"></a> |
|
77 <h4>EricPlainTextDialog (Constructor)</h4> |
|
78 <b>EricPlainTextDialog</b>(<i>title="", text="", readOnly=True, parent=None</i>) |
|
79 |
|
80 <p> |
|
81 Constructor |
|
82 </p> |
|
83 <dl> |
|
84 |
|
85 <dt><i>title</i> (str (optional))</dt> |
|
86 <dd> |
|
87 title of the dialog (defaults to "") |
|
88 </dd> |
|
89 <dt><i>text</i> (str (optional))</dt> |
|
90 <dd> |
|
91 text to be shown (defaults to "") |
|
92 </dd> |
|
93 <dt><i>readOnly</i> (bool (optional))</dt> |
|
94 <dd> |
|
95 flag indicating a read-only dialog (defaults to True) |
|
96 </dd> |
|
97 <dt><i>parent</i> (QWidget (optional))</dt> |
|
98 <dd> |
|
99 reference to the parent widget (defaults to None) |
|
100 </dd> |
|
101 </dl> |
|
102 <a NAME="EricPlainTextDialog.on_copyButton_clicked" ID="EricPlainTextDialog.on_copyButton_clicked"></a> |
|
103 <h4>EricPlainTextDialog.on_copyButton_clicked</h4> |
|
104 <b>on_copyButton_clicked</b>(<i></i>) |
|
105 |
|
106 <p> |
|
107 Private slot to copy the text to the clipboard. |
|
108 </p> |
|
109 <a NAME="EricPlainTextDialog.toPlainText" ID="EricPlainTextDialog.toPlainText"></a> |
|
110 <h4>EricPlainTextDialog.toPlainText</h4> |
|
111 <b>toPlainText</b>(<i></i>) |
|
112 |
|
113 <p> |
|
114 Public method to get the plain text. |
|
115 </p> |
|
116 <dl> |
|
117 <dt>Return:</dt> |
|
118 <dd> |
|
119 contents of the plain text edit |
|
120 </dd> |
|
121 </dl> |
|
122 <dl> |
|
123 <dt>Return Type:</dt> |
|
124 <dd> |
|
125 str |
|
126 </dd> |
|
127 </dl> |
|
128 <div align="right"><a href="#top">Up</a></div> |
|
129 <hr /> |
|
130 </body></html> |