--- a/src/eric7/Documentation/Source/eric7.QScintilla.SearchReplaceWidget.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.SearchReplaceWidget.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,19 +7,17 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.QScintilla.SearchReplaceWidget</h1> - <p> Module implementing the search and replace widget. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#SearchReplaceSlidingWidget">SearchReplaceSlidingWidget</a></td> <td>Class implementing the search and replace widget with sliding behavior.</td> @@ -29,19 +27,20 @@ <td>Class implementing the search and replace widget.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="SearchReplaceSlidingWidget" ID="SearchReplaceSlidingWidget"></a> <h2>SearchReplaceSlidingWidget</h2> - <p> Class implementing the search and replace widget with sliding behavior. </p> + <h3>Signals</h3> <dl> @@ -53,19 +52,17 @@ <h3>Derived from</h3> QWidget <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#SearchReplaceSlidingWidget.__init__">SearchReplaceSlidingWidget</a></td> <td>Constructor</td> @@ -131,19 +128,20 @@ <td>Public slot to update the selection check box.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="SearchReplaceSlidingWidget.__init__" ID="SearchReplaceSlidingWidget.__init__"></a> <h4>SearchReplaceSlidingWidget (Constructor)</h4> <b>SearchReplaceSlidingWidget</b>(<i>vm, parent=None</i>) - <p> Constructor </p> + <dl> <dt><i>vm</i> (ViewManager)</dt> @@ -158,17 +156,17 @@ <a NAME="SearchReplaceSlidingWidget.__enableScrollerButtons" ID="SearchReplaceSlidingWidget.__enableScrollerButtons"></a> <h4>SearchReplaceSlidingWidget.__enableScrollerButtons</h4> <b>__enableScrollerButtons</b>(<i></i>) - <p> Private method to set the enabled state of the scroll buttons. </p> + <a NAME="SearchReplaceSlidingWidget.__slide" ID="SearchReplaceSlidingWidget.__slide"></a> <h4>SearchReplaceSlidingWidget.__slide</h4> <b>__slide</b>(<i>toLeft</i>) - <p> Private method to move the sliding widget. </p> + <dl> <dt><i>toLeft</i> (bool)</dt> @@ -179,26 +177,26 @@ <a NAME="SearchReplaceSlidingWidget.__slideLeft" ID="SearchReplaceSlidingWidget.__slideLeft"></a> <h4>SearchReplaceSlidingWidget.__slideLeft</h4> <b>__slideLeft</b>(<i></i>) - <p> Private slot to move the widget to the left, i.e. show contents to the right. </p> + <a NAME="SearchReplaceSlidingWidget.__slideRight" ID="SearchReplaceSlidingWidget.__slideRight"></a> <h4>SearchReplaceSlidingWidget.__slideRight</h4> <b>__slideRight</b>(<i></i>) - <p> Private slot to move the widget to the right, i.e. show contents to the left. </p> + <a NAME="SearchReplaceSlidingWidget.changeEvent" ID="SearchReplaceSlidingWidget.changeEvent"></a> <h4>SearchReplaceSlidingWidget.changeEvent</h4> <b>changeEvent</b>(<i>evt</i>) - <p> Protected method handling state changes. </p> + <dl> <dt><i>evt</i> (QEvent)</dt> @@ -209,10 +207,10 @@ <a NAME="SearchReplaceSlidingWidget.editorClosed" ID="SearchReplaceSlidingWidget.editorClosed"></a> <h4>SearchReplaceSlidingWidget.editorClosed</h4> <b>editorClosed</b>(<i>editor</i>) - <p> Public slot to handle the closing of an editor. </p> + <dl> <dt><i>editor</i> (Editor)</dt> @@ -223,45 +221,45 @@ <a NAME="SearchReplaceSlidingWidget.findNext" ID="SearchReplaceSlidingWidget.findNext"></a> <h4>SearchReplaceSlidingWidget.findNext</h4> <b>findNext</b>(<i></i>) - <p> Public slot to find the next occurrence of text. </p> + <a NAME="SearchReplaceSlidingWidget.findPrev" ID="SearchReplaceSlidingWidget.findPrev"></a> <h4>SearchReplaceSlidingWidget.findPrev</h4> <b>findPrev</b>(<i></i>) - <p> Public slot to find the next previous of text. </p> + <a NAME="SearchReplaceSlidingWidget.replace" ID="SearchReplaceSlidingWidget.replace"></a> <h4>SearchReplaceSlidingWidget.replace</h4> <b>replace</b>(<i></i>) - <p> Public method to replace the current selection. </p> + <a NAME="SearchReplaceSlidingWidget.replaceAll" ID="SearchReplaceSlidingWidget.replaceAll"></a> <h4>SearchReplaceSlidingWidget.replaceAll</h4> <b>replaceAll</b>(<i></i>) - <p> Public method to replace all occurrences. </p> + <a NAME="SearchReplaceSlidingWidget.replaceSearch" ID="SearchReplaceSlidingWidget.replaceSearch"></a> <h4>SearchReplaceSlidingWidget.replaceSearch</h4> <b>replaceSearch</b>(<i></i>) - <p> Public method to replace the current selection and search again. </p> + <a NAME="SearchReplaceSlidingWidget.resizeEvent" ID="SearchReplaceSlidingWidget.resizeEvent"></a> <h4>SearchReplaceSlidingWidget.resizeEvent</h4> <b>resizeEvent</b>(<i>evt</i>) - <p> Protected method to handle resize events. </p> + <dl> <dt><i>evt</i> (QResizeEvent)</dt> @@ -272,10 +270,10 @@ <a NAME="SearchReplaceSlidingWidget.selectionChanged" ID="SearchReplaceSlidingWidget.selectionChanged"></a> <h4>SearchReplaceSlidingWidget.selectionChanged</h4> <b>selectionChanged</b>(<i>editor</i>) - <p> Public slot tracking changes of selected text. </p> + <dl> <dt><i>editor</i> (Editor)</dt> @@ -286,10 +284,10 @@ <a NAME="SearchReplaceSlidingWidget.show" ID="SearchReplaceSlidingWidget.show"></a> <h4>SearchReplaceSlidingWidget.show</h4> <b>show</b>(<i>text="", replaceMode=False</i>) - <p> Public slot to show the widget. </p> + <dl> <dt><i>text</i> (str (optional))</dt> @@ -305,10 +303,10 @@ <a NAME="SearchReplaceSlidingWidget.updateSelectionCheckBox" ID="SearchReplaceSlidingWidget.updateSelectionCheckBox"></a> <h4>SearchReplaceSlidingWidget.updateSelectionCheckBox</h4> <b>updateSelectionCheckBox</b>(<i>editor</i>) - <p> Public slot to update the selection check box. </p> + <dl> <dt><i>editor</i> (Editor)</dt> @@ -321,10 +319,10 @@ <hr /> <a NAME="SearchReplaceWidget" ID="SearchReplaceWidget"></a> <h2>SearchReplaceWidget</h2> - <p> Class implementing the search and replace widget. </p> + <h3>Signals</h3> <dl> @@ -336,19 +334,17 @@ <h3>Derived from</h3> QWidget, Ui_SearchReplaceWidget <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#SearchReplaceWidget.__init__">SearchReplaceWidget</a></td> <td>Constructor</td> @@ -514,19 +510,20 @@ <td>Public slot to update the selection check box.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="SearchReplaceWidget.__init__" ID="SearchReplaceWidget.__init__"></a> <h4>SearchReplaceWidget (Constructor)</h4> <b>SearchReplaceWidget</b>(<i>vm, parent=None, sliding=False</i>) - <p> Constructor </p> + <dl> <dt><i>vm</i> (ViewManager)</dt> @@ -546,10 +543,10 @@ <a NAME="SearchReplaceWidget.__doReplace" ID="SearchReplaceWidget.__doReplace"></a> <h4>SearchReplaceWidget.__doReplace</h4> <b>__doReplace</b>(<i>searchNext</i>) - <p> Private method to replace one occurrence of text. </p> + <dl> <dt><i>searchNext</i> (bool)</dt> @@ -560,18 +557,18 @@ <a NAME="SearchReplaceWidget.__findByReturnPressed" ID="SearchReplaceWidget.__findByReturnPressed"></a> <h4>SearchReplaceWidget.__findByReturnPressed</h4> <b>__findByReturnPressed</b>(<i></i>) - <p> Private slot to handle the returnPressed signal of the findtext combobox. </p> + <a NAME="SearchReplaceWidget.__findNextPrev" ID="SearchReplaceWidget.__findNextPrev"></a> <h4>SearchReplaceWidget.__findNextPrev</h4> <b>__findNextPrev</b>(<i>txt, backwards</i>) - <p> Private method to find the next occurrence of the search text. </p> + <dl> <dt><i>txt</i> (str)</dt> @@ -598,10 +595,10 @@ <a NAME="SearchReplaceWidget.__markOccurrences" ID="SearchReplaceWidget.__markOccurrences"></a> <h4>SearchReplaceWidget.__markOccurrences</h4> <b>__markOccurrences</b>(<i>txt</i>) - <p> Private method to mark all occurrences of the search text. </p> + <dl> <dt><i>txt</i> (str)</dt> @@ -612,10 +609,10 @@ <a NAME="SearchReplaceWidget.__quickSearch" ID="SearchReplaceWidget.__quickSearch"></a> <h4>SearchReplaceWidget.__quickSearch</h4> <b>__quickSearch</b>(<i>txt</i>) - <p> Private slot to search for the entered text while typing. </p> + <dl> <dt><i>txt</i> (str)</dt> @@ -626,17 +623,17 @@ <a NAME="SearchReplaceWidget.__quickSearchMarkOccurrences" ID="SearchReplaceWidget.__quickSearchMarkOccurrences"></a> <h4>SearchReplaceWidget.__quickSearchMarkOccurrences</h4> <b>__quickSearchMarkOccurrences</b>(<i></i>) - <p> Private slot to mark all occurrences of the current search text. </p> + <a NAME="SearchReplaceWidget.__selectionBoundary" ID="SearchReplaceWidget.__selectionBoundary"></a> <h4>SearchReplaceWidget.__selectionBoundary</h4> <b>__selectionBoundary</b>(<i>selections=None</i>) - <p> Private method to calculate the current selection boundary. </p> + <dl> <dt><i>selections</i> (list of tuples of four int)</dt> @@ -660,10 +657,10 @@ <a NAME="SearchReplaceWidget.__setFindNextEnabled" ID="SearchReplaceWidget.__setFindNextEnabled"></a> <h4>SearchReplaceWidget.__setFindNextEnabled</h4> <b>__setFindNextEnabled</b>(<i>enable</i>) - <p> Private method to set the enabled state of "Find Next". </p> + <dl> <dt><i>enable</i> (bool)</dt> @@ -674,10 +671,10 @@ <a NAME="SearchReplaceWidget.__setFindPrevEnabled" ID="SearchReplaceWidget.__setFindPrevEnabled"></a> <h4>SearchReplaceWidget.__setFindPrevEnabled</h4> <b>__setFindPrevEnabled</b>(<i>enable</i>) - <p> Private method to set the enabled state of "Find Prev". </p> + <dl> <dt><i>enable</i> (bool)</dt> @@ -688,10 +685,10 @@ <a NAME="SearchReplaceWidget.__setReplaceAllEnabled" ID="SearchReplaceWidget.__setReplaceAllEnabled"></a> <h4>SearchReplaceWidget.__setReplaceAllEnabled</h4> <b>__setReplaceAllEnabled</b>(<i>enable</i>) - <p> Private method to set the enabled state of "Replace All". </p> + <dl> <dt><i>enable</i> (bool)</dt> @@ -702,10 +699,10 @@ <a NAME="SearchReplaceWidget.__setReplaceAndSearchEnabled" ID="SearchReplaceWidget.__setReplaceAndSearchEnabled"></a> <h4>SearchReplaceWidget.__setReplaceAndSearchEnabled</h4> <b>__setReplaceAndSearchEnabled</b>(<i>enable</i>) - <p> Private method to set the enabled state of "Replace And Search". </p> + <dl> <dt><i>enable</i> (bool)</dt> @@ -716,10 +713,10 @@ <a NAME="SearchReplaceWidget.__setReplaceSelectionEnabled" ID="SearchReplaceWidget.__setReplaceSelectionEnabled"></a> <h4>SearchReplaceWidget.__setReplaceSelectionEnabled</h4> <b>__setReplaceSelectionEnabled</b>(<i>enable</i>) - <p> Private method to set the enabled state of "Replace Occurrence". </p> + <dl> <dt><i>enable</i> (bool)</dt> @@ -730,10 +727,10 @@ <a NAME="SearchReplaceWidget.__setSearchEditColors" ID="SearchReplaceWidget.__setSearchEditColors"></a> <h4>SearchReplaceWidget.__setSearchEditColors</h4> <b>__setSearchEditColors</b>(<i>ok</i>) - <p> Private method to set the search edit colors. </p> + <dl> <dt><i>ok</i> (bool)</dt> @@ -744,18 +741,18 @@ <a NAME="SearchReplaceWidget.__setShortcuts" ID="SearchReplaceWidget.__setShortcuts"></a> <h4>SearchReplaceWidget.__setShortcuts</h4> <b>__setShortcuts</b>(<i></i>) - <p> Private method to set the local action's shortcuts to the same key sequences as in the view manager. </p> + <a NAME="SearchReplaceWidget.__showFind" ID="SearchReplaceWidget.__showFind"></a> <h4>SearchReplaceWidget.__showFind</h4> <b>__showFind</b>(<i>text=""</i>) - <p> Private method to display this widget in find mode. </p> + <dl> <dt><i>text</i> (str (optional))</dt> @@ -766,10 +763,10 @@ <a NAME="SearchReplaceWidget.__showReplace" ID="SearchReplaceWidget.__showReplace"></a> <h4>SearchReplaceWidget.__showReplace</h4> <b>__showReplace</b>(<i>text=""</i>) - <p> Private slot to display this widget in replace mode. </p> + <dl> <dt><i>text</i> (str (optional))</dt> @@ -780,17 +777,17 @@ <a NAME="SearchReplaceWidget.__toggleReplaceMode" ID="SearchReplaceWidget.__toggleReplaceMode"></a> <h4>SearchReplaceWidget.__toggleReplaceMode</h4> <b>__toggleReplaceMode</b>(<i></i>) - <p> Private slot to toggle the widget mode. </p> + <a NAME="SearchReplaceWidget.__updateQuickSearchMarkers" ID="SearchReplaceWidget.__updateQuickSearchMarkers"></a> <h4>SearchReplaceWidget.__updateQuickSearchMarkers</h4> <b>__updateQuickSearchMarkers</b>(<i>on</i>) - <p> Private slot to handle the selection of the various check boxes. </p> + <dl> <dt><i>on</i> (bool)</dt> @@ -801,10 +798,10 @@ <a NAME="SearchReplaceWidget.changeEvent" ID="SearchReplaceWidget.changeEvent"></a> <h4>SearchReplaceWidget.changeEvent</h4> <b>changeEvent</b>(<i>evt</i>) - <p> Protected method handling state changes. </p> + <dl> <dt><i>evt</i> (QEvent)</dt> @@ -815,10 +812,10 @@ <a NAME="SearchReplaceWidget.editorClosed" ID="SearchReplaceWidget.editorClosed"></a> <h4>SearchReplaceWidget.editorClosed</h4> <b>editorClosed</b>(<i>editor</i>) - <p> Public slot to handle the closing of an editor. </p> + <dl> <dt><i>editor</i> (Editor)</dt> @@ -829,10 +826,10 @@ <a NAME="SearchReplaceWidget.eventFilter" ID="SearchReplaceWidget.eventFilter"></a> <h4>SearchReplaceWidget.eventFilter</h4> <b>eventFilter</b>(<i>obj, evt</i>) - <p> Public method to handle events for other objects. </p> + <dl> <dt><i>obj</i> (QObject)</dt> @@ -859,24 +856,24 @@ <a NAME="SearchReplaceWidget.findNext" ID="SearchReplaceWidget.findNext"></a> <h4>SearchReplaceWidget.findNext</h4> <b>findNext</b>(<i></i>) - <p> Public slot to find the next occurrence of text. </p> + <a NAME="SearchReplaceWidget.findPrev" ID="SearchReplaceWidget.findPrev"></a> <h4>SearchReplaceWidget.findPrev</h4> <b>findPrev</b>(<i></i>) - <p> Public slot to find the next previous of text. </p> + <a NAME="SearchReplaceWidget.keyPressEvent" ID="SearchReplaceWidget.keyPressEvent"></a> <h4>SearchReplaceWidget.keyPressEvent</h4> <b>keyPressEvent</b>(<i>event</i>) - <p> Protected slot to handle key press events. </p> + <dl> <dt><i>event</i> (QKeyEvent)</dt> @@ -887,17 +884,17 @@ <a NAME="SearchReplaceWidget.on_closeButton_clicked" ID="SearchReplaceWidget.on_closeButton_clicked"></a> <h4>SearchReplaceWidget.on_closeButton_clicked</h4> <b>on_closeButton_clicked</b>(<i></i>) - <p> Private slot to close the widget. </p> + <a NAME="SearchReplaceWidget.on_escapeCheckBox_toggled" ID="SearchReplaceWidget.on_escapeCheckBox_toggled"></a> <h4>SearchReplaceWidget.on_escapeCheckBox_toggled</h4> <b>on_escapeCheckBox_toggled</b>(<i>checked</i>) - <p> Private slot handling a change of the escape selector. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -908,31 +905,31 @@ <a NAME="SearchReplaceWidget.on_extendButton_clicked" ID="SearchReplaceWidget.on_extendButton_clicked"></a> <h4>SearchReplaceWidget.on_extendButton_clicked</h4> <b>on_extendButton_clicked</b>(<i></i>) - <p> Private slot to handle the quick search extend action. </p> + <a NAME="SearchReplaceWidget.on_findNextButton_clicked" ID="SearchReplaceWidget.on_findNextButton_clicked"></a> <h4>SearchReplaceWidget.on_findNextButton_clicked</h4> <b>on_findNextButton_clicked</b>(<i></i>) - <p> Private slot to find the next occurrence of text. </p> + <a NAME="SearchReplaceWidget.on_findPrevButton_clicked" ID="SearchReplaceWidget.on_findPrevButton_clicked"></a> <h4>SearchReplaceWidget.on_findPrevButton_clicked</h4> <b>on_findPrevButton_clicked</b>(<i></i>) - <p> Private slot to find the previous occurrence of text. </p> + <a NAME="SearchReplaceWidget.on_findtextCombo_editTextChanged" ID="SearchReplaceWidget.on_findtextCombo_editTextChanged"></a> <h4>SearchReplaceWidget.on_findtextCombo_editTextChanged</h4> <b>on_findtextCombo_editTextChanged</b>(<i>txt</i>) - <p> Private slot to enable/disable the find buttons. </p> + <dl> <dt><i>txt</i> (str)</dt> @@ -943,10 +940,10 @@ <a NAME="SearchReplaceWidget.on_regexpCheckBox_toggled" ID="SearchReplaceWidget.on_regexpCheckBox_toggled"></a> <h4>SearchReplaceWidget.on_regexpCheckBox_toggled</h4> <b>on_regexpCheckBox_toggled</b>(<i>checked</i>) - <p> Private slot handling a change of the regexp selector. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -957,53 +954,53 @@ <a NAME="SearchReplaceWidget.on_replaceAllButton_clicked" ID="SearchReplaceWidget.on_replaceAllButton_clicked"></a> <h4>SearchReplaceWidget.on_replaceAllButton_clicked</h4> <b>on_replaceAllButton_clicked</b>(<i></i>) - <p> Private slot to replace all occurrences of text. </p> + <a NAME="SearchReplaceWidget.on_replaceButton_clicked" ID="SearchReplaceWidget.on_replaceButton_clicked"></a> <h4>SearchReplaceWidget.on_replaceButton_clicked</h4> <b>on_replaceButton_clicked</b>(<i></i>) - <p> Private slot to replace one occurrence of text. </p> + <a NAME="SearchReplaceWidget.on_replaceSearchButton_clicked" ID="SearchReplaceWidget.on_replaceSearchButton_clicked"></a> <h4>SearchReplaceWidget.on_replaceSearchButton_clicked</h4> <b>on_replaceSearchButton_clicked</b>(<i></i>) - <p> Private slot to replace one occurrence of text and search for the next one. </p> + <a NAME="SearchReplaceWidget.replace" ID="SearchReplaceWidget.replace"></a> <h4>SearchReplaceWidget.replace</h4> <b>replace</b>(<i></i>) - <p> Public method to replace the current selection. </p> + <a NAME="SearchReplaceWidget.replaceAll" ID="SearchReplaceWidget.replaceAll"></a> <h4>SearchReplaceWidget.replaceAll</h4> <b>replaceAll</b>(<i></i>) - <p> Public method to replace all occurrences. </p> + <a NAME="SearchReplaceWidget.replaceSearch" ID="SearchReplaceWidget.replaceSearch"></a> <h4>SearchReplaceWidget.replaceSearch</h4> <b>replaceSearch</b>(<i></i>) - <p> Public method to replace the current selection and search again. </p> + <a NAME="SearchReplaceWidget.selectionChanged" ID="SearchReplaceWidget.selectionChanged"></a> <h4>SearchReplaceWidget.selectionChanged</h4> <b>selectionChanged</b>(<i>editor</i>) - <p> Public slot tracking changes of selected text. </p> + <dl> <dt><i>editor</i> (Editor)</dt> @@ -1014,10 +1011,10 @@ <a NAME="SearchReplaceWidget.show" ID="SearchReplaceWidget.show"></a> <h4>SearchReplaceWidget.show</h4> <b>show</b>(<i>text="", replaceMode=False</i>) - <p> Public slot to show the widget. </p> + <dl> <dt><i>text</i> (str (optional))</dt> @@ -1033,10 +1030,10 @@ <a NAME="SearchReplaceWidget.updateSelectionCheckBox" ID="SearchReplaceWidget.updateSelectionCheckBox"></a> <h4>SearchReplaceWidget.updateSelectionCheckBox</h4> <b>updateSelectionCheckBox</b>(<i>editor</i>) - <p> Public slot to update the selection check box. </p> + <dl> <dt><i>editor</i> (Editor)</dt> @@ -1046,4 +1043,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>