Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.E5Gui.E5FileDialog.html
Documentation/Source/eric5.E5Gui.E5FileDialog.html
- changeset 882
- 34b86be88bf0
- parent 520
- b0f523c3b037
- child 896
- f855351d5e98
equal
deleted
inserted
replaced
| 881:ff23d907f87b | 882:34b86be88bf0 |
|---|---|
| 21 </head> | 21 </head> |
| 22 <body><a NAME="top" ID="top"></a> | 22 <body><a NAME="top" ID="top"></a> |
| 23 <h1>eric5.E5Gui.E5FileDialog</h1> | 23 <h1>eric5.E5Gui.E5FileDialog</h1> |
| 24 <p> | 24 <p> |
| 25 Module implementing alternative functions for the QFileDialog static methods | 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. | 26 to cope with distributor's usage of KDE wrapper dialogs for Qt file dialogs. |
| 27 </p> | 27 </p> |
| 28 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 <table> | 29 <table> |
| 30 <tr><td>None</td></tr> | 30 <tr><td>DontConfirmOverwrite</td></tr><tr><td>DontResolveSymlinks</td></tr><tr><td>DontUseNativeDialog</td></tr><tr><td>DontUseSheet</td></tr><tr><td>HideNameFilterDetails</td></tr><tr><td>ReadOnly</td></tr><tr><td>ShowDirsOnly</td></tr> |
| 31 </table> | 31 </table> |
| 32 <h3>Classes</h3> | 32 <h3>Classes</h3> |
| 33 <table> | 33 <table> |
| 34 <tr><td>None</td></tr> | 34 <tr><td>None</td></tr> |
| 35 </table> | 35 </table> |
| 37 <table> | 37 <table> |
| 38 <tr> | 38 <tr> |
| 39 <td><a href="#__reorderFilter">__reorderFilter</a></td> | 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> | 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> | 41 </tr><tr> |
| 42 <td><a href="#getExistingDirectory">getExistingDirectory</a></td> | |
| 43 <td>Module function to get the name of a directory.</td> | |
| 44 </tr><tr> | |
| 45 <td><a href="#getOpenFileName">getOpenFileName</a></td> | |
| 46 <td>Module function to get the name of a file for opening it.</td> | |
| 47 </tr><tr> | |
| 42 <td><a href="#getOpenFileNameAndFilter">getOpenFileNameAndFilter</a></td> | 48 <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> | 49 <td>Module function to get the name of a file for opening it and the selected file name filter.</td> |
| 44 </tr><tr> | 50 </tr><tr> |
| 51 <td><a href="#getOpenFileNames">getOpenFileNames</a></td> | |
| 52 <td>Module function to get a list of names of files for opening.</td> | |
| 53 </tr><tr> | |
| 45 <td><a href="#getOpenFileNamesAndFilter">getOpenFileNamesAndFilter</a></td> | 54 <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> | 55 <td>Module function to get a list of names of files for opening and the selected file name filter.</td> |
| 56 </tr><tr> | |
| 57 <td><a href="#getSaveFileName">getSaveFileName</a></td> | |
| 58 <td>Module function to get the name of a file for saving it.</td> | |
| 47 </tr><tr> | 59 </tr><tr> |
| 48 <td><a href="#getSaveFileNameAndFilter">getSaveFileNameAndFilter</a></td> | 60 <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> | 61 <td>Module function to get the name of a file for saving it and the selected file name filter.</td> |
| 50 </tr> | 62 </tr> |
| 51 </table> | 63 </table> |
| 52 <hr /><hr /> | 64 <hr /><hr /> |
| 53 <a NAME="__reorderFilter" ID="__reorderFilter"></a> | 65 <a NAME="__reorderFilter" ID="__reorderFilter"></a> |
| 54 <h2>__reorderFilter</h2> | 66 <h2>__reorderFilter</h2> |
| 55 <b>__reorderFilter</b>(<i>filter, initialFilter = ""</i>) | 67 <b>__reorderFilter</b>(<i>filter, initialFilter = ""</i>) |
| 56 <p> | 68 <p> |
| 57 Private function to reorder the file filter to cope with a KDE issue introduced | 69 Private function to reorder the file filter to cope with a KDE issue |
| 58 by distributor's usage of KDE file dialogs. | 70 introduced by distributor's usage of KDE file dialogs. |
| 59 </p><dl> | 71 </p><dl> |
| 60 <dt><i>filter</i></dt> | 72 <dt><i>filter</i></dt> |
| 61 <dd> | 73 <dd> |
| 62 Qt file filter (string) | 74 Qt file filter (string) |
| 63 </dd><dt><i>initialFilter</i></dt> | 75 </dd><dt><i>initialFilter</i></dt> |
| 66 </dd> | 78 </dd> |
| 67 </dl><dl> | 79 </dl><dl> |
| 68 <dt>Returns:</dt> | 80 <dt>Returns:</dt> |
| 69 <dd> | 81 <dd> |
| 70 the rearranged Qt file filter (string) | 82 the rearranged Qt file filter (string) |
| 83 </dd> | |
| 84 </dl> | |
| 85 <div align="right"><a href="#top">Up</a></div> | |
| 86 <hr /><hr /> | |
| 87 <a NAME="getExistingDirectory" ID="getExistingDirectory"></a> | |
| 88 <h2>getExistingDirectory</h2> | |
| 89 <b>getExistingDirectory</b>(<i>parent = None, caption = "", directory = "", options = QFileDialog.ShowDirsOnly</i>) | |
| 90 <p> | |
| 91 Module function to get the name of a directory. | |
| 92 </p><dl> | |
| 93 <dt><i>parent</i></dt> | |
| 94 <dd> | |
| 95 parent widget of the dialog (QWidget) | |
| 96 </dd><dt><i>caption</i></dt> | |
| 97 <dd> | |
| 98 window title of the dialog (string) | |
| 99 </dd><dt><i>directory</i></dt> | |
| 100 <dd> | |
| 101 working directory of the dialog (string) | |
| 102 </dd><dt><i>options</i></dt> | |
| 103 <dd> | |
| 104 various options for the dialog (QFileDialog.Options) | |
| 105 </dd> | |
| 106 </dl><dl> | |
| 107 <dt>Returns:</dt> | |
| 108 <dd> | |
| 109 name of selected directory (string) | |
| 110 </dd> | |
| 111 </dl> | |
| 112 <div align="right"><a href="#top">Up</a></div> | |
| 113 <hr /><hr /> | |
| 114 <a NAME="getOpenFileName" ID="getOpenFileName"></a> | |
| 115 <h2>getOpenFileName</h2> | |
| 116 <b>getOpenFileName</b>(<i>parent = None, caption = "", directory = "", filter = "", options = QFileDialog.Options()</i>) | |
| 117 <p> | |
| 118 Module function to get the name of a file for opening it. | |
| 119 </p><dl> | |
| 120 <dt><i>parent</i></dt> | |
| 121 <dd> | |
| 122 parent widget of the dialog (QWidget) | |
| 123 </dd><dt><i>caption</i></dt> | |
| 124 <dd> | |
| 125 window title of the dialog (string) | |
| 126 </dd><dt><i>directory</i></dt> | |
| 127 <dd> | |
| 128 working directory of the dialog (string) | |
| 129 </dd><dt><i>filter</i></dt> | |
| 130 <dd> | |
| 131 filter string for the dialog (string) | |
| 132 </dd><dt><i>options</i></dt> | |
| 133 <dd> | |
| 134 various options for the dialog (QFileDialog.Options) | |
| 135 </dd> | |
| 136 </dl><dl> | |
| 137 <dt>Returns:</dt> | |
| 138 <dd> | |
| 139 name of file to be opened (string) | |
| 71 </dd> | 140 </dd> |
| 72 </dl> | 141 </dl> |
| 73 <div align="right"><a href="#top">Up</a></div> | 142 <div align="right"><a href="#top">Up</a></div> |
| 74 <hr /><hr /> | 143 <hr /><hr /> |
| 75 <a NAME="getOpenFileNameAndFilter" ID="getOpenFileNameAndFilter"></a> | 144 <a NAME="getOpenFileNameAndFilter" ID="getOpenFileNameAndFilter"></a> |
| 104 name of file to be opened and selected filter (string, string) | 173 name of file to be opened and selected filter (string, string) |
| 105 </dd> | 174 </dd> |
| 106 </dl> | 175 </dl> |
| 107 <div align="right"><a href="#top">Up</a></div> | 176 <div align="right"><a href="#top">Up</a></div> |
| 108 <hr /><hr /> | 177 <hr /><hr /> |
| 178 <a NAME="getOpenFileNames" ID="getOpenFileNames"></a> | |
| 179 <h2>getOpenFileNames</h2> | |
| 180 <b>getOpenFileNames</b>(<i>parent = None, caption = "", directory = "", filter = "", options = QFileDialog.Options()</i>) | |
| 181 <p> | |
| 182 Module function to get a list of names of files for opening. | |
| 183 </p><dl> | |
| 184 <dt><i>parent</i></dt> | |
| 185 <dd> | |
| 186 parent widget of the dialog (QWidget) | |
| 187 </dd><dt><i>caption</i></dt> | |
| 188 <dd> | |
| 189 window title of the dialog (string) | |
| 190 </dd><dt><i>directory</i></dt> | |
| 191 <dd> | |
| 192 working directory of the dialog (string) | |
| 193 </dd><dt><i>filter</i></dt> | |
| 194 <dd> | |
| 195 filter string for the dialog (string) | |
| 196 </dd><dt><i>options</i></dt> | |
| 197 <dd> | |
| 198 various options for the dialog (QFileDialog.Options) | |
| 199 </dd> | |
| 200 </dl><dl> | |
| 201 <dt>Returns:</dt> | |
| 202 <dd> | |
| 203 list of file names to be opened (list of string) | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <div align="right"><a href="#top">Up</a></div> | |
| 207 <hr /><hr /> | |
| 109 <a NAME="getOpenFileNamesAndFilter" ID="getOpenFileNamesAndFilter"></a> | 208 <a NAME="getOpenFileNamesAndFilter" ID="getOpenFileNamesAndFilter"></a> |
| 110 <h2>getOpenFileNamesAndFilter</h2> | 209 <h2>getOpenFileNamesAndFilter</h2> |
| 111 <b>getOpenFileNamesAndFilter</b>(<i>parent = None, caption = "", directory = "", filter = "", initialFilter = "", options = QFileDialog.Options()</i>) | 210 <b>getOpenFileNamesAndFilter</b>(<i>parent = None, caption = "", directory = "", filter = "", initialFilter = "", options = QFileDialog.Options()</i>) |
| 112 <p> | 211 <p> |
| 113 Module function to get a list of names of files for opening and the selected | 212 Module function to get a list of names of files for opening and the |
| 114 file name filter. | 213 selected file name filter. |
| 115 </p><dl> | 214 </p><dl> |
| 116 <dt><i>parent</i></dt> | 215 <dt><i>parent</i></dt> |
| 117 <dd> | 216 <dd> |
| 118 parent widget of the dialog (QWidget) | 217 parent widget of the dialog (QWidget) |
| 119 </dd><dt><i>caption</i></dt> | 218 </dd><dt><i>caption</i></dt> |
| 135 </dl><dl> | 234 </dl><dl> |
| 136 <dt>Returns:</dt> | 235 <dt>Returns:</dt> |
| 137 <dd> | 236 <dd> |
| 138 list of file names to be opened and selected filter | 237 list of file names to be opened and selected filter |
| 139 (list of string, string) | 238 (list of string, string) |
| 239 </dd> | |
| 240 </dl> | |
| 241 <div align="right"><a href="#top">Up</a></div> | |
| 242 <hr /><hr /> | |
| 243 <a NAME="getSaveFileName" ID="getSaveFileName"></a> | |
| 244 <h2>getSaveFileName</h2> | |
| 245 <b>getSaveFileName</b>(<i>parent = None, caption = "", directory = "", filter = "", options = QFileDialog.Options()</i>) | |
| 246 <p> | |
| 247 Module function to get the name of a file for saving it. | |
| 248 </p><dl> | |
| 249 <dt><i>parent</i></dt> | |
| 250 <dd> | |
| 251 parent widget of the dialog (QWidget) | |
| 252 </dd><dt><i>caption</i></dt> | |
| 253 <dd> | |
| 254 window title of the dialog (string) | |
| 255 </dd><dt><i>directory</i></dt> | |
| 256 <dd> | |
| 257 working directory of the dialog (string) | |
| 258 </dd><dt><i>filter</i></dt> | |
| 259 <dd> | |
| 260 filter string for the dialog (string) | |
| 261 </dd><dt><i>options</i></dt> | |
| 262 <dd> | |
| 263 various options for the dialog (QFileDialog.Options) | |
| 264 </dd> | |
| 265 </dl><dl> | |
| 266 <dt>Returns:</dt> | |
| 267 <dd> | |
| 268 name of file to be saved (string) | |
| 140 </dd> | 269 </dd> |
| 141 </dl> | 270 </dl> |
| 142 <div align="right"><a href="#top">Up</a></div> | 271 <div align="right"><a href="#top">Up</a></div> |
| 143 <hr /><hr /> | 272 <hr /><hr /> |
| 144 <a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a> | 273 <a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a> |
