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.PdfViewer.PdfSearchWidget</h1> |
9 <h1>eric7.PdfViewer.PdfSearchWidget</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing a Search widget. |
11 Module implementing a Search widget. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
15 <table> |
16 <table> |
16 <tr><td>None</td></tr> |
17 <tr><td>None</td></tr> |
17 </table> |
18 </table> |
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
20 <table> |
21 <table> |
|
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#PdfSearchResultsWidget">PdfSearchResultsWidget</a></td> |
22 <td><a href="#PdfSearchResultsWidget">PdfSearchResultsWidget</a></td> |
25 <td>Class implementing a widget to show the search results.</td> |
23 <td>Class implementing a widget to show the search results.</td> |
26 </tr> |
24 </tr> |
27 <tr> |
25 <tr> |
28 <td><a href="#PdfSearchWidget">PdfSearchWidget</a></td> |
26 <td><a href="#PdfSearchWidget">PdfSearchWidget</a></td> |
29 <td>Class implementing a Search widget.</td> |
27 <td>Class implementing a Search widget.</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="PdfSearchResultsWidget" ID="PdfSearchResultsWidget"></a> |
38 <a NAME="PdfSearchResultsWidget" ID="PdfSearchResultsWidget"></a> |
40 <h2>PdfSearchResultsWidget</h2> |
39 <h2>PdfSearchResultsWidget</h2> |
41 |
|
42 <p> |
40 <p> |
43 Class implementing a widget to show the search results. |
41 Class implementing a widget to show the search results. |
44 </p> |
42 </p> |
|
43 |
45 <h3>Signals</h3> |
44 <h3>Signals</h3> |
46 <dl> |
45 <dl> |
47 |
46 |
48 <dt>rowCountChanged()</dt> |
47 <dt>rowCountChanged()</dt> |
49 <dd> |
48 <dd> |
137 <tr> |
134 <tr> |
138 <td><a href="#PdfSearchResultsWidget.setSearchString">setSearchString</a></td> |
135 <td><a href="#PdfSearchResultsWidget.setSearchString">setSearchString</a></td> |
139 <td>Public method to set the search string.</td> |
136 <td>Public method to set the search string.</td> |
140 </tr> |
137 </tr> |
141 </table> |
138 </table> |
|
139 |
142 <h3>Static Methods</h3> |
140 <h3>Static Methods</h3> |
143 |
141 <table> |
144 <table> |
142 <tr><td>None</td></tr> |
145 <tr><td>None</td></tr> |
143 </table> |
146 </table> |
144 |
147 |
145 |
148 <a NAME="PdfSearchResultsWidget.__init__" ID="PdfSearchResultsWidget.__init__"></a> |
146 <a NAME="PdfSearchResultsWidget.__init__" ID="PdfSearchResultsWidget.__init__"></a> |
149 <h4>PdfSearchResultsWidget (Constructor)</h4> |
147 <h4>PdfSearchResultsWidget (Constructor)</h4> |
150 <b>PdfSearchResultsWidget</b>(<i>parent=None</i>) |
148 <b>PdfSearchResultsWidget</b>(<i>parent=None</i>) |
151 |
|
152 <p> |
149 <p> |
153 Constructor |
150 Constructor |
154 </p> |
151 </p> |
|
152 |
155 <dl> |
153 <dl> |
156 |
154 |
157 <dt><i>parent</i> (QWidget (optional))</dt> |
155 <dt><i>parent</i> (QWidget (optional))</dt> |
158 <dd> |
156 <dd> |
159 reference to the parent widget (defaults to None) |
157 reference to the parent widget (defaults to None) |
160 </dd> |
158 </dd> |
161 </dl> |
159 </dl> |
162 <a NAME="PdfSearchResultsWidget.__clear" ID="PdfSearchResultsWidget.__clear"></a> |
160 <a NAME="PdfSearchResultsWidget.__clear" ID="PdfSearchResultsWidget.__clear"></a> |
163 <h4>PdfSearchResultsWidget.__clear</h4> |
161 <h4>PdfSearchResultsWidget.__clear</h4> |
164 <b>__clear</b>(<i></i>) |
162 <b>__clear</b>(<i></i>) |
165 |
|
166 <p> |
163 <p> |
167 Private slot to clear the list of search results. |
164 Private slot to clear the list of search results. |
168 </p> |
165 </p> |
|
166 |
169 <a NAME="PdfSearchResultsWidget.__handleCurrentItemChanged" ID="PdfSearchResultsWidget.__handleCurrentItemChanged"></a> |
167 <a NAME="PdfSearchResultsWidget.__handleCurrentItemChanged" ID="PdfSearchResultsWidget.__handleCurrentItemChanged"></a> |
170 <h4>PdfSearchResultsWidget.__handleCurrentItemChanged</h4> |
168 <h4>PdfSearchResultsWidget.__handleCurrentItemChanged</h4> |
171 <b>__handleCurrentItemChanged</b>(<i></i>) |
169 <b>__handleCurrentItemChanged</b>(<i></i>) |
172 |
|
173 <p> |
170 <p> |
174 Private slot to handle a change of the current item. |
171 Private slot to handle a change of the current item. |
175 </p> |
172 </p> |
|
173 |
176 <a NAME="PdfSearchResultsWidget.__rowsInserted" ID="PdfSearchResultsWidget.__rowsInserted"></a> |
174 <a NAME="PdfSearchResultsWidget.__rowsInserted" ID="PdfSearchResultsWidget.__rowsInserted"></a> |
177 <h4>PdfSearchResultsWidget.__rowsInserted</h4> |
175 <h4>PdfSearchResultsWidget.__rowsInserted</h4> |
178 <b>__rowsInserted</b>(<i>parent, first, last</i>) |
176 <b>__rowsInserted</b>(<i>parent, first, last</i>) |
179 |
|
180 <p> |
177 <p> |
181 Private slot to handle the insertion of rows of the search model. |
178 Private slot to handle the insertion of rows of the search model. |
182 </p> |
179 </p> |
|
180 |
183 <dl> |
181 <dl> |
184 |
182 |
185 <dt><i>parent</i> (QModelIndex)</dt> |
183 <dt><i>parent</i> (QModelIndex)</dt> |
186 <dd> |
184 <dd> |
187 reference to the parent index |
185 reference to the parent index |
328 </dd> |
326 </dd> |
329 </dl> |
327 </dl> |
330 <a NAME="PdfSearchResultsWidget.setCurrentRow" ID="PdfSearchResultsWidget.setCurrentRow"></a> |
328 <a NAME="PdfSearchResultsWidget.setCurrentRow" ID="PdfSearchResultsWidget.setCurrentRow"></a> |
331 <h4>PdfSearchResultsWidget.setCurrentRow</h4> |
329 <h4>PdfSearchResultsWidget.setCurrentRow</h4> |
332 <b>setCurrentRow</b>(<i>row</i>) |
330 <b>setCurrentRow</b>(<i>row</i>) |
333 |
|
334 <p> |
331 <p> |
335 Public method to set the current row. |
332 Public method to set the current row. |
336 </p> |
333 </p> |
|
334 |
337 <dl> |
335 <dl> |
338 |
336 |
339 <dt><i>row</i> (int)</dt> |
337 <dt><i>row</i> (int)</dt> |
340 <dd> |
338 <dd> |
341 row number to make the current row |
339 row number to make the current row |
342 </dd> |
340 </dd> |
343 </dl> |
341 </dl> |
344 <a NAME="PdfSearchResultsWidget.setDocument" ID="PdfSearchResultsWidget.setDocument"></a> |
342 <a NAME="PdfSearchResultsWidget.setDocument" ID="PdfSearchResultsWidget.setDocument"></a> |
345 <h4>PdfSearchResultsWidget.setDocument</h4> |
343 <h4>PdfSearchResultsWidget.setDocument</h4> |
346 <b>setDocument</b>(<i>document</i>) |
344 <b>setDocument</b>(<i>document</i>) |
347 |
|
348 <p> |
345 <p> |
349 Public method to set the PDF document object to be searched. |
346 Public method to set the PDF document object to be searched. |
350 </p> |
347 </p> |
|
348 |
351 <dl> |
349 <dl> |
352 |
350 |
353 <dt><i>document</i> (QPdfDocument)</dt> |
351 <dt><i>document</i> (QPdfDocument)</dt> |
354 <dd> |
352 <dd> |
355 reference to the PDF document object |
353 reference to the PDF document object |
356 </dd> |
354 </dd> |
357 </dl> |
355 </dl> |
358 <a NAME="PdfSearchResultsWidget.setSearchString" ID="PdfSearchResultsWidget.setSearchString"></a> |
356 <a NAME="PdfSearchResultsWidget.setSearchString" ID="PdfSearchResultsWidget.setSearchString"></a> |
359 <h4>PdfSearchResultsWidget.setSearchString</h4> |
357 <h4>PdfSearchResultsWidget.setSearchString</h4> |
360 <b>setSearchString</b>(<i>searchString</i>) |
358 <b>setSearchString</b>(<i>searchString</i>) |
361 |
|
362 <p> |
359 <p> |
363 Public method to set the search string. |
360 Public method to set the search string. |
364 </p> |
361 </p> |
|
362 |
365 <dl> |
363 <dl> |
366 |
364 |
367 <dt><i>searchString</i> (str)</dt> |
365 <dt><i>searchString</i> (str)</dt> |
368 <dd> |
366 <dd> |
369 search string |
367 search string |
457 <tr> |
453 <tr> |
458 <td><a href="#PdfSearchWidget.previousResult">previousResult</a></td> |
454 <td><a href="#PdfSearchWidget.previousResult">previousResult</a></td> |
459 <td>Public slot to activate the previous result.</td> |
455 <td>Public slot to activate the previous result.</td> |
460 </tr> |
456 </tr> |
461 </table> |
457 </table> |
|
458 |
462 <h3>Static Methods</h3> |
459 <h3>Static Methods</h3> |
463 |
460 <table> |
464 <table> |
461 <tr><td>None</td></tr> |
465 <tr><td>None</td></tr> |
462 </table> |
466 </table> |
463 |
467 |
464 |
468 <a NAME="PdfSearchWidget.__init__" ID="PdfSearchWidget.__init__"></a> |
465 <a NAME="PdfSearchWidget.__init__" ID="PdfSearchWidget.__init__"></a> |
469 <h4>PdfSearchWidget (Constructor)</h4> |
466 <h4>PdfSearchWidget (Constructor)</h4> |
470 <b>PdfSearchWidget</b>(<i>document, parent=None</i>) |
467 <b>PdfSearchWidget</b>(<i>document, parent=None</i>) |
471 |
|
472 <p> |
468 <p> |
473 Constructor |
469 Constructor |
474 </p> |
470 </p> |
|
471 |
475 <dl> |
472 <dl> |
476 |
473 |
477 <dt><i>document</i> (QPdfDocument)</dt> |
474 <dt><i>document</i> (QPdfDocument)</dt> |
478 <dd> |
475 <dd> |
479 reference to the PDF document object |
476 reference to the PDF document object |
484 </dd> |
481 </dd> |
485 </dl> |
482 </dl> |
486 <a NAME="PdfSearchWidget.__entrySelected" ID="PdfSearchWidget.__entrySelected"></a> |
483 <a NAME="PdfSearchWidget.__entrySelected" ID="PdfSearchWidget.__entrySelected"></a> |
487 <h4>PdfSearchWidget.__entrySelected</h4> |
484 <h4>PdfSearchWidget.__entrySelected</h4> |
488 <b>__entrySelected</b>(<i>item</i>) |
485 <b>__entrySelected</b>(<i>item</i>) |
489 |
|
490 <p> |
486 <p> |
491 Private slot to handle the selection of a search result entry. |
487 Private slot to handle the selection of a search result entry. |
492 </p> |
488 </p> |
|
489 |
493 <dl> |
490 <dl> |
494 |
491 |
495 <dt><i>item</i> (QTreeWidgetItem)</dt> |
492 <dt><i>item</i> (QTreeWidgetItem)</dt> |
496 <dd> |
493 <dd> |
497 reference to the selected item |
494 reference to the selected item |
498 </dd> |
495 </dd> |
499 </dl> |
496 </dl> |
500 <a NAME="PdfSearchWidget.__handleDocumentStatus" ID="PdfSearchWidget.__handleDocumentStatus"></a> |
497 <a NAME="PdfSearchWidget.__handleDocumentStatus" ID="PdfSearchWidget.__handleDocumentStatus"></a> |
501 <h4>PdfSearchWidget.__handleDocumentStatus</h4> |
498 <h4>PdfSearchWidget.__handleDocumentStatus</h4> |
502 <b>__handleDocumentStatus</b>(<i>status</i>) |
499 <b>__handleDocumentStatus</b>(<i>status</i>) |
503 |
|
504 <p> |
500 <p> |
505 Private slot to handle a change of the document status. |
501 Private slot to handle a change of the document status. |
506 </p> |
502 </p> |
|
503 |
507 <dl> |
504 <dl> |
508 |
505 |
509 <dt><i>status</i> (QPdfDocument.Status)</dt> |
506 <dt><i>status</i> (QPdfDocument.Status)</dt> |
510 <dd> |
507 <dd> |
511 document status |
508 document status |
512 </dd> |
509 </dd> |
513 </dl> |
510 </dl> |
514 <a NAME="PdfSearchWidget.__search" ID="PdfSearchWidget.__search"></a> |
511 <a NAME="PdfSearchWidget.__search" ID="PdfSearchWidget.__search"></a> |
515 <h4>PdfSearchWidget.__search</h4> |
512 <h4>PdfSearchWidget.__search</h4> |
516 <b>__search</b>(<i></i>) |
513 <b>__search</b>(<i></i>) |
517 |
|
518 <p> |
514 <p> |
519 Private slot to initiate a new search. |
515 Private slot to initiate a new search. |
520 </p> |
516 </p> |
|
517 |
521 <a NAME="PdfSearchWidget.__searchTextChanged" ID="PdfSearchWidget.__searchTextChanged"></a> |
518 <a NAME="PdfSearchWidget.__searchTextChanged" ID="PdfSearchWidget.__searchTextChanged"></a> |
522 <h4>PdfSearchWidget.__searchTextChanged</h4> |
519 <h4>PdfSearchWidget.__searchTextChanged</h4> |
523 <b>__searchTextChanged</b>(<i>text</i>) |
520 <b>__searchTextChanged</b>(<i>text</i>) |
524 |
|
525 <p> |
521 <p> |
526 Private slot to handle a change of the search string. |
522 Private slot to handle a change of the search string. |
527 </p> |
523 </p> |
|
524 |
528 <dl> |
525 <dl> |
529 |
526 |
530 <dt><i>text</i> (str)</dt> |
527 <dt><i>text</i> (str)</dt> |
531 <dd> |
528 <dd> |
532 search string |
529 search string |
533 </dd> |
530 </dd> |
534 </dl> |
531 </dl> |
535 <a NAME="PdfSearchWidget.__updateInfoLabel" ID="PdfSearchWidget.__updateInfoLabel"></a> |
532 <a NAME="PdfSearchWidget.__updateInfoLabel" ID="PdfSearchWidget.__updateInfoLabel"></a> |
536 <h4>PdfSearchWidget.__updateInfoLabel</h4> |
533 <h4>PdfSearchWidget.__updateInfoLabel</h4> |
537 <b>__updateInfoLabel</b>(<i></i>) |
534 <b>__updateInfoLabel</b>(<i></i>) |
538 |
|
539 <p> |
535 <p> |
540 Private slot to update the data of the info label. |
536 Private slot to update the data of the info label. |
541 </p> |
537 </p> |
|
538 |
542 <a NAME="PdfSearchWidget.activateSearch" ID="PdfSearchWidget.activateSearch"></a> |
539 <a NAME="PdfSearchWidget.activateSearch" ID="PdfSearchWidget.activateSearch"></a> |
543 <h4>PdfSearchWidget.activateSearch</h4> |
540 <h4>PdfSearchWidget.activateSearch</h4> |
544 <b>activateSearch</b>(<i></i>) |
541 <b>activateSearch</b>(<i></i>) |
545 |
|
546 <p> |
542 <p> |
547 Public slot to 'activate' a search. |
543 Public slot to 'activate' a search. |
548 </p> |
544 </p> |
|
545 |
549 <a NAME="PdfSearchWidget.nextResult" ID="PdfSearchWidget.nextResult"></a> |
546 <a NAME="PdfSearchWidget.nextResult" ID="PdfSearchWidget.nextResult"></a> |
550 <h4>PdfSearchWidget.nextResult</h4> |
547 <h4>PdfSearchWidget.nextResult</h4> |
551 <b>nextResult</b>(<i></i>) |
548 <b>nextResult</b>(<i></i>) |
552 |
|
553 <p> |
549 <p> |
554 Public slot to activate the next result. |
550 Public slot to activate the next result. |
555 </p> |
551 </p> |
|
552 |
556 <a NAME="PdfSearchWidget.previousResult" ID="PdfSearchWidget.previousResult"></a> |
553 <a NAME="PdfSearchWidget.previousResult" ID="PdfSearchWidget.previousResult"></a> |
557 <h4>PdfSearchWidget.previousResult</h4> |
554 <h4>PdfSearchWidget.previousResult</h4> |
558 <b>previousResult</b>(<i></i>) |
555 <b>previousResult</b>(<i></i>) |
559 |
|
560 <p> |
556 <p> |
561 Public slot to activate the previous result. |
557 Public slot to activate the previous result. |
562 </p> |
558 </p> |
|
559 |
563 <div align="right"><a href="#top">Up</a></div> |
560 <div align="right"><a href="#top">Up</a></div> |
564 <hr /> |
561 <hr /> |
565 </body></html> |
562 </body></html> |