|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.E5Gui.E5FileDialog</title> |
|
6 <style> |
|
7 body { |
|
8 background:white; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #4FA4FF; } |
|
14 h2 { color: white; background: #4FA4FF; } |
|
15 h3 { color: white; background: #00557F; } |
|
16 h4 { color: white; background: #00557F; } |
|
17 |
|
18 a { color: #AA5500; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric5.E5Gui.E5FileDialog</h1> |
|
24 <p> |
|
25 Module implementing alternative functions for the QFileDialog static methods |
|
26 to cope with dustributor's usage of KDE wrapper dialogs for Qt file dialogs. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 <table> |
|
30 <tr><td>None</td></tr> |
|
31 </table> |
|
32 <h3>Classes</h3> |
|
33 <table> |
|
34 <tr><td>None</td></tr> |
|
35 </table> |
|
36 <h3>Functions</h3> |
|
37 <table> |
|
38 <tr> |
|
39 <td><a href="#__reorderFilter">__reorderFilter</a></td> |
|
40 <td>Private function to reorder the file filter to cope with a KDE issue introduced by distributor's usage of KDE file dialogs.</td> |
|
41 </tr><tr> |
|
42 <td><a href="#getOpenFileNameAndFilter">getOpenFileNameAndFilter</a></td> |
|
43 <td>Module function to get the name of a file for opening it and the selected file name filter.</td> |
|
44 </tr><tr> |
|
45 <td><a href="#getOpenFileNamesAndFilter">getOpenFileNamesAndFilter</a></td> |
|
46 <td>Module function to get a list of names of files for opening and the selected file name filter.</td> |
|
47 </tr><tr> |
|
48 <td><a href="#getSaveFileNameAndFilter">getSaveFileNameAndFilter</a></td> |
|
49 <td>Module function to get the name of a file for saving it and the selected file name filter.</td> |
|
50 </tr> |
|
51 </table> |
|
52 <hr /><hr /> |
|
53 <a NAME="__reorderFilter" ID="__reorderFilter"></a> |
|
54 <h2>__reorderFilter</h2> |
|
55 <b>__reorderFilter</b>(<i>filter, initialFilter = ""</i>) |
|
56 <p> |
|
57 Private function to reorder the file filter to cope with a KDE issue introduced |
|
58 by distributor's usage of KDE file dialogs. |
|
59 </p><dl> |
|
60 <dt><i>filter</i></dt> |
|
61 <dd> |
|
62 Qt file filter (string) |
|
63 </dd><dt><i>initialFilter</i></dt> |
|
64 <dd> |
|
65 initial filter (string) |
|
66 </dd> |
|
67 </dl><dl> |
|
68 <dt>Returns:</dt> |
|
69 <dd> |
|
70 the rearranged Qt file filter (string) |
|
71 </dd> |
|
72 </dl> |
|
73 <div align="right"><a href="#top">Up</a></div> |
|
74 <hr /><hr /> |
|
75 <a NAME="getOpenFileNameAndFilter" ID="getOpenFileNameAndFilter"></a> |
|
76 <h2>getOpenFileNameAndFilter</h2> |
|
77 <b>getOpenFileNameAndFilter</b>(<i>parent = None, caption = "", directory = "", filter = "", initialFilter = "", options = QFileDialog.Options()</i>) |
|
78 <p> |
|
79 Module function to get the name of a file for opening it and the selected |
|
80 file name filter. |
|
81 </p><dl> |
|
82 <dt><i>parent</i></dt> |
|
83 <dd> |
|
84 parent widget of the dialog (QWidget) |
|
85 </dd><dt><i>caption</i></dt> |
|
86 <dd> |
|
87 window title of the dialog (string) |
|
88 </dd><dt><i>directory</i></dt> |
|
89 <dd> |
|
90 working directory of the dialog (string) |
|
91 </dd><dt><i>filter</i></dt> |
|
92 <dd> |
|
93 filter string for the dialog (string) |
|
94 </dd><dt><i>initialFilter</i></dt> |
|
95 <dd> |
|
96 initial filter for the dialog (string) |
|
97 </dd><dt><i>options</i></dt> |
|
98 <dd> |
|
99 various options for the dialog (QFileDialog.Options) |
|
100 </dd> |
|
101 </dl><dl> |
|
102 <dt>Returns:</dt> |
|
103 <dd> |
|
104 name of file to be opened and selected filter (string, string) |
|
105 </dd> |
|
106 </dl> |
|
107 <div align="right"><a href="#top">Up</a></div> |
|
108 <hr /><hr /> |
|
109 <a NAME="getOpenFileNamesAndFilter" ID="getOpenFileNamesAndFilter"></a> |
|
110 <h2>getOpenFileNamesAndFilter</h2> |
|
111 <b>getOpenFileNamesAndFilter</b>(<i>parent = None, caption = "", directory = "", filter = "", initialFilter = "", options = QFileDialog.Options()</i>) |
|
112 <p> |
|
113 Module function to get a list of names of files for opening and the selected |
|
114 file name filter. |
|
115 </p><dl> |
|
116 <dt><i>parent</i></dt> |
|
117 <dd> |
|
118 parent widget of the dialog (QWidget) |
|
119 </dd><dt><i>caption</i></dt> |
|
120 <dd> |
|
121 window title of the dialog (string) |
|
122 </dd><dt><i>directory</i></dt> |
|
123 <dd> |
|
124 working directory of the dialog (string) |
|
125 </dd><dt><i>filter</i></dt> |
|
126 <dd> |
|
127 filter string for the dialog (string) |
|
128 </dd><dt><i>initialFilter</i></dt> |
|
129 <dd> |
|
130 initial filter for the dialog (string) |
|
131 </dd><dt><i>options</i></dt> |
|
132 <dd> |
|
133 various options for the dialog (QFileDialog.Options) |
|
134 </dd> |
|
135 </dl><dl> |
|
136 <dt>Returns:</dt> |
|
137 <dd> |
|
138 list of file names to be opened and selected filter |
|
139 (list of string, string) |
|
140 </dd> |
|
141 </dl> |
|
142 <div align="right"><a href="#top">Up</a></div> |
|
143 <hr /><hr /> |
|
144 <a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a> |
|
145 <h2>getSaveFileNameAndFilter</h2> |
|
146 <b>getSaveFileNameAndFilter</b>(<i>parent = None, caption = "", directory = "", filter = "", initialFilter = "", options = QFileDialog.Options()</i>) |
|
147 <p> |
|
148 Module function to get the name of a file for saving it and the selected |
|
149 file name filter. |
|
150 </p><dl> |
|
151 <dt><i>parent</i></dt> |
|
152 <dd> |
|
153 parent widget of the dialog (QWidget) |
|
154 </dd><dt><i>caption</i></dt> |
|
155 <dd> |
|
156 window title of the dialog (string) |
|
157 </dd><dt><i>directory</i></dt> |
|
158 <dd> |
|
159 working directory of the dialog (string) |
|
160 </dd><dt><i>filter</i></dt> |
|
161 <dd> |
|
162 filter string for the dialog (string) |
|
163 </dd><dt><i>initialFilter</i></dt> |
|
164 <dd> |
|
165 initial filter for the dialog (string) |
|
166 </dd><dt><i>options</i></dt> |
|
167 <dd> |
|
168 various options for the dialog (QFileDialog.Options) |
|
169 </dd> |
|
170 </dl><dl> |
|
171 <dt>Returns:</dt> |
|
172 <dd> |
|
173 name of file to be saved and selected filter (string, string) |
|
174 </dd> |
|
175 </dl> |
|
176 <div align="right"><a href="#top">Up</a></div> |
|
177 <hr /> |
|
178 </body></html> |