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 10479
856476537696
parent 10435
c712d09cc839
child 10493
f795d68d8e09
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.UI.FindFileWidget</h1> 9 <h1>eric7.UI.FindFileWidget</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to search for text in files. 11 Module implementing a dialog to search for text in files.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#FindFileDialog">FindFileDialog</a></td> 22 <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> 23 <td>Class implementing a dialog to search for text in files and replace it with some other text.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
28 <td><a href="#FindFileWidget">FindFileWidget</a></td> 26 <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> 27 <td>Class implementing a widget to search for text in files and replace it with some other text.</td>
30 </tr> 28 </tr>
31 </table> 29 </table>
30
32 <h3>Functions</h3> 31 <h3>Functions</h3>
33
34 <table> 32 <table>
35 <tr><td>None</td></tr> 33 <tr><td>None</td></tr>
36 </table> 34 </table>
35
37 <hr /> 36 <hr />
38 <hr /> 37 <hr />
39 <a NAME="FindFileDialog" ID="FindFileDialog"></a> 38 <a NAME="FindFileDialog" ID="FindFileDialog"></a>
40 <h2>FindFileDialog</h2> 39 <h2>FindFileDialog</h2>
41
42 <p> 40 <p>
43 Class implementing a dialog to search for text in files and replace it 41 Class implementing a dialog to search for text in files and replace it
44 with some other text. 42 with some other text.
45 </p> 43 </p>
46 <p> 44 <p>
49 click onto the respective entry of the list. If the widget is in replace 47 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 48 mode the line below shows the text after replacement. Replacements can
51 be authorized by ticking them on. Pressing the replace button performs 49 be authorized by ticking them on. Pressing the replace button performs
52 all ticked replacement operations. 50 all ticked replacement operations.
53 </p> 51 </p>
52
54 <h3>Signals</h3> 53 <h3>Signals</h3>
55 <dl> 54 <dl>
56 55
57 <dt>designerFile(str)</dt> 56 <dt>designerFile(str)</dt>
58 <dd> 57 <dd>
85 </dd> 84 </dd>
86 </dl> 85 </dl>
87 <h3>Derived from</h3> 86 <h3>Derived from</h3>
88 QDialog 87 QDialog
89 <h3>Class Attributes</h3> 88 <h3>Class Attributes</h3>
90
91 <table> 89 <table>
92 <tr><td>None</td></tr> 90 <tr><td>None</td></tr>
93 </table> 91 </table>
92
94 <h3>Class Methods</h3> 93 <h3>Class Methods</h3>
95
96 <table> 94 <table>
97 <tr><td>None</td></tr> 95 <tr><td>None</td></tr>
98 </table> 96 </table>
97
99 <h3>Methods</h3> 98 <h3>Methods</h3>
100 99 <table>
101 <table>
102
103 <tr> 100 <tr>
104 <td><a href="#FindFileDialog.__init__">FindFileDialog</a></td> 101 <td><a href="#FindFileDialog.__init__">FindFileDialog</a></td>
105 <td>Constructor</td> 102 <td>Constructor</td>
106 </tr> 103 </tr>
107 <tr> 104 <tr>
111 <tr> 108 <tr>
112 <td><a href="#FindFileDialog.populateFileCategories">populateFileCategories</a></td> 109 <td><a href="#FindFileDialog.populateFileCategories">populateFileCategories</a></td>
113 <td>Public method to populate the search file categories list.</td> 110 <td>Public method to populate the search file categories list.</td>
114 </tr> 111 </tr>
115 </table> 112 </table>
113
116 <h3>Static Methods</h3> 114 <h3>Static Methods</h3>
117
118 <table> 115 <table>
119 <tr><td>None</td></tr> 116 <tr><td>None</td></tr>
120 </table> 117 </table>
118
121 119
122 <a NAME="FindFileDialog.__init__" ID="FindFileDialog.__init__"></a> 120 <a NAME="FindFileDialog.__init__" ID="FindFileDialog.__init__"></a>
123 <h4>FindFileDialog (Constructor)</h4> 121 <h4>FindFileDialog (Constructor)</h4>
124 <b>FindFileDialog</b>(<i>project, parent=None</i>) 122 <b>FindFileDialog</b>(<i>project, parent=None</i>)
125
126 <p> 123 <p>
127 Constructor 124 Constructor
128 </p> 125 </p>
126
129 <dl> 127 <dl>
130 128
131 <dt><i>project</i> (Project)</dt> 129 <dt><i>project</i> (Project)</dt>
132 <dd> 130 <dd>
133 reference to the project object 131 reference to the project object
138 </dd> 136 </dd>
139 </dl> 137 </dl>
140 <a NAME="FindFileDialog.activate" ID="FindFileDialog.activate"></a> 138 <a NAME="FindFileDialog.activate" ID="FindFileDialog.activate"></a>
141 <h4>FindFileDialog.activate</h4> 139 <h4>FindFileDialog.activate</h4>
142 <b>activate</b>(<i>replaceMode=False, txt="", searchDir="", openFiles=False</i>) 140 <b>activate</b>(<i>replaceMode=False, txt="", searchDir="", openFiles=False</i>)
143
144 <p> 141 <p>
145 Public method to activate the dialog with a given mode, a text 142 Public method to activate the dialog with a given mode, a text
146 to search for and some search parameters. 143 to search for and some search parameters.
147 </p> 144 </p>
145
148 <dl> 146 <dl>
149 147
150 <dt><i>replaceMode</i> (bool (optional))</dt> 148 <dt><i>replaceMode</i> (bool (optional))</dt>
151 <dd> 149 <dd>
152 flag indicating replacement mode (defaults to False) 150 flag indicating replacement mode (defaults to False)
166 </dd> 164 </dd>
167 </dl> 165 </dl>
168 <a NAME="FindFileDialog.populateFileCategories" ID="FindFileDialog.populateFileCategories"></a> 166 <a NAME="FindFileDialog.populateFileCategories" ID="FindFileDialog.populateFileCategories"></a>
169 <h4>FindFileDialog.populateFileCategories</h4> 167 <h4>FindFileDialog.populateFileCategories</h4>
170 <b>populateFileCategories</b>(<i></i>) 168 <b>populateFileCategories</b>(<i></i>)
171
172 <p> 169 <p>
173 Public method to populate the search file categories list. 170 Public method to populate the search file categories list.
174 </p> 171 </p>
172
175 <div align="right"><a href="#top">Up</a></div> 173 <div align="right"><a href="#top">Up</a></div>
176 <hr /> 174 <hr />
177 <hr /> 175 <hr />
178 <a NAME="FindFileWidget" ID="FindFileWidget"></a> 176 <a NAME="FindFileWidget" ID="FindFileWidget"></a>
179 <h2>FindFileWidget</h2> 177 <h2>FindFileWidget</h2>
180
181 <p> 178 <p>
182 Class implementing a widget to search for text in files and replace it 179 Class implementing a widget to search for text in files and replace it
183 with some other text. 180 with some other text.
184 </p> 181 </p>
185 <p> 182 <p>
188 click onto the respective entry of the list. If the widget is in replace 185 click onto the respective entry of the list. If the widget is in replace
189 mode the line below shows the text after replacement. Replacements can 186 mode the line below shows the text after replacement. Replacements can
190 be authorized by ticking them on. Pressing the replace button performs 187 be authorized by ticking them on. Pressing the replace button performs
191 all ticked replacement operations. 188 all ticked replacement operations.
192 </p> 189 </p>
190
193 <h3>Signals</h3> 191 <h3>Signals</h3>
194 <dl> 192 <dl>
195 193
196 <dt>designerFile(str)</dt> 194 <dt>designerFile(str)</dt>
197 <dd> 195 <dd>
224 </dd> 222 </dd>
225 </dl> 223 </dl>
226 <h3>Derived from</h3> 224 <h3>Derived from</h3>
227 QWidget, Ui_FindFileWidget 225 QWidget, Ui_FindFileWidget
228 <h3>Class Attributes</h3> 226 <h3>Class Attributes</h3>
229 227 <table>
230 <table> 228 <tr><td>endRole</td></tr>
231 <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> 229 <tr><td>lineRole</td></tr>
232 </table> 230 <tr><td>md5Role</td></tr>
231 <tr><td>replaceRole</td></tr>
232 <tr><td>startRole</td></tr>
233 </table>
234
233 <h3>Class Methods</h3> 235 <h3>Class Methods</h3>
234
235 <table> 236 <table>
236 <tr><td>None</td></tr> 237 <tr><td>None</td></tr>
237 </table> 238 </table>
239
238 <h3>Methods</h3> 240 <h3>Methods</h3>
239 241 <table>
240 <table>
241
242 <tr> 242 <tr>
243 <td><a href="#FindFileWidget.__init__">FindFileWidget</a></td> 243 <td><a href="#FindFileWidget.__init__">FindFileWidget</a></td>
244 <td>Constructor</td> 244 <td>Constructor</td>
245 </tr> 245 </tr>
246 <tr> 246 <tr>
366 <tr> 366 <tr>
367 <td><a href="#FindFileWidget.populateFileCategories">populateFileCategories</a></td> 367 <td><a href="#FindFileWidget.populateFileCategories">populateFileCategories</a></td>
368 <td>Public method to populate the search file categories list.</td> 368 <td>Public method to populate the search file categories list.</td>
369 </tr> 369 </tr>
370 </table> 370 </table>
371
371 <h3>Static Methods</h3> 372 <h3>Static Methods</h3>
372
373 <table> 373 <table>
374 <tr><td>None</td></tr> 374 <tr><td>None</td></tr>
375 </table> 375 </table>
376
376 377
377 <a NAME="FindFileWidget.__init__" ID="FindFileWidget.__init__"></a> 378 <a NAME="FindFileWidget.__init__" ID="FindFileWidget.__init__"></a>
378 <h4>FindFileWidget (Constructor)</h4> 379 <h4>FindFileWidget (Constructor)</h4>
379 <b>FindFileWidget</b>(<i>project, parent=None</i>) 380 <b>FindFileWidget</b>(<i>project, parent=None</i>)
380
381 <p> 381 <p>
382 Constructor 382 Constructor
383 </p> 383 </p>
384
384 <dl> 385 <dl>
385 386
386 <dt><i>project</i> (Project)</dt> 387 <dt><i>project</i> (Project)</dt>
387 <dd> 388 <dd>
388 reference to the project object 389 reference to the project object
393 </dd> 394 </dd>
394 </dl> 395 </dl>
395 <a NAME="FindFileWidget.__clearResults" ID="FindFileWidget.__clearResults"></a> 396 <a NAME="FindFileWidget.__clearResults" ID="FindFileWidget.__clearResults"></a>
396 <h4>FindFileWidget.__clearResults</h4> 397 <h4>FindFileWidget.__clearResults</h4>
397 <b>__clearResults</b>(<i></i>) 398 <b>__clearResults</b>(<i></i>)
398
399 <p> 399 <p>
400 Private slot to clear the current search results. 400 Private slot to clear the current search results.
401 </p> 401 </p>
402
402 <a NAME="FindFileWidget.__contextMenuRequested" ID="FindFileWidget.__contextMenuRequested"></a> 403 <a NAME="FindFileWidget.__contextMenuRequested" ID="FindFileWidget.__contextMenuRequested"></a>
403 <h4>FindFileWidget.__contextMenuRequested</h4> 404 <h4>FindFileWidget.__contextMenuRequested</h4>
404 <b>__contextMenuRequested</b>(<i>pos</i>) 405 <b>__contextMenuRequested</b>(<i>pos</i>)
405
406 <p> 406 <p>
407 Private slot to handle the context menu request. 407 Private slot to handle the context menu request.
408 </p> 408 </p>
409
409 <dl> 410 <dl>
410 411
411 <dt><i>pos</i> (QPoint)</dt> 412 <dt><i>pos</i> (QPoint)</dt>
412 <dd> 413 <dd>
413 position the context menu shall be shown 414 position the context menu shall be shown
414 </dd> 415 </dd>
415 </dl> 416 </dl>
416 <a NAME="FindFileWidget.__copyToClipboard" ID="FindFileWidget.__copyToClipboard"></a> 417 <a NAME="FindFileWidget.__copyToClipboard" ID="FindFileWidget.__copyToClipboard"></a>
417 <h4>FindFileWidget.__copyToClipboard</h4> 418 <h4>FindFileWidget.__copyToClipboard</h4>
418 <b>__copyToClipboard</b>(<i></i>) 419 <b>__copyToClipboard</b>(<i></i>)
419
420 <p> 420 <p>
421 Private slot to copy the path of an entry to the clipboard. 421 Private slot to copy the path of an entry to the clipboard.
422 </p> 422 </p>
423
423 <a NAME="FindFileWidget.__createItem" ID="FindFileWidget.__createItem"></a> 424 <a NAME="FindFileWidget.__createItem" ID="FindFileWidget.__createItem"></a>
424 <h4>FindFileWidget.__createItem</h4> 425 <h4>FindFileWidget.__createItem</h4>
425 <b>__createItem</b>(<i>file, line, text, start, end, replTxt="", md5=""</i>) 426 <b>__createItem</b>(<i>file, line, text, start, end, replTxt="", md5=""</i>)
426
427 <p> 427 <p>
428 Private method to create an entry in the file list. 428 Private method to create an entry in the file list.
429 </p> 429 </p>
430
430 <dl> 431 <dl>
431 432
432 <dt><i>file</i> (str)</dt> 433 <dt><i>file</i> (str)</dt>
433 <dd> 434 <dd>
434 filename of file 435 filename of file
459 </dd> 460 </dd>
460 </dl> 461 </dl>
461 <a NAME="FindFileWidget.__deselectAll" ID="FindFileWidget.__deselectAll"></a> 462 <a NAME="FindFileWidget.__deselectAll" ID="FindFileWidget.__deselectAll"></a>
462 <h4>FindFileWidget.__deselectAll</h4> 463 <h4>FindFileWidget.__deselectAll</h4>
463 <b>__deselectAll</b>(<i></i>) 464 <b>__deselectAll</b>(<i></i>)
464
465 <p> 465 <p>
466 Private slot to deselect all entries. 466 Private slot to deselect all entries.
467 </p> 467 </p>
468
468 <a NAME="FindFileWidget.__doSearch" ID="FindFileWidget.__doSearch"></a> 469 <a NAME="FindFileWidget.__doSearch" ID="FindFileWidget.__doSearch"></a>
469 <h4>FindFileWidget.__doSearch</h4> 470 <h4>FindFileWidget.__doSearch</h4>
470 <b>__doSearch</b>(<i></i>) 471 <b>__doSearch</b>(<i></i>)
471
472 <p> 472 <p>
473 Private slot to handle the find button being pressed. 473 Private slot to handle the find button being pressed.
474 </p> 474 </p>
475
475 <a NAME="FindFileWidget.__enableFindButton" ID="FindFileWidget.__enableFindButton"></a> 476 <a NAME="FindFileWidget.__enableFindButton" ID="FindFileWidget.__enableFindButton"></a>
476 <h4>FindFileWidget.__enableFindButton</h4> 477 <h4>FindFileWidget.__enableFindButton</h4>
477 <b>__enableFindButton</b>(<i></i>) 478 <b>__enableFindButton</b>(<i></i>)
478
479 <p> 479 <p>
480 Private slot called to enable the find button. 480 Private slot called to enable the find button.
481 </p> 481 </p>
482
482 <a NAME="FindFileWidget.__getFileList" ID="FindFileWidget.__getFileList"></a> 483 <a NAME="FindFileWidget.__getFileList" ID="FindFileWidget.__getFileList"></a>
483 <h4>FindFileWidget.__getFileList</h4> 484 <h4>FindFileWidget.__getFileList</h4>
484 <b>__getFileList</b>(<i>path, filterRe, excludeHiddenDirs=False, excludeHiddenFiles=False</i>) 485 <b>__getFileList</b>(<i>path, filterRe, excludeHiddenDirs=False, excludeHiddenFiles=False</i>)
485
486 <p> 486 <p>
487 Private method to get a list of files to search. 487 Private method to get a list of files to search.
488 </p> 488 </p>
489
489 <dl> 490 <dl>
490 491
491 <dt><i>path</i> (str)</dt> 492 <dt><i>path</i> (str)</dt>
492 <dd> 493 <dd>
493 the root directory to search in 494 the root directory to search in
519 </dd> 520 </dd>
520 </dl> 521 </dl>
521 <a NAME="FindFileWidget.__openFile" ID="FindFileWidget.__openFile"></a> 522 <a NAME="FindFileWidget.__openFile" ID="FindFileWidget.__openFile"></a>
522 <h4>FindFileWidget.__openFile</h4> 523 <h4>FindFileWidget.__openFile</h4>
523 <b>__openFile</b>(<i></i>) 524 <b>__openFile</b>(<i></i>)
524
525 <p> 525 <p>
526 Private slot to open the currently selected entry. 526 Private slot to open the currently selected entry.
527 </p> 527 </p>
528
528 <a NAME="FindFileWidget.__projectClosed" ID="FindFileWidget.__projectClosed"></a> 529 <a NAME="FindFileWidget.__projectClosed" ID="FindFileWidget.__projectClosed"></a>
529 <h4>FindFileWidget.__projectClosed</h4> 530 <h4>FindFileWidget.__projectClosed</h4>
530 <b>__projectClosed</b>(<i></i>) 531 <b>__projectClosed</b>(<i></i>)
531
532 <p> 532 <p>
533 Private slot to react to the closing of a project. 533 Private slot to react to the closing of a project.
534 </p> 534 </p>
535
535 <a NAME="FindFileWidget.__projectOpened" ID="FindFileWidget.__projectOpened"></a> 536 <a NAME="FindFileWidget.__projectOpened" ID="FindFileWidget.__projectOpened"></a>
536 <h4>FindFileWidget.__projectOpened</h4> 537 <h4>FindFileWidget.__projectOpened</h4>
537 <b>__projectOpened</b>(<i></i>) 538 <b>__projectOpened</b>(<i></i>)
538
539 <p> 539 <p>
540 Private slot to react to the opening of a project. 540 Private slot to react to the opening of a project.
541 </p> 541 </p>
542
542 <a NAME="FindFileWidget.__selectAll" ID="FindFileWidget.__selectAll"></a> 543 <a NAME="FindFileWidget.__selectAll" ID="FindFileWidget.__selectAll"></a>
543 <h4>FindFileWidget.__selectAll</h4> 544 <h4>FindFileWidget.__selectAll</h4>
544 <b>__selectAll</b>(<i>check=True</i>) 545 <b>__selectAll</b>(<i>check=True</i>)
545
546 <p> 546 <p>
547 Private slot to select all entries. 547 Private slot to select all entries.
548 </p> 548 </p>
549
549 <dl> 550 <dl>
550 551
551 <dt><i>check</i> (bool (optional))</dt> 552 <dt><i>check</i> (bool (optional))</dt>
552 <dd> 553 <dd>
553 flag indicating the desired check state (defaults to True) 554 flag indicating the desired check state (defaults to True)
554 </dd> 555 </dd>
555 </dl> 556 </dl>
556 <a NAME="FindFileWidget.__setOpenFiles" ID="FindFileWidget.__setOpenFiles"></a> 557 <a NAME="FindFileWidget.__setOpenFiles" ID="FindFileWidget.__setOpenFiles"></a>
557 <h4>FindFileWidget.__setOpenFiles</h4> 558 <h4>FindFileWidget.__setOpenFiles</h4>
558 <b>__setOpenFiles</b>(<i></i>) 559 <b>__setOpenFiles</b>(<i></i>)
559
560 <p> 560 <p>
561 Private slot to set the mode to search in open files. 561 Private slot to set the mode to search in open files.
562 </p> 562 </p>
563
563 <a NAME="FindFileWidget.__setSearchDirectory" ID="FindFileWidget.__setSearchDirectory"></a> 564 <a NAME="FindFileWidget.__setSearchDirectory" ID="FindFileWidget.__setSearchDirectory"></a>
564 <h4>FindFileWidget.__setSearchDirectory</h4> 565 <h4>FindFileWidget.__setSearchDirectory</h4>
565 <b>__setSearchDirectory</b>(<i>searchDir</i>) 566 <b>__setSearchDirectory</b>(<i>searchDir</i>)
566
567 <p> 567 <p>
568 Private slot to set the name of the directory to search in. 568 Private slot to set the name of the directory to search in.
569 </p> 569 </p>
570
570 <dl> 571 <dl>
571 572
572 <dt><i>searchDir</i> (str)</dt> 573 <dt><i>searchDir</i> (str)</dt>
573 <dd> 574 <dd>
574 name of the directory to search in 575 name of the directory to search in
575 </dd> 576 </dd>
576 </dl> 577 </dl>
577 <a NAME="FindFileWidget.__stopSearch" ID="FindFileWidget.__stopSearch"></a> 578 <a NAME="FindFileWidget.__stopSearch" ID="FindFileWidget.__stopSearch"></a>
578 <h4>FindFileWidget.__stopSearch</h4> 579 <h4>FindFileWidget.__stopSearch</h4>
579 <b>__stopSearch</b>(<i></i>) 580 <b>__stopSearch</b>(<i></i>)
580
581 <p> 581 <p>
582 Private slot to handle the stop button being pressed. 582 Private slot to handle the stop button being pressed.
583 </p> 583 </p>
584
584 <a NAME="FindFileWidget.__stripEol" ID="FindFileWidget.__stripEol"></a> 585 <a NAME="FindFileWidget.__stripEol" ID="FindFileWidget.__stripEol"></a>
585 <h4>FindFileWidget.__stripEol</h4> 586 <h4>FindFileWidget.__stripEol</h4>
586 <b>__stripEol</b>(<i>txt</i>) 587 <b>__stripEol</b>(<i>txt</i>)
587
588 <p> 588 <p>
589 Private method to strip the eol part. 589 Private method to strip the eol part.
590 </p> 590 </p>
591
591 <dl> 592 <dl>
592 593
593 <dt><i>txt</i> (str)</dt> 594 <dt><i>txt</i> (str)</dt>
594 <dd> 595 <dd>
595 line of text that should be treated 596 line of text that should be treated
608 </dd> 609 </dd>
609 </dl> 610 </dl>
610 <a NAME="FindFileWidget.__toggleReplaceMode" ID="FindFileWidget.__toggleReplaceMode"></a> 611 <a NAME="FindFileWidget.__toggleReplaceMode" ID="FindFileWidget.__toggleReplaceMode"></a>
611 <h4>FindFileWidget.__toggleReplaceMode</h4> 612 <h4>FindFileWidget.__toggleReplaceMode</h4>
612 <b>__toggleReplaceMode</b>(<i></i>) 613 <b>__toggleReplaceMode</b>(<i></i>)
613
614 <p> 614 <p>
615 Private slot to toggle the dialog mode. 615 Private slot to toggle the dialog mode.
616 </p> 616 </p>
617
617 <a NAME="FindFileWidget.activate" ID="FindFileWidget.activate"></a> 618 <a NAME="FindFileWidget.activate" ID="FindFileWidget.activate"></a>
618 <h4>FindFileWidget.activate</h4> 619 <h4>FindFileWidget.activate</h4>
619 <b>activate</b>(<i>replaceMode=False, txt="", searchDir="", openFiles=False</i>) 620 <b>activate</b>(<i>replaceMode=False, txt="", searchDir="", openFiles=False</i>)
620
621 <p> 621 <p>
622 Public method to activate the widget with a given mode, a text 622 Public method to activate the widget with a given mode, a text
623 to search for and some search parameters. 623 to search for and some search parameters.
624 </p> 624 </p>
625
625 <dl> 626 <dl>
626 627
627 <dt><i>replaceMode</i> (bool (optional))</dt> 628 <dt><i>replaceMode</i> (bool (optional))</dt>
628 <dd> 629 <dd>
629 flag indicating replacement mode (defaults to False) 630 flag indicating replacement mode (defaults to False)
643 </dd> 644 </dd>
644 </dl> 645 </dl>
645 <a NAME="FindFileWidget.on_dirButton_clicked" ID="FindFileWidget.on_dirButton_clicked"></a> 646 <a NAME="FindFileWidget.on_dirButton_clicked" ID="FindFileWidget.on_dirButton_clicked"></a>
646 <h4>FindFileWidget.on_dirButton_clicked</h4> 647 <h4>FindFileWidget.on_dirButton_clicked</h4>
647 <b>on_dirButton_clicked</b>(<i></i>) 648 <b>on_dirButton_clicked</b>(<i></i>)
648
649 <p> 649 <p>
650 Private slot to handle the selection of the 'Directory' radio button. 650 Private slot to handle the selection of the 'Directory' radio button.
651 </p> 651 </p>
652
652 <a NAME="FindFileWidget.on_dirPicker_editTextChanged" ID="FindFileWidget.on_dirPicker_editTextChanged"></a> 653 <a NAME="FindFileWidget.on_dirPicker_editTextChanged" ID="FindFileWidget.on_dirPicker_editTextChanged"></a>
653 <h4>FindFileWidget.on_dirPicker_editTextChanged</h4> 654 <h4>FindFileWidget.on_dirPicker_editTextChanged</h4>
654 <b>on_dirPicker_editTextChanged</b>(<i>text</i>) 655 <b>on_dirPicker_editTextChanged</b>(<i>text</i>)
655
656 <p> 656 <p>
657 Private slot to handle the textChanged signal of the directory 657 Private slot to handle the textChanged signal of the directory
658 picker. 658 picker.
659 </p> 659 </p>
660
660 <dl> 661 <dl>
661 662
662 <dt><i>text</i> (str)</dt> 663 <dt><i>text</i> (str)</dt>
663 <dd> 664 <dd>
664 (ignored) 665 (ignored)
665 </dd> 666 </dd>
666 </dl> 667 </dl>
667 <a NAME="FindFileWidget.on_escapeToolButton_toggled" ID="FindFileWidget.on_escapeToolButton_toggled"></a> 668 <a NAME="FindFileWidget.on_escapeToolButton_toggled" ID="FindFileWidget.on_escapeToolButton_toggled"></a>
668 <h4>FindFileWidget.on_escapeToolButton_toggled</h4> 669 <h4>FindFileWidget.on_escapeToolButton_toggled</h4>
669 <b>on_escapeToolButton_toggled</b>(<i>checked</i>) 670 <b>on_escapeToolButton_toggled</b>(<i>checked</i>)
670
671 <p> 671 <p>
672 Private slot handling a change of the escape selector. 672 Private slot handling a change of the escape selector.
673 </p> 673 </p>
674
674 <dl> 675 <dl>
675 676
676 <dt><i>checked</i> (bool)</dt> 677 <dt><i>checked</i> (bool)</dt>
677 <dd> 678 <dd>
678 state of the escape selector 679 state of the escape selector
679 </dd> 680 </dd>
680 </dl> 681 </dl>
681 <a NAME="FindFileWidget.on_filterCheckBox_clicked" ID="FindFileWidget.on_filterCheckBox_clicked"></a> 682 <a NAME="FindFileWidget.on_filterCheckBox_clicked" ID="FindFileWidget.on_filterCheckBox_clicked"></a>
682 <h4>FindFileWidget.on_filterCheckBox_clicked</h4> 683 <h4>FindFileWidget.on_filterCheckBox_clicked</h4>
683 <b>on_filterCheckBox_clicked</b>(<i></i>) 684 <b>on_filterCheckBox_clicked</b>(<i></i>)
684
685 <p> 685 <p>
686 Private slot to handle the selection of the file filter check box. 686 Private slot to handle the selection of the file filter check box.
687 </p> 687 </p>
688
688 <a NAME="FindFileWidget.on_filterEdit_textEdited" ID="FindFileWidget.on_filterEdit_textEdited"></a> 689 <a NAME="FindFileWidget.on_filterEdit_textEdited" ID="FindFileWidget.on_filterEdit_textEdited"></a>
689 <h4>FindFileWidget.on_filterEdit_textEdited</h4> 690 <h4>FindFileWidget.on_filterEdit_textEdited</h4>
690 <b>on_filterEdit_textEdited</b>(<i>text</i>) 691 <b>on_filterEdit_textEdited</b>(<i>text</i>)
691
692 <p> 692 <p>
693 Private slot to handle the textChanged signal of the file filter edit. 693 Private slot to handle the textChanged signal of the file filter edit.
694 </p> 694 </p>
695
695 <dl> 696 <dl>
696 697
697 <dt><i>text</i> (str)</dt> 698 <dt><i>text</i> (str)</dt>
698 <dd> 699 <dd>
699 (ignored) 700 (ignored)
700 </dd> 701 </dd>
701 </dl> 702 </dl>
702 <a NAME="FindFileWidget.on_findList_itemDoubleClicked" ID="FindFileWidget.on_findList_itemDoubleClicked"></a> 703 <a NAME="FindFileWidget.on_findList_itemDoubleClicked" ID="FindFileWidget.on_findList_itemDoubleClicked"></a>
703 <h4>FindFileWidget.on_findList_itemDoubleClicked</h4> 704 <h4>FindFileWidget.on_findList_itemDoubleClicked</h4>
704 <b>on_findList_itemDoubleClicked</b>(<i>itm, column</i>) 705 <b>on_findList_itemDoubleClicked</b>(<i>itm, column</i>)
705
706 <p> 706 <p>
707 Private slot to handle the double click on a file item. 707 Private slot to handle the double click on a file item.
708 </p> 708 </p>
709 <p> 709 <p>
710 It emits a signal depending on the file extension. 710 It emits a signal depending on the file extension.
711 </p> 711 </p>
712
712 <dl> 713 <dl>
713 714
714 <dt><i>itm</i> (QTreeWidgetItem)</dt> 715 <dt><i>itm</i> (QTreeWidgetItem)</dt>
715 <dd> 716 <dd>
716 the double clicked tree item 717 the double clicked tree item
721 </dd> 722 </dd>
722 </dl> 723 </dl>
723 <a NAME="FindFileWidget.on_findtextCombo_editTextChanged" ID="FindFileWidget.on_findtextCombo_editTextChanged"></a> 724 <a NAME="FindFileWidget.on_findtextCombo_editTextChanged" ID="FindFileWidget.on_findtextCombo_editTextChanged"></a>
724 <h4>FindFileWidget.on_findtextCombo_editTextChanged</h4> 725 <h4>FindFileWidget.on_findtextCombo_editTextChanged</h4>
725 <b>on_findtextCombo_editTextChanged</b>(<i>text</i>) 726 <b>on_findtextCombo_editTextChanged</b>(<i>text</i>)
726
727 <p> 727 <p>
728 Private slot to handle the editTextChanged signal of the find 728 Private slot to handle the editTextChanged signal of the find
729 text combo. 729 text combo.
730 </p> 730 </p>
731
731 <dl> 732 <dl>
732 733
733 <dt><i>text</i> (str)</dt> 734 <dt><i>text</i> (str)</dt>
734 <dd> 735 <dd>
735 (ignored) 736 (ignored)
736 </dd> 737 </dd>
737 </dl> 738 </dl>
738 <a NAME="FindFileWidget.on_openFilesButton_clicked" ID="FindFileWidget.on_openFilesButton_clicked"></a> 739 <a NAME="FindFileWidget.on_openFilesButton_clicked" ID="FindFileWidget.on_openFilesButton_clicked"></a>
739 <h4>FindFileWidget.on_openFilesButton_clicked</h4> 740 <h4>FindFileWidget.on_openFilesButton_clicked</h4>
740 <b>on_openFilesButton_clicked</b>(<i></i>) 741 <b>on_openFilesButton_clicked</b>(<i></i>)
741
742 <p> 742 <p>
743 Private slot to handle the selection of the 'Open Files' radio button. 743 Private slot to handle the selection of the 'Open Files' radio button.
744 </p> 744 </p>
745
745 <a NAME="FindFileWidget.on_projectButton_clicked" ID="FindFileWidget.on_projectButton_clicked"></a> 746 <a NAME="FindFileWidget.on_projectButton_clicked" ID="FindFileWidget.on_projectButton_clicked"></a>
746 <h4>FindFileWidget.on_projectButton_clicked</h4> 747 <h4>FindFileWidget.on_projectButton_clicked</h4>
747 <b>on_projectButton_clicked</b>(<i></i>) 748 <b>on_projectButton_clicked</b>(<i></i>)
748
749 <p> 749 <p>
750 Private slot to handle the selection of the 'Project' radio button. 750 Private slot to handle the selection of the 'Project' radio button.
751 </p> 751 </p>
752
752 <a NAME="FindFileWidget.on_regexpToolButton_toggled" ID="FindFileWidget.on_regexpToolButton_toggled"></a> 753 <a NAME="FindFileWidget.on_regexpToolButton_toggled" ID="FindFileWidget.on_regexpToolButton_toggled"></a>
753 <h4>FindFileWidget.on_regexpToolButton_toggled</h4> 754 <h4>FindFileWidget.on_regexpToolButton_toggled</h4>
754 <b>on_regexpToolButton_toggled</b>(<i>checked</i>) 755 <b>on_regexpToolButton_toggled</b>(<i>checked</i>)
755
756 <p> 756 <p>
757 Private slot handling a change of the regexp selector. 757 Private slot handling a change of the regexp selector.
758 </p> 758 </p>
759
759 <dl> 760 <dl>
760 761
761 <dt><i>checked</i> (bool)</dt> 762 <dt><i>checked</i> (bool)</dt>
762 <dd> 763 <dd>
763 state of the regexp selector 764 state of the regexp selector
764 </dd> 765 </dd>
765 </dl> 766 </dl>
766 <a NAME="FindFileWidget.on_replaceButton_clicked" ID="FindFileWidget.on_replaceButton_clicked"></a> 767 <a NAME="FindFileWidget.on_replaceButton_clicked" ID="FindFileWidget.on_replaceButton_clicked"></a>
767 <h4>FindFileWidget.on_replaceButton_clicked</h4> 768 <h4>FindFileWidget.on_replaceButton_clicked</h4>
768 <b>on_replaceButton_clicked</b>(<i></i>) 769 <b>on_replaceButton_clicked</b>(<i></i>)
769
770 <p> 770 <p>
771 Private slot to perform the requested replace actions. 771 Private slot to perform the requested replace actions.
772 </p> 772 </p>
773
773 <a NAME="FindFileWidget.on_replacetextCombo_editTextChanged" ID="FindFileWidget.on_replacetextCombo_editTextChanged"></a> 774 <a NAME="FindFileWidget.on_replacetextCombo_editTextChanged" ID="FindFileWidget.on_replacetextCombo_editTextChanged"></a>
774 <h4>FindFileWidget.on_replacetextCombo_editTextChanged</h4> 775 <h4>FindFileWidget.on_replacetextCombo_editTextChanged</h4>
775 <b>on_replacetextCombo_editTextChanged</b>(<i>text</i>) 776 <b>on_replacetextCombo_editTextChanged</b>(<i>text</i>)
776
777 <p> 777 <p>
778 Private slot to handle the editTextChanged signal of the replace 778 Private slot to handle the editTextChanged signal of the replace
779 text combo. 779 text combo.
780 </p> 780 </p>
781
781 <dl> 782 <dl>
782 783
783 <dt><i>text</i> (str)</dt> 784 <dt><i>text</i> (str)</dt>
784 <dd> 785 <dd>
785 (ignored) 786 (ignored)
786 </dd> 787 </dd>
787 </dl> 788 </dl>
788 <a NAME="FindFileWidget.populateFileCategories" ID="FindFileWidget.populateFileCategories"></a> 789 <a NAME="FindFileWidget.populateFileCategories" ID="FindFileWidget.populateFileCategories"></a>
789 <h4>FindFileWidget.populateFileCategories</h4> 790 <h4>FindFileWidget.populateFileCategories</h4>
790 <b>populateFileCategories</b>(<i></i>) 791 <b>populateFileCategories</b>(<i></i>)
791
792 <p> 792 <p>
793 Public method to populate the search file categories list. 793 Public method to populate the search file categories list.
794 </p> 794 </p>
795
795 <div align="right"><a href="#top">Up</a></div> 796 <div align="right"><a href="#top">Up</a></div>
796 <hr /> 797 <hr />
797 </body></html> 798 </body></html>

Mercurial Repository: eric

eric ide

mercurial