Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.EricWidgets.EricFileDialog.html
eric7/Documentation/Source/eric7.EricWidgets.EricFileDialog.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.EricFileDialog</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.EricFileDialog</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing alternative functions for the QFileDialog static methods | |
| 27 to cope with distributor's usage of KDE wrapper dialogs for Qt file dialogs. | |
| 28 </p> | |
| 29 <h3>Global Attributes</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>DontConfirmOverwrite</td></tr><tr><td>DontResolveSymlinks</td></tr><tr><td>DontUseCustomDirectoryIcons</td></tr><tr><td>DontUseNativeDialog</td></tr><tr><td>HideNameFilterDetails</td></tr><tr><td>Option</td></tr><tr><td>ReadOnly</td></tr><tr><td>ShowDirsOnly</td></tr> | |
| 33 </table> | |
| 34 <h3>Classes</h3> | |
| 35 | |
| 36 <table> | |
| 37 <tr><td>None</td></tr> | |
| 38 </table> | |
| 39 <h3>Functions</h3> | |
| 40 | |
| 41 <table> | |
| 42 | |
| 43 <tr> | |
| 44 <td><a href="#__reorderFilter">__reorderFilter</a></td> | |
| 45 <td>Private function to reorder the file filter to cope with a KDE issue introduced by distributor's usage of KDE file dialogs.</td> | |
| 46 </tr> | |
| 47 <tr> | |
| 48 <td><a href="#getExistingDirectory">getExistingDirectory</a></td> | |
| 49 <td>Module function to get the name of a directory.</td> | |
| 50 </tr> | |
| 51 <tr> | |
| 52 <td><a href="#getOpenFileName">getOpenFileName</a></td> | |
| 53 <td>Module function to get the name of a file for opening it.</td> | |
| 54 </tr> | |
| 55 <tr> | |
| 56 <td><a href="#getOpenFileNameAndFilter">getOpenFileNameAndFilter</a></td> | |
| 57 <td>Module function to get the name of a file for opening it and the selected file name filter.</td> | |
| 58 </tr> | |
| 59 <tr> | |
| 60 <td><a href="#getOpenFileNames">getOpenFileNames</a></td> | |
| 61 <td>Module function to get a list of names of files for opening.</td> | |
| 62 </tr> | |
| 63 <tr> | |
| 64 <td><a href="#getOpenFileNamesAndFilter">getOpenFileNamesAndFilter</a></td> | |
| 65 <td>Module function to get a list of names of files for opening and the selected file name filter.</td> | |
| 66 </tr> | |
| 67 <tr> | |
| 68 <td><a href="#getSaveFileName">getSaveFileName</a></td> | |
| 69 <td>Module function to get the name of a file for saving it.</td> | |
| 70 </tr> | |
| 71 <tr> | |
| 72 <td><a href="#getSaveFileNameAndFilter">getSaveFileNameAndFilter</a></td> | |
| 73 <td>Module function to get the name of a file for saving it and the selected file name filter.</td> | |
| 74 </tr> | |
| 75 </table> | |
| 76 <hr /> | |
| 77 <hr /> | |
| 78 <a NAME="__reorderFilter" ID="__reorderFilter"></a> | |
| 79 <h2>__reorderFilter</h2> | |
| 80 <b>__reorderFilter</b>(<i>filterStr, initialFilter=""</i>) | |
| 81 | |
| 82 <p> | |
| 83 Private function to reorder the file filter to cope with a KDE issue | |
| 84 introduced by distributor's usage of KDE file dialogs. | |
| 85 </p> | |
| 86 <dl> | |
| 87 | |
| 88 <dt><i>filterStr</i></dt> | |
| 89 <dd> | |
| 90 Qt file filter (string) | |
| 91 </dd> | |
| 92 <dt><i>initialFilter</i></dt> | |
| 93 <dd> | |
| 94 initial filter (string) | |
| 95 </dd> | |
| 96 </dl> | |
| 97 <dl> | |
| 98 <dt>Return:</dt> | |
| 99 <dd> | |
| 100 the rearranged Qt file filter (string) | |
| 101 </dd> | |
| 102 </dl> | |
| 103 <div align="right"><a href="#top">Up</a></div> | |
| 104 <hr /> | |
| 105 <hr /> | |
| 106 <a NAME="getExistingDirectory" ID="getExistingDirectory"></a> | |
| 107 <h2>getExistingDirectory</h2> | |
| 108 <b>getExistingDirectory</b>(<i>parent=None, caption="", directory="", options=QFileDialog.Option.ShowDirsOnly</i>) | |
| 109 | |
| 110 <p> | |
| 111 Module function to get the name of a directory. | |
| 112 </p> | |
| 113 <dl> | |
| 114 | |
| 115 <dt><i>parent</i></dt> | |
| 116 <dd> | |
| 117 parent widget of the dialog (QWidget) | |
| 118 </dd> | |
| 119 <dt><i>caption</i></dt> | |
| 120 <dd> | |
| 121 window title of the dialog (string) | |
| 122 </dd> | |
| 123 <dt><i>directory</i></dt> | |
| 124 <dd> | |
| 125 working directory of the dialog (string) | |
| 126 </dd> | |
| 127 <dt><i>options</i></dt> | |
| 128 <dd> | |
| 129 various options for the dialog (QFileDialog.Options) | |
| 130 </dd> | |
| 131 </dl> | |
| 132 <dl> | |
| 133 <dt>Return:</dt> | |
| 134 <dd> | |
| 135 name of selected directory (string) | |
| 136 </dd> | |
| 137 </dl> | |
| 138 <div align="right"><a href="#top">Up</a></div> | |
| 139 <hr /> | |
| 140 <hr /> | |
| 141 <a NAME="getOpenFileName" ID="getOpenFileName"></a> | |
| 142 <h2>getOpenFileName</h2> | |
| 143 <b>getOpenFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) | |
| 144 | |
| 145 <p> | |
| 146 Module function to get the name of a file for opening it. | |
| 147 </p> | |
| 148 <dl> | |
| 149 | |
| 150 <dt><i>parent</i></dt> | |
| 151 <dd> | |
| 152 parent widget of the dialog (QWidget) | |
| 153 </dd> | |
| 154 <dt><i>caption</i></dt> | |
| 155 <dd> | |
| 156 window title of the dialog (string) | |
| 157 </dd> | |
| 158 <dt><i>directory</i></dt> | |
| 159 <dd> | |
| 160 working directory of the dialog (string) | |
| 161 </dd> | |
| 162 <dt><i>filterStr</i></dt> | |
| 163 <dd> | |
| 164 filter string for the dialog (string) | |
| 165 </dd> | |
| 166 <dt><i>options</i></dt> | |
| 167 <dd> | |
| 168 various options for the dialog (QFileDialog.Options) | |
| 169 </dd> | |
| 170 </dl> | |
| 171 <dl> | |
| 172 <dt>Return:</dt> | |
| 173 <dd> | |
| 174 name of file to be opened (string) | |
| 175 </dd> | |
| 176 </dl> | |
| 177 <div align="right"><a href="#top">Up</a></div> | |
| 178 <hr /> | |
| 179 <hr /> | |
| 180 <a NAME="getOpenFileNameAndFilter" ID="getOpenFileNameAndFilter"></a> | |
| 181 <h2>getOpenFileNameAndFilter</h2> | |
| 182 <b>getOpenFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) | |
| 183 | |
| 184 <p> | |
| 185 Module function to get the name of a file for opening it and the selected | |
| 186 file name filter. | |
| 187 </p> | |
| 188 <dl> | |
| 189 | |
| 190 <dt><i>parent</i></dt> | |
| 191 <dd> | |
| 192 parent widget of the dialog (QWidget) | |
| 193 </dd> | |
| 194 <dt><i>caption</i></dt> | |
| 195 <dd> | |
| 196 window title of the dialog (string) | |
| 197 </dd> | |
| 198 <dt><i>directory</i></dt> | |
| 199 <dd> | |
| 200 working directory of the dialog (string) | |
| 201 </dd> | |
| 202 <dt><i>filterStr</i></dt> | |
| 203 <dd> | |
| 204 filter string for the dialog (string) | |
| 205 </dd> | |
| 206 <dt><i>initialFilter</i></dt> | |
| 207 <dd> | |
| 208 initial filter for the dialog (string) | |
| 209 </dd> | |
| 210 <dt><i>options</i></dt> | |
| 211 <dd> | |
| 212 various options for the dialog (QFileDialog.Options) | |
| 213 </dd> | |
| 214 </dl> | |
| 215 <dl> | |
| 216 <dt>Return:</dt> | |
| 217 <dd> | |
| 218 name of file to be opened and selected filter (string, string) | |
| 219 </dd> | |
| 220 </dl> | |
| 221 <div align="right"><a href="#top">Up</a></div> | |
| 222 <hr /> | |
| 223 <hr /> | |
| 224 <a NAME="getOpenFileNames" ID="getOpenFileNames"></a> | |
| 225 <h2>getOpenFileNames</h2> | |
| 226 <b>getOpenFileNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) | |
| 227 | |
| 228 <p> | |
| 229 Module function to get a list of names of files for opening. | |
| 230 </p> | |
| 231 <dl> | |
| 232 | |
| 233 <dt><i>parent</i></dt> | |
| 234 <dd> | |
| 235 parent widget of the dialog (QWidget) | |
| 236 </dd> | |
| 237 <dt><i>caption</i></dt> | |
| 238 <dd> | |
| 239 window title of the dialog (string) | |
| 240 </dd> | |
| 241 <dt><i>directory</i></dt> | |
| 242 <dd> | |
| 243 working directory of the dialog (string) | |
| 244 </dd> | |
| 245 <dt><i>filterStr</i></dt> | |
| 246 <dd> | |
| 247 filter string for the dialog (string) | |
| 248 </dd> | |
| 249 <dt><i>options</i></dt> | |
| 250 <dd> | |
| 251 various options for the dialog (QFileDialog.Options) | |
| 252 </dd> | |
| 253 </dl> | |
| 254 <dl> | |
| 255 <dt>Return:</dt> | |
| 256 <dd> | |
| 257 list of file names to be opened (list of string) | |
| 258 </dd> | |
| 259 </dl> | |
| 260 <div align="right"><a href="#top">Up</a></div> | |
| 261 <hr /> | |
| 262 <hr /> | |
| 263 <a NAME="getOpenFileNamesAndFilter" ID="getOpenFileNamesAndFilter"></a> | |
| 264 <h2>getOpenFileNamesAndFilter</h2> | |
| 265 <b>getOpenFileNamesAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) | |
| 266 | |
| 267 <p> | |
| 268 Module function to get a list of names of files for opening and the | |
| 269 selected file name filter. | |
| 270 </p> | |
| 271 <dl> | |
| 272 | |
| 273 <dt><i>parent</i></dt> | |
| 274 <dd> | |
| 275 parent widget of the dialog (QWidget) | |
| 276 </dd> | |
| 277 <dt><i>caption</i></dt> | |
| 278 <dd> | |
| 279 window title of the dialog (string) | |
| 280 </dd> | |
| 281 <dt><i>directory</i></dt> | |
| 282 <dd> | |
| 283 working directory of the dialog (string) | |
| 284 </dd> | |
| 285 <dt><i>filterStr</i></dt> | |
| 286 <dd> | |
| 287 filter string for the dialog (string) | |
| 288 </dd> | |
| 289 <dt><i>initialFilter</i></dt> | |
| 290 <dd> | |
| 291 initial filter for the dialog (string) | |
| 292 </dd> | |
| 293 <dt><i>options</i></dt> | |
| 294 <dd> | |
| 295 various options for the dialog (QFileDialog.Options) | |
| 296 </dd> | |
| 297 </dl> | |
| 298 <dl> | |
| 299 <dt>Return:</dt> | |
| 300 <dd> | |
| 301 list of file names to be opened and selected filter | |
| 302 (list of string, string) | |
| 303 </dd> | |
| 304 </dl> | |
| 305 <div align="right"><a href="#top">Up</a></div> | |
| 306 <hr /> | |
| 307 <hr /> | |
| 308 <a NAME="getSaveFileName" ID="getSaveFileName"></a> | |
| 309 <h2>getSaveFileName</h2> | |
| 310 <b>getSaveFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>) | |
| 311 | |
| 312 <p> | |
| 313 Module function to get the name of a file for saving it. | |
| 314 </p> | |
| 315 <dl> | |
| 316 | |
| 317 <dt><i>parent</i></dt> | |
| 318 <dd> | |
| 319 parent widget of the dialog (QWidget) | |
| 320 </dd> | |
| 321 <dt><i>caption</i></dt> | |
| 322 <dd> | |
| 323 window title of the dialog (string) | |
| 324 </dd> | |
| 325 <dt><i>directory</i></dt> | |
| 326 <dd> | |
| 327 working directory of the dialog (string) | |
| 328 </dd> | |
| 329 <dt><i>filterStr</i></dt> | |
| 330 <dd> | |
| 331 filter string for the dialog (string) | |
| 332 </dd> | |
| 333 <dt><i>options</i></dt> | |
| 334 <dd> | |
| 335 various options for the dialog (QFileDialog.Options) | |
| 336 </dd> | |
| 337 </dl> | |
| 338 <dl> | |
| 339 <dt>Return:</dt> | |
| 340 <dd> | |
| 341 name of file to be saved (string) | |
| 342 </dd> | |
| 343 </dl> | |
| 344 <div align="right"><a href="#top">Up</a></div> | |
| 345 <hr /> | |
| 346 <hr /> | |
| 347 <a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a> | |
| 348 <h2>getSaveFileNameAndFilter</h2> | |
| 349 <b>getSaveFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>) | |
| 350 | |
| 351 <p> | |
| 352 Module function to get the name of a file for saving it and the selected | |
| 353 file name filter. | |
| 354 </p> | |
| 355 <dl> | |
| 356 | |
| 357 <dt><i>parent</i></dt> | |
| 358 <dd> | |
| 359 parent widget of the dialog (QWidget) | |
| 360 </dd> | |
| 361 <dt><i>caption</i></dt> | |
| 362 <dd> | |
| 363 window title of the dialog (string) | |
| 364 </dd> | |
| 365 <dt><i>directory</i></dt> | |
| 366 <dd> | |
| 367 working directory of the dialog (string) | |
| 368 </dd> | |
| 369 <dt><i>filterStr</i></dt> | |
| 370 <dd> | |
| 371 filter string for the dialog (string) | |
| 372 </dd> | |
| 373 <dt><i>initialFilter</i></dt> | |
| 374 <dd> | |
| 375 initial filter for the dialog (string) | |
| 376 </dd> | |
| 377 <dt><i>options</i></dt> | |
| 378 <dd> | |
| 379 various options for the dialog (QFileDialog.Options) | |
| 380 </dd> | |
| 381 </dl> | |
| 382 <dl> | |
| 383 <dt>Return:</dt> | |
| 384 <dd> | |
| 385 name of file to be saved and selected filter (string, string) | |
| 386 </dd> | |
| 387 </dl> | |
| 388 <div align="right"><a href="#top">Up</a></div> | |
| 389 <hr /> | |
| 390 </body></html> |
