--- a/src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchEngine.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchEngine.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.OpenSearch.OpenSearchEngine</h1>
-
<p>
Module implementing the open search engine.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#OpenSearchEngine">OpenSearchEngine</a></td>
<td>Class implementing the open search engine.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="OpenSearchEngine" ID="OpenSearchEngine"></a>
<h2>OpenSearchEngine</h2>
-
<p>
Class implementing the open search engine.
</p>
+
<h3>Signals</h3>
<dl>
@@ -54,23 +53,20 @@
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
-
<tr>
<td><a href="#OpenSearchEngine.parseTemplate">parseTemplate</a></td>
<td>Class method to parse a search template.</td>
</tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#OpenSearchEngine.__init__">OpenSearchEngine</a></td>
<td>Constructor</td>
@@ -208,19 +204,20 @@
<td>Public method to get the search URL template of the engine.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="OpenSearchEngine.parseTemplate" ID="OpenSearchEngine.parseTemplate"></a>
<h4>OpenSearchEngine.parseTemplate (class method)</h4>
<b>parseTemplate</b>(<i>searchTerm, searchTemplate</i>)
-
<p>
Class method to parse a search template.
</p>
+
<dl>
<dt><i>searchTerm</i> (str)</dt>
@@ -247,10 +244,10 @@
<a NAME="OpenSearchEngine.__init__" ID="OpenSearchEngine.__init__"></a>
<h4>OpenSearchEngine (Constructor)</h4>
<b>OpenSearchEngine</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QObject)</dt>
@@ -261,10 +258,10 @@
<a NAME="OpenSearchEngine.__eq__" ID="OpenSearchEngine.__eq__"></a>
<h4>OpenSearchEngine.__eq__</h4>
<b>__eq__</b>(<i>other</i>)
-
<p>
Special method implementing the == operator.
</p>
+
<dl>
<dt><i>other</i> (OpenSearchEngine)</dt>
@@ -287,10 +284,10 @@
<a NAME="OpenSearchEngine.__imageObtained" ID="OpenSearchEngine.__imageObtained"></a>
<h4>OpenSearchEngine.__imageObtained</h4>
<b>__imageObtained</b>(<i>reply</i>)
-
<p>
Private slot to receive the image of the engine.
</p>
+
<dl>
<dt><i>reply</i> (QNetworkReply)</dt>
@@ -301,10 +298,10 @@
<a NAME="OpenSearchEngine.__lt__" ID="OpenSearchEngine.__lt__"></a>
<h4>OpenSearchEngine.__lt__</h4>
<b>__lt__</b>(<i>other</i>)
-
<p>
Special method implementing the < operator.
</p>
+
<dl>
<dt><i>other</i> (OpenSearchEngine)</dt>
@@ -327,17 +324,17 @@
<a NAME="OpenSearchEngine.__suggestionsObtained" ID="OpenSearchEngine.__suggestionsObtained"></a>
<h4>OpenSearchEngine.__suggestionsObtained</h4>
<b>__suggestionsObtained</b>(<i></i>)
-
<p>
Private slot to receive the suggestions.
</p>
+
<a NAME="OpenSearchEngine.description" ID="OpenSearchEngine.description"></a>
<h4>OpenSearchEngine.description</h4>
<b>description</b>(<i></i>)
-
<p>
Public method to get the description of the engine.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -353,10 +350,10 @@
<a NAME="OpenSearchEngine.image" ID="OpenSearchEngine.image"></a>
<h4>OpenSearchEngine.image</h4>
<b>image</b>(<i></i>)
-
<p>
Public method to get the image of the engine.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -372,10 +369,10 @@
<a NAME="OpenSearchEngine.imageUrl" ID="OpenSearchEngine.imageUrl"></a>
<h4>OpenSearchEngine.imageUrl</h4>
<b>imageUrl</b>(<i></i>)
-
<p>
Public method to get the image URL of the engine.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -391,10 +388,10 @@
<a NAME="OpenSearchEngine.isValid" ID="OpenSearchEngine.isValid"></a>
<h4>OpenSearchEngine.isValid</h4>
<b>isValid</b>(<i></i>)
-
<p>
Public method to check, if the engine is valid.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -410,17 +407,17 @@
<a NAME="OpenSearchEngine.loadImage" ID="OpenSearchEngine.loadImage"></a>
<h4>OpenSearchEngine.loadImage</h4>
<b>loadImage</b>(<i></i>)
-
<p>
Public method to load the image of the engine.
</p>
+
<a NAME="OpenSearchEngine.name" ID="OpenSearchEngine.name"></a>
<h4>OpenSearchEngine.name</h4>
<b>name</b>(<i></i>)
-
<p>
Public method to get the name of the engine.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -436,10 +433,10 @@
<a NAME="OpenSearchEngine.networkAccessManager" ID="OpenSearchEngine.networkAccessManager"></a>
<h4>OpenSearchEngine.networkAccessManager</h4>
<b>networkAccessManager</b>(<i></i>)
-
<p>
Public method to get a reference to the network access manager object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -455,10 +452,10 @@
<a NAME="OpenSearchEngine.providesSuggestions" ID="OpenSearchEngine.providesSuggestions"></a>
<h4>OpenSearchEngine.providesSuggestions</h4>
<b>providesSuggestions</b>(<i></i>)
-
<p>
Public method to check, if the engine provides suggestions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -474,10 +471,10 @@
<a NAME="OpenSearchEngine.requestSuggestions" ID="OpenSearchEngine.requestSuggestions"></a>
<h4>OpenSearchEngine.requestSuggestions</h4>
<b>requestSuggestions</b>(<i>searchTerm</i>)
-
<p>
Public method to request suggestions.
</p>
+
<dl>
<dt><i>searchTerm</i> (str)</dt>
@@ -488,11 +485,11 @@
<a NAME="OpenSearchEngine.searchMethod" ID="OpenSearchEngine.searchMethod"></a>
<h4>OpenSearchEngine.searchMethod</h4>
<b>searchMethod</b>(<i></i>)
-
<p>
Public method to get the HTTP request method used to perform search
requests.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -508,10 +505,10 @@
<a NAME="OpenSearchEngine.searchParameters" ID="OpenSearchEngine.searchParameters"></a>
<h4>OpenSearchEngine.searchParameters</h4>
<b>searchParameters</b>(<i></i>)
-
<p>
Public method to get the search parameters of the engine.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -527,10 +524,10 @@
<a NAME="OpenSearchEngine.searchUrl" ID="OpenSearchEngine.searchUrl"></a>
<h4>OpenSearchEngine.searchUrl</h4>
<b>searchUrl</b>(<i>searchTerm</i>)
-
<p>
Public method to get a URL ready for searching.
</p>
+
<dl>
<dt><i>searchTerm</i> (str)</dt>
@@ -553,10 +550,10 @@
<a NAME="OpenSearchEngine.searchUrlTemplate" ID="OpenSearchEngine.searchUrlTemplate"></a>
<h4>OpenSearchEngine.searchUrlTemplate</h4>
<b>searchUrlTemplate</b>(<i></i>)
-
<p>
Public method to get the search URL template of the engine.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -572,10 +569,10 @@
<a NAME="OpenSearchEngine.setDescription" ID="OpenSearchEngine.setDescription"></a>
<h4>OpenSearchEngine.setDescription</h4>
<b>setDescription</b>(<i>description</i>)
-
<p>
Public method to set the engine description.
</p>
+
<dl>
<dt><i>description</i> (str)</dt>
@@ -586,10 +583,10 @@
<a NAME="OpenSearchEngine.setImage" ID="OpenSearchEngine.setImage"></a>
<h4>OpenSearchEngine.setImage</h4>
<b>setImage</b>(<i>image</i>)
-
<p>
Public method to set the image of the engine.
</p>
+
<dl>
<dt><i>image</i> (QImage)</dt>
@@ -600,10 +597,10 @@
<a NAME="OpenSearchEngine.setImageUrl" ID="OpenSearchEngine.setImageUrl"></a>
<h4>OpenSearchEngine.setImageUrl</h4>
<b>setImageUrl</b>(<i>imageUrl</i>)
-
<p>
Public method to set the engine image URL.
</p>
+
<dl>
<dt><i>imageUrl</i> (str)</dt>
@@ -614,10 +611,10 @@
<a NAME="OpenSearchEngine.setImageUrlAndLoad" ID="OpenSearchEngine.setImageUrlAndLoad"></a>
<h4>OpenSearchEngine.setImageUrlAndLoad</h4>
<b>setImageUrlAndLoad</b>(<i>imageUrl</i>)
-
<p>
Public method to set the engine image URL.
</p>
+
<dl>
<dt><i>imageUrl</i> (str)</dt>
@@ -628,10 +625,10 @@
<a NAME="OpenSearchEngine.setName" ID="OpenSearchEngine.setName"></a>
<h4>OpenSearchEngine.setName</h4>
<b>setName</b>(<i>name</i>)
-
<p>
Public method to set the engine name.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -642,10 +639,10 @@
<a NAME="OpenSearchEngine.setNetworkAccessManager" ID="OpenSearchEngine.setNetworkAccessManager"></a>
<h4>OpenSearchEngine.setNetworkAccessManager</h4>
<b>setNetworkAccessManager</b>(<i>networkAccessManager</i>)
-
<p>
Public method to set the reference to the network access manager.
</p>
+
<dl>
<dt><i>networkAccessManager</i> (QNetworkAccessManager)</dt>
@@ -657,11 +654,11 @@
<a NAME="OpenSearchEngine.setSearchMethod" ID="OpenSearchEngine.setSearchMethod"></a>
<h4>OpenSearchEngine.setSearchMethod</h4>
<b>setSearchMethod</b>(<i>method</i>)
-
<p>
Public method to set the HTTP request method used to perform search
requests.
</p>
+
<dl>
<dt><i>method</i> (str)</dt>
@@ -672,10 +669,10 @@
<a NAME="OpenSearchEngine.setSearchParameters" ID="OpenSearchEngine.setSearchParameters"></a>
<h4>OpenSearchEngine.setSearchParameters</h4>
<b>setSearchParameters</b>(<i>searchParameters</i>)
-
<p>
Public method to set the engine search parameters.
</p>
+
<dl>
<dt><i>searchParameters</i> (list of [tuple, tuple])</dt>
@@ -686,7 +683,6 @@
<a NAME="OpenSearchEngine.setSearchUrlTemplate" ID="OpenSearchEngine.setSearchUrlTemplate"></a>
<h4>OpenSearchEngine.setSearchUrlTemplate</h4>
<b>setSearchUrlTemplate</b>(<i>searchUrlTemplate</i>)
-
<p>
Public method to set the engine search URL template.
</p>
@@ -715,6 +711,7 @@
<td>application name, QCoreApplication::applicationName()</td></tr>
</table>
</p>
+
<dl>
<dt><i>searchUrlTemplate</i> (str)</dt>
@@ -725,11 +722,11 @@
<a NAME="OpenSearchEngine.setSuggestionsMethod" ID="OpenSearchEngine.setSuggestionsMethod"></a>
<h4>OpenSearchEngine.setSuggestionsMethod</h4>
<b>setSuggestionsMethod</b>(<i>method</i>)
-
<p>
Public method to set the HTTP request method used to perform
suggestions requests.
</p>
+
<dl>
<dt><i>method</i> (str)</dt>
@@ -740,10 +737,10 @@
<a NAME="OpenSearchEngine.setSuggestionsParameters" ID="OpenSearchEngine.setSuggestionsParameters"></a>
<h4>OpenSearchEngine.setSuggestionsParameters</h4>
<b>setSuggestionsParameters</b>(<i>suggestionsParameters</i>)
-
<p>
Public method to set the engine suggestions parameters.
</p>
+
<dl>
<dt><i>suggestionsParameters</i> (list of [tuple, tuple])</dt>
@@ -754,10 +751,10 @@
<a NAME="OpenSearchEngine.setSuggestionsUrlTemplate" ID="OpenSearchEngine.setSuggestionsUrlTemplate"></a>
<h4>OpenSearchEngine.setSuggestionsUrlTemplate</h4>
<b>setSuggestionsUrlTemplate</b>(<i>suggestionsUrlTemplate</i>)
-
<p>
Public method to set the engine suggestions URL template.
</p>
+
<dl>
<dt><i>suggestionsUrlTemplate</i> (str)</dt>
@@ -769,11 +766,11 @@
<a NAME="OpenSearchEngine.suggestionsMethod" ID="OpenSearchEngine.suggestionsMethod"></a>
<h4>OpenSearchEngine.suggestionsMethod</h4>
<b>suggestionsMethod</b>(<i></i>)
-
<p>
Public method to get the HTTP request method used to perform
suggestions requests.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -789,10 +786,10 @@
<a NAME="OpenSearchEngine.suggestionsParameters" ID="OpenSearchEngine.suggestionsParameters"></a>
<h4>OpenSearchEngine.suggestionsParameters</h4>
<b>suggestionsParameters</b>(<i></i>)
-
<p>
Public method to get the suggestions parameters of the engine.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -808,10 +805,10 @@
<a NAME="OpenSearchEngine.suggestionsUrl" ID="OpenSearchEngine.suggestionsUrl"></a>
<h4>OpenSearchEngine.suggestionsUrl</h4>
<b>suggestionsUrl</b>(<i>searchTerm</i>)
-
<p>
Public method to get a URL ready for suggestions.
</p>
+
<dl>
<dt><i>searchTerm</i> (str)</dt>
@@ -834,10 +831,10 @@
<a NAME="OpenSearchEngine.suggestionsUrlTemplate" ID="OpenSearchEngine.suggestionsUrlTemplate"></a>
<h4>OpenSearchEngine.suggestionsUrlTemplate</h4>
<b>suggestionsUrlTemplate</b>(<i></i>)
-
<p>
Public method to get the search URL template of the engine.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -852,4 +849,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
