|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.EricWidgets.EricPathPicker</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.EricPathPicker</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a path picker widget. |
|
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="#EricComboPathPicker">EricComboPathPicker</a></td> |
|
25 <td>Class implementing a path picker widget consisting of a combobox and a tool button to open a file dialog.</td> |
|
26 </tr> |
|
27 <tr> |
|
28 <td><a href="#EricPathPicker">EricPathPicker</a></td> |
|
29 <td>Class implementing a path picker widget consisting of a line edit and a tool button to open a file dialog.</td> |
|
30 </tr> |
|
31 <tr> |
|
32 <td><a href="#EricPathPickerBase">EricPathPickerBase</a></td> |
|
33 <td>Class implementing the base of a path picker widget consisting of a line edit or combo box and a tool button to open a file dialog.</td> |
|
34 </tr> |
|
35 <tr> |
|
36 <td><a href="#EricPathPickerModes">EricPathPickerModes</a></td> |
|
37 <td>Class implementing the path picker modes.</td> |
|
38 </tr> |
|
39 </table> |
|
40 <h3>Functions</h3> |
|
41 |
|
42 <table> |
|
43 <tr><td>None</td></tr> |
|
44 </table> |
|
45 <hr /> |
|
46 <hr /> |
|
47 <a NAME="EricComboPathPicker" ID="EricComboPathPicker"></a> |
|
48 <h2>EricComboPathPicker</h2> |
|
49 |
|
50 <p> |
|
51 Class implementing a path picker widget consisting of a combobox and a |
|
52 tool button to open a file dialog. |
|
53 </p> |
|
54 <h3>Derived from</h3> |
|
55 EricPathPickerBase |
|
56 <h3>Class Attributes</h3> |
|
57 |
|
58 <table> |
|
59 <tr><td>None</td></tr> |
|
60 </table> |
|
61 <h3>Class Methods</h3> |
|
62 |
|
63 <table> |
|
64 <tr><td>None</td></tr> |
|
65 </table> |
|
66 <h3>Methods</h3> |
|
67 |
|
68 <table> |
|
69 |
|
70 <tr> |
|
71 <td><a href="#EricComboPathPicker.__init__">EricComboPathPicker</a></td> |
|
72 <td>Constructor</td> |
|
73 </tr> |
|
74 <tr> |
|
75 <td><a href="#EricComboPathPicker.getPathItems">getPathItems</a></td> |
|
76 <td>Public method to get the list of remembered paths.</td> |
|
77 </tr> |
|
78 </table> |
|
79 <h3>Static Methods</h3> |
|
80 |
|
81 <table> |
|
82 <tr><td>None</td></tr> |
|
83 </table> |
|
84 |
|
85 <a NAME="EricComboPathPicker.__init__" ID="EricComboPathPicker.__init__"></a> |
|
86 <h4>EricComboPathPicker (Constructor)</h4> |
|
87 <b>EricComboPathPicker</b>(<i>parent=None</i>) |
|
88 |
|
89 <p> |
|
90 Constructor |
|
91 </p> |
|
92 <dl> |
|
93 |
|
94 <dt><i>parent</i> (QWidget)</dt> |
|
95 <dd> |
|
96 reference to the parent widget |
|
97 </dd> |
|
98 </dl> |
|
99 <a NAME="EricComboPathPicker.getPathItems" ID="EricComboPathPicker.getPathItems"></a> |
|
100 <h4>EricComboPathPicker.getPathItems</h4> |
|
101 <b>getPathItems</b>(<i></i>) |
|
102 |
|
103 <p> |
|
104 Public method to get the list of remembered paths. |
|
105 </p> |
|
106 <dl> |
|
107 <dt>Return:</dt> |
|
108 <dd> |
|
109 list od remembered paths |
|
110 </dd> |
|
111 </dl> |
|
112 <dl> |
|
113 <dt>Return Type:</dt> |
|
114 <dd> |
|
115 list of str |
|
116 </dd> |
|
117 </dl> |
|
118 <div align="right"><a href="#top">Up</a></div> |
|
119 <hr /> |
|
120 <hr /> |
|
121 <a NAME="EricPathPicker" ID="EricPathPicker"></a> |
|
122 <h2>EricPathPicker</h2> |
|
123 |
|
124 <p> |
|
125 Class implementing a path picker widget consisting of a line edit and a |
|
126 tool button to open a file dialog. |
|
127 </p> |
|
128 <h3>Derived from</h3> |
|
129 EricPathPickerBase |
|
130 <h3>Class Attributes</h3> |
|
131 |
|
132 <table> |
|
133 <tr><td>None</td></tr> |
|
134 </table> |
|
135 <h3>Class Methods</h3> |
|
136 |
|
137 <table> |
|
138 <tr><td>None</td></tr> |
|
139 </table> |
|
140 <h3>Methods</h3> |
|
141 |
|
142 <table> |
|
143 |
|
144 <tr> |
|
145 <td><a href="#EricPathPicker.__init__">EricPathPicker</a></td> |
|
146 <td>Constructor</td> |
|
147 </tr> |
|
148 </table> |
|
149 <h3>Static Methods</h3> |
|
150 |
|
151 <table> |
|
152 <tr><td>None</td></tr> |
|
153 </table> |
|
154 |
|
155 <a NAME="EricPathPicker.__init__" ID="EricPathPicker.__init__"></a> |
|
156 <h4>EricPathPicker (Constructor)</h4> |
|
157 <b>EricPathPicker</b>(<i>parent=None</i>) |
|
158 |
|
159 <p> |
|
160 Constructor |
|
161 </p> |
|
162 <dl> |
|
163 |
|
164 <dt><i>parent</i> (QWidget)</dt> |
|
165 <dd> |
|
166 reference to the parent widget |
|
167 </dd> |
|
168 </dl> |
|
169 <div align="right"><a href="#top">Up</a></div> |
|
170 <hr /> |
|
171 <hr /> |
|
172 <a NAME="EricPathPickerBase" ID="EricPathPickerBase"></a> |
|
173 <h2>EricPathPickerBase</h2> |
|
174 |
|
175 <p> |
|
176 Class implementing the base of a path picker widget consisting of a |
|
177 line edit or combo box and a tool button to open a file dialog. |
|
178 </p> |
|
179 <h3>Signals</h3> |
|
180 <dl> |
|
181 |
|
182 <dt>aboutToShowPathPickerDialog</dt> |
|
183 <dd> |
|
184 emitted before the file dialog is shown |
|
185 </dd> |
|
186 <dt>editTextChanged(path)</dt> |
|
187 <dd> |
|
188 emitted when the entered path has changed |
|
189 (combo box based widget) |
|
190 </dd> |
|
191 <dt>pathSelected(path)</dt> |
|
192 <dd> |
|
193 emitted after a path has been selected via the |
|
194 file dialog |
|
195 </dd> |
|
196 <dt>pickerButtonClicked</dt> |
|
197 <dd> |
|
198 emitted when the picker button was pressed and |
|
199 the widget mode is custom |
|
200 </dd> |
|
201 <dt>textChanged(path)</dt> |
|
202 <dd> |
|
203 emitted when the entered path has changed |
|
204 (line edit based widget) |
|
205 </dd> |
|
206 </dl> |
|
207 <h3>Derived from</h3> |
|
208 QWidget |
|
209 <h3>Class Attributes</h3> |
|
210 |
|
211 <table> |
|
212 <tr><td>DefaultMode</td></tr> |
|
213 </table> |
|
214 <h3>Class Methods</h3> |
|
215 |
|
216 <table> |
|
217 <tr><td>None</td></tr> |
|
218 </table> |
|
219 <h3>Methods</h3> |
|
220 |
|
221 <table> |
|
222 |
|
223 <tr> |
|
224 <td><a href="#EricPathPickerBase.__init__">EricPathPickerBase</a></td> |
|
225 <td>Constructor</td> |
|
226 </tr> |
|
227 <tr> |
|
228 <td><a href="#EricPathPickerBase.__pathEdited">__pathEdited</a></td> |
|
229 <td>Private slot handling editing of the path.</td> |
|
230 </tr> |
|
231 <tr> |
|
232 <td><a href="#EricPathPickerBase.__showPathPickerDialog">__showPathPickerDialog</a></td> |
|
233 <td>Private slot to show the path picker dialog.</td> |
|
234 </tr> |
|
235 <tr> |
|
236 <td><a href="#EricPathPickerBase._editorText">_editorText</a></td> |
|
237 <td>Protected method to get the text of the editor.</td> |
|
238 </tr> |
|
239 <tr> |
|
240 <td><a href="#EricPathPickerBase._setEditorText">_setEditorText</a></td> |
|
241 <td>Protected method to set the text of the editor.</td> |
|
242 </tr> |
|
243 <tr> |
|
244 <td><a href="#EricPathPickerBase.addItem">addItem</a></td> |
|
245 <td>Public method to add a paths to the current list.</td> |
|
246 </tr> |
|
247 <tr> |
|
248 <td><a href="#EricPathPickerBase.addItems">addItems</a></td> |
|
249 <td>Public method to add paths to the current list.</td> |
|
250 </tr> |
|
251 <tr> |
|
252 <td><a href="#EricPathPickerBase.buttonToolTip">buttonToolTip</a></td> |
|
253 <td>Public method to get the tool button tool tip.</td> |
|
254 </tr> |
|
255 <tr> |
|
256 <td><a href="#EricPathPickerBase.clear">clear</a></td> |
|
257 <td>Public method to clear the current path or list of paths.</td> |
|
258 </tr> |
|
259 <tr> |
|
260 <td><a href="#EricPathPickerBase.clearEditText">clearEditText</a></td> |
|
261 <td>Public method to clear the current path.</td> |
|
262 </tr> |
|
263 <tr> |
|
264 <td><a href="#EricPathPickerBase.currentText">currentText</a></td> |
|
265 <td>Public method to get the current path.</td> |
|
266 </tr> |
|
267 <tr> |
|
268 <td><a href="#EricPathPickerBase.defaultDirectory">defaultDirectory</a></td> |
|
269 <td>Public method to get the default directory.</td> |
|
270 </tr> |
|
271 <tr> |
|
272 <td><a href="#EricPathPickerBase.editorEnabled">editorEnabled</a></td> |
|
273 <td>Public method to get the path editor's enabled state.</td> |
|
274 </tr> |
|
275 <tr> |
|
276 <td><a href="#EricPathPickerBase.editorToolTip">editorToolTip</a></td> |
|
277 <td>Public method to get the editor tool tip.</td> |
|
278 </tr> |
|
279 <tr> |
|
280 <td><a href="#EricPathPickerBase.filters">filters</a></td> |
|
281 <td>Public methods to get the filter string.</td> |
|
282 </tr> |
|
283 <tr> |
|
284 <td><a href="#EricPathPickerBase.firstPath">firstPath</a></td> |
|
285 <td>Public method to get the first path of a list of entered paths.</td> |
|
286 </tr> |
|
287 <tr> |
|
288 <td><a href="#EricPathPickerBase.isPickerEnabled">isPickerEnabled</a></td> |
|
289 <td>Public method to get the file dialog button enabled state.</td> |
|
290 </tr> |
|
291 <tr> |
|
292 <td><a href="#EricPathPickerBase.isReadOnly">isReadOnly</a></td> |
|
293 <td>Public method to check the path picker for read only mode.</td> |
|
294 </tr> |
|
295 <tr> |
|
296 <td><a href="#EricPathPickerBase.lastPath">lastPath</a></td> |
|
297 <td>Public method to get the last path of a list of entered paths.</td> |
|
298 </tr> |
|
299 <tr> |
|
300 <td><a href="#EricPathPickerBase.mode">mode</a></td> |
|
301 <td>Public method to get the path picker mode.</td> |
|
302 </tr> |
|
303 <tr> |
|
304 <td><a href="#EricPathPickerBase.path">path</a></td> |
|
305 <td>Public method to get the current path.</td> |
|
306 </tr> |
|
307 <tr> |
|
308 <td><a href="#EricPathPickerBase.paths">paths</a></td> |
|
309 <td>Public method to get the list of entered paths.</td> |
|
310 </tr> |
|
311 <tr> |
|
312 <td><a href="#EricPathPickerBase.setButtonToolTip">setButtonToolTip</a></td> |
|
313 <td>Public method to set the tool button tool tip.</td> |
|
314 </tr> |
|
315 <tr> |
|
316 <td><a href="#EricPathPickerBase.setCurrentIndex">setCurrentIndex</a></td> |
|
317 <td>Public slot to set the current index.</td> |
|
318 </tr> |
|
319 <tr> |
|
320 <td><a href="#EricPathPickerBase.setCurrentText">setCurrentText</a></td> |
|
321 <td>Public slot to set the current text.</td> |
|
322 </tr> |
|
323 <tr> |
|
324 <td><a href="#EricPathPickerBase.setDefaultDirectory">setDefaultDirectory</a></td> |
|
325 <td>Public method to set the default directory.</td> |
|
326 </tr> |
|
327 <tr> |
|
328 <td><a href="#EricPathPickerBase.setEditText">setEditText</a></td> |
|
329 <td>Public method to set the current path.</td> |
|
330 </tr> |
|
331 <tr> |
|
332 <td><a href="#EricPathPickerBase.setEditorEnabled">setEditorEnabled</a></td> |
|
333 <td>Public method to set the path editor's enabled state.</td> |
|
334 </tr> |
|
335 <tr> |
|
336 <td><a href="#EricPathPickerBase.setEditorToolTip">setEditorToolTip</a></td> |
|
337 <td>Public method to set the editor tool tip.</td> |
|
338 </tr> |
|
339 <tr> |
|
340 <td><a href="#EricPathPickerBase.setFilters">setFilters</a></td> |
|
341 <td>Public method to set the filters for the path picker dialog.</td> |
|
342 </tr> |
|
343 <tr> |
|
344 <td><a href="#EricPathPickerBase.setInsertPolicy">setInsertPolicy</a></td> |
|
345 <td>Public method to set the insertion policy of the combo box.</td> |
|
346 </tr> |
|
347 <tr> |
|
348 <td><a href="#EricPathPickerBase.setMode">setMode</a></td> |
|
349 <td>Public method to set the path picker mode.</td> |
|
350 </tr> |
|
351 <tr> |
|
352 <td><a href="#EricPathPickerBase.setNameFilters">setNameFilters</a></td> |
|
353 <td>Public method to set the name filters for the completer.</td> |
|
354 </tr> |
|
355 <tr> |
|
356 <td><a href="#EricPathPickerBase.setPath">setPath</a></td> |
|
357 <td>Public method to set the current path.</td> |
|
358 </tr> |
|
359 <tr> |
|
360 <td><a href="#EricPathPickerBase.setPathsList">setPathsList</a></td> |
|
361 <td>Public method to set the paths list.</td> |
|
362 </tr> |
|
363 <tr> |
|
364 <td><a href="#EricPathPickerBase.setPickerEnabled">setPickerEnabled</a></td> |
|
365 <td>Public method to set the enabled state of the file dialog button.</td> |
|
366 </tr> |
|
367 <tr> |
|
368 <td><a href="#EricPathPickerBase.setReadOnly">setReadOnly</a></td> |
|
369 <td>Public method to set the path picker to read only mode.</td> |
|
370 </tr> |
|
371 <tr> |
|
372 <td><a href="#EricPathPickerBase.setSizeAdjustPolicy">setSizeAdjustPolicy</a></td> |
|
373 <td>Public method to set the size adjust policy of the combo box.</td> |
|
374 </tr> |
|
375 <tr> |
|
376 <td><a href="#EricPathPickerBase.setText">setText</a></td> |
|
377 <td>Public method to set the current path.</td> |
|
378 </tr> |
|
379 <tr> |
|
380 <td><a href="#EricPathPickerBase.setWindowTitle">setWindowTitle</a></td> |
|
381 <td>Public method to set the path picker dialog window title.</td> |
|
382 </tr> |
|
383 <tr> |
|
384 <td><a href="#EricPathPickerBase.text">text</a></td> |
|
385 <td>Public method to get the current path.</td> |
|
386 </tr> |
|
387 <tr> |
|
388 <td><a href="#EricPathPickerBase.windowTitle">windowTitle</a></td> |
|
389 <td>Public method to get the path picker dialog's window title.</td> |
|
390 </tr> |
|
391 </table> |
|
392 <h3>Static Methods</h3> |
|
393 |
|
394 <table> |
|
395 <tr><td>None</td></tr> |
|
396 </table> |
|
397 |
|
398 <a NAME="EricPathPickerBase.__init__" ID="EricPathPickerBase.__init__"></a> |
|
399 <h4>EricPathPickerBase (Constructor)</h4> |
|
400 <b>EricPathPickerBase</b>(<i>parent=None, useLineEdit=True</i>) |
|
401 |
|
402 <p> |
|
403 Constructor |
|
404 </p> |
|
405 <dl> |
|
406 |
|
407 <dt><i>parent</i> (QWidget)</dt> |
|
408 <dd> |
|
409 reference to the parent widget |
|
410 </dd> |
|
411 <dt><i>useLineEdit</i> (bool)</dt> |
|
412 <dd> |
|
413 flag indicating the use of a line edit |
|
414 </dd> |
|
415 </dl> |
|
416 <a NAME="EricPathPickerBase.__pathEdited" ID="EricPathPickerBase.__pathEdited"></a> |
|
417 <h4>EricPathPickerBase.__pathEdited</h4> |
|
418 <b>__pathEdited</b>(<i>fpath</i>) |
|
419 |
|
420 <p> |
|
421 Private slot handling editing of the path. |
|
422 </p> |
|
423 <dl> |
|
424 |
|
425 <dt><i>fpath</i> (str)</dt> |
|
426 <dd> |
|
427 current text of the path line edit |
|
428 </dd> |
|
429 </dl> |
|
430 <a NAME="EricPathPickerBase.__showPathPickerDialog" ID="EricPathPickerBase.__showPathPickerDialog"></a> |
|
431 <h4>EricPathPickerBase.__showPathPickerDialog</h4> |
|
432 <b>__showPathPickerDialog</b>(<i></i>) |
|
433 |
|
434 <p> |
|
435 Private slot to show the path picker dialog. |
|
436 </p> |
|
437 <a NAME="EricPathPickerBase._editorText" ID="EricPathPickerBase._editorText"></a> |
|
438 <h4>EricPathPickerBase._editorText</h4> |
|
439 <b>_editorText</b>(<i></i>) |
|
440 |
|
441 <p> |
|
442 Protected method to get the text of the editor. |
|
443 </p> |
|
444 <dl> |
|
445 <dt>Return:</dt> |
|
446 <dd> |
|
447 text of the editor |
|
448 </dd> |
|
449 </dl> |
|
450 <dl> |
|
451 <dt>Return Type:</dt> |
|
452 <dd> |
|
453 str |
|
454 </dd> |
|
455 </dl> |
|
456 <a NAME="EricPathPickerBase._setEditorText" ID="EricPathPickerBase._setEditorText"></a> |
|
457 <h4>EricPathPickerBase._setEditorText</h4> |
|
458 <b>_setEditorText</b>(<i>text</i>) |
|
459 |
|
460 <p> |
|
461 Protected method to set the text of the editor. |
|
462 </p> |
|
463 <dl> |
|
464 |
|
465 <dt><i>text</i> (str)</dt> |
|
466 <dd> |
|
467 text to set |
|
468 </dd> |
|
469 </dl> |
|
470 <a NAME="EricPathPickerBase.addItem" ID="EricPathPickerBase.addItem"></a> |
|
471 <h4>EricPathPickerBase.addItem</h4> |
|
472 <b>addItem</b>(<i>fpath</i>) |
|
473 |
|
474 <p> |
|
475 Public method to add a paths to the current list. |
|
476 </p> |
|
477 <dl> |
|
478 |
|
479 <dt><i>fpath</i> (str)</dt> |
|
480 <dd> |
|
481 path to add |
|
482 </dd> |
|
483 </dl> |
|
484 <a NAME="EricPathPickerBase.addItems" ID="EricPathPickerBase.addItems"></a> |
|
485 <h4>EricPathPickerBase.addItems</h4> |
|
486 <b>addItems</b>(<i>pathsList</i>) |
|
487 |
|
488 <p> |
|
489 Public method to add paths to the current list. |
|
490 </p> |
|
491 <dl> |
|
492 |
|
493 <dt><i>pathsList</i> (list of str)</dt> |
|
494 <dd> |
|
495 list of paths to add |
|
496 </dd> |
|
497 </dl> |
|
498 <a NAME="EricPathPickerBase.buttonToolTip" ID="EricPathPickerBase.buttonToolTip"></a> |
|
499 <h4>EricPathPickerBase.buttonToolTip</h4> |
|
500 <b>buttonToolTip</b>(<i></i>) |
|
501 |
|
502 <p> |
|
503 Public method to get the tool button tool tip. |
|
504 </p> |
|
505 <dl> |
|
506 <dt>Return:</dt> |
|
507 <dd> |
|
508 tool tip text |
|
509 </dd> |
|
510 </dl> |
|
511 <dl> |
|
512 <dt>Return Type:</dt> |
|
513 <dd> |
|
514 str |
|
515 </dd> |
|
516 </dl> |
|
517 <a NAME="EricPathPickerBase.clear" ID="EricPathPickerBase.clear"></a> |
|
518 <h4>EricPathPickerBase.clear</h4> |
|
519 <b>clear</b>(<i></i>) |
|
520 |
|
521 <p> |
|
522 Public method to clear the current path or list of paths. |
|
523 </p> |
|
524 <a NAME="EricPathPickerBase.clearEditText" ID="EricPathPickerBase.clearEditText"></a> |
|
525 <h4>EricPathPickerBase.clearEditText</h4> |
|
526 <b>clearEditText</b>(<i></i>) |
|
527 |
|
528 <p> |
|
529 Public method to clear the current path. |
|
530 </p> |
|
531 <a NAME="EricPathPickerBase.currentText" ID="EricPathPickerBase.currentText"></a> |
|
532 <h4>EricPathPickerBase.currentText</h4> |
|
533 <b>currentText</b>(<i>toNative=True</i>) |
|
534 |
|
535 <p> |
|
536 Public method to get the current path. |
|
537 </p> |
|
538 <dl> |
|
539 |
|
540 <dt><i>toNative</i> (bool)</dt> |
|
541 <dd> |
|
542 flag indicating to convert the path into |
|
543 a native format |
|
544 </dd> |
|
545 </dl> |
|
546 <dl> |
|
547 <dt>Return:</dt> |
|
548 <dd> |
|
549 current path |
|
550 </dd> |
|
551 </dl> |
|
552 <dl> |
|
553 <dt>Return Type:</dt> |
|
554 <dd> |
|
555 str |
|
556 </dd> |
|
557 </dl> |
|
558 <a NAME="EricPathPickerBase.defaultDirectory" ID="EricPathPickerBase.defaultDirectory"></a> |
|
559 <h4>EricPathPickerBase.defaultDirectory</h4> |
|
560 <b>defaultDirectory</b>(<i></i>) |
|
561 |
|
562 <p> |
|
563 Public method to get the default directory. |
|
564 </p> |
|
565 <dl> |
|
566 <dt>Return:</dt> |
|
567 <dd> |
|
568 default directory |
|
569 </dd> |
|
570 </dl> |
|
571 <dl> |
|
572 <dt>Return Type:</dt> |
|
573 <dd> |
|
574 str |
|
575 </dd> |
|
576 </dl> |
|
577 <a NAME="EricPathPickerBase.editorEnabled" ID="EricPathPickerBase.editorEnabled"></a> |
|
578 <h4>EricPathPickerBase.editorEnabled</h4> |
|
579 <b>editorEnabled</b>(<i></i>) |
|
580 |
|
581 <p> |
|
582 Public method to get the path editor's enabled state. |
|
583 </p> |
|
584 <dl> |
|
585 <dt>Return:</dt> |
|
586 <dd> |
|
587 flag indicating the enabled state |
|
588 </dd> |
|
589 </dl> |
|
590 <dl> |
|
591 <dt>Return Type:</dt> |
|
592 <dd> |
|
593 bool |
|
594 </dd> |
|
595 </dl> |
|
596 <a NAME="EricPathPickerBase.editorToolTip" ID="EricPathPickerBase.editorToolTip"></a> |
|
597 <h4>EricPathPickerBase.editorToolTip</h4> |
|
598 <b>editorToolTip</b>(<i></i>) |
|
599 |
|
600 <p> |
|
601 Public method to get the editor tool tip. |
|
602 </p> |
|
603 <dl> |
|
604 <dt>Return:</dt> |
|
605 <dd> |
|
606 tool tip text |
|
607 </dd> |
|
608 </dl> |
|
609 <dl> |
|
610 <dt>Return Type:</dt> |
|
611 <dd> |
|
612 str |
|
613 </dd> |
|
614 </dl> |
|
615 <a NAME="EricPathPickerBase.filters" ID="EricPathPickerBase.filters"></a> |
|
616 <h4>EricPathPickerBase.filters</h4> |
|
617 <b>filters</b>(<i></i>) |
|
618 |
|
619 <p> |
|
620 Public methods to get the filter string. |
|
621 </p> |
|
622 <dl> |
|
623 <dt>Return:</dt> |
|
624 <dd> |
|
625 filter string |
|
626 </dd> |
|
627 </dl> |
|
628 <dl> |
|
629 <dt>Return Type:</dt> |
|
630 <dd> |
|
631 str |
|
632 </dd> |
|
633 </dl> |
|
634 <a NAME="EricPathPickerBase.firstPath" ID="EricPathPickerBase.firstPath"></a> |
|
635 <h4>EricPathPickerBase.firstPath</h4> |
|
636 <b>firstPath</b>(<i>toNative=True</i>) |
|
637 |
|
638 <p> |
|
639 Public method to get the first path of a list of entered paths. |
|
640 </p> |
|
641 <dl> |
|
642 |
|
643 <dt><i>toNative</i> (bool)</dt> |
|
644 <dd> |
|
645 flag indicating to convert the path into |
|
646 a native format |
|
647 </dd> |
|
648 </dl> |
|
649 <dl> |
|
650 <dt>Return:</dt> |
|
651 <dd> |
|
652 first path |
|
653 </dd> |
|
654 </dl> |
|
655 <dl> |
|
656 <dt>Return Type:</dt> |
|
657 <dd> |
|
658 str |
|
659 </dd> |
|
660 </dl> |
|
661 <a NAME="EricPathPickerBase.isPickerEnabled" ID="EricPathPickerBase.isPickerEnabled"></a> |
|
662 <h4>EricPathPickerBase.isPickerEnabled</h4> |
|
663 <b>isPickerEnabled</b>(<i></i>) |
|
664 |
|
665 <p> |
|
666 Public method to get the file dialog button enabled state. |
|
667 </p> |
|
668 <dl> |
|
669 <dt>Return:</dt> |
|
670 <dd> |
|
671 flag indicating the enabled state |
|
672 </dd> |
|
673 </dl> |
|
674 <dl> |
|
675 <dt>Return Type:</dt> |
|
676 <dd> |
|
677 bool |
|
678 </dd> |
|
679 </dl> |
|
680 <a NAME="EricPathPickerBase.isReadOnly" ID="EricPathPickerBase.isReadOnly"></a> |
|
681 <h4>EricPathPickerBase.isReadOnly</h4> |
|
682 <b>isReadOnly</b>(<i></i>) |
|
683 |
|
684 <p> |
|
685 Public method to check the path picker for read only mode. |
|
686 </p> |
|
687 <dl> |
|
688 <dt>Return:</dt> |
|
689 <dd> |
|
690 flg indicating read only mode |
|
691 </dd> |
|
692 </dl> |
|
693 <dl> |
|
694 <dt>Return Type:</dt> |
|
695 <dd> |
|
696 bool |
|
697 </dd> |
|
698 </dl> |
|
699 <a NAME="EricPathPickerBase.lastPath" ID="EricPathPickerBase.lastPath"></a> |
|
700 <h4>EricPathPickerBase.lastPath</h4> |
|
701 <b>lastPath</b>(<i>toNative=True</i>) |
|
702 |
|
703 <p> |
|
704 Public method to get the last path of a list of entered paths. |
|
705 </p> |
|
706 <dl> |
|
707 |
|
708 <dt><i>toNative</i> (bool)</dt> |
|
709 <dd> |
|
710 flag indicating to convert the path into |
|
711 a native format |
|
712 </dd> |
|
713 </dl> |
|
714 <dl> |
|
715 <dt>Return:</dt> |
|
716 <dd> |
|
717 last path |
|
718 </dd> |
|
719 </dl> |
|
720 <dl> |
|
721 <dt>Return Type:</dt> |
|
722 <dd> |
|
723 str |
|
724 </dd> |
|
725 </dl> |
|
726 <a NAME="EricPathPickerBase.mode" ID="EricPathPickerBase.mode"></a> |
|
727 <h4>EricPathPickerBase.mode</h4> |
|
728 <b>mode</b>(<i></i>) |
|
729 |
|
730 <p> |
|
731 Public method to get the path picker mode. |
|
732 </p> |
|
733 <dl> |
|
734 <dt>Return:</dt> |
|
735 <dd> |
|
736 path picker mode |
|
737 </dd> |
|
738 </dl> |
|
739 <dl> |
|
740 <dt>Return Type:</dt> |
|
741 <dd> |
|
742 EricPathPickerModes |
|
743 </dd> |
|
744 </dl> |
|
745 <a NAME="EricPathPickerBase.path" ID="EricPathPickerBase.path"></a> |
|
746 <h4>EricPathPickerBase.path</h4> |
|
747 <b>path</b>(<i>toNative=True</i>) |
|
748 |
|
749 <p> |
|
750 Public method to get the current path. |
|
751 </p> |
|
752 <dl> |
|
753 |
|
754 <dt><i>toNative</i> (bool)</dt> |
|
755 <dd> |
|
756 flag indicating to convert the path into |
|
757 a native format |
|
758 </dd> |
|
759 </dl> |
|
760 <dl> |
|
761 <dt>Return:</dt> |
|
762 <dd> |
|
763 current path |
|
764 </dd> |
|
765 </dl> |
|
766 <dl> |
|
767 <dt>Return Type:</dt> |
|
768 <dd> |
|
769 str |
|
770 </dd> |
|
771 </dl> |
|
772 <a NAME="EricPathPickerBase.paths" ID="EricPathPickerBase.paths"></a> |
|
773 <h4>EricPathPickerBase.paths</h4> |
|
774 <b>paths</b>(<i>toNative=True</i>) |
|
775 |
|
776 <p> |
|
777 Public method to get the list of entered paths. |
|
778 </p> |
|
779 <dl> |
|
780 |
|
781 <dt><i>toNative</i> (bool)</dt> |
|
782 <dd> |
|
783 flag indicating to convert the path into |
|
784 a native format |
|
785 </dd> |
|
786 </dl> |
|
787 <dl> |
|
788 <dt>Return:</dt> |
|
789 <dd> |
|
790 entered paths |
|
791 </dd> |
|
792 </dl> |
|
793 <dl> |
|
794 <dt>Return Type:</dt> |
|
795 <dd> |
|
796 list of str |
|
797 </dd> |
|
798 </dl> |
|
799 <a NAME="EricPathPickerBase.setButtonToolTip" ID="EricPathPickerBase.setButtonToolTip"></a> |
|
800 <h4>EricPathPickerBase.setButtonToolTip</h4> |
|
801 <b>setButtonToolTip</b>(<i>tooltip</i>) |
|
802 |
|
803 <p> |
|
804 Public method to set the tool button tool tip. |
|
805 </p> |
|
806 <dl> |
|
807 |
|
808 <dt><i>tooltip</i> (str)</dt> |
|
809 <dd> |
|
810 text to be set as a tool tip |
|
811 </dd> |
|
812 </dl> |
|
813 <a NAME="EricPathPickerBase.setCurrentIndex" ID="EricPathPickerBase.setCurrentIndex"></a> |
|
814 <h4>EricPathPickerBase.setCurrentIndex</h4> |
|
815 <b>setCurrentIndex</b>(<i>index</i>) |
|
816 |
|
817 <p> |
|
818 Public slot to set the current index. |
|
819 </p> |
|
820 <dl> |
|
821 |
|
822 <dt><i>index</i> (int)</dt> |
|
823 <dd> |
|
824 index of the item to set current |
|
825 </dd> |
|
826 </dl> |
|
827 <a NAME="EricPathPickerBase.setCurrentText" ID="EricPathPickerBase.setCurrentText"></a> |
|
828 <h4>EricPathPickerBase.setCurrentText</h4> |
|
829 <b>setCurrentText</b>(<i>text</i>) |
|
830 |
|
831 <p> |
|
832 Public slot to set the current text. |
|
833 </p> |
|
834 <dl> |
|
835 |
|
836 <dt><i>text</i> (str)</dt> |
|
837 <dd> |
|
838 text of the item to set current |
|
839 </dd> |
|
840 </dl> |
|
841 <a NAME="EricPathPickerBase.setDefaultDirectory" ID="EricPathPickerBase.setDefaultDirectory"></a> |
|
842 <h4>EricPathPickerBase.setDefaultDirectory</h4> |
|
843 <b>setDefaultDirectory</b>(<i>directory</i>) |
|
844 |
|
845 <p> |
|
846 Public method to set the default directory. |
|
847 </p> |
|
848 <dl> |
|
849 |
|
850 <dt><i>directory</i> (str)</dt> |
|
851 <dd> |
|
852 default directory |
|
853 </dd> |
|
854 </dl> |
|
855 <a NAME="EricPathPickerBase.setEditText" ID="EricPathPickerBase.setEditText"></a> |
|
856 <h4>EricPathPickerBase.setEditText</h4> |
|
857 <b>setEditText</b>(<i>fpath, toNative=True</i>) |
|
858 |
|
859 <p> |
|
860 Public method to set the current path. |
|
861 </p> |
|
862 <dl> |
|
863 |
|
864 <dt><i>fpath</i> (str)</dt> |
|
865 <dd> |
|
866 path to be set |
|
867 </dd> |
|
868 <dt><i>toNative</i> (bool)</dt> |
|
869 <dd> |
|
870 flag indicating to convert the path into |
|
871 a native format |
|
872 </dd> |
|
873 </dl> |
|
874 <a NAME="EricPathPickerBase.setEditorEnabled" ID="EricPathPickerBase.setEditorEnabled"></a> |
|
875 <h4>EricPathPickerBase.setEditorEnabled</h4> |
|
876 <b>setEditorEnabled</b>(<i>enable</i>) |
|
877 |
|
878 <p> |
|
879 Public method to set the path editor's enabled state. |
|
880 </p> |
|
881 <dl> |
|
882 |
|
883 <dt><i>enable</i> (bool)</dt> |
|
884 <dd> |
|
885 flag indicating the enable state |
|
886 </dd> |
|
887 </dl> |
|
888 <a NAME="EricPathPickerBase.setEditorToolTip" ID="EricPathPickerBase.setEditorToolTip"></a> |
|
889 <h4>EricPathPickerBase.setEditorToolTip</h4> |
|
890 <b>setEditorToolTip</b>(<i>tooltip</i>) |
|
891 |
|
892 <p> |
|
893 Public method to set the editor tool tip. |
|
894 </p> |
|
895 <dl> |
|
896 |
|
897 <dt><i>tooltip</i> (str)</dt> |
|
898 <dd> |
|
899 text to be set as a tool tip |
|
900 </dd> |
|
901 </dl> |
|
902 <a NAME="EricPathPickerBase.setFilters" ID="EricPathPickerBase.setFilters"></a> |
|
903 <h4>EricPathPickerBase.setFilters</h4> |
|
904 <b>setFilters</b>(<i>filters</i>) |
|
905 |
|
906 <p> |
|
907 Public method to set the filters for the path picker dialog. |
|
908 </p> |
|
909 <p> |
|
910 Note: Multiple filters must be separated by ';;'. |
|
911 </p> |
|
912 <dl> |
|
913 |
|
914 <dt><i>filters</i> (str)</dt> |
|
915 <dd> |
|
916 string containing the file filters |
|
917 </dd> |
|
918 </dl> |
|
919 <a NAME="EricPathPickerBase.setInsertPolicy" ID="EricPathPickerBase.setInsertPolicy"></a> |
|
920 <h4>EricPathPickerBase.setInsertPolicy</h4> |
|
921 <b>setInsertPolicy</b>(<i>policy</i>) |
|
922 |
|
923 <p> |
|
924 Public method to set the insertion policy of the combo box. |
|
925 </p> |
|
926 <dl> |
|
927 |
|
928 <dt><i>policy</i> (QComboBox.InsertPolicy)</dt> |
|
929 <dd> |
|
930 insertion policy |
|
931 </dd> |
|
932 </dl> |
|
933 <a NAME="EricPathPickerBase.setMode" ID="EricPathPickerBase.setMode"></a> |
|
934 <h4>EricPathPickerBase.setMode</h4> |
|
935 <b>setMode</b>(<i>mode</i>) |
|
936 |
|
937 <p> |
|
938 Public method to set the path picker mode. |
|
939 </p> |
|
940 <dl> |
|
941 |
|
942 <dt><i>mode</i> (EricPathPickerModes)</dt> |
|
943 <dd> |
|
944 picker mode |
|
945 </dd> |
|
946 </dl> |
|
947 <dl> |
|
948 |
|
949 <dt>Raises <b>ValueError</b>:</dt> |
|
950 <dd> |
|
951 raised to indicate a bad parameter value |
|
952 </dd> |
|
953 </dl> |
|
954 <a NAME="EricPathPickerBase.setNameFilters" ID="EricPathPickerBase.setNameFilters"></a> |
|
955 <h4>EricPathPickerBase.setNameFilters</h4> |
|
956 <b>setNameFilters</b>(<i>filters</i>) |
|
957 |
|
958 <p> |
|
959 Public method to set the name filters for the completer. |
|
960 </p> |
|
961 <dl> |
|
962 |
|
963 <dt><i>filters</i> (list of str)</dt> |
|
964 <dd> |
|
965 list of file name filters |
|
966 </dd> |
|
967 </dl> |
|
968 <a NAME="EricPathPickerBase.setPath" ID="EricPathPickerBase.setPath"></a> |
|
969 <h4>EricPathPickerBase.setPath</h4> |
|
970 <b>setPath</b>(<i>fpath, toNative=True</i>) |
|
971 |
|
972 <p> |
|
973 Public method to set the current path. |
|
974 </p> |
|
975 <dl> |
|
976 |
|
977 <dt><i>fpath</i> (str)</dt> |
|
978 <dd> |
|
979 path to be set |
|
980 </dd> |
|
981 <dt><i>toNative</i> (bool)</dt> |
|
982 <dd> |
|
983 flag indicating to convert the path into |
|
984 a native format |
|
985 </dd> |
|
986 </dl> |
|
987 <a NAME="EricPathPickerBase.setPathsList" ID="EricPathPickerBase.setPathsList"></a> |
|
988 <h4>EricPathPickerBase.setPathsList</h4> |
|
989 <b>setPathsList</b>(<i>pathsList</i>) |
|
990 |
|
991 <p> |
|
992 Public method to set the paths list. |
|
993 </p> |
|
994 <dl> |
|
995 |
|
996 <dt><i>pathsList</i> (list of str)</dt> |
|
997 <dd> |
|
998 list of paths |
|
999 </dd> |
|
1000 </dl> |
|
1001 <a NAME="EricPathPickerBase.setPickerEnabled" ID="EricPathPickerBase.setPickerEnabled"></a> |
|
1002 <h4>EricPathPickerBase.setPickerEnabled</h4> |
|
1003 <b>setPickerEnabled</b>(<i>enable</i>) |
|
1004 |
|
1005 <p> |
|
1006 Public method to set the enabled state of the file dialog button. |
|
1007 </p> |
|
1008 <dl> |
|
1009 |
|
1010 <dt><i>enable</i> (bool)</dt> |
|
1011 <dd> |
|
1012 flag indicating the enabled state |
|
1013 </dd> |
|
1014 </dl> |
|
1015 <a NAME="EricPathPickerBase.setReadOnly" ID="EricPathPickerBase.setReadOnly"></a> |
|
1016 <h4>EricPathPickerBase.setReadOnly</h4> |
|
1017 <b>setReadOnly</b>(<i>readOnly</i>) |
|
1018 |
|
1019 <p> |
|
1020 Public method to set the path picker to read only mode. |
|
1021 </p> |
|
1022 <dl> |
|
1023 |
|
1024 <dt><i>readOnly</i> (bool)</dt> |
|
1025 <dd> |
|
1026 flag indicating read only mode |
|
1027 </dd> |
|
1028 </dl> |
|
1029 <a NAME="EricPathPickerBase.setSizeAdjustPolicy" ID="EricPathPickerBase.setSizeAdjustPolicy"></a> |
|
1030 <h4>EricPathPickerBase.setSizeAdjustPolicy</h4> |
|
1031 <b>setSizeAdjustPolicy</b>(<i>policy</i>) |
|
1032 |
|
1033 <p> |
|
1034 Public method to set the size adjust policy of the combo box. |
|
1035 </p> |
|
1036 <dl> |
|
1037 |
|
1038 <dt><i>policy</i> (QComboBox.SizeAdjustPolicy)</dt> |
|
1039 <dd> |
|
1040 size adjust policy |
|
1041 </dd> |
|
1042 </dl> |
|
1043 <a NAME="EricPathPickerBase.setText" ID="EricPathPickerBase.setText"></a> |
|
1044 <h4>EricPathPickerBase.setText</h4> |
|
1045 <b>setText</b>(<i>fpath, toNative=True</i>) |
|
1046 |
|
1047 <p> |
|
1048 Public method to set the current path. |
|
1049 </p> |
|
1050 <dl> |
|
1051 |
|
1052 <dt><i>fpath</i> (str)</dt> |
|
1053 <dd> |
|
1054 path to be set |
|
1055 </dd> |
|
1056 <dt><i>toNative</i> (bool)</dt> |
|
1057 <dd> |
|
1058 flag indicating to convert the path into |
|
1059 a native format |
|
1060 </dd> |
|
1061 </dl> |
|
1062 <a NAME="EricPathPickerBase.setWindowTitle" ID="EricPathPickerBase.setWindowTitle"></a> |
|
1063 <h4>EricPathPickerBase.setWindowTitle</h4> |
|
1064 <b>setWindowTitle</b>(<i>title</i>) |
|
1065 |
|
1066 <p> |
|
1067 Public method to set the path picker dialog window title. |
|
1068 </p> |
|
1069 <dl> |
|
1070 |
|
1071 <dt><i>title</i> (str)</dt> |
|
1072 <dd> |
|
1073 window title |
|
1074 </dd> |
|
1075 </dl> |
|
1076 <a NAME="EricPathPickerBase.text" ID="EricPathPickerBase.text"></a> |
|
1077 <h4>EricPathPickerBase.text</h4> |
|
1078 <b>text</b>(<i>toNative=True</i>) |
|
1079 |
|
1080 <p> |
|
1081 Public method to get the current path. |
|
1082 </p> |
|
1083 <dl> |
|
1084 |
|
1085 <dt><i>toNative</i> (bool)</dt> |
|
1086 <dd> |
|
1087 flag indicating to convert the path into |
|
1088 a native format |
|
1089 </dd> |
|
1090 </dl> |
|
1091 <dl> |
|
1092 <dt>Return:</dt> |
|
1093 <dd> |
|
1094 current path |
|
1095 </dd> |
|
1096 </dl> |
|
1097 <dl> |
|
1098 <dt>Return Type:</dt> |
|
1099 <dd> |
|
1100 str |
|
1101 </dd> |
|
1102 </dl> |
|
1103 <a NAME="EricPathPickerBase.windowTitle" ID="EricPathPickerBase.windowTitle"></a> |
|
1104 <h4>EricPathPickerBase.windowTitle</h4> |
|
1105 <b>windowTitle</b>(<i></i>) |
|
1106 |
|
1107 <p> |
|
1108 Public method to get the path picker dialog's window title. |
|
1109 </p> |
|
1110 <dl> |
|
1111 <dt>Return:</dt> |
|
1112 <dd> |
|
1113 window title |
|
1114 </dd> |
|
1115 </dl> |
|
1116 <dl> |
|
1117 <dt>Return Type:</dt> |
|
1118 <dd> |
|
1119 str |
|
1120 </dd> |
|
1121 </dl> |
|
1122 <div align="right"><a href="#top">Up</a></div> |
|
1123 <hr /> |
|
1124 <hr /> |
|
1125 <a NAME="EricPathPickerModes" ID="EricPathPickerModes"></a> |
|
1126 <h2>EricPathPickerModes</h2> |
|
1127 |
|
1128 <p> |
|
1129 Class implementing the path picker modes. |
|
1130 </p> |
|
1131 <h3>Derived from</h3> |
|
1132 enum.Enum |
|
1133 <h3>Class Attributes</h3> |
|
1134 |
|
1135 <table> |
|
1136 <tr><td>CUSTOM_MODE</td></tr><tr><td>DIRECTORY_MODE</td></tr><tr><td>DIRECTORY_SHOW_FILES_MODE</td></tr><tr><td>NO_MODE</td></tr><tr><td>OPEN_FILES_AND_DIRS_MODE</td></tr><tr><td>OPEN_FILES_MODE</td></tr><tr><td>OPEN_FILE_MODE</td></tr><tr><td>SAVE_FILE_ENSURE_EXTENSION_MODE</td></tr><tr><td>SAVE_FILE_MODE</td></tr><tr><td>SAVE_FILE_OVERWRITE_MODE</td></tr> |
|
1137 </table> |
|
1138 <h3>Class Methods</h3> |
|
1139 |
|
1140 <table> |
|
1141 <tr><td>None</td></tr> |
|
1142 </table> |
|
1143 <h3>Methods</h3> |
|
1144 |
|
1145 <table> |
|
1146 <tr><td>None</td></tr> |
|
1147 </table> |
|
1148 <h3>Static Methods</h3> |
|
1149 |
|
1150 <table> |
|
1151 <tr><td>None</td></tr> |
|
1152 </table> |
|
1153 |
|
1154 <div align="right"><a href="#top">Up</a></div> |
|
1155 <hr /> |
|
1156 </body></html> |