src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchEngine.html

branch
eric7
changeset 10436
f6881d10e995
parent 9209
b99e7fd55fd3
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchEngine.html	Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchEngine.html	Fri Dec 22 17:24:07 2023 +0100
@@ -223,19 +223,25 @@
 </p>
 <dl>
 
-<dt><i>searchTerm</i></dt>
+<dt><i>searchTerm</i> (str)</dt>
 <dd>
-term to search for (string)
+term to search for
 </dd>
-<dt><i>searchTemplate</i></dt>
+<dt><i>searchTemplate</i> (str)</dt>
 <dd>
-template to be parsed (string)
+template to be parsed
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-parsed template (string)
+parsed template
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.__init__" ID="OpenSearchEngine.__init__"></a>
@@ -247,9 +253,9 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QObject)</dt>
 <dd>
-reference to the parent object (QObject)
+reference to the parent object
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.__eq__" ID="OpenSearchEngine.__eq__"></a>
@@ -261,15 +267,21 @@
 </p>
 <dl>
 
-<dt><i>other</i></dt>
+<dt><i>other</i> (OpenSearchEngine)</dt>
 <dd>
-reference to an open search engine (OpenSearchEngine)
+reference to an open search engine
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating equality (boolean)
+flag indicating equality
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.__imageObtained" ID="OpenSearchEngine.__imageObtained"></a>
@@ -295,15 +307,21 @@
 </p>
 <dl>
 
-<dt><i>other</i></dt>
+<dt><i>other</i> (OpenSearchEngine)</dt>
 <dd>
-reference to an open search engine (OpenSearchEngine)
+reference to an open search engine
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating less than (boolean)
+flag indicating less than
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.__suggestionsObtained" ID="OpenSearchEngine.__suggestionsObtained"></a>
@@ -323,7 +341,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-description of the engine (string)
+description of the engine
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.image" ID="OpenSearchEngine.image"></a>
@@ -336,7 +360,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-image of the engine (QImage)
+image of the engine
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QImage
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.imageUrl" ID="OpenSearchEngine.imageUrl"></a>
@@ -349,7 +379,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-image URL of the engine (string)
+image URL of the engine
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.isValid" ID="OpenSearchEngine.isValid"></a>
@@ -362,7 +398,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating validity (boolean)
+flag indicating validity
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.loadImage" ID="OpenSearchEngine.loadImage"></a>
@@ -382,7 +424,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-name of the engine (string)
+name of the engine
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.networkAccessManager" ID="OpenSearchEngine.networkAccessManager"></a>
@@ -396,7 +444,12 @@
 <dt>Return:</dt>
 <dd>
 reference to the network access manager object
-            (QNetworkAccessManager)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QNetworkAccessManager
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.providesSuggestions" ID="OpenSearchEngine.providesSuggestions"></a>
@@ -409,7 +462,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating suggestions are provided (boolean)
+flag indicating suggestions are provided
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.requestSuggestions" ID="OpenSearchEngine.requestSuggestions"></a>
@@ -421,9 +480,9 @@
 </p>
 <dl>
 
-<dt><i>searchTerm</i></dt>
+<dt><i>searchTerm</i> (str)</dt>
 <dd>
-term to get suggestions for (string)
+term to get suggestions for
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.searchMethod" ID="OpenSearchEngine.searchMethod"></a>
@@ -437,7 +496,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-HTTP request method (string)
+HTTP request method
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.searchParameters" ID="OpenSearchEngine.searchParameters"></a>
@@ -450,7 +515,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-search parameters of the engine (list of two tuples)
+search parameters of the engine
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of [tuple, tuple]
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.searchUrl" ID="OpenSearchEngine.searchUrl"></a>
@@ -462,15 +533,21 @@
 </p>
 <dl>
 
-<dt><i>searchTerm</i></dt>
+<dt><i>searchTerm</i> (str)</dt>
 <dd>
-term to search for (string)
+term to search for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-URL (QUrl)
+URL
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QUrl
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.searchUrlTemplate" ID="OpenSearchEngine.searchUrlTemplate"></a>
@@ -483,7 +560,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-search URL template of the engine (string)
+search URL template of the engine
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.setDescription" ID="OpenSearchEngine.setDescription"></a>
@@ -495,9 +578,9 @@
 </p>
 <dl>
 
-<dt><i>description</i></dt>
+<dt><i>description</i> (str)</dt>
 <dd>
-description of the engine (string)
+description of the engine
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.setImage" ID="OpenSearchEngine.setImage"></a>
@@ -509,9 +592,9 @@
 </p>
 <dl>
 
-<dt><i>image</i></dt>
+<dt><i>image</i> (QImage)</dt>
 <dd>
-image to be set (QImage)
+image to be set
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.setImageUrl" ID="OpenSearchEngine.setImageUrl"></a>
@@ -523,9 +606,9 @@
 </p>
 <dl>
 
-<dt><i>imageUrl</i></dt>
+<dt><i>imageUrl</i> (str)</dt>
 <dd>
-image URL of the engine (string)
+image URL of the engine
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.setImageUrlAndLoad" ID="OpenSearchEngine.setImageUrlAndLoad"></a>
@@ -537,9 +620,9 @@
 </p>
 <dl>
 
-<dt><i>imageUrl</i></dt>
+<dt><i>imageUrl</i> (str)</dt>
 <dd>
-image URL of the engine (string)
+image URL of the engine
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.setName" ID="OpenSearchEngine.setName"></a>
@@ -551,9 +634,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the engine (string)
+name of the engine
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.setNetworkAccessManager" ID="OpenSearchEngine.setNetworkAccessManager"></a>
@@ -565,10 +648,10 @@
 </p>
 <dl>
 
-<dt><i>networkAccessManager</i></dt>
+<dt><i>networkAccessManager</i> (QNetworkAccessManager)</dt>
 <dd>
 reference to the network access manager
-            object (QNetworkAccessManager)
+            object
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.setSearchMethod" ID="OpenSearchEngine.setSearchMethod"></a>
@@ -581,9 +664,9 @@
 </p>
 <dl>
 
-<dt><i>method</i></dt>
+<dt><i>method</i> (str)</dt>
 <dd>
-HTTP request method (string)
+HTTP request method
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.setSearchParameters" ID="OpenSearchEngine.setSearchParameters"></a>
@@ -595,10 +678,9 @@
 </p>
 <dl>
 
-<dt><i>searchParameters</i></dt>
+<dt><i>searchParameters</i> (list of [tuple, tuple])</dt>
 <dd>
 search parameters of the engine
-            (list of two tuples)
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.setSearchUrlTemplate" ID="OpenSearchEngine.setSearchUrlTemplate"></a>
@@ -635,9 +717,9 @@
 </p>
 <dl>
 
-<dt><i>searchUrlTemplate</i></dt>
+<dt><i>searchUrlTemplate</i> (str)</dt>
 <dd>
-search URL template of the engine (string)
+search URL template of the engine
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.setSuggestionsMethod" ID="OpenSearchEngine.setSuggestionsMethod"></a>
@@ -650,9 +732,9 @@
 </p>
 <dl>
 
-<dt><i>method</i></dt>
+<dt><i>method</i> (str)</dt>
 <dd>
-HTTP request method (string)
+HTTP request method
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.setSuggestionsParameters" ID="OpenSearchEngine.setSuggestionsParameters"></a>
@@ -664,10 +746,9 @@
 </p>
 <dl>
 
-<dt><i>suggestionsParameters</i></dt>
+<dt><i>suggestionsParameters</i> (list of [tuple, tuple])</dt>
 <dd>
-suggestions parameters of the
-            engine (list of two tuples)
+suggestions parameters of the engine
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.setSuggestionsUrlTemplate" ID="OpenSearchEngine.setSuggestionsUrlTemplate"></a>
@@ -679,10 +760,10 @@
 </p>
 <dl>
 
-<dt><i>suggestionsUrlTemplate</i></dt>
+<dt><i>suggestionsUrlTemplate</i> (str)</dt>
 <dd>
 suggestions URL template of the
-            engine (string)
+            engine
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.suggestionsMethod" ID="OpenSearchEngine.suggestionsMethod"></a>
@@ -696,7 +777,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-HTTP request method (string)
+HTTP request method
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.suggestionsParameters" ID="OpenSearchEngine.suggestionsParameters"></a>
@@ -709,7 +796,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-suggestions parameters of the engine (list of two tuples)
+suggestions parameters of the engine
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of [tuple, tuple]
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.suggestionsUrl" ID="OpenSearchEngine.suggestionsUrl"></a>
@@ -721,15 +814,21 @@
 </p>
 <dl>
 
-<dt><i>searchTerm</i></dt>
+<dt><i>searchTerm</i> (str)</dt>
 <dd>
-term to search for (string)
+term to search for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-URL (QUrl)
+URL
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QUrl
 </dd>
 </dl>
 <a NAME="OpenSearchEngine.suggestionsUrlTemplate" ID="OpenSearchEngine.suggestionsUrlTemplate"></a>
@@ -742,7 +841,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-search URL template of the engine (string)
+search URL template of the engine
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial