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

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.EricWidgets.EricTextInputDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.EricWidgets.EricTextInputDialog</h1>
24
25 <p>
26 Module implementing a dialog to enter some text.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#EricTextInputDialog">EricTextInputDialog</a></td>
39 <td>Class implementing a dialog to enter some text.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45
46 <tr>
47 <td><a href="#getText">getText</a></td>
48 <td>Function to get create a dialog to enter some text and return it.</td>
49 </tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="EricTextInputDialog" ID="EricTextInputDialog"></a>
54 <h2>EricTextInputDialog</h2>
55
56 <p>
57 Class implementing a dialog to enter some text.
58 </p>
59 <h3>Derived from</h3>
60 QDialog
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Methods</h3>
72
73 <table>
74
75 <tr>
76 <td><a href="#EricTextInputDialog.__init__">EricTextInputDialog</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#EricTextInputDialog.labelText">labelText</a></td>
81 <td>Public method to get the current label text.</td>
82 </tr>
83 <tr>
84 <td><a href="#EricTextInputDialog.setLabelText">setLabelText</a></td>
85 <td>Public method to set the label text.</td>
86 </tr>
87 <tr>
88 <td><a href="#EricTextInputDialog.setTextEchoMode">setTextEchoMode</a></td>
89 <td>Public method to set the echo mode of the line edit.</td>
90 </tr>
91 <tr>
92 <td><a href="#EricTextInputDialog.setTextValue">setTextValue</a></td>
93 <td>Public method to set the text of the line edit.</td>
94 </tr>
95 <tr>
96 <td><a href="#EricTextInputDialog.textEchoMode">textEchoMode</a></td>
97 <td>Public method to get the current echo mode of the line edit.</td>
98 </tr>
99 <tr>
100 <td><a href="#EricTextInputDialog.textValue">textValue</a></td>
101 <td>Public method to get the text of the line edit.</td>
102 </tr>
103 </table>
104 <h3>Static Methods</h3>
105
106 <table>
107 <tr><td>None</td></tr>
108 </table>
109
110 <a NAME="EricTextInputDialog.__init__" ID="EricTextInputDialog.__init__"></a>
111 <h4>EricTextInputDialog (Constructor)</h4>
112 <b>EricTextInputDialog</b>(<i>parent=None</i>)
113
114 <p>
115 Constructor
116 </p>
117 <dl>
118
119 <dt><i>parent</i> (QWidget)</dt>
120 <dd>
121 reference to the parent widget
122 </dd>
123 </dl>
124 <a NAME="EricTextInputDialog.labelText" ID="EricTextInputDialog.labelText"></a>
125 <h4>EricTextInputDialog.labelText</h4>
126 <b>labelText</b>(<i></i>)
127
128 <p>
129 Public method to get the current label text.
130 </p>
131 <dl>
132 <dt>Return:</dt>
133 <dd>
134 current label text
135 </dd>
136 </dl>
137 <dl>
138 <dt>Return Type:</dt>
139 <dd>
140 str
141 </dd>
142 </dl>
143 <a NAME="EricTextInputDialog.setLabelText" ID="EricTextInputDialog.setLabelText"></a>
144 <h4>EricTextInputDialog.setLabelText</h4>
145 <b>setLabelText</b>(<i>text</i>)
146
147 <p>
148 Public method to set the label text.
149 </p>
150 <dl>
151
152 <dt><i>text</i> (str)</dt>
153 <dd>
154 label text
155 </dd>
156 </dl>
157 <a NAME="EricTextInputDialog.setTextEchoMode" ID="EricTextInputDialog.setTextEchoMode"></a>
158 <h4>EricTextInputDialog.setTextEchoMode</h4>
159 <b>setTextEchoMode</b>(<i>echoMode</i>)
160
161 <p>
162 Public method to set the echo mode of the line edit.
163 </p>
164 <dl>
165
166 <dt><i>echoMode</i> (QLineEdit.EchoMode)</dt>
167 <dd>
168 echo mode of the line edit
169 </dd>
170 </dl>
171 <a NAME="EricTextInputDialog.setTextValue" ID="EricTextInputDialog.setTextValue"></a>
172 <h4>EricTextInputDialog.setTextValue</h4>
173 <b>setTextValue</b>(<i>text</i>)
174
175 <p>
176 Public method to set the text of the line edit.
177 </p>
178 <dl>
179
180 <dt><i>text</i> (str)</dt>
181 <dd>
182 text for the line edit
183 </dd>
184 </dl>
185 <a NAME="EricTextInputDialog.textEchoMode" ID="EricTextInputDialog.textEchoMode"></a>
186 <h4>EricTextInputDialog.textEchoMode</h4>
187 <b>textEchoMode</b>(<i></i>)
188
189 <p>
190 Public method to get the current echo mode of the line edit.
191 </p>
192 <dl>
193 <dt>Return:</dt>
194 <dd>
195 echo mode of the line edit
196 </dd>
197 </dl>
198 <dl>
199 <dt>Return Type:</dt>
200 <dd>
201 QLineEdit.EchoMode
202 </dd>
203 </dl>
204 <a NAME="EricTextInputDialog.textValue" ID="EricTextInputDialog.textValue"></a>
205 <h4>EricTextInputDialog.textValue</h4>
206 <b>textValue</b>(<i></i>)
207
208 <p>
209 Public method to get the text of the line edit.
210 </p>
211 <dl>
212 <dt>Return:</dt>
213 <dd>
214 text of the line edit
215 </dd>
216 </dl>
217 <dl>
218 <dt>Return Type:</dt>
219 <dd>
220 str
221 </dd>
222 </dl>
223 <div align="right"><a href="#top">Up</a></div>
224 <hr />
225 <hr />
226 <a NAME="getText" ID="getText"></a>
227 <h2>getText</h2>
228 <b>getText</b>(<i>parent, title, label, mode=QLineEdit.EchoMode.Normal, text="", minimumWidth=300</i>)
229
230 <p>
231 Function to get create a dialog to enter some text and return it.
232 </p>
233 <dl>
234
235 <dt><i>parent</i> (QWidget)</dt>
236 <dd>
237 reference to the parent widget
238 </dd>
239 <dt><i>title</i> (str)</dt>
240 <dd>
241 title of the dialog
242 </dd>
243 <dt><i>label</i> (str)</dt>
244 <dd>
245 label of the dialog
246 </dd>
247 <dt><i>mode</i> (QLineEdit.EchoMode)</dt>
248 <dd>
249 echo mode of the line edit
250 </dd>
251 <dt><i>text</i> (str)</dt>
252 <dd>
253 initial text of the line edit
254 </dd>
255 <dt><i>minimumWidth</i> (int)</dt>
256 <dd>
257 minimum width of the dialog
258 </dd>
259 </dl>
260 <dl>
261 <dt>Return:</dt>
262 <dd>
263 tuple containing a flag indicating the dialog was accepted and the
264 entered text
265 </dd>
266 </dl>
267 <dl>
268 <dt>Return Type:</dt>
269 <dd>
270 tuple of (bool, str)
271 </dd>
272 </dl>
273 <div align="right"><a href="#top">Up</a></div>
274 <hr />
275 </body></html>

eric ide

mercurial