Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.E5Gui.E5PathPicker.html

eric6/Documentation/Source/eric6.E5Gui.E5PathPicker.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.E5Gui.E5PathPicker</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><a NAME="top" ID="top"></a>
22 <h1>eric6.E5Gui.E5PathPicker</h1>
23 <p>
24 Module implementing a path picker widget.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#E5ComboPathPicker">E5ComboPathPicker</a></td>
34 <td>Class implementing a path picker widget consisting of a combobox and a tool button to open a file dialog.</td>
35 </tr><tr>
36 <td><a href="#E5PathPicker">E5PathPicker</a></td>
37 <td>Class implementing a path picker widget consisting of a line edit and a tool button to open a file dialog.</td>
38 </tr><tr>
39 <td><a href="#E5PathPickerBase">E5PathPickerBase</a></td>
40 <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>
41 </tr><tr>
42 <td><a href="#E5PathPickerModes">E5PathPickerModes</a></td>
43 <td>Class implementing the path picker modes.</td>
44 </tr>
45 </table>
46 <h3>Functions</h3>
47 <table>
48 <tr><td>None</td></tr>
49 </table>
50 <hr /><hr />
51 <a NAME="E5ComboPathPicker" ID="E5ComboPathPicker"></a>
52 <h2>E5ComboPathPicker</h2>
53 <p>
54 Class implementing a path picker widget consisting of a combobox and a
55 tool button to open a file dialog.
56 </p>
57 <h3>Derived from</h3>
58 E5PathPickerBase
59 <h3>Class Attributes</h3>
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Class Methods</h3>
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68 <table>
69 <tr>
70 <td><a href="#E5ComboPathPicker.__init__">E5ComboPathPicker</a></td>
71 <td>Constructor</td>
72 </tr><tr>
73 <td><a href="#E5ComboPathPicker.getPathItems">getPathItems</a></td>
74 <td>Public method to get the list of remembered paths.</td>
75 </tr>
76 </table>
77 <h3>Static Methods</h3>
78 <table>
79 <tr><td>None</td></tr>
80 </table>
81 <a NAME="E5ComboPathPicker.__init__" ID="E5ComboPathPicker.__init__"></a>
82 <h4>E5ComboPathPicker (Constructor)</h4>
83 <b>E5ComboPathPicker</b>(<i>parent=None</i>)
84 <p>
85 Constructor
86 </p><dl>
87 <dt><i>parent</i> (QWidget)</dt>
88 <dd>
89 reference to the parent widget
90 </dd>
91 </dl><a NAME="E5ComboPathPicker.getPathItems" ID="E5ComboPathPicker.getPathItems"></a>
92 <h4>E5ComboPathPicker.getPathItems</h4>
93 <b>getPathItems</b>(<i></i>)
94 <p>
95 Public method to get the list of remembered paths.
96 </p><dl>
97 <dt>Returns:</dt>
98 <dd>
99 list od remembered paths
100 </dd>
101 </dl><dl>
102 <dt>Return Type:</dt>
103 <dd>
104 list of str
105 </dd>
106 </dl>
107 <div align="right"><a href="#top">Up</a></div>
108 <hr /><hr />
109 <a NAME="E5PathPicker" ID="E5PathPicker"></a>
110 <h2>E5PathPicker</h2>
111 <p>
112 Class implementing a path picker widget consisting of a line edit and a
113 tool button to open a file dialog.
114 </p>
115 <h3>Derived from</h3>
116 E5PathPickerBase
117 <h3>Class Attributes</h3>
118 <table>
119 <tr><td>None</td></tr>
120 </table>
121 <h3>Class Methods</h3>
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125 <h3>Methods</h3>
126 <table>
127 <tr>
128 <td><a href="#E5PathPicker.__init__">E5PathPicker</a></td>
129 <td>Constructor</td>
130 </tr>
131 </table>
132 <h3>Static Methods</h3>
133 <table>
134 <tr><td>None</td></tr>
135 </table>
136 <a NAME="E5PathPicker.__init__" ID="E5PathPicker.__init__"></a>
137 <h4>E5PathPicker (Constructor)</h4>
138 <b>E5PathPicker</b>(<i>parent=None</i>)
139 <p>
140 Constructor
141 </p><dl>
142 <dt><i>parent</i> (QWidget)</dt>
143 <dd>
144 reference to the parent widget
145 </dd>
146 </dl>
147 <div align="right"><a href="#top">Up</a></div>
148 <hr /><hr />
149 <a NAME="E5PathPickerBase" ID="E5PathPickerBase"></a>
150 <h2>E5PathPickerBase</h2>
151 <p>
152 Class implementing the base of a path picker widget consisting of a
153 line edit or combo box and a tool button to open a file dialog.
154 </p><h3>Signals</h3>
155 <dl>
156 <dt>aboutToShowPathPickerDialog</dt>
157 <dd>
158 emitted before the file dialog is shown
159 </dd><dt>editTextChanged(path)</dt>
160 <dd>
161 emitted when the entered path has changed
162 (combo box based widget)
163 </dd><dt>pathSelected(path)</dt>
164 <dd>
165 emitted after a path has been selected via the
166 file dialog
167 </dd><dt>pickerButtonClicked</dt>
168 <dd>
169 emitted when the picker button was pressed and
170 the widget mode is custom
171 </dd><dt>textChanged(path)</dt>
172 <dd>
173 emitted when the entered path has changed
174 (line edit based widget)
175 </dd>
176 </dl>
177 <h3>Derived from</h3>
178 QWidget
179 <h3>Class Attributes</h3>
180 <table>
181 <tr><td>DefaultMode</td></tr>
182 </table>
183 <h3>Class Methods</h3>
184 <table>
185 <tr><td>None</td></tr>
186 </table>
187 <h3>Methods</h3>
188 <table>
189 <tr>
190 <td><a href="#E5PathPickerBase.__init__">E5PathPickerBase</a></td>
191 <td>Constructor</td>
192 </tr><tr>
193 <td><a href="#E5PathPickerBase.__pathEdited">__pathEdited</a></td>
194 <td>Private slot handling editing of the path.</td>
195 </tr><tr>
196 <td><a href="#E5PathPickerBase.__showPathPickerDialog">__showPathPickerDialog</a></td>
197 <td>Private slot to show the path picker dialog.</td>
198 </tr><tr>
199 <td><a href="#E5PathPickerBase._editorText">_editorText</a></td>
200 <td>Protected method to get the text of the editor.</td>
201 </tr><tr>
202 <td><a href="#E5PathPickerBase._setEditorText">_setEditorText</a></td>
203 <td>Protected method to set the text of the editor.</td>
204 </tr><tr>
205 <td><a href="#E5PathPickerBase.addItem">addItem</a></td>
206 <td>Public method to add a paths to the current list.</td>
207 </tr><tr>
208 <td><a href="#E5PathPickerBase.addItems">addItems</a></td>
209 <td>Public method to add paths to the current list.</td>
210 </tr><tr>
211 <td><a href="#E5PathPickerBase.buttonToolTip">buttonToolTip</a></td>
212 <td>Public method to get the tool button tool tip.</td>
213 </tr><tr>
214 <td><a href="#E5PathPickerBase.clear">clear</a></td>
215 <td>Public method to clear the current path or list of paths.</td>
216 </tr><tr>
217 <td><a href="#E5PathPickerBase.clearEditText">clearEditText</a></td>
218 <td>Public method to clear the current path.</td>
219 </tr><tr>
220 <td><a href="#E5PathPickerBase.currentText">currentText</a></td>
221 <td>Public method to get the current path.</td>
222 </tr><tr>
223 <td><a href="#E5PathPickerBase.defaultDirectory">defaultDirectory</a></td>
224 <td>Public method to get the default directory.</td>
225 </tr><tr>
226 <td><a href="#E5PathPickerBase.editorEnabled">editorEnabled</a></td>
227 <td>Public method to get the path editor's enabled state.</td>
228 </tr><tr>
229 <td><a href="#E5PathPickerBase.editorToolTip">editorToolTip</a></td>
230 <td>Public method to get the editor tool tip.</td>
231 </tr><tr>
232 <td><a href="#E5PathPickerBase.filters">filters</a></td>
233 <td>Public methods to get the filter string.</td>
234 </tr><tr>
235 <td><a href="#E5PathPickerBase.firstPath">firstPath</a></td>
236 <td>Public method to get the first path of a list of entered paths.</td>
237 </tr><tr>
238 <td><a href="#E5PathPickerBase.isPickerEnabled">isPickerEnabled</a></td>
239 <td>Public method to get the file dialog button enabled state.</td>
240 </tr><tr>
241 <td><a href="#E5PathPickerBase.isReadOnly">isReadOnly</a></td>
242 <td>Public method to check the path picker for read only mode.</td>
243 </tr><tr>
244 <td><a href="#E5PathPickerBase.lastPath">lastPath</a></td>
245 <td>Public method to get the last path of a list of entered paths.</td>
246 </tr><tr>
247 <td><a href="#E5PathPickerBase.mode">mode</a></td>
248 <td>Public method to get the path picker mode.</td>
249 </tr><tr>
250 <td><a href="#E5PathPickerBase.path">path</a></td>
251 <td>Public method to get the current path.</td>
252 </tr><tr>
253 <td><a href="#E5PathPickerBase.paths">paths</a></td>
254 <td>Public method to get the list of entered paths.</td>
255 </tr><tr>
256 <td><a href="#E5PathPickerBase.setButtonToolTip">setButtonToolTip</a></td>
257 <td>Public method to set the tool button tool tip.</td>
258 </tr><tr>
259 <td><a href="#E5PathPickerBase.setCurrentIndex">setCurrentIndex</a></td>
260 <td>Public slot to set the current index.</td>
261 </tr><tr>
262 <td><a href="#E5PathPickerBase.setDefaultDirectory">setDefaultDirectory</a></td>
263 <td>Public method to set the default directory.</td>
264 </tr><tr>
265 <td><a href="#E5PathPickerBase.setEditText">setEditText</a></td>
266 <td>Public method to set the current path.</td>
267 </tr><tr>
268 <td><a href="#E5PathPickerBase.setEditorEnabled">setEditorEnabled</a></td>
269 <td>Public method to set the path editor's enabled state.</td>
270 </tr><tr>
271 <td><a href="#E5PathPickerBase.setEditorToolTip">setEditorToolTip</a></td>
272 <td>Public method to set the editor tool tip.</td>
273 </tr><tr>
274 <td><a href="#E5PathPickerBase.setFilters">setFilters</a></td>
275 <td>Public method to set the filters for the path picker dialog.</td>
276 </tr><tr>
277 <td><a href="#E5PathPickerBase.setInsertPolicy">setInsertPolicy</a></td>
278 <td>Public method to set the insertion policy of the combo box.</td>
279 </tr><tr>
280 <td><a href="#E5PathPickerBase.setMode">setMode</a></td>
281 <td>Public method to set the path picker mode.</td>
282 </tr><tr>
283 <td><a href="#E5PathPickerBase.setNameFilters">setNameFilters</a></td>
284 <td>Public method to set the name filters for the completer.</td>
285 </tr><tr>
286 <td><a href="#E5PathPickerBase.setPath">setPath</a></td>
287 <td>Public method to set the current path.</td>
288 </tr><tr>
289 <td><a href="#E5PathPickerBase.setPathsList">setPathsList</a></td>
290 <td>Public method to set the paths list.</td>
291 </tr><tr>
292 <td><a href="#E5PathPickerBase.setPickerEnabled">setPickerEnabled</a></td>
293 <td>Public method to set the enabled state of the file dialog button.</td>
294 </tr><tr>
295 <td><a href="#E5PathPickerBase.setReadOnly">setReadOnly</a></td>
296 <td>Public method to set the path picker to read only mode.</td>
297 </tr><tr>
298 <td><a href="#E5PathPickerBase.setSizeAdjustPolicy">setSizeAdjustPolicy</a></td>
299 <td>Public method to set the size adjust policy of the combo box.</td>
300 </tr><tr>
301 <td><a href="#E5PathPickerBase.setText">setText</a></td>
302 <td>Public method to set the current path.</td>
303 </tr><tr>
304 <td><a href="#E5PathPickerBase.setWindowTitle">setWindowTitle</a></td>
305 <td>Public method to set the path picker dialog window title.</td>
306 </tr><tr>
307 <td><a href="#E5PathPickerBase.text">text</a></td>
308 <td>Public method to get the current path.</td>
309 </tr><tr>
310 <td><a href="#E5PathPickerBase.windowTitle">windowTitle</a></td>
311 <td>Public method to get the path picker dialog's window title.</td>
312 </tr>
313 </table>
314 <h3>Static Methods</h3>
315 <table>
316 <tr><td>None</td></tr>
317 </table>
318 <a NAME="E5PathPickerBase.__init__" ID="E5PathPickerBase.__init__"></a>
319 <h4>E5PathPickerBase (Constructor)</h4>
320 <b>E5PathPickerBase</b>(<i>parent=None, useLineEdit=True</i>)
321 <p>
322 Constructor
323 </p><dl>
324 <dt><i>parent</i> (QWidget)</dt>
325 <dd>
326 reference to the parent widget
327 </dd><dt><i>useLineEdit</i> (bool)</dt>
328 <dd>
329 flag indicating the use of a line edit
330 </dd>
331 </dl><a NAME="E5PathPickerBase.__pathEdited" ID="E5PathPickerBase.__pathEdited"></a>
332 <h4>E5PathPickerBase.__pathEdited</h4>
333 <b>__pathEdited</b>(<i>path</i>)
334 <p>
335 Private slot handling editing of the path.
336 </p><dl>
337 <dt><i>path</i> (str)</dt>
338 <dd>
339 current text of the path line edit
340 </dd>
341 </dl><a NAME="E5PathPickerBase.__showPathPickerDialog" ID="E5PathPickerBase.__showPathPickerDialog"></a>
342 <h4>E5PathPickerBase.__showPathPickerDialog</h4>
343 <b>__showPathPickerDialog</b>(<i></i>)
344 <p>
345 Private slot to show the path picker dialog.
346 </p><a NAME="E5PathPickerBase._editorText" ID="E5PathPickerBase._editorText"></a>
347 <h4>E5PathPickerBase._editorText</h4>
348 <b>_editorText</b>(<i></i>)
349 <p>
350 Protected method to get the text of the editor.
351 </p><dl>
352 <dt>Returns:</dt>
353 <dd>
354 text of the editor
355 </dd>
356 </dl><dl>
357 <dt>Return Type:</dt>
358 <dd>
359 str
360 </dd>
361 </dl><a NAME="E5PathPickerBase._setEditorText" ID="E5PathPickerBase._setEditorText"></a>
362 <h4>E5PathPickerBase._setEditorText</h4>
363 <b>_setEditorText</b>(<i>text</i>)
364 <p>
365 Protected method to set the text of the editor.
366 </p><dl>
367 <dt><i>text</i> (str)</dt>
368 <dd>
369 text to set
370 </dd>
371 </dl><a NAME="E5PathPickerBase.addItem" ID="E5PathPickerBase.addItem"></a>
372 <h4>E5PathPickerBase.addItem</h4>
373 <b>addItem</b>(<i>path</i>)
374 <p>
375 Public method to add a paths to the current list.
376 </p><dl>
377 <dt><i>path</i> (str)</dt>
378 <dd>
379 path to add
380 </dd>
381 </dl><a NAME="E5PathPickerBase.addItems" ID="E5PathPickerBase.addItems"></a>
382 <h4>E5PathPickerBase.addItems</h4>
383 <b>addItems</b>(<i>pathsList</i>)
384 <p>
385 Public method to add paths to the current list.
386 </p><dl>
387 <dt><i>pathsList</i> (list of str)</dt>
388 <dd>
389 list of paths to add
390 </dd>
391 </dl><a NAME="E5PathPickerBase.buttonToolTip" ID="E5PathPickerBase.buttonToolTip"></a>
392 <h4>E5PathPickerBase.buttonToolTip</h4>
393 <b>buttonToolTip</b>(<i></i>)
394 <p>
395 Public method to get the tool button tool tip.
396 </p><dl>
397 <dt>Returns:</dt>
398 <dd>
399 tool tip text
400 </dd>
401 </dl><dl>
402 <dt>Return Type:</dt>
403 <dd>
404 str
405 </dd>
406 </dl><a NAME="E5PathPickerBase.clear" ID="E5PathPickerBase.clear"></a>
407 <h4>E5PathPickerBase.clear</h4>
408 <b>clear</b>(<i></i>)
409 <p>
410 Public method to clear the current path or list of paths.
411 </p><a NAME="E5PathPickerBase.clearEditText" ID="E5PathPickerBase.clearEditText"></a>
412 <h4>E5PathPickerBase.clearEditText</h4>
413 <b>clearEditText</b>(<i></i>)
414 <p>
415 Public method to clear the current path.
416 </p><a NAME="E5PathPickerBase.currentText" ID="E5PathPickerBase.currentText"></a>
417 <h4>E5PathPickerBase.currentText</h4>
418 <b>currentText</b>(<i>toNative=True</i>)
419 <p>
420 Public method to get the current path.
421 </p><dl>
422 <dt><i>toNative</i> (bool)</dt>
423 <dd>
424 flag indicating to convert the path into
425 a native format
426 </dd>
427 </dl><dl>
428 <dt>Returns:</dt>
429 <dd>
430 current path
431 </dd>
432 </dl><dl>
433 <dt>Return Type:</dt>
434 <dd>
435 str
436 </dd>
437 </dl><a NAME="E5PathPickerBase.defaultDirectory" ID="E5PathPickerBase.defaultDirectory"></a>
438 <h4>E5PathPickerBase.defaultDirectory</h4>
439 <b>defaultDirectory</b>(<i></i>)
440 <p>
441 Public method to get the default directory.
442 </p><dl>
443 <dt>Returns:</dt>
444 <dd>
445 default directory
446 </dd>
447 </dl><dl>
448 <dt>Return Type:</dt>
449 <dd>
450 str
451 </dd>
452 </dl><a NAME="E5PathPickerBase.editorEnabled" ID="E5PathPickerBase.editorEnabled"></a>
453 <h4>E5PathPickerBase.editorEnabled</h4>
454 <b>editorEnabled</b>(<i></i>)
455 <p>
456 Public method to get the path editor's enabled state.
457 </p><dl>
458 <dt>Returns:</dt>
459 <dd>
460 flag indicating the enabled state
461 </dd>
462 </dl><dl>
463 <dt>Return Type:</dt>
464 <dd>
465 bool
466 </dd>
467 </dl><a NAME="E5PathPickerBase.editorToolTip" ID="E5PathPickerBase.editorToolTip"></a>
468 <h4>E5PathPickerBase.editorToolTip</h4>
469 <b>editorToolTip</b>(<i></i>)
470 <p>
471 Public method to get the editor tool tip.
472 </p><dl>
473 <dt>Returns:</dt>
474 <dd>
475 tool tip text
476 </dd>
477 </dl><dl>
478 <dt>Return Type:</dt>
479 <dd>
480 str
481 </dd>
482 </dl><a NAME="E5PathPickerBase.filters" ID="E5PathPickerBase.filters"></a>
483 <h4>E5PathPickerBase.filters</h4>
484 <b>filters</b>(<i></i>)
485 <p>
486 Public methods to get the filter string.
487 </p><dl>
488 <dt>Returns:</dt>
489 <dd>
490 filter string
491 </dd>
492 </dl><dl>
493 <dt>Return Type:</dt>
494 <dd>
495 str
496 </dd>
497 </dl><a NAME="E5PathPickerBase.firstPath" ID="E5PathPickerBase.firstPath"></a>
498 <h4>E5PathPickerBase.firstPath</h4>
499 <b>firstPath</b>(<i>toNative=True</i>)
500 <p>
501 Public method to get the first path of a list of entered paths.
502 </p><dl>
503 <dt><i>toNative</i> (bool)</dt>
504 <dd>
505 flag indicating to convert the path into
506 a native format
507 </dd>
508 </dl><dl>
509 <dt>Returns:</dt>
510 <dd>
511 first path
512 </dd>
513 </dl><dl>
514 <dt>Return Type:</dt>
515 <dd>
516 str
517 </dd>
518 </dl><a NAME="E5PathPickerBase.isPickerEnabled" ID="E5PathPickerBase.isPickerEnabled"></a>
519 <h4>E5PathPickerBase.isPickerEnabled</h4>
520 <b>isPickerEnabled</b>(<i></i>)
521 <p>
522 Public method to get the file dialog button enabled state.
523 </p><dl>
524 <dt>Returns:</dt>
525 <dd>
526 flag indicating the enabled state
527 </dd>
528 </dl><dl>
529 <dt>Return Type:</dt>
530 <dd>
531 bool
532 </dd>
533 </dl><a NAME="E5PathPickerBase.isReadOnly" ID="E5PathPickerBase.isReadOnly"></a>
534 <h4>E5PathPickerBase.isReadOnly</h4>
535 <b>isReadOnly</b>(<i></i>)
536 <p>
537 Public method to check the path picker for read only mode.
538 </p><dl>
539 <dt>Returns:</dt>
540 <dd>
541 flg indicating read only mode
542 </dd>
543 </dl><dl>
544 <dt>Return Type:</dt>
545 <dd>
546 bool
547 </dd>
548 </dl><a NAME="E5PathPickerBase.lastPath" ID="E5PathPickerBase.lastPath"></a>
549 <h4>E5PathPickerBase.lastPath</h4>
550 <b>lastPath</b>(<i>toNative=True</i>)
551 <p>
552 Public method to get the last path of a list of entered paths.
553 </p><dl>
554 <dt><i>toNative</i> (bool)</dt>
555 <dd>
556 flag indicating to convert the path into
557 a native format
558 </dd>
559 </dl><dl>
560 <dt>Returns:</dt>
561 <dd>
562 last path
563 </dd>
564 </dl><dl>
565 <dt>Return Type:</dt>
566 <dd>
567 str
568 </dd>
569 </dl><a NAME="E5PathPickerBase.mode" ID="E5PathPickerBase.mode"></a>
570 <h4>E5PathPickerBase.mode</h4>
571 <b>mode</b>(<i></i>)
572 <p>
573 Public method to get the path picker mode.
574 </p><dl>
575 <dt>Returns:</dt>
576 <dd>
577 path picker mode
578 </dd>
579 </dl><dl>
580 <dt>Return Type:</dt>
581 <dd>
582 E5PathPickerModes
583 </dd>
584 </dl><a NAME="E5PathPickerBase.path" ID="E5PathPickerBase.path"></a>
585 <h4>E5PathPickerBase.path</h4>
586 <b>path</b>(<i>toNative=True</i>)
587 <p>
588 Public method to get the current path.
589 </p><dl>
590 <dt><i>toNative</i> (bool)</dt>
591 <dd>
592 flag indicating to convert the path into
593 a native format
594 </dd>
595 </dl><dl>
596 <dt>Returns:</dt>
597 <dd>
598 current path
599 </dd>
600 </dl><dl>
601 <dt>Return Type:</dt>
602 <dd>
603 str
604 </dd>
605 </dl><a NAME="E5PathPickerBase.paths" ID="E5PathPickerBase.paths"></a>
606 <h4>E5PathPickerBase.paths</h4>
607 <b>paths</b>(<i>toNative=True</i>)
608 <p>
609 Public method to get the list of entered paths.
610 </p><dl>
611 <dt><i>toNative</i> (bool)</dt>
612 <dd>
613 flag indicating to convert the path into
614 a native format
615 </dd>
616 </dl><dl>
617 <dt>Returns:</dt>
618 <dd>
619 entered paths
620 </dd>
621 </dl><dl>
622 <dt>Return Type:</dt>
623 <dd>
624 list of str
625 </dd>
626 </dl><a NAME="E5PathPickerBase.setButtonToolTip" ID="E5PathPickerBase.setButtonToolTip"></a>
627 <h4>E5PathPickerBase.setButtonToolTip</h4>
628 <b>setButtonToolTip</b>(<i>tooltip</i>)
629 <p>
630 Public method to set the tool button tool tip.
631 </p><dl>
632 <dt><i>tooltip</i> (str)</dt>
633 <dd>
634 text to be set as a tool tip
635 </dd>
636 </dl><a NAME="E5PathPickerBase.setCurrentIndex" ID="E5PathPickerBase.setCurrentIndex"></a>
637 <h4>E5PathPickerBase.setCurrentIndex</h4>
638 <b>setCurrentIndex</b>(<i>index</i>)
639 <p>
640 Public slot to set the current index.
641 </p><dl>
642 <dt><i>index</i> (int)</dt>
643 <dd>
644 index of the item to set current
645 </dd>
646 </dl><a NAME="E5PathPickerBase.setDefaultDirectory" ID="E5PathPickerBase.setDefaultDirectory"></a>
647 <h4>E5PathPickerBase.setDefaultDirectory</h4>
648 <b>setDefaultDirectory</b>(<i>directory</i>)
649 <p>
650 Public method to set the default directory.
651 </p><dl>
652 <dt><i>directory</i> (str)</dt>
653 <dd>
654 default directory
655 </dd>
656 </dl><a NAME="E5PathPickerBase.setEditText" ID="E5PathPickerBase.setEditText"></a>
657 <h4>E5PathPickerBase.setEditText</h4>
658 <b>setEditText</b>(<i>path, toNative=True</i>)
659 <p>
660 Public method to set the current path.
661 </p><dl>
662 <dt><i>path</i> (str)</dt>
663 <dd>
664 path to be set
665 </dd><dt><i>toNative</i> (bool)</dt>
666 <dd>
667 flag indicating to convert the path into
668 a native format
669 </dd>
670 </dl><a NAME="E5PathPickerBase.setEditorEnabled" ID="E5PathPickerBase.setEditorEnabled"></a>
671 <h4>E5PathPickerBase.setEditorEnabled</h4>
672 <b>setEditorEnabled</b>(<i>enable</i>)
673 <p>
674 Public method to set the path editor's enabled state.
675 </p><dl>
676 <dt><i>enable</i> (bool)</dt>
677 <dd>
678 flag indicating the enable state
679 </dd>
680 </dl><a NAME="E5PathPickerBase.setEditorToolTip" ID="E5PathPickerBase.setEditorToolTip"></a>
681 <h4>E5PathPickerBase.setEditorToolTip</h4>
682 <b>setEditorToolTip</b>(<i>tooltip</i>)
683 <p>
684 Public method to set the editor tool tip.
685 </p><dl>
686 <dt><i>tooltip</i> (str)</dt>
687 <dd>
688 text to be set as a tool tip
689 </dd>
690 </dl><a NAME="E5PathPickerBase.setFilters" ID="E5PathPickerBase.setFilters"></a>
691 <h4>E5PathPickerBase.setFilters</h4>
692 <b>setFilters</b>(<i>filters</i>)
693 <p>
694 Public method to set the filters for the path picker dialog.
695 </p><p>
696 Note: Multiple filters must be separated by ';;'.
697 </p><dl>
698 <dt><i>filters</i> (str)</dt>
699 <dd>
700 string containing the file filters
701 </dd>
702 </dl><a NAME="E5PathPickerBase.setInsertPolicy" ID="E5PathPickerBase.setInsertPolicy"></a>
703 <h4>E5PathPickerBase.setInsertPolicy</h4>
704 <b>setInsertPolicy</b>(<i>policy</i>)
705 <p>
706 Public method to set the insertion policy of the combo box.
707 </p><dl>
708 <dt><i>policy</i> (QComboBox.InsertPolicy)</dt>
709 <dd>
710 insertion policy
711 </dd>
712 </dl><a NAME="E5PathPickerBase.setMode" ID="E5PathPickerBase.setMode"></a>
713 <h4>E5PathPickerBase.setMode</h4>
714 <b>setMode</b>(<i>mode</i>)
715 <p>
716 Public method to set the path picker mode.
717 </p><dl>
718 <dt><i>mode</i> (E5PathPickerModes)</dt>
719 <dd>
720 picker mode
721 </dd>
722 </dl><a NAME="E5PathPickerBase.setNameFilters" ID="E5PathPickerBase.setNameFilters"></a>
723 <h4>E5PathPickerBase.setNameFilters</h4>
724 <b>setNameFilters</b>(<i>filters</i>)
725 <p>
726 Public method to set the name filters for the completer.
727 </p><dl>
728 <dt><i>filters</i> (list of str)</dt>
729 <dd>
730 list of file name filters
731 </dd>
732 </dl><a NAME="E5PathPickerBase.setPath" ID="E5PathPickerBase.setPath"></a>
733 <h4>E5PathPickerBase.setPath</h4>
734 <b>setPath</b>(<i>path, toNative=True</i>)
735 <p>
736 Public method to set the current path.
737 </p><dl>
738 <dt><i>path</i> (str)</dt>
739 <dd>
740 path to be set
741 </dd><dt><i>toNative</i> (bool)</dt>
742 <dd>
743 flag indicating to convert the path into
744 a native format
745 </dd>
746 </dl><a NAME="E5PathPickerBase.setPathsList" ID="E5PathPickerBase.setPathsList"></a>
747 <h4>E5PathPickerBase.setPathsList</h4>
748 <b>setPathsList</b>(<i>pathsList</i>)
749 <p>
750 Public method to set the paths list.
751 </p><dl>
752 <dt><i>pathsList</i> (list of str)</dt>
753 <dd>
754 list of paths
755 </dd>
756 </dl><a NAME="E5PathPickerBase.setPickerEnabled" ID="E5PathPickerBase.setPickerEnabled"></a>
757 <h4>E5PathPickerBase.setPickerEnabled</h4>
758 <b>setPickerEnabled</b>(<i>enable</i>)
759 <p>
760 Public method to set the enabled state of the file dialog button.
761 </p><dl>
762 <dt><i>enable</i> (bool)</dt>
763 <dd>
764 flag indicating the enabled state
765 </dd>
766 </dl><a NAME="E5PathPickerBase.setReadOnly" ID="E5PathPickerBase.setReadOnly"></a>
767 <h4>E5PathPickerBase.setReadOnly</h4>
768 <b>setReadOnly</b>(<i>readOnly</i>)
769 <p>
770 Public method to set the path picker to read only mode.
771 </p><dl>
772 <dt><i>readOnly</i> (bool)</dt>
773 <dd>
774 flag indicating read only mode
775 </dd>
776 </dl><a NAME="E5PathPickerBase.setSizeAdjustPolicy" ID="E5PathPickerBase.setSizeAdjustPolicy"></a>
777 <h4>E5PathPickerBase.setSizeAdjustPolicy</h4>
778 <b>setSizeAdjustPolicy</b>(<i>policy</i>)
779 <p>
780 Public method to set the size adjust policy of the combo box.
781 </p><dl>
782 <dt><i>policy</i> (QComboBox.SizeAdjustPolicy)</dt>
783 <dd>
784 size adjust policy
785 </dd>
786 </dl><a NAME="E5PathPickerBase.setText" ID="E5PathPickerBase.setText"></a>
787 <h4>E5PathPickerBase.setText</h4>
788 <b>setText</b>(<i>path, toNative=True</i>)
789 <p>
790 Public method to set the current path.
791 </p><dl>
792 <dt><i>path</i> (str)</dt>
793 <dd>
794 path to be set
795 </dd><dt><i>toNative</i> (bool)</dt>
796 <dd>
797 flag indicating to convert the path into
798 a native format
799 </dd>
800 </dl><a NAME="E5PathPickerBase.setWindowTitle" ID="E5PathPickerBase.setWindowTitle"></a>
801 <h4>E5PathPickerBase.setWindowTitle</h4>
802 <b>setWindowTitle</b>(<i>title</i>)
803 <p>
804 Public method to set the path picker dialog window title.
805 </p><dl>
806 <dt><i>title</i> (str)</dt>
807 <dd>
808 window title
809 </dd>
810 </dl><a NAME="E5PathPickerBase.text" ID="E5PathPickerBase.text"></a>
811 <h4>E5PathPickerBase.text</h4>
812 <b>text</b>(<i>toNative=True</i>)
813 <p>
814 Public method to get the current path.
815 </p><dl>
816 <dt><i>toNative</i> (bool)</dt>
817 <dd>
818 flag indicating to convert the path into
819 a native format
820 </dd>
821 </dl><dl>
822 <dt>Returns:</dt>
823 <dd>
824 current path
825 </dd>
826 </dl><dl>
827 <dt>Return Type:</dt>
828 <dd>
829 str
830 </dd>
831 </dl><a NAME="E5PathPickerBase.windowTitle" ID="E5PathPickerBase.windowTitle"></a>
832 <h4>E5PathPickerBase.windowTitle</h4>
833 <b>windowTitle</b>(<i></i>)
834 <p>
835 Public method to get the path picker dialog's window title.
836 </p><dl>
837 <dt>Returns:</dt>
838 <dd>
839 window title
840 </dd>
841 </dl><dl>
842 <dt>Return Type:</dt>
843 <dd>
844 str
845 </dd>
846 </dl>
847 <div align="right"><a href="#top">Up</a></div>
848 <hr /><hr />
849 <a NAME="E5PathPickerModes" ID="E5PathPickerModes"></a>
850 <h2>E5PathPickerModes</h2>
851 <p>
852 Class implementing the path picker modes.
853 </p>
854 <h3>Derived from</h3>
855 Enum
856 <h3>Class Attributes</h3>
857 <table>
858 <tr><td>CustomMode</td></tr><tr><td>DirectoryMode</td></tr><tr><td>DirectoryShowFilesMode</td></tr><tr><td>NoMode</td></tr><tr><td>OpenFileMode</td></tr><tr><td>OpenFilesMode</td></tr><tr><td>SaveFileEnsureExtensionMode</td></tr><tr><td>SaveFileMode</td></tr><tr><td>SaveFileOverwriteMode</td></tr>
859 </table>
860 <h3>Class Methods</h3>
861 <table>
862 <tr><td>None</td></tr>
863 </table>
864 <h3>Methods</h3>
865 <table>
866 <tr><td>None</td></tr>
867 </table>
868 <h3>Static Methods</h3>
869 <table>
870 <tr><td>None</td></tr>
871 </table>
872
873 <div align="right"><a href="#top">Up</a></div>
874 <hr />
875 </body></html>

Mercurial Repository: eric

eric ide

mercurial