Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.EricWidgets.EricPathPicker.html

eric7/Documentation/Source/eric7.EricWidgets.EricPathPicker.html

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

Mercurial Repository: eric

eric ide

mercurial