--- a/eric7/Documentation/Source/eric7.EricWidgets.EricTextEditSearchWidget.html Mon Nov 01 16:53:32 2021 +0100
+++ b/eric7/Documentation/Source/eric7.EricWidgets.EricTextEditSearchWidget.html Mon Nov 01 16:58:52 2021 +0100
@@ -42,6 +42,15 @@
<p>
Class implementing a horizontal search widget for QTextEdit.
</p>
+<h3>Signals</h3>
+<dl>
+
+<dt>closePressed()</dt>
+<dd>
+emitted to indicate the closing of the widget via
+ the close button
+</dd>
+</dl>
<h3>Derived from</h3>
QWidget
<h3>Class Attributes</h3>
@@ -67,6 +76,10 @@
<td>Private method to set the middle part of the layout.</td>
</tr>
<tr>
+<td><a href="#EricTextEditSearchWidget.__closeButtonClicked">__closeButtonClicked</a></td>
+<td>Private slot to close the widget.</td>
+</tr>
+<tr>
<td><a href="#EricTextEditSearchWidget.__find">__find</a></td>
<td>Private method to search the associated text edit.</td>
</tr>
@@ -75,10 +88,6 @@
<td>Private slot to handle the returnPressed signal of the findtext combobox.</td>
</tr>
<tr>
-<td><a href="#EricTextEditSearchWidget.__findNextPrevCallback">__findNextPrevCallback</a></td>
-<td>Private method to process the result of the last search.</td>
-</tr>
-<tr>
<td><a href="#EricTextEditSearchWidget.__findPrevNextQTextEdit">__findPrevNextQTextEdit</a></td>
<td>Private method to to search the associated edit widget of type QTextEdit.</td>
</tr>
@@ -87,6 +96,10 @@
<td>Private method to to search the associated edit widget of type QWebEngineView.</td>
</tr>
<tr>
+<td><a href="#EricTextEditSearchWidget.__findTextFinished">__findTextFinished</a></td>
+<td>Private slot handling the findTextFinished signal of the web page.</td>
+</tr>
+<tr>
<td><a href="#EricTextEditSearchWidget.__setFindtextComboBackground">__setFindtextComboBackground</a></td>
<td>Private slot to change the findtext combo background to indicate errors.</td>
</tr>
@@ -99,8 +112,28 @@
<td>Private method to generate the UI.</td>
</tr>
<tr>
+<td><a href="#EricTextEditSearchWidget.activate">activate</a></td>
+<td>Public slot to activate the widget.</td>
+</tr>
+<tr>
<td><a href="#EricTextEditSearchWidget.attachTextEdit">attachTextEdit</a></td>
-<td>Public method to attach a QTextEdit widget.</td>
+<td>Public method to attach a QTextEdit or QWebEngineView widget.</td>
+</tr>
+<tr>
+<td><a href="#EricTextEditSearchWidget.deactivate">deactivate</a></td>
+<td>Public slot to deactivate the widget.</td>
+</tr>
+<tr>
+<td><a href="#EricTextEditSearchWidget.detachTextEdit">detachTextEdit</a></td>
+<td>Public method to detach the current text edit.</td>
+</tr>
+<tr>
+<td><a href="#EricTextEditSearchWidget.findNext">findNext</a></td>
+<td>Public slot to find the next occurrence of the current search term.</td>
+</tr>
+<tr>
+<td><a href="#EricTextEditSearchWidget.findPrev">findPrev</a></td>
+<td>Public slot to find the previous occurrence of the current search term.</td>
</tr>
<tr>
<td><a href="#EricTextEditSearchWidget.keyPressEvent">keyPressEvent</a></td>
@@ -122,6 +155,10 @@
<td><a href="#EricTextEditSearchWidget.setWidthForHeight">setWidthForHeight</a></td>
<td>Public method to set the 'width for height'.</td>
</tr>
+<tr>
+<td><a href="#EricTextEditSearchWidget.showInfo">showInfo</a></td>
+<td>Public method to show some information in the info label.</td>
+</tr>
</table>
<h3>Static Methods</h3>
@@ -131,7 +168,7 @@
<a NAME="EricTextEditSearchWidget.__init__" ID="EricTextEditSearchWidget.__init__"></a>
<h4>EricTextEditSearchWidget (Constructor)</h4>
-<b>EricTextEditSearchWidget</b>(<i>parent=None, widthForHeight=True</i>)
+<b>EricTextEditSearchWidget</b>(<i>parent=None, widthForHeight=True, enableClose=False</i>)
<p>
Constructor
@@ -148,6 +185,10 @@
If this parameter is False, some widgets are shown in a third
line.
</dd>
+<dt><i>enableClose</i> (bool)</dt>
+<dd>
+flag indicating to show a close button
+</dd>
</dl>
<a NAME="EricTextEditSearchWidget.__addWidthForHeightLayout" ID="EricTextEditSearchWidget.__addWidthForHeightLayout"></a>
<h4>EricTextEditSearchWidget.__addWidthForHeightLayout</h4>
@@ -163,6 +204,16 @@
flag indicating to prefer width
</dd>
</dl>
+<a NAME="EricTextEditSearchWidget.__closeButtonClicked" ID="EricTextEditSearchWidget.__closeButtonClicked"></a>
+<h4>EricTextEditSearchWidget.__closeButtonClicked</h4>
+<b>__closeButtonClicked</b>(<i></i>)
+
+<p>
+ Private slot to close the widget.
+</p>
+<p>
+ Note: The widget is just hidden.
+</p>
<a NAME="EricTextEditSearchWidget.__find" ID="EricTextEditSearchWidget.__find"></a>
<h4>EricTextEditSearchWidget.__find</h4>
<b>__find</b>(<i>backwards</i>)
@@ -172,9 +223,9 @@
</p>
<dl>
-<dt><i>backwards</i></dt>
+<dt><i>backwards</i> (bool)</dt>
<dd>
-flag indicating a backwards search (boolean)
+flag indicating a backwards search
</dd>
</dl>
<a NAME="EricTextEditSearchWidget.__findByReturnPressed" ID="EricTextEditSearchWidget.__findByReturnPressed"></a>
@@ -185,20 +236,6 @@
Private slot to handle the returnPressed signal of the findtext
combobox.
</p>
-<a NAME="EricTextEditSearchWidget.__findNextPrevCallback" ID="EricTextEditSearchWidget.__findNextPrevCallback"></a>
-<h4>EricTextEditSearchWidget.__findNextPrevCallback</h4>
-<b>__findNextPrevCallback</b>(<i>found</i>)
-
-<p>
- Private method to process the result of the last search.
-</p>
-<dl>
-
-<dt><i>found</i> (bool)</dt>
-<dd>
-flag indicating if the last search succeeded
-</dd>
-</dl>
<a NAME="EricTextEditSearchWidget.__findPrevNextQTextEdit" ID="EricTextEditSearchWidget.__findPrevNextQTextEdit"></a>
<h4>EricTextEditSearchWidget.__findPrevNextQTextEdit</h4>
<b>__findPrevNextQTextEdit</b>(<i>backwards</i>)
@@ -214,18 +251,6 @@
flag indicating a backwards search
</dd>
</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-flag indicating the search result
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-bool
-</dd>
-</dl>
<a NAME="EricTextEditSearchWidget.__findPrevNextQWebEngineView" ID="EricTextEditSearchWidget.__findPrevNextQWebEngineView"></a>
<h4>EricTextEditSearchWidget.__findPrevNextQWebEngineView</h4>
<b>__findPrevNextQWebEngineView</b>(<i>backwards</i>)
@@ -241,6 +266,21 @@
flag indicating a backwards search
</dd>
</dl>
+<a NAME="EricTextEditSearchWidget.__findTextFinished" ID="EricTextEditSearchWidget.__findTextFinished"></a>
+<h4>EricTextEditSearchWidget.__findTextFinished</h4>
+<b>__findTextFinished</b>(<i>result</i>)
+
+<p>
+ Private slot handling the findTextFinished signal of the web page.
+</p>
+<dl>
+
+<dt><i>result</i> (QWebEngineFindTextResult)</dt>
+<dd>
+reference to the QWebEngineFindTextResult object of the
+ last search
+</dd>
+</dl>
<a NAME="EricTextEditSearchWidget.__setFindtextComboBackground" ID="EricTextEditSearchWidget.__setFindtextComboBackground"></a>
<h4>EricTextEditSearchWidget.__setFindtextComboBackground</h4>
<b>__setFindtextComboBackground</b>(<i>error</i>)
@@ -251,9 +291,9 @@
</p>
<dl>
-<dt><i>error</i></dt>
+<dt><i>error</i> (bool)</dt>
<dd>
-flag indicating an error condition (boolean)
+flag indicating an error condition
</dd>
</dl>
<a NAME="EricTextEditSearchWidget.__setSearchButtons" ID="EricTextEditSearchWidget.__setSearchButtons"></a>
@@ -265,14 +305,14 @@
</p>
<dl>
-<dt><i>enabled</i></dt>
+<dt><i>enabled</i> (bool)</dt>
<dd>
-flag indicating the state (boolean)
+flag indicating the state
</dd>
</dl>
<a NAME="EricTextEditSearchWidget.__setupUi" ID="EricTextEditSearchWidget.__setupUi"></a>
<h4>EricTextEditSearchWidget.__setupUi</h4>
-<b>__setupUi</b>(<i>widthForHeight</i>)
+<b>__setupUi</b>(<i>widthForHeight, enableClose</i>)
<p>
Private method to generate the UI.
@@ -283,17 +323,28 @@
<dd>
flag indicating to prefer width for height
</dd>
+<dt><i>enableClose</i> (bool)</dt>
+<dd>
+flag indicating to show a close button
+</dd>
</dl>
+<a NAME="EricTextEditSearchWidget.activate" ID="EricTextEditSearchWidget.activate"></a>
+<h4>EricTextEditSearchWidget.activate</h4>
+<b>activate</b>(<i></i>)
+
+<p>
+ Public slot to activate the widget.
+</p>
<a NAME="EricTextEditSearchWidget.attachTextEdit" ID="EricTextEditSearchWidget.attachTextEdit"></a>
<h4>EricTextEditSearchWidget.attachTextEdit</h4>
<b>attachTextEdit</b>(<i>textedit, editType=EricTextEditType.QTEXTEDIT</i>)
<p>
- Public method to attach a QTextEdit widget.
+ Public method to attach a QTextEdit or QWebEngineView widget.
</p>
<dl>
-<dt><i>textedit</i> (QTextEdit, QWebEngineView or QWebView)</dt>
+<dt><i>textedit</i> (QTextEdit, QTextBrowser or QWebEngineView)</dt>
<dd>
reference to the edit widget to be attached
</dd>
@@ -302,6 +353,34 @@
type of the attached edit widget
</dd>
</dl>
+<a NAME="EricTextEditSearchWidget.deactivate" ID="EricTextEditSearchWidget.deactivate"></a>
+<h4>EricTextEditSearchWidget.deactivate</h4>
+<b>deactivate</b>(<i></i>)
+
+<p>
+ Public slot to deactivate the widget.
+</p>
+<a NAME="EricTextEditSearchWidget.detachTextEdit" ID="EricTextEditSearchWidget.detachTextEdit"></a>
+<h4>EricTextEditSearchWidget.detachTextEdit</h4>
+<b>detachTextEdit</b>(<i></i>)
+
+<p>
+ Public method to detach the current text edit.
+</p>
+<a NAME="EricTextEditSearchWidget.findNext" ID="EricTextEditSearchWidget.findNext"></a>
+<h4>EricTextEditSearchWidget.findNext</h4>
+<b>findNext</b>(<i></i>)
+
+<p>
+ Public slot to find the next occurrence of the current search term.
+</p>
+<a NAME="EricTextEditSearchWidget.findPrev" ID="EricTextEditSearchWidget.findPrev"></a>
+<h4>EricTextEditSearchWidget.findPrev</h4>
+<b>findPrev</b>(<i></i>)
+
+<p>
+ Public slot to find the previous occurrence of the current search term.
+</p>
<a NAME="EricTextEditSearchWidget.keyPressEvent" ID="EricTextEditSearchWidget.keyPressEvent"></a>
<h4>EricTextEditSearchWidget.keyPressEvent</h4>
<b>keyPressEvent</b>(<i>event</i>)
@@ -311,9 +390,9 @@
</p>
<dl>
-<dt><i>event</i></dt>
+<dt><i>event</i> (QKeyEvent)</dt>
<dd>
-reference to the key press event (QKeyEvent)
+reference to the key press event
</dd>
</dl>
<a NAME="EricTextEditSearchWidget.on_findNextButton_clicked" ID="EricTextEditSearchWidget.on_findNextButton_clicked"></a>
@@ -339,9 +418,9 @@
</p>
<dl>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
<dd>
-text of the combobox (string)
+text of the combobox
</dd>
</dl>
<a NAME="EricTextEditSearchWidget.setWidthForHeight" ID="EricTextEditSearchWidget.setWidthForHeight"></a>
@@ -358,6 +437,20 @@
flag indicating to prefer width
</dd>
</dl>
+<a NAME="EricTextEditSearchWidget.showInfo" ID="EricTextEditSearchWidget.showInfo"></a>
+<h4>EricTextEditSearchWidget.showInfo</h4>
+<b>showInfo</b>(<i>info</i>)
+
+<p>
+ Public method to show some information in the info label.
+</p>
+<dl>
+
+<dt><i>info</i> (str)</dt>
+<dd>
+informational text to be shown
+</dd>
+</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
