Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.E5Gui.E5PathPicker.html

changeset 4573
365f39d86985
child 4575
464a6b049f89
equal deleted inserted replaced
4572:193e308b2f6e 4573:365f39d86985
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="#E5PathPicker">E5PathPicker</a></td>
34 <td>Class implementing a path picker widget consisting of a line edit and a tool button to open a file dialog.</td>
35 </tr><tr>
36 <td><a href="#E5PathPickerModes">E5PathPickerModes</a></td>
37 <td>Class implementing the path picker modes.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="E5PathPicker" ID="E5PathPicker"></a>
46 <h2>E5PathPicker</h2>
47 <p>
48 Class implementing a path picker widget consisting of a line edit and a
49 tool button to open a file dialog.
50 </p>
51 <h3>Derived from</h3>
52 QWidget
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>DefaultMode</td></tr>
56 </table>
57 <h3>Class Methods</h3>
58 <table>
59 <tr><td>None</td></tr>
60 </table>
61 <h3>Methods</h3>
62 <table>
63 <tr>
64 <td><a href="#E5PathPicker.__init__">E5PathPicker</a></td>
65 <td>Constructor</td>
66 </tr><tr>
67 <td><a href="#E5PathPicker.__showPathPickerDialog">__showPathPickerDialog</a></td>
68 <td>Private slot to show the path picker dialog.</td>
69 </tr><tr>
70 <td><a href="#E5PathPicker.buttonToolTip">buttonToolTip</a></td>
71 <td>Public method to get the tool button tool tip.</td>
72 </tr><tr>
73 <td><a href="#E5PathPicker.defaultDirectory">defaultDirectory</a></td>
74 <td>Public method to get the default directory.</td>
75 </tr><tr>
76 <td><a href="#E5PathPicker.editorEnabled">editorEnabled</a></td>
77 <td>Public method to get the path editor's enabled state.</td>
78 </tr><tr>
79 <td><a href="#E5PathPicker.editorToolTip">editorToolTip</a></td>
80 <td>Public method to get the editor tool tip.</td>
81 </tr><tr>
82 <td><a href="#E5PathPicker.filters">filters</a></td>
83 <td>Public methods to get the filter string.</td>
84 </tr><tr>
85 <td><a href="#E5PathPicker.mode">mode</a></td>
86 <td>Public method to get the path picker mode.</td>
87 </tr><tr>
88 <td><a href="#E5PathPicker.path">path</a></td>
89 <td>Public method to get the current path.</td>
90 </tr><tr>
91 <td><a href="#E5PathPicker.setButtonToolTip">setButtonToolTip</a></td>
92 <td>Public method to set the tool button tool tip.</td>
93 </tr><tr>
94 <td><a href="#E5PathPicker.setDefaultDirectory">setDefaultDirectory</a></td>
95 <td>Public method to set the default directory.</td>
96 </tr><tr>
97 <td><a href="#E5PathPicker.setEditorEnabled">setEditorEnabled</a></td>
98 <td>Public method to set the path editor's enabled state.</td>
99 </tr><tr>
100 <td><a href="#E5PathPicker.setEditorToolTip">setEditorToolTip</a></td>
101 <td>Public method to set the editor tool tip.</td>
102 </tr><tr>
103 <td><a href="#E5PathPicker.setFilters">setFilters</a></td>
104 <td>Public method to set the filters for the path picker dialog.</td>
105 </tr><tr>
106 <td><a href="#E5PathPicker.setMode">setMode</a></td>
107 <td>Public method to set the path picker mode.</td>
108 </tr><tr>
109 <td><a href="#E5PathPicker.setPath">setPath</a></td>
110 <td>Public method to set the current path.</td>
111 </tr><tr>
112 <td><a href="#E5PathPicker.setText">setText</a></td>
113 <td>Public method to set the current path.</td>
114 </tr><tr>
115 <td><a href="#E5PathPicker.setWindowTitle">setWindowTitle</a></td>
116 <td>Public method to set the path picker dialog window title.</td>
117 </tr><tr>
118 <td><a href="#E5PathPicker.text">text</a></td>
119 <td>Public method to get the current path.</td>
120 </tr><tr>
121 <td><a href="#E5PathPicker.windowTitle">windowTitle</a></td>
122 <td>Public method to get the path picker dialog's window title.</td>
123 </tr>
124 </table>
125 <h3>Static Methods</h3>
126 <table>
127 <tr><td>None</td></tr>
128 </table>
129 <a NAME="E5PathPicker.__init__" ID="E5PathPicker.__init__"></a>
130 <h4>E5PathPicker (Constructor)</h4>
131 <b>E5PathPicker</b>(<i>parent=None</i>)
132 <p>
133 Constructor
134 </p><dl>
135 <dt><i>parent</i> (QWidget)</dt>
136 <dd>
137 reference to the parent widget
138 </dd>
139 </dl><a NAME="E5PathPicker.__showPathPickerDialog" ID="E5PathPicker.__showPathPickerDialog"></a>
140 <h4>E5PathPicker.__showPathPickerDialog</h4>
141 <b>__showPathPickerDialog</b>(<i></i>)
142 <p>
143 Private slot to show the path picker dialog.
144 </p><a NAME="E5PathPicker.buttonToolTip" ID="E5PathPicker.buttonToolTip"></a>
145 <h4>E5PathPicker.buttonToolTip</h4>
146 <b>buttonToolTip</b>(<i></i>)
147 <p>
148 Public method to get the tool button tool tip.
149 </p><dl>
150 <dt>Returns:</dt>
151 <dd>
152 tool tip text
153 </dd>
154 </dl><dl>
155 <dt>Return Type:</dt>
156 <dd>
157 str
158 </dd>
159 </dl><a NAME="E5PathPicker.defaultDirectory" ID="E5PathPicker.defaultDirectory"></a>
160 <h4>E5PathPicker.defaultDirectory</h4>
161 <b>defaultDirectory</b>(<i></i>)
162 <p>
163 Public method to get the default directory.
164 </p><dl>
165 <dt>Returns:</dt>
166 <dd>
167 default directory
168 </dd>
169 </dl><dl>
170 <dt>Return Type:</dt>
171 <dd>
172 str
173 </dd>
174 </dl><a NAME="E5PathPicker.editorEnabled" ID="E5PathPicker.editorEnabled"></a>
175 <h4>E5PathPicker.editorEnabled</h4>
176 <b>editorEnabled</b>(<i></i>)
177 <p>
178 Public method to get the path editor's enabled state.
179 </p><dl>
180 <dt>Returns:</dt>
181 <dd>
182 flag indicating the enabled state
183 </dd>
184 </dl><dl>
185 <dt>Return Type:</dt>
186 <dd>
187 bool
188 </dd>
189 </dl><a NAME="E5PathPicker.editorToolTip" ID="E5PathPicker.editorToolTip"></a>
190 <h4>E5PathPicker.editorToolTip</h4>
191 <b>editorToolTip</b>(<i></i>)
192 <p>
193 Public method to get the editor tool tip.
194 </p><dl>
195 <dt>Returns:</dt>
196 <dd>
197 tool tip text
198 </dd>
199 </dl><dl>
200 <dt>Return Type:</dt>
201 <dd>
202 str
203 </dd>
204 </dl><a NAME="E5PathPicker.filters" ID="E5PathPicker.filters"></a>
205 <h4>E5PathPicker.filters</h4>
206 <b>filters</b>(<i></i>)
207 <p>
208 Public methods to get the filter string.
209 </p><dl>
210 <dt>Returns:</dt>
211 <dd>
212 filter string
213 </dd>
214 </dl><dl>
215 <dt>Return Type:</dt>
216 <dd>
217 str
218 </dd>
219 </dl><a NAME="E5PathPicker.mode" ID="E5PathPicker.mode"></a>
220 <h4>E5PathPicker.mode</h4>
221 <b>mode</b>(<i></i>)
222 <p>
223 Public method to get the path picker mode.
224 </p><dl>
225 <dt>Returns:</dt>
226 <dd>
227 path picker mode
228 </dd>
229 </dl><dl>
230 <dt>Return Type:</dt>
231 <dd>
232 E5PathPickerModes
233 </dd>
234 </dl><a NAME="E5PathPicker.path" ID="E5PathPicker.path"></a>
235 <h4>E5PathPicker.path</h4>
236 <b>path</b>(<i></i>)
237 <p>
238 Public method to get the current path.
239 </p><dl>
240 <dt>Returns:</dt>
241 <dd>
242 current path
243 </dd>
244 </dl><dl>
245 <dt>Return Type:</dt>
246 <dd>
247 str
248 </dd>
249 </dl><a NAME="E5PathPicker.setButtonToolTip" ID="E5PathPicker.setButtonToolTip"></a>
250 <h4>E5PathPicker.setButtonToolTip</h4>
251 <b>setButtonToolTip</b>(<i>tooltip</i>)
252 <p>
253 Public method to set the tool button tool tip.
254 </p><dl>
255 <dt><i>tooltip</i> (str)</dt>
256 <dd>
257 text to be set as a tool tip
258 </dd>
259 </dl><a NAME="E5PathPicker.setDefaultDirectory" ID="E5PathPicker.setDefaultDirectory"></a>
260 <h4>E5PathPicker.setDefaultDirectory</h4>
261 <b>setDefaultDirectory</b>(<i>directory</i>)
262 <p>
263 Public method to set the default directory.
264 </p><dl>
265 <dt><i>directory</i> (str)</dt>
266 <dd>
267 default directory
268 </dd>
269 </dl><a NAME="E5PathPicker.setEditorEnabled" ID="E5PathPicker.setEditorEnabled"></a>
270 <h4>E5PathPicker.setEditorEnabled</h4>
271 <b>setEditorEnabled</b>(<i>enable</i>)
272 <p>
273 Public method to set the path editor's enabled state.
274 </p><dl>
275 <dt><i>enable</i> (bool)</dt>
276 <dd>
277 flag indicating the enable state
278 </dd>
279 </dl><a NAME="E5PathPicker.setEditorToolTip" ID="E5PathPicker.setEditorToolTip"></a>
280 <h4>E5PathPicker.setEditorToolTip</h4>
281 <b>setEditorToolTip</b>(<i>tooltip</i>)
282 <p>
283 Public method to set the editor tool tip.
284 </p><dl>
285 <dt><i>tooltip</i> (str)</dt>
286 <dd>
287 text to be set as a tool tip
288 </dd>
289 </dl><a NAME="E5PathPicker.setFilters" ID="E5PathPicker.setFilters"></a>
290 <h4>E5PathPicker.setFilters</h4>
291 <b>setFilters</b>(<i>filters</i>)
292 <p>
293 Public method to set the filters for the path picker dialog.
294 </p><p>
295 Note: Multiple filters must be separated by ';;'.
296 </p><dl>
297 <dt><i>filters</i> (str)</dt>
298 <dd>
299 string containing the file filters
300 </dd>
301 </dl><a NAME="E5PathPicker.setMode" ID="E5PathPicker.setMode"></a>
302 <h4>E5PathPicker.setMode</h4>
303 <b>setMode</b>(<i>mode</i>)
304 <p>
305 Public method to set the path picker mode.
306 </p><dl>
307 <dt><i>mode</i> (E5PathPickerModes)</dt>
308 <dd>
309 picker mode
310 </dd>
311 </dl><a NAME="E5PathPicker.setPath" ID="E5PathPicker.setPath"></a>
312 <h4>E5PathPicker.setPath</h4>
313 <b>setPath</b>(<i>path</i>)
314 <p>
315 Public method to set the current path.
316 </p><dl>
317 <dt><i>path</i> (str)</dt>
318 <dd>
319 path to be set
320 </dd>
321 </dl><a NAME="E5PathPicker.setText" ID="E5PathPicker.setText"></a>
322 <h4>E5PathPicker.setText</h4>
323 <b>setText</b>(<i>path</i>)
324 <p>
325 Public method to set the current path.
326 </p><dl>
327 <dt><i>path</i> (str)</dt>
328 <dd>
329 path to be set
330 </dd>
331 </dl><a NAME="E5PathPicker.setWindowTitle" ID="E5PathPicker.setWindowTitle"></a>
332 <h4>E5PathPicker.setWindowTitle</h4>
333 <b>setWindowTitle</b>(<i>title</i>)
334 <p>
335 Public method to set the path picker dialog window title.
336 </p><dl>
337 <dt><i>title</i> (str)</dt>
338 <dd>
339 window title
340 </dd>
341 </dl><a NAME="E5PathPicker.text" ID="E5PathPicker.text"></a>
342 <h4>E5PathPicker.text</h4>
343 <b>text</b>(<i></i>)
344 <p>
345 Public method to get the current path.
346 </p><dl>
347 <dt>Returns:</dt>
348 <dd>
349 current path
350 </dd>
351 </dl><dl>
352 <dt>Return Type:</dt>
353 <dd>
354 str
355 </dd>
356 </dl><a NAME="E5PathPicker.windowTitle" ID="E5PathPicker.windowTitle"></a>
357 <h4>E5PathPicker.windowTitle</h4>
358 <b>windowTitle</b>(<i></i>)
359 <p>
360 Public method to get the path picker dialog's window title.
361 </p><dl>
362 <dt>Returns:</dt>
363 <dd>
364 window title
365 </dd>
366 </dl><dl>
367 <dt>Return Type:</dt>
368 <dd>
369 str
370 </dd>
371 </dl>
372 <div align="right"><a href="#top">Up</a></div>
373 <hr /><hr />
374 <a NAME="E5PathPickerModes" ID="E5PathPickerModes"></a>
375 <h2>E5PathPickerModes</h2>
376 <p>
377 Class implementing the path picker modes.
378 </p>
379 <h3>Derived from</h3>
380 Enum
381 <h3>Class Attributes</h3>
382 <table>
383 <tr><td>DiretoryMode</td></tr><tr><td>OpenFileMode</td></tr><tr><td>OpenFilesMode</td></tr><tr><td>SaveFileMode</td></tr>
384 </table>
385 <h3>Class Methods</h3>
386 <table>
387 <tr><td>None</td></tr>
388 </table>
389 <h3>Methods</h3>
390 <table>
391 <tr><td>None</td></tr>
392 </table>
393 <h3>Static Methods</h3>
394 <table>
395 <tr><td>None</td></tr>
396 </table>
397
398 <div align="right"><a href="#top">Up</a></div>
399 <hr />
400 </body></html>

Mercurial Repository: eric

eric ide

mercurial