Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.UI.FindFileWidget.html
src/eric7/Documentation/Source/eric7.UI.FindFileWidget.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 9042
- d08cf11928a4
- child 9559
- 34fc53e6159d
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.UI.FindFileWidget</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.UI.FindFileWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to search for text in files. | |
| 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="#FindFileDialog">FindFileDialog</a></td> | |
| 25 <td>Class implementing a dialog to search for text in files and replace it with some other text.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#FindFileWidget">FindFileWidget</a></td> | |
| 29 <td>Class implementing a widget to search for text in files and replace it with some other text.</td> | |
| 30 </tr> | |
| 31 </table> | |
| 32 <h3>Functions</h3> | |
| 33 | |
| 34 <table> | |
| 35 <tr><td>None</td></tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="FindFileDialog" ID="FindFileDialog"></a> | |
| 40 <h2>FindFileDialog</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing a dialog to search for text in files and replace it | |
| 44 with some other text. | |
| 45 </p> | |
| 46 <p> | |
| 47 The occurrences found are displayed in a tree showing the file name, | |
| 48 the line number and the text found. The file will be opened upon a double | |
| 49 click onto the respective entry of the list. If the widget is in replace | |
| 50 mode the line below shows the text after replacement. Replacements can | |
| 51 be authorized by ticking them on. Pressing the replace button performs | |
| 52 all ticked replacement operations. | |
| 53 </p> | |
| 54 <h3>Signals</h3> | |
| 55 <dl> | |
| 56 | |
| 57 <dt>designerFile(str)</dt> | |
| 58 <dd> | |
| 59 emitted to open a Qt-Designer file | |
| 60 </dd> | |
| 61 <dt>linguistFile(str)</dt> | |
| 62 <dd> | |
| 63 emitted to open a Qt-Linguist (*.ts) file | |
| 64 </dd> | |
| 65 <dt>pixmapFile(str)</dt> | |
| 66 <dd> | |
| 67 emitted to open a pixmap file | |
| 68 </dd> | |
| 69 <dt>sourceFile(str, int, str, int, int)</dt> | |
| 70 <dd> | |
| 71 emitted to open a source file | |
| 72 at a specificline | |
| 73 </dd> | |
| 74 <dt>svgFile(str)</dt> | |
| 75 <dd> | |
| 76 emitted to open a SVG file | |
| 77 </dd> | |
| 78 <dt>trpreview([str])</dt> | |
| 79 <dd> | |
| 80 emitted to preview Qt-Linguist (*.qm) files | |
| 81 </dd> | |
| 82 <dt>umlFile(str)</dt> | |
| 83 <dd> | |
| 84 emitted to open an eric UML file | |
| 85 </dd> | |
| 86 </dl> | |
| 87 <h3>Derived from</h3> | |
| 88 QDialog | |
| 89 <h3>Class Attributes</h3> | |
| 90 | |
| 91 <table> | |
| 92 <tr><td>None</td></tr> | |
| 93 </table> | |
| 94 <h3>Class Methods</h3> | |
| 95 | |
| 96 <table> | |
| 97 <tr><td>None</td></tr> | |
| 98 </table> | |
| 99 <h3>Methods</h3> | |
| 100 | |
| 101 <table> | |
| 102 | |
| 103 <tr> | |
| 104 <td><a href="#FindFileDialog.__init__">FindFileDialog</a></td> | |
| 105 <td>Constructor</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#FindFileDialog.activate">activate</a></td> | |
| 109 <td>Public method to activate the dialog with a given mode, a text to search for and some search parameters.</td> | |
| 110 </tr> | |
| 111 </table> | |
| 112 <h3>Static Methods</h3> | |
| 113 | |
| 114 <table> | |
| 115 <tr><td>None</td></tr> | |
| 116 </table> | |
| 117 | |
| 118 <a NAME="FindFileDialog.__init__" ID="FindFileDialog.__init__"></a> | |
| 119 <h4>FindFileDialog (Constructor)</h4> | |
| 120 <b>FindFileDialog</b>(<i>project, parent=None</i>) | |
| 121 | |
| 122 <p> | |
| 123 Constructor | |
| 124 </p> | |
| 125 <dl> | |
| 126 | |
| 127 <dt><i>project</i> (Project)</dt> | |
| 128 <dd> | |
| 129 reference to the project object | |
| 130 </dd> | |
| 131 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 132 <dd> | |
| 133 parent widget of this dialog (defaults to None) | |
| 134 </dd> | |
| 135 </dl> | |
| 136 <a NAME="FindFileDialog.activate" ID="FindFileDialog.activate"></a> | |
| 137 <h4>FindFileDialog.activate</h4> | |
| 138 <b>activate</b>(<i>replaceMode=False, txt="", searchDir="", openFiles=False</i>) | |
| 139 | |
| 140 <p> | |
| 141 Public method to activate the dialog with a given mode, a text | |
| 142 to search for and some search parameters. | |
| 143 </p> | |
| 144 <dl> | |
| 145 | |
| 146 <dt><i>replaceMode</i> (bool (optional))</dt> | |
| 147 <dd> | |
| 148 flag indicating replacement mode (defaults to False) | |
| 149 </dd> | |
| 150 <dt><i>txt</i> (str (optional))</dt> | |
| 151 <dd> | |
| 152 text to be searched for (defaults to "") | |
| 153 </dd> | |
| 154 <dt><i>searchDir</i> (str (optional))</dt> | |
| 155 <dd> | |
| 156 directory to search in (defaults to "") | |
| 157 </dd> | |
| 158 <dt><i>openFiles</i> (bool (optional))</dt> | |
| 159 <dd> | |
| 160 flag indicating to operate on open files only | |
| 161 (defaults to False) | |
| 162 </dd> | |
| 163 </dl> | |
| 164 <div align="right"><a href="#top">Up</a></div> | |
| 165 <hr /> | |
| 166 <hr /> | |
| 167 <a NAME="FindFileWidget" ID="FindFileWidget"></a> | |
| 168 <h2>FindFileWidget</h2> | |
| 169 | |
| 170 <p> | |
| 171 Class implementing a widget to search for text in files and replace it | |
| 172 with some other text. | |
| 173 </p> | |
| 174 <p> | |
| 175 The occurrences found are displayed in a tree showing the file name, | |
| 176 the line number and the text found. The file will be opened upon a double | |
| 177 click onto the respective entry of the list. If the widget is in replace | |
| 178 mode the line below shows the text after replacement. Replacements can | |
| 179 be authorized by ticking them on. Pressing the replace button performs | |
| 180 all ticked replacement operations. | |
| 181 </p> | |
| 182 <h3>Signals</h3> | |
| 183 <dl> | |
| 184 | |
| 185 <dt>designerFile(str)</dt> | |
| 186 <dd> | |
| 187 emitted to open a Qt-Designer file | |
| 188 </dd> | |
| 189 <dt>linguistFile(str)</dt> | |
| 190 <dd> | |
| 191 emitted to open a Qt-Linguist (*.ts) file | |
| 192 </dd> | |
| 193 <dt>pixmapFile(str)</dt> | |
| 194 <dd> | |
| 195 emitted to open a pixmap file | |
| 196 </dd> | |
| 197 <dt>sourceFile(str, int, str, int, int)</dt> | |
| 198 <dd> | |
| 199 emitted to open a source file | |
| 200 at a specificline | |
| 201 </dd> | |
| 202 <dt>svgFile(str)</dt> | |
| 203 <dd> | |
| 204 emitted to open a SVG file | |
| 205 </dd> | |
| 206 <dt>trpreview([str])</dt> | |
| 207 <dd> | |
| 208 emitted to preview Qt-Linguist (*.qm) files | |
| 209 </dd> | |
| 210 <dt>umlFile(str)</dt> | |
| 211 <dd> | |
| 212 emitted to open an eric UML file | |
| 213 </dd> | |
| 214 </dl> | |
| 215 <h3>Derived from</h3> | |
| 216 QWidget, Ui_FindFileWidget | |
| 217 <h3>Class Attributes</h3> | |
| 218 | |
| 219 <table> | |
| 220 <tr><td>endRole</td></tr><tr><td>lineRole</td></tr><tr><td>md5Role</td></tr><tr><td>replaceRole</td></tr><tr><td>startRole</td></tr> | |
| 221 </table> | |
| 222 <h3>Class Methods</h3> | |
| 223 | |
| 224 <table> | |
| 225 <tr><td>None</td></tr> | |
| 226 </table> | |
| 227 <h3>Methods</h3> | |
| 228 | |
| 229 <table> | |
| 230 | |
| 231 <tr> | |
| 232 <td><a href="#FindFileWidget.__init__">FindFileWidget</a></td> | |
| 233 <td>Constructor</td> | |
| 234 </tr> | |
| 235 <tr> | |
| 236 <td><a href="#FindFileWidget.__clearResults">__clearResults</a></td> | |
| 237 <td>Private slot to clear the current search results.</td> | |
| 238 </tr> | |
| 239 <tr> | |
| 240 <td><a href="#FindFileWidget.__contextMenuRequested">__contextMenuRequested</a></td> | |
| 241 <td>Private slot to handle the context menu request.</td> | |
| 242 </tr> | |
| 243 <tr> | |
| 244 <td><a href="#FindFileWidget.__copyToClipboard">__copyToClipboard</a></td> | |
| 245 <td>Private slot to copy the path of an entry to the clipboard.</td> | |
| 246 </tr> | |
| 247 <tr> | |
| 248 <td><a href="#FindFileWidget.__createItem">__createItem</a></td> | |
| 249 <td>Private method to create an entry in the file list.</td> | |
| 250 </tr> | |
| 251 <tr> | |
| 252 <td><a href="#FindFileWidget.__doSearch">__doSearch</a></td> | |
| 253 <td>Private slot to handle the find button being pressed.</td> | |
| 254 </tr> | |
| 255 <tr> | |
| 256 <td><a href="#FindFileWidget.__enableFindButton">__enableFindButton</a></td> | |
| 257 <td>Private slot called to enable the find button.</td> | |
| 258 </tr> | |
| 259 <tr> | |
| 260 <td><a href="#FindFileWidget.__getFileList">__getFileList</a></td> | |
| 261 <td>Private method to get a list of files to search.</td> | |
| 262 </tr> | |
| 263 <tr> | |
| 264 <td><a href="#FindFileWidget.__openFile">__openFile</a></td> | |
| 265 <td>Private slot to open the currently selected entry.</td> | |
| 266 </tr> | |
| 267 <tr> | |
| 268 <td><a href="#FindFileWidget.__projectClosed">__projectClosed</a></td> | |
| 269 <td>Private slot to react to the closing of a project.</td> | |
| 270 </tr> | |
| 271 <tr> | |
| 272 <td><a href="#FindFileWidget.__projectOpened">__projectOpened</a></td> | |
| 273 <td>Private slot to react to the opening of a project.</td> | |
| 274 </tr> | |
| 275 <tr> | |
| 276 <td><a href="#FindFileWidget.__setOpenFiles">__setOpenFiles</a></td> | |
| 277 <td>Private slot to set the mode to search in open files.</td> | |
| 278 </tr> | |
| 279 <tr> | |
| 280 <td><a href="#FindFileWidget.__setSearchDirectory">__setSearchDirectory</a></td> | |
| 281 <td>Private slot to set the name of the directory to search in.</td> | |
| 282 </tr> | |
| 283 <tr> | |
| 284 <td><a href="#FindFileWidget.__stopSearch">__stopSearch</a></td> | |
| 285 <td>Private slot to handle the stop button being pressed.</td> | |
| 286 </tr> | |
| 287 <tr> | |
| 288 <td><a href="#FindFileWidget.__stripEol">__stripEol</a></td> | |
| 289 <td>Private method to strip the eol part.</td> | |
| 290 </tr> | |
| 291 <tr> | |
| 292 <td><a href="#FindFileWidget.__toggleReplaceMode">__toggleReplaceMode</a></td> | |
| 293 <td>Private slot to toggle the dialog mode.</td> | |
| 294 </tr> | |
| 295 <tr> | |
| 296 <td><a href="#FindFileWidget.activate">activate</a></td> | |
| 297 <td>Public method to activate the widget with a given mode, a text to search for and some search parameters.</td> | |
| 298 </tr> | |
| 299 <tr> | |
| 300 <td><a href="#FindFileWidget.on_dirButton_clicked">on_dirButton_clicked</a></td> | |
| 301 <td>Private slot to handle the selection of the 'Directory' radio button.</td> | |
| 302 </tr> | |
| 303 <tr> | |
| 304 <td><a href="#FindFileWidget.on_dirPicker_editTextChanged">on_dirPicker_editTextChanged</a></td> | |
| 305 <td>Private slot to handle the textChanged signal of the directory picker.</td> | |
| 306 </tr> | |
| 307 <tr> | |
| 308 <td><a href="#FindFileWidget.on_filterCheckBox_clicked">on_filterCheckBox_clicked</a></td> | |
| 309 <td>Private slot to handle the selection of the file filter check box.</td> | |
| 310 </tr> | |
| 311 <tr> | |
| 312 <td><a href="#FindFileWidget.on_filterEdit_textEdited">on_filterEdit_textEdited</a></td> | |
| 313 <td>Private slot to handle the textChanged signal of the file filter edit.</td> | |
| 314 </tr> | |
| 315 <tr> | |
| 316 <td><a href="#FindFileWidget.on_findList_itemDoubleClicked">on_findList_itemDoubleClicked</a></td> | |
| 317 <td>Private slot to handle the double click on a file item.</td> | |
| 318 </tr> | |
| 319 <tr> | |
| 320 <td><a href="#FindFileWidget.on_findtextCombo_editTextChanged">on_findtextCombo_editTextChanged</a></td> | |
| 321 <td>Private slot to handle the editTextChanged signal of the find text combo.</td> | |
| 322 </tr> | |
| 323 <tr> | |
| 324 <td><a href="#FindFileWidget.on_openFilesButton_clicked">on_openFilesButton_clicked</a></td> | |
| 325 <td>Private slot to handle the selection of the 'Open Files' radio button.</td> | |
| 326 </tr> | |
| 327 <tr> | |
| 328 <td><a href="#FindFileWidget.on_projectButton_clicked">on_projectButton_clicked</a></td> | |
| 329 <td>Private slot to handle the selection of the 'Project' radio button.</td> | |
| 330 </tr> | |
| 331 <tr> | |
| 332 <td><a href="#FindFileWidget.on_replaceButton_clicked">on_replaceButton_clicked</a></td> | |
| 333 <td>Private slot to perform the requested replace actions.</td> | |
| 334 </tr> | |
| 335 <tr> | |
| 336 <td><a href="#FindFileWidget.on_replacetextCombo_editTextChanged">on_replacetextCombo_editTextChanged</a></td> | |
| 337 <td>Private slot to handle the editTextChanged signal of the replace text combo.</td> | |
| 338 </tr> | |
| 339 </table> | |
| 340 <h3>Static Methods</h3> | |
| 341 | |
| 342 <table> | |
| 343 <tr><td>None</td></tr> | |
| 344 </table> | |
| 345 | |
| 346 <a NAME="FindFileWidget.__init__" ID="FindFileWidget.__init__"></a> | |
| 347 <h4>FindFileWidget (Constructor)</h4> | |
| 348 <b>FindFileWidget</b>(<i>project, parent=None</i>) | |
| 349 | |
| 350 <p> | |
| 351 Constructor | |
| 352 </p> | |
| 353 <dl> | |
| 354 | |
| 355 <dt><i>project</i> (Project)</dt> | |
| 356 <dd> | |
| 357 reference to the project object | |
| 358 </dd> | |
| 359 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 360 <dd> | |
| 361 parent widget of this dialog (defaults to None) | |
| 362 </dd> | |
| 363 </dl> | |
| 364 <a NAME="FindFileWidget.__clearResults" ID="FindFileWidget.__clearResults"></a> | |
| 365 <h4>FindFileWidget.__clearResults</h4> | |
| 366 <b>__clearResults</b>(<i></i>) | |
| 367 | |
| 368 <p> | |
| 369 Private slot to clear the current search results. | |
| 370 </p> | |
| 371 <a NAME="FindFileWidget.__contextMenuRequested" ID="FindFileWidget.__contextMenuRequested"></a> | |
| 372 <h4>FindFileWidget.__contextMenuRequested</h4> | |
| 373 <b>__contextMenuRequested</b>(<i>pos</i>) | |
| 374 | |
| 375 <p> | |
| 376 Private slot to handle the context menu request. | |
| 377 </p> | |
| 378 <dl> | |
| 379 | |
| 380 <dt><i>pos</i> (QPoint)</dt> | |
| 381 <dd> | |
| 382 position the context menu shall be shown | |
| 383 </dd> | |
| 384 </dl> | |
| 385 <a NAME="FindFileWidget.__copyToClipboard" ID="FindFileWidget.__copyToClipboard"></a> | |
| 386 <h4>FindFileWidget.__copyToClipboard</h4> | |
| 387 <b>__copyToClipboard</b>(<i></i>) | |
| 388 | |
| 389 <p> | |
| 390 Private slot to copy the path of an entry to the clipboard. | |
| 391 </p> | |
| 392 <a NAME="FindFileWidget.__createItem" ID="FindFileWidget.__createItem"></a> | |
| 393 <h4>FindFileWidget.__createItem</h4> | |
| 394 <b>__createItem</b>(<i>file, line, text, start, end, replTxt="", md5=""</i>) | |
| 395 | |
| 396 <p> | |
| 397 Private method to create an entry in the file list. | |
| 398 </p> | |
| 399 <dl> | |
| 400 | |
| 401 <dt><i>file</i> (str)</dt> | |
| 402 <dd> | |
| 403 filename of file | |
| 404 </dd> | |
| 405 <dt><i>line</i> (int)</dt> | |
| 406 <dd> | |
| 407 line number | |
| 408 </dd> | |
| 409 <dt><i>text</i> (str)</dt> | |
| 410 <dd> | |
| 411 text found | |
| 412 </dd> | |
| 413 <dt><i>start</i> (int)</dt> | |
| 414 <dd> | |
| 415 start position of match | |
| 416 </dd> | |
| 417 <dt><i>end</i> (int)</dt> | |
| 418 <dd> | |
| 419 end position of match | |
| 420 </dd> | |
| 421 <dt><i>replTxt</i> (str (optional))</dt> | |
| 422 <dd> | |
| 423 text with replacements applied (defaults to "") | |
| 424 </dd> | |
| 425 <dt><i>md5</i> (str (optional))</dt> | |
| 426 <dd> | |
| 427 MD5 hash of the file (defaults to "") | |
| 428 </dd> | |
| 429 </dl> | |
| 430 <a NAME="FindFileWidget.__doSearch" ID="FindFileWidget.__doSearch"></a> | |
| 431 <h4>FindFileWidget.__doSearch</h4> | |
| 432 <b>__doSearch</b>(<i></i>) | |
| 433 | |
| 434 <p> | |
| 435 Private slot to handle the find button being pressed. | |
| 436 </p> | |
| 437 <a NAME="FindFileWidget.__enableFindButton" ID="FindFileWidget.__enableFindButton"></a> | |
| 438 <h4>FindFileWidget.__enableFindButton</h4> | |
| 439 <b>__enableFindButton</b>(<i></i>) | |
| 440 | |
| 441 <p> | |
| 442 Private slot called to enable the find button. | |
| 443 </p> | |
| 444 <a NAME="FindFileWidget.__getFileList" ID="FindFileWidget.__getFileList"></a> | |
| 445 <h4>FindFileWidget.__getFileList</h4> | |
| 446 <b>__getFileList</b>(<i>path, filterRe, excludeHiddenDirs=False, excludeHiddenFiles=False</i>) | |
| 447 | |
| 448 <p> | |
| 449 Private method to get a list of files to search. | |
| 450 </p> | |
| 451 <dl> | |
| 452 | |
| 453 <dt><i>path</i> (str)</dt> | |
| 454 <dd> | |
| 455 the root directory to search in | |
| 456 </dd> | |
| 457 <dt><i>filterRe</i> (regexp object)</dt> | |
| 458 <dd> | |
| 459 regular expression defining the filter | |
| 460 criteria | |
| 461 </dd> | |
| 462 <dt><i>excludeHiddenDirs</i> (bool)</dt> | |
| 463 <dd> | |
| 464 flag indicating to exclude hidden directories | |
| 465 </dd> | |
| 466 <dt><i>excludeHiddenFiles</i> (bool)</dt> | |
| 467 <dd> | |
| 468 flag indicating to exclude hidden files | |
| 469 </dd> | |
| 470 </dl> | |
| 471 <dl> | |
| 472 <dt>Return:</dt> | |
| 473 <dd> | |
| 474 list of files to be processed | |
| 475 </dd> | |
| 476 </dl> | |
| 477 <dl> | |
| 478 <dt>Return Type:</dt> | |
| 479 <dd> | |
| 480 list of str | |
| 481 </dd> | |
| 482 </dl> | |
| 483 <a NAME="FindFileWidget.__openFile" ID="FindFileWidget.__openFile"></a> | |
| 484 <h4>FindFileWidget.__openFile</h4> | |
| 485 <b>__openFile</b>(<i></i>) | |
| 486 | |
| 487 <p> | |
| 488 Private slot to open the currently selected entry. | |
| 489 </p> | |
| 490 <a NAME="FindFileWidget.__projectClosed" ID="FindFileWidget.__projectClosed"></a> | |
| 491 <h4>FindFileWidget.__projectClosed</h4> | |
| 492 <b>__projectClosed</b>(<i></i>) | |
| 493 | |
| 494 <p> | |
| 495 Private slot to react to the closing of a project. | |
| 496 </p> | |
| 497 <a NAME="FindFileWidget.__projectOpened" ID="FindFileWidget.__projectOpened"></a> | |
| 498 <h4>FindFileWidget.__projectOpened</h4> | |
| 499 <b>__projectOpened</b>(<i></i>) | |
| 500 | |
| 501 <p> | |
| 502 Private slot to react to the opening of a project. | |
| 503 </p> | |
| 504 <a NAME="FindFileWidget.__setOpenFiles" ID="FindFileWidget.__setOpenFiles"></a> | |
| 505 <h4>FindFileWidget.__setOpenFiles</h4> | |
| 506 <b>__setOpenFiles</b>(<i></i>) | |
| 507 | |
| 508 <p> | |
| 509 Private slot to set the mode to search in open files. | |
| 510 </p> | |
| 511 <a NAME="FindFileWidget.__setSearchDirectory" ID="FindFileWidget.__setSearchDirectory"></a> | |
| 512 <h4>FindFileWidget.__setSearchDirectory</h4> | |
| 513 <b>__setSearchDirectory</b>(<i>searchDir</i>) | |
| 514 | |
| 515 <p> | |
| 516 Private slot to set the name of the directory to search in. | |
| 517 </p> | |
| 518 <dl> | |
| 519 | |
| 520 <dt><i>searchDir</i> (str)</dt> | |
| 521 <dd> | |
| 522 name of the directory to search in | |
| 523 </dd> | |
| 524 </dl> | |
| 525 <a NAME="FindFileWidget.__stopSearch" ID="FindFileWidget.__stopSearch"></a> | |
| 526 <h4>FindFileWidget.__stopSearch</h4> | |
| 527 <b>__stopSearch</b>(<i></i>) | |
| 528 | |
| 529 <p> | |
| 530 Private slot to handle the stop button being pressed. | |
| 531 </p> | |
| 532 <a NAME="FindFileWidget.__stripEol" ID="FindFileWidget.__stripEol"></a> | |
| 533 <h4>FindFileWidget.__stripEol</h4> | |
| 534 <b>__stripEol</b>(<i>txt</i>) | |
| 535 | |
| 536 <p> | |
| 537 Private method to strip the eol part. | |
| 538 </p> | |
| 539 <dl> | |
| 540 | |
| 541 <dt><i>txt</i> (str)</dt> | |
| 542 <dd> | |
| 543 line of text that should be treated | |
| 544 </dd> | |
| 545 </dl> | |
| 546 <dl> | |
| 547 <dt>Return:</dt> | |
| 548 <dd> | |
| 549 text with eol stripped | |
| 550 </dd> | |
| 551 </dl> | |
| 552 <dl> | |
| 553 <dt>Return Type:</dt> | |
| 554 <dd> | |
| 555 str | |
| 556 </dd> | |
| 557 </dl> | |
| 558 <a NAME="FindFileWidget.__toggleReplaceMode" ID="FindFileWidget.__toggleReplaceMode"></a> | |
| 559 <h4>FindFileWidget.__toggleReplaceMode</h4> | |
| 560 <b>__toggleReplaceMode</b>(<i></i>) | |
| 561 | |
| 562 <p> | |
| 563 Private slot to toggle the dialog mode. | |
| 564 </p> | |
| 565 <a NAME="FindFileWidget.activate" ID="FindFileWidget.activate"></a> | |
| 566 <h4>FindFileWidget.activate</h4> | |
| 567 <b>activate</b>(<i>replaceMode=False, txt="", searchDir="", openFiles=False</i>) | |
| 568 | |
| 569 <p> | |
| 570 Public method to activate the widget with a given mode, a text | |
| 571 to search for and some search parameters. | |
| 572 </p> | |
| 573 <dl> | |
| 574 | |
| 575 <dt><i>replaceMode</i> (bool (optional))</dt> | |
| 576 <dd> | |
| 577 flag indicating replacement mode (defaults to False) | |
| 578 </dd> | |
| 579 <dt><i>txt</i> (str (optional))</dt> | |
| 580 <dd> | |
| 581 text to be searched for (defaults to "") | |
| 582 </dd> | |
| 583 <dt><i>searchDir</i> (str (optional))</dt> | |
| 584 <dd> | |
| 585 directory to search in (defaults to "") | |
| 586 </dd> | |
| 587 <dt><i>openFiles</i> (bool (optional))</dt> | |
| 588 <dd> | |
| 589 flag indicating to operate on open files only | |
| 590 (defaults to False) | |
| 591 </dd> | |
| 592 </dl> | |
| 593 <a NAME="FindFileWidget.on_dirButton_clicked" ID="FindFileWidget.on_dirButton_clicked"></a> | |
| 594 <h4>FindFileWidget.on_dirButton_clicked</h4> | |
| 595 <b>on_dirButton_clicked</b>(<i></i>) | |
| 596 | |
| 597 <p> | |
| 598 Private slot to handle the selection of the 'Directory' radio button. | |
| 599 </p> | |
| 600 <a NAME="FindFileWidget.on_dirPicker_editTextChanged" ID="FindFileWidget.on_dirPicker_editTextChanged"></a> | |
| 601 <h4>FindFileWidget.on_dirPicker_editTextChanged</h4> | |
| 602 <b>on_dirPicker_editTextChanged</b>(<i>text</i>) | |
| 603 | |
| 604 <p> | |
| 605 Private slot to handle the textChanged signal of the directory | |
| 606 picker. | |
| 607 </p> | |
| 608 <dl> | |
| 609 | |
| 610 <dt><i>text</i></dt> | |
| 611 <dd> | |
| 612 (ignored) | |
| 613 </dd> | |
| 614 </dl> | |
| 615 <a NAME="FindFileWidget.on_filterCheckBox_clicked" ID="FindFileWidget.on_filterCheckBox_clicked"></a> | |
| 616 <h4>FindFileWidget.on_filterCheckBox_clicked</h4> | |
| 617 <b>on_filterCheckBox_clicked</b>(<i></i>) | |
| 618 | |
| 619 <p> | |
| 620 Private slot to handle the selection of the file filter check box. | |
| 621 </p> | |
| 622 <a NAME="FindFileWidget.on_filterEdit_textEdited" ID="FindFileWidget.on_filterEdit_textEdited"></a> | |
| 623 <h4>FindFileWidget.on_filterEdit_textEdited</h4> | |
| 624 <b>on_filterEdit_textEdited</b>(<i>text</i>) | |
| 625 | |
| 626 <p> | |
| 627 Private slot to handle the textChanged signal of the file filter edit. | |
| 628 </p> | |
| 629 <dl> | |
| 630 | |
| 631 <dt><i>text</i></dt> | |
| 632 <dd> | |
| 633 (ignored) | |
| 634 </dd> | |
| 635 </dl> | |
| 636 <a NAME="FindFileWidget.on_findList_itemDoubleClicked" ID="FindFileWidget.on_findList_itemDoubleClicked"></a> | |
| 637 <h4>FindFileWidget.on_findList_itemDoubleClicked</h4> | |
| 638 <b>on_findList_itemDoubleClicked</b>(<i>itm, column</i>) | |
| 639 | |
| 640 <p> | |
| 641 Private slot to handle the double click on a file item. | |
| 642 </p> | |
| 643 <p> | |
| 644 It emits a signal depending on the file extension. | |
| 645 </p> | |
| 646 <dl> | |
| 647 | |
| 648 <dt><i>itm</i> (QTreeWidgetItem)</dt> | |
| 649 <dd> | |
| 650 the double clicked tree item | |
| 651 </dd> | |
| 652 <dt><i>column</i> (int)</dt> | |
| 653 <dd> | |
| 654 column that was double clicked (ignored) | |
| 655 </dd> | |
| 656 </dl> | |
| 657 <a NAME="FindFileWidget.on_findtextCombo_editTextChanged" ID="FindFileWidget.on_findtextCombo_editTextChanged"></a> | |
| 658 <h4>FindFileWidget.on_findtextCombo_editTextChanged</h4> | |
| 659 <b>on_findtextCombo_editTextChanged</b>(<i>text</i>) | |
| 660 | |
| 661 <p> | |
| 662 Private slot to handle the editTextChanged signal of the find | |
| 663 text combo. | |
| 664 </p> | |
| 665 <dl> | |
| 666 | |
| 667 <dt><i>text</i></dt> | |
| 668 <dd> | |
| 669 (ignored) | |
| 670 </dd> | |
| 671 </dl> | |
| 672 <a NAME="FindFileWidget.on_openFilesButton_clicked" ID="FindFileWidget.on_openFilesButton_clicked"></a> | |
| 673 <h4>FindFileWidget.on_openFilesButton_clicked</h4> | |
| 674 <b>on_openFilesButton_clicked</b>(<i></i>) | |
| 675 | |
| 676 <p> | |
| 677 Private slot to handle the selection of the 'Open Files' radio button. | |
| 678 </p> | |
| 679 <a NAME="FindFileWidget.on_projectButton_clicked" ID="FindFileWidget.on_projectButton_clicked"></a> | |
| 680 <h4>FindFileWidget.on_projectButton_clicked</h4> | |
| 681 <b>on_projectButton_clicked</b>(<i></i>) | |
| 682 | |
| 683 <p> | |
| 684 Private slot to handle the selection of the 'Project' radio button. | |
| 685 </p> | |
| 686 <a NAME="FindFileWidget.on_replaceButton_clicked" ID="FindFileWidget.on_replaceButton_clicked"></a> | |
| 687 <h4>FindFileWidget.on_replaceButton_clicked</h4> | |
| 688 <b>on_replaceButton_clicked</b>(<i></i>) | |
| 689 | |
| 690 <p> | |
| 691 Private slot to perform the requested replace actions. | |
| 692 </p> | |
| 693 <a NAME="FindFileWidget.on_replacetextCombo_editTextChanged" ID="FindFileWidget.on_replacetextCombo_editTextChanged"></a> | |
| 694 <h4>FindFileWidget.on_replacetextCombo_editTextChanged</h4> | |
| 695 <b>on_replacetextCombo_editTextChanged</b>(<i>text</i>) | |
| 696 | |
| 697 <p> | |
| 698 Private slot to handle the editTextChanged signal of the replace | |
| 699 text combo. | |
| 700 </p> | |
| 701 <dl> | |
| 702 | |
| 703 <dt><i>text</i></dt> | |
| 704 <dd> | |
| 705 (ignored) | |
| 706 </dd> | |
| 707 </dl> | |
| 708 <div align="right"><a href="#top">Up</a></div> | |
| 709 <hr /> | |
| 710 </body></html> |
