Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.EricWidgets.EricPathPickerDialog.html
src/eric7/Documentation/Source/eric7.EricWidgets.EricPathPickerDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.EricWidgets.EricPathPickerDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.EricWidgets.EricPathPickerDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to enter a file system path using a file picker. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#EricPathPickerDialog">EricPathPickerDialog</a></td> | |
| 25 <td>Class implementing a dialog to enter a file system path using a file picker.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#getPath">getPath</a></td> | |
| 34 <td>Function to get a file or directory path from the user.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="EricPathPickerDialog" ID="EricPathPickerDialog"></a> | |
| 40 <h2>EricPathPickerDialog</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing a dialog to enter a file system path using a file | |
| 44 picker. | |
| 45 </p> | |
| 46 <h3>Derived from</h3> | |
| 47 QDialog | |
| 48 <h3>Class Attributes</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 | |
| 60 <table> | |
| 61 | |
| 62 <tr> | |
| 63 <td><a href="#EricPathPickerDialog.__init__">EricPathPickerDialog</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#EricPathPickerDialog.getPath">getPath</a></td> | |
| 68 <td>Public method to get the current path.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#EricPathPickerDialog.setDefaultDirectory">setDefaultDirectory</a></td> | |
| 72 <td>Public method to set the default directory of the path picker.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#EricPathPickerDialog.setLabelText">setLabelText</a></td> | |
| 76 <td>Public method to set the label text.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#EricPathPickerDialog.setPickerFilters">setPickerFilters</a></td> | |
| 80 <td>Public method to set the filters of the path picker.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#EricPathPickerDialog.setPickerMode">setPickerMode</a></td> | |
| 84 <td>Public method to set the mode of the path picker.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#EricPathPickerDialog.setPickerPath">setPickerPath</a></td> | |
| 88 <td>Public method to set the path of the path picker.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#EricPathPickerDialog.setTitle">setTitle</a></td> | |
| 92 <td>Public method to set the window title.</td> | |
| 93 </tr> | |
| 94 </table> | |
| 95 <h3>Static Methods</h3> | |
| 96 | |
| 97 <table> | |
| 98 <tr><td>None</td></tr> | |
| 99 </table> | |
| 100 | |
| 101 <a NAME="EricPathPickerDialog.__init__" ID="EricPathPickerDialog.__init__"></a> | |
| 102 <h4>EricPathPickerDialog (Constructor)</h4> | |
| 103 <b>EricPathPickerDialog</b>(<i>parent=None</i>) | |
| 104 | |
| 105 <p> | |
| 106 Constructor | |
| 107 </p> | |
| 108 <dl> | |
| 109 | |
| 110 <dt><i>parent</i> (QWidget)</dt> | |
| 111 <dd> | |
| 112 reference to the parent widget | |
| 113 </dd> | |
| 114 </dl> | |
| 115 <a NAME="EricPathPickerDialog.getPath" ID="EricPathPickerDialog.getPath"></a> | |
| 116 <h4>EricPathPickerDialog.getPath</h4> | |
| 117 <b>getPath</b>(<i></i>) | |
| 118 | |
| 119 <p> | |
| 120 Public method to get the current path. | |
| 121 </p> | |
| 122 <dl> | |
| 123 <dt>Return:</dt> | |
| 124 <dd> | |
| 125 current path | |
| 126 </dd> | |
| 127 </dl> | |
| 128 <dl> | |
| 129 <dt>Return Type:</dt> | |
| 130 <dd> | |
| 131 str | |
| 132 </dd> | |
| 133 </dl> | |
| 134 <a NAME="EricPathPickerDialog.setDefaultDirectory" ID="EricPathPickerDialog.setDefaultDirectory"></a> | |
| 135 <h4>EricPathPickerDialog.setDefaultDirectory</h4> | |
| 136 <b>setDefaultDirectory</b>(<i>directory</i>) | |
| 137 | |
| 138 <p> | |
| 139 Public method to set the default directory of the path picker. | |
| 140 </p> | |
| 141 <dl> | |
| 142 | |
| 143 <dt><i>directory</i> (str)</dt> | |
| 144 <dd> | |
| 145 default directory | |
| 146 </dd> | |
| 147 </dl> | |
| 148 <a NAME="EricPathPickerDialog.setLabelText" ID="EricPathPickerDialog.setLabelText"></a> | |
| 149 <h4>EricPathPickerDialog.setLabelText</h4> | |
| 150 <b>setLabelText</b>(<i>text</i>) | |
| 151 | |
| 152 <p> | |
| 153 Public method to set the label text. | |
| 154 </p> | |
| 155 <dl> | |
| 156 | |
| 157 <dt><i>text</i> (str)</dt> | |
| 158 <dd> | |
| 159 label text | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <a NAME="EricPathPickerDialog.setPickerFilters" ID="EricPathPickerDialog.setPickerFilters"></a> | |
| 163 <h4>EricPathPickerDialog.setPickerFilters</h4> | |
| 164 <b>setPickerFilters</b>(<i>filters</i>) | |
| 165 | |
| 166 <p> | |
| 167 Public method to set the filters of the path picker. | |
| 168 </p> | |
| 169 <p> | |
| 170 Note: Multiple filters must be separated by ';;'. | |
| 171 </p> | |
| 172 <dl> | |
| 173 | |
| 174 <dt><i>filters</i> (str)</dt> | |
| 175 <dd> | |
| 176 string containing the file filters | |
| 177 </dd> | |
| 178 </dl> | |
| 179 <a NAME="EricPathPickerDialog.setPickerMode" ID="EricPathPickerDialog.setPickerMode"></a> | |
| 180 <h4>EricPathPickerDialog.setPickerMode</h4> | |
| 181 <b>setPickerMode</b>(<i>mode</i>) | |
| 182 | |
| 183 <p> | |
| 184 Public method to set the mode of the path picker. | |
| 185 </p> | |
| 186 <dl> | |
| 187 | |
| 188 <dt><i>mode</i> (EricPathPickerModes)</dt> | |
| 189 <dd> | |
| 190 picker mode | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <a NAME="EricPathPickerDialog.setPickerPath" ID="EricPathPickerDialog.setPickerPath"></a> | |
| 194 <h4>EricPathPickerDialog.setPickerPath</h4> | |
| 195 <b>setPickerPath</b>(<i>path</i>) | |
| 196 | |
| 197 <p> | |
| 198 Public method to set the path of the path picker. | |
| 199 </p> | |
| 200 <dl> | |
| 201 | |
| 202 <dt><i>path</i> (str)</dt> | |
| 203 <dd> | |
| 204 path to be set | |
| 205 </dd> | |
| 206 </dl> | |
| 207 <a NAME="EricPathPickerDialog.setTitle" ID="EricPathPickerDialog.setTitle"></a> | |
| 208 <h4>EricPathPickerDialog.setTitle</h4> | |
| 209 <b>setTitle</b>(<i>title</i>) | |
| 210 | |
| 211 <p> | |
| 212 Public method to set the window title. | |
| 213 </p> | |
| 214 <dl> | |
| 215 | |
| 216 <dt><i>title</i> (str)</dt> | |
| 217 <dd> | |
| 218 window title | |
| 219 </dd> | |
| 220 </dl> | |
| 221 <div align="right"><a href="#top">Up</a></div> | |
| 222 <hr /> | |
| 223 <hr /> | |
| 224 <a NAME="getPath" ID="getPath"></a> | |
| 225 <h2>getPath</h2> | |
| 226 <b>getPath</b>(<i>parent, title, label, mode=EricPathPickerModes.OPEN_FILE_MODE, path="", defaultDirectory="", filters=None</i>) | |
| 227 | |
| 228 <p> | |
| 229 Function to get a file or directory path from the user. | |
| 230 </p> | |
| 231 <dl> | |
| 232 | |
| 233 <dt><i>parent</i> (QWidget)</dt> | |
| 234 <dd> | |
| 235 reference to the parent widget | |
| 236 </dd> | |
| 237 <dt><i>title</i> (str)</dt> | |
| 238 <dd> | |
| 239 title of the dialog | |
| 240 </dd> | |
| 241 <dt><i>label</i> (str)</dt> | |
| 242 <dd> | |
| 243 text to be shown above the path picker | |
| 244 </dd> | |
| 245 <dt><i>mode</i> (EricPathPickerModes)</dt> | |
| 246 <dd> | |
| 247 mode of the path picker | |
| 248 </dd> | |
| 249 <dt><i>path</i> (str)</dt> | |
| 250 <dd> | |
| 251 initial path to be shown | |
| 252 </dd> | |
| 253 <dt><i>defaultDirectory</i> (str)</dt> | |
| 254 <dd> | |
| 255 default directory of the path picker selection | |
| 256 dialog | |
| 257 </dd> | |
| 258 <dt><i>filters</i> (list of str)</dt> | |
| 259 <dd> | |
| 260 list of file filters | |
| 261 </dd> | |
| 262 </dl> | |
| 263 <dl> | |
| 264 <dt>Return:</dt> | |
| 265 <dd> | |
| 266 tuple containing the entered path and a flag indicating that the | |
| 267 user pressed the OK button | |
| 268 </dd> | |
| 269 </dl> | |
| 270 <dl> | |
| 271 <dt>Return Type:</dt> | |
| 272 <dd> | |
| 273 tuple of (str, bool) | |
| 274 </dd> | |
| 275 </dl> | |
| 276 <div align="right"><a href="#top">Up</a></div> | |
| 277 <hr /> | |
| 278 </body></html> |
