Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Project.QuickFindFileDialog.html
src/eric7/Documentation/Source/eric7.Project.QuickFindFileDialog.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10430
- e440aaf179ce
- child 10692
- 9becf9ca115c
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.Project.QuickFindFileDialog</h1> | 9 <h1>eric7.Project.QuickFindFileDialog</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a quick search for files. | 11 Module implementing a quick search for files. |
| 13 </p> | 12 </p> |
| 14 <p> | 13 <p> |
| 15 This is basically the FindFileNameDialog modified to support faster | 14 This is basically the FindFileNameDialog modified to support faster |
| 16 interactions. | 15 interactions. |
| 17 </p> | 16 </p> |
| 17 | |
| 18 <h3>Global Attributes</h3> | 18 <h3>Global Attributes</h3> |
| 19 | 19 <table> |
| 20 <table> | 20 <tr><td>None</td></tr> |
| 21 <tr><td>None</td></tr> | 21 </table> |
| 22 </table> | 22 |
| 23 <h3>Classes</h3> | 23 <h3>Classes</h3> |
| 24 | 24 <table> |
| 25 <table> | |
| 26 | |
| 27 <tr> | 25 <tr> |
| 28 <td><a href="#QuickFindFileDialog">QuickFindFileDialog</a></td> | 26 <td><a href="#QuickFindFileDialog">QuickFindFileDialog</a></td> |
| 29 <td>Class implementing the Quick Find File by Name Dialog.</td> | 27 <td>Class implementing the Quick Find File by Name Dialog.</td> |
| 30 </tr> | 28 </tr> |
| 31 </table> | 29 </table> |
| 30 | |
| 32 <h3>Functions</h3> | 31 <h3>Functions</h3> |
| 33 | 32 <table> |
| 34 <table> | 33 <tr><td>None</td></tr> |
| 35 <tr><td>None</td></tr> | 34 </table> |
| 36 </table> | 35 |
| 37 <hr /> | 36 <hr /> |
| 38 <hr /> | 37 <hr /> |
| 39 <a NAME="QuickFindFileDialog" ID="QuickFindFileDialog"></a> | 38 <a NAME="QuickFindFileDialog" ID="QuickFindFileDialog"></a> |
| 40 <h2>QuickFindFileDialog</h2> | 39 <h2>QuickFindFileDialog</h2> |
| 41 | |
| 42 <p> | 40 <p> |
| 43 Class implementing the Quick Find File by Name Dialog. | 41 Class implementing the Quick Find File by Name Dialog. |
| 44 </p> | 42 </p> |
| 45 <p> | 43 <p> |
| 46 This dialog provides a slightly more streamlined behaviour | 44 This dialog provides a slightly more streamlined behaviour |
| 47 than the standard FindFileNameDialog in that it tries to | 45 than the standard FindFileNameDialog in that it tries to |
| 48 match any name in the project against (fragmentary) bits of | 46 match any name in the project against (fragmentary) bits of |
| 49 file names. | 47 file names. |
| 50 </p> | 48 </p> |
| 49 | |
| 51 <h3>Signals</h3> | 50 <h3>Signals</h3> |
| 52 <dl> | 51 <dl> |
| 53 | 52 |
| 54 <dt>designerFile(str)</dt> | 53 <dt>designerFile(str)</dt> |
| 55 <dd> | 54 <dd> |
| 65 </dd> | 64 </dd> |
| 66 </dl> | 65 </dl> |
| 67 <h3>Derived from</h3> | 66 <h3>Derived from</h3> |
| 68 QWidget, Ui_QuickFindFile | 67 QWidget, Ui_QuickFindFile |
| 69 <h3>Class Attributes</h3> | 68 <h3>Class Attributes</h3> |
| 70 | 69 <table> |
| 71 <table> | 70 <tr><td>None</td></tr> |
| 72 <tr><td>None</td></tr> | 71 </table> |
| 73 </table> | 72 |
| 74 <h3>Class Methods</h3> | 73 <h3>Class Methods</h3> |
| 75 | 74 <table> |
| 76 <table> | 75 <tr><td>None</td></tr> |
| 77 <tr><td>None</td></tr> | 76 </table> |
| 78 </table> | 77 |
| 79 <h3>Methods</h3> | 78 <h3>Methods</h3> |
| 80 | 79 <table> |
| 81 <table> | |
| 82 | |
| 83 <tr> | 80 <tr> |
| 84 <td><a href="#QuickFindFileDialog.__init__">QuickFindFileDialog</a></td> | 81 <td><a href="#QuickFindFileDialog.__init__">QuickFindFileDialog</a></td> |
| 85 <td>Constructor</td> | 82 <td>Constructor</td> |
| 86 </tr> | 83 </tr> |
| 87 <tr> | 84 <tr> |
| 127 <tr> | 124 <tr> |
| 128 <td><a href="#QuickFindFileDialog.show">show</a></td> | 125 <td><a href="#QuickFindFileDialog.show">show</a></td> |
| 129 <td>Public method to enable/disable the project checkbox.</td> | 126 <td>Public method to enable/disable the project checkbox.</td> |
| 130 </tr> | 127 </tr> |
| 131 </table> | 128 </table> |
| 129 | |
| 132 <h3>Static Methods</h3> | 130 <h3>Static Methods</h3> |
| 133 | 131 <table> |
| 134 <table> | 132 <tr><td>None</td></tr> |
| 135 <tr><td>None</td></tr> | 133 </table> |
| 136 </table> | 134 |
| 137 | 135 |
| 138 <a NAME="QuickFindFileDialog.__init__" ID="QuickFindFileDialog.__init__"></a> | 136 <a NAME="QuickFindFileDialog.__init__" ID="QuickFindFileDialog.__init__"></a> |
| 139 <h4>QuickFindFileDialog (Constructor)</h4> | 137 <h4>QuickFindFileDialog (Constructor)</h4> |
| 140 <b>QuickFindFileDialog</b>(<i>project, parent=None</i>) | 138 <b>QuickFindFileDialog</b>(<i>project, parent=None</i>) |
| 141 | |
| 142 <p> | 139 <p> |
| 143 Constructor | 140 Constructor |
| 144 </p> | 141 </p> |
| 142 | |
| 145 <dl> | 143 <dl> |
| 146 | 144 |
| 147 <dt><i>project</i> (Project)</dt> | 145 <dt><i>project</i> (Project)</dt> |
| 148 <dd> | 146 <dd> |
| 149 reference to the project object | 147 reference to the project object |
| 154 </dd> | 152 </dd> |
| 155 </dl> | 153 </dl> |
| 156 <a NAME="QuickFindFileDialog.__generateLocations" ID="QuickFindFileDialog.__generateLocations"></a> | 154 <a NAME="QuickFindFileDialog.__generateLocations" ID="QuickFindFileDialog.__generateLocations"></a> |
| 157 <h4>QuickFindFileDialog.__generateLocations</h4> | 155 <h4>QuickFindFileDialog.__generateLocations</h4> |
| 158 <b>__generateLocations</b>(<i></i>) | 156 <b>__generateLocations</b>(<i></i>) |
| 159 | |
| 160 <p> | 157 <p> |
| 161 Private method to generate a set of locations that can be searched. | 158 Private method to generate a set of locations that can be searched. |
| 162 </p> | 159 </p> |
| 160 | |
| 163 <dl> | 161 <dl> |
| 164 <dt>Yield:</dt> | 162 <dt>Yield:</dt> |
| 165 <dd> | 163 <dd> |
| 166 set of files in our project | 164 set of files in our project |
| 167 </dd> | 165 </dd> |
| 173 </dd> | 171 </dd> |
| 174 </dl> | 172 </dl> |
| 175 <a NAME="QuickFindFileDialog.__openFile" ID="QuickFindFileDialog.__openFile"></a> | 173 <a NAME="QuickFindFileDialog.__openFile" ID="QuickFindFileDialog.__openFile"></a> |
| 176 <h4>QuickFindFileDialog.__openFile</h4> | 174 <h4>QuickFindFileDialog.__openFile</h4> |
| 177 <b>__openFile</b>(<i>itm=None</i>) | 175 <b>__openFile</b>(<i>itm=None</i>) |
| 178 | |
| 179 <p> | 176 <p> |
| 180 Private slot to open a file. | 177 Private slot to open a file. |
| 181 </p> | 178 </p> |
| 182 <p> | 179 <p> |
| 183 It emits the signal sourceFile or designerFile depending on the | 180 It emits the signal sourceFile or designerFile depending on the |
| 184 file extension. | 181 file extension. |
| 185 </p> | 182 </p> |
| 183 | |
| 186 <dl> | 184 <dl> |
| 187 | 185 |
| 188 <dt><i>itm</i> (QTreeWidgetItem)</dt> | 186 <dt><i>itm</i> (QTreeWidgetItem)</dt> |
| 189 <dd> | 187 <dd> |
| 190 item to be opened | 188 item to be opened |
| 203 </dd> | 201 </dd> |
| 204 </dl> | 202 </dl> |
| 205 <a NAME="QuickFindFileDialog.__searchFile" ID="QuickFindFileDialog.__searchFile"></a> | 203 <a NAME="QuickFindFileDialog.__searchFile" ID="QuickFindFileDialog.__searchFile"></a> |
| 206 <h4>QuickFindFileDialog.__searchFile</h4> | 204 <h4>QuickFindFileDialog.__searchFile</h4> |
| 207 <b>__searchFile</b>(<i></i>) | 205 <b>__searchFile</b>(<i></i>) |
| 208 | |
| 209 <p> | 206 <p> |
| 210 Private slot to handle the search. | 207 Private slot to handle the search. |
| 211 </p> | 208 </p> |
| 209 | |
| 212 <a NAME="QuickFindFileDialog.__sortedMatches" ID="QuickFindFileDialog.__sortedMatches"></a> | 210 <a NAME="QuickFindFileDialog.__sortedMatches" ID="QuickFindFileDialog.__sortedMatches"></a> |
| 213 <h4>QuickFindFileDialog.__sortedMatches</h4> | 211 <h4>QuickFindFileDialog.__sortedMatches</h4> |
| 214 <b>__sortedMatches</b>(<i>items, searchTerm</i>) | 212 <b>__sortedMatches</b>(<i>items, searchTerm</i>) |
| 215 | |
| 216 <p> | 213 <p> |
| 217 Private method to find the subset of items which match a search term. | 214 Private method to find the subset of items which match a search term. |
| 218 </p> | 215 </p> |
| 216 | |
| 219 <dl> | 217 <dl> |
| 220 | 218 |
| 221 <dt><i>items</i> (list of str)</dt> | 219 <dt><i>items</i> (list of str)</dt> |
| 222 <dd> | 220 <dd> |
| 223 list of items to be scanned for the search term | 221 list of items to be scanned for the search term |
| 241 </dd> | 239 </dd> |
| 242 </dl> | 240 </dl> |
| 243 <a NAME="QuickFindFileDialog.eventFilter" ID="QuickFindFileDialog.eventFilter"></a> | 241 <a NAME="QuickFindFileDialog.eventFilter" ID="QuickFindFileDialog.eventFilter"></a> |
| 244 <h4>QuickFindFileDialog.eventFilter</h4> | 242 <h4>QuickFindFileDialog.eventFilter</h4> |
| 245 <b>eventFilter</b>(<i>source, event</i>) | 243 <b>eventFilter</b>(<i>source, event</i>) |
| 246 | |
| 247 <p> | 244 <p> |
| 248 Public method to handle event for another object. | 245 Public method to handle event for another object. |
| 249 </p> | 246 </p> |
| 247 | |
| 250 <dl> | 248 <dl> |
| 251 | 249 |
| 252 <dt><i>source</i> (QObject)</dt> | 250 <dt><i>source</i> (QObject)</dt> |
| 253 <dd> | 251 <dd> |
| 254 object to handle events for | 252 object to handle events for |
| 271 </dd> | 269 </dd> |
| 272 </dl> | 270 </dl> |
| 273 <a NAME="QuickFindFileDialog.on_buttonBox_clicked" ID="QuickFindFileDialog.on_buttonBox_clicked"></a> | 271 <a NAME="QuickFindFileDialog.on_buttonBox_clicked" ID="QuickFindFileDialog.on_buttonBox_clicked"></a> |
| 274 <h4>QuickFindFileDialog.on_buttonBox_clicked</h4> | 272 <h4>QuickFindFileDialog.on_buttonBox_clicked</h4> |
| 275 <b>on_buttonBox_clicked</b>(<i>button</i>) | 273 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 276 | |
| 277 <p> | 274 <p> |
| 278 Private slot called by a button of the button box clicked. | 275 Private slot called by a button of the button box clicked. |
| 279 </p> | 276 </p> |
| 277 | |
| 280 <dl> | 278 <dl> |
| 281 | 279 |
| 282 <dt><i>button</i> (QAbstractButton)</dt> | 280 <dt><i>button</i> (QAbstractButton)</dt> |
| 283 <dd> | 281 <dd> |
| 284 button that was clicked | 282 button that was clicked |
| 285 </dd> | 283 </dd> |
| 286 </dl> | 284 </dl> |
| 287 <a NAME="QuickFindFileDialog.on_fileList_currentItemChanged" ID="QuickFindFileDialog.on_fileList_currentItemChanged"></a> | 285 <a NAME="QuickFindFileDialog.on_fileList_currentItemChanged" ID="QuickFindFileDialog.on_fileList_currentItemChanged"></a> |
| 288 <h4>QuickFindFileDialog.on_fileList_currentItemChanged</h4> | 286 <h4>QuickFindFileDialog.on_fileList_currentItemChanged</h4> |
| 289 <b>on_fileList_currentItemChanged</b>(<i>current, previous</i>) | 287 <b>on_fileList_currentItemChanged</b>(<i>current, previous</i>) |
| 290 | |
| 291 <p> | 288 <p> |
| 292 Private slot handling a change of the current item. | 289 Private slot handling a change of the current item. |
| 293 </p> | 290 </p> |
| 291 | |
| 294 <dl> | 292 <dl> |
| 295 | 293 |
| 296 <dt><i>current</i> (QTreeWidgetItem)</dt> | 294 <dt><i>current</i> (QTreeWidgetItem)</dt> |
| 297 <dd> | 295 <dd> |
| 298 current item | 296 current item |
| 303 </dd> | 301 </dd> |
| 304 </dl> | 302 </dl> |
| 305 <a NAME="QuickFindFileDialog.on_fileList_itemActivated" ID="QuickFindFileDialog.on_fileList_itemActivated"></a> | 303 <a NAME="QuickFindFileDialog.on_fileList_itemActivated" ID="QuickFindFileDialog.on_fileList_itemActivated"></a> |
| 306 <h4>QuickFindFileDialog.on_fileList_itemActivated</h4> | 304 <h4>QuickFindFileDialog.on_fileList_itemActivated</h4> |
| 307 <b>on_fileList_itemActivated</b>(<i>itm, column</i>) | 305 <b>on_fileList_itemActivated</b>(<i>itm, column</i>) |
| 308 | |
| 309 <p> | 306 <p> |
| 310 Private slot to handle the double click on a file item. | 307 Private slot to handle the double click on a file item. |
| 311 </p> | 308 </p> |
| 312 <p> | 309 <p> |
| 313 It emits the signal sourceFile or designerFile depending on the | 310 It emits the signal sourceFile or designerFile depending on the |
| 314 file extension. | 311 file extension. |
| 315 </p> | 312 </p> |
| 313 | |
| 316 <dl> | 314 <dl> |
| 317 | 315 |
| 318 <dt><i>itm</i> (QTreeWidgetItem)</dt> | 316 <dt><i>itm</i> (QTreeWidgetItem)</dt> |
| 319 <dd> | 317 <dd> |
| 320 the double clicked listview item | 318 the double clicked listview item |
| 325 </dd> | 323 </dd> |
| 326 </dl> | 324 </dl> |
| 327 <a NAME="QuickFindFileDialog.on_fileNameEdit_returnPressed" ID="QuickFindFileDialog.on_fileNameEdit_returnPressed"></a> | 325 <a NAME="QuickFindFileDialog.on_fileNameEdit_returnPressed" ID="QuickFindFileDialog.on_fileNameEdit_returnPressed"></a> |
| 328 <h4>QuickFindFileDialog.on_fileNameEdit_returnPressed</h4> | 326 <h4>QuickFindFileDialog.on_fileNameEdit_returnPressed</h4> |
| 329 <b>on_fileNameEdit_returnPressed</b>(<i></i>) | 327 <b>on_fileNameEdit_returnPressed</b>(<i></i>) |
| 330 | |
| 331 <p> | 328 <p> |
| 332 Private slot to handle enter being pressed on the file name edit box. | 329 Private slot to handle enter being pressed on the file name edit box. |
| 333 </p> | 330 </p> |
| 331 | |
| 334 <a NAME="QuickFindFileDialog.on_fileNameEdit_textChanged" ID="QuickFindFileDialog.on_fileNameEdit_textChanged"></a> | 332 <a NAME="QuickFindFileDialog.on_fileNameEdit_textChanged" ID="QuickFindFileDialog.on_fileNameEdit_textChanged"></a> |
| 335 <h4>QuickFindFileDialog.on_fileNameEdit_textChanged</h4> | 333 <h4>QuickFindFileDialog.on_fileNameEdit_textChanged</h4> |
| 336 <b>on_fileNameEdit_textChanged</b>(<i>text</i>) | 334 <b>on_fileNameEdit_textChanged</b>(<i>text</i>) |
| 337 | |
| 338 <p> | 335 <p> |
| 339 Private slot to handle the textChanged signal of the file name edit. | 336 Private slot to handle the textChanged signal of the file name edit. |
| 340 </p> | 337 </p> |
| 338 | |
| 341 <dl> | 339 <dl> |
| 342 | 340 |
| 343 <dt><i>text</i> (str)</dt> | 341 <dt><i>text</i> (str)</dt> |
| 344 <dd> | 342 <dd> |
| 345 (ignored) | 343 (ignored) |
| 346 </dd> | 344 </dd> |
| 347 </dl> | 345 </dl> |
| 348 <a NAME="QuickFindFileDialog.show" ID="QuickFindFileDialog.show"></a> | 346 <a NAME="QuickFindFileDialog.show" ID="QuickFindFileDialog.show"></a> |
| 349 <h4>QuickFindFileDialog.show</h4> | 347 <h4>QuickFindFileDialog.show</h4> |
| 350 <b>show</b>(<i></i>) | 348 <b>show</b>(<i></i>) |
| 351 | |
| 352 <p> | 349 <p> |
| 353 Public method to enable/disable the project checkbox. | 350 Public method to enable/disable the project checkbox. |
| 354 </p> | 351 </p> |
| 352 | |
| 355 <div align="right"><a href="#top">Up</a></div> | 353 <div align="right"><a href="#top">Up</a></div> |
| 356 <hr /> | 354 <hr /> |
| 357 </body></html> | 355 </body></html> |
