Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchManager.html	Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchManager.html	Fri Dec 22 17:24:07 2023 +0100
@@ -207,9 +207,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="OpenSearchManager.__addEngineByEngine" ID="OpenSearchManager.__addEngineByEngine"></a>
@@ -222,15 +222,21 @@
 </p>
 <dl>
 
-<dt><i>engine</i></dt>
+<dt><i>engine</i> (OpenSearchEngine)</dt>
 <dd>
-reference to an engine object (OpenSearchEngine)
+reference to an engine object
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="OpenSearchManager.__addEngineByFile" ID="OpenSearchManager.__addEngineByFile"></a>
@@ -242,16 +248,21 @@
 </p>
 <dl>
 
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
 name of a file containing the engine definition
-            (string)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="OpenSearchManager.__addEngineByUrl" ID="OpenSearchManager.__addEngineByUrl"></a>
@@ -263,15 +274,21 @@
 </p>
 <dl>
 
-<dt><i>url</i></dt>
+<dt><i>url</i> (QUrl)</dt>
 <dd>
-URL of the engine definition file (QUrl)
+URL of the engine definition file
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="OpenSearchManager.__confirmAddition" ID="OpenSearchManager.__confirmAddition"></a>
@@ -283,15 +300,21 @@
 </p>
 <dl>
 
-<dt><i>engine</i></dt>
+<dt><i>engine</i> (OpenSearchEngine)</dt>
 <dd>
-reference to the engine to be added (OpenSearchEngine)
+reference to the engine to be added
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the engine shall be added (boolean)
+flag indicating the engine shall be added
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="OpenSearchManager.__engineFromUrlAvailable" ID="OpenSearchManager.__engineFromUrlAvailable"></a>
@@ -317,17 +340,23 @@
 </p>
 <dl>
 
-<dt><i>engine</i></dt>
+<dt><i>engine</i> (str)</dt>
 <dd>
 URL of the engine definition file (QUrl) or
-            name of a file containing the engine definition (string)
+            name of a file containing the engine definition
             or reference to an engine object (OpenSearchEngine)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="OpenSearchManager.addEngineFromForm" ID="OpenSearchManager.addEngineFromForm"></a>
@@ -359,7 +388,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-sorted list of all engine names (list of strings)
+sorted list of all engine names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="OpenSearchManager.close" ID="OpenSearchManager.close"></a>
@@ -378,15 +413,21 @@
 </p>
 <dl>
 
-<dt><i>keywordSearch</i></dt>
+<dt><i>keywordSearch</i> (str)</dt>
 <dd>
-search string for keyword search (string)
+search string for keyword search
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-search URL (QUrl)
+search URL
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QUrl
 </dd>
 </dl>
 <a NAME="OpenSearchManager.currentEngine" ID="OpenSearchManager.currentEngine"></a>
@@ -399,7 +440,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the current engine (OpenSearchEngine)
+reference to the current engine
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+OpenSearchEngine
 </dd>
 </dl>
 <a NAME="OpenSearchManager.currentEngineName" ID="OpenSearchManager.currentEngineName"></a>
@@ -412,7 +459,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-name of the current search engine (string)
+name of the current search engine
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="OpenSearchManager.engine" ID="OpenSearchManager.engine"></a>
@@ -424,15 +477,21 @@
 </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>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the engine (OpenSearchEngine)
+reference to the engine
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+OpenSearchEngine
 </dd>
 </dl>
 <a NAME="OpenSearchManager.engineExists" ID="OpenSearchManager.engineExists"></a>
@@ -444,15 +503,21 @@
 </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>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating an existing engine (boolean)
+flag indicating an existing engine
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a>
@@ -464,15 +529,21 @@
 </p>
 <dl>
 
-<dt><i>keyword</i></dt>
+<dt><i>keyword</i> (str)</dt>
 <dd>
-keyword to get engine for (string)
+keyword to get engine for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the search engine object (OpenSearchEngine)
+reference to the search engine object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+OpenSearchEngine
 </dd>
 </dl>
 <a NAME="OpenSearchManager.enginesChanged" ID="OpenSearchManager.enginesChanged"></a>
@@ -493,7 +564,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-number of engines (integer)
+number of engines
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="OpenSearchManager.enginesDirectory" ID="OpenSearchManager.enginesDirectory"></a>
@@ -507,7 +584,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-directory name (string)
+directory name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="OpenSearchManager.generateEngineFileName" ID="OpenSearchManager.generateEngineFileName"></a>
@@ -519,15 +602,21 @@
 </p>
 <dl>
 
-<dt><i>engineName</i></dt>
+<dt><i>engineName</i> (str)</dt>
 <dd>
-name of the engine (string)
+name of the engine
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-valid engine file name (string)
+valid engine file name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="OpenSearchManager.keywordsForEngine" ID="OpenSearchManager.keywordsForEngine"></a>
@@ -539,15 +628,21 @@
 </p>
 <dl>
 
-<dt><i>engine</i></dt>
+<dt><i>engine</i> (OpenSearchEngine)</dt>
 <dd>
-reference to the search engine object (OpenSearchEngine)
+reference to the search engine object
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of keywords (list of strings)
+list of keywords
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="OpenSearchManager.load" ID="OpenSearchManager.load"></a>
@@ -566,15 +661,21 @@
 </p>
 <dl>
 
-<dt><i>dirName</i></dt>
+<dt><i>dirName</i> (str)</dt>
 <dd>
-name of the directory to load the files from (string)
+name of the directory to load the files from
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="OpenSearchManager.removeEngine" ID="OpenSearchManager.removeEngine"></a>
@@ -586,9 +687,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="OpenSearchManager.restoreDefaults" ID="OpenSearchManager.restoreDefaults"></a>
@@ -614,9 +715,9 @@
 </p>
 <dl>
 
-<dt><i>dirName</i></dt>
+<dt><i>dirName</i> (str)</dt>
 <dd>
-name of the directory to write the files to (string)
+name of the directory to write the files to
 </dd>
 </dl>
 <a NAME="OpenSearchManager.setCurrentEngine" ID="OpenSearchManager.setCurrentEngine"></a>
@@ -628,9 +729,9 @@
 </p>
 <dl>
 
-<dt><i>engine</i></dt>
+<dt><i>engine</i> (OpenSearchEngine)</dt>
 <dd>
-reference to the new current engine (OpenSearchEngine)
+reference to the new current engine
 </dd>
 </dl>
 <a NAME="OpenSearchManager.setCurrentEngineName" ID="OpenSearchManager.setCurrentEngineName"></a>
@@ -642,9 +743,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the new current engine (string)
+name of the new current engine
 </dd>
 </dl>
 <a NAME="OpenSearchManager.setEngineForKeyword" ID="OpenSearchManager.setEngineForKeyword"></a>
@@ -656,14 +757,14 @@
 </p>
 <dl>
 
-<dt><i>keyword</i></dt>
+<dt><i>keyword</i> (str)</dt>
 <dd>
-keyword to get engine for (string)
+keyword to get engine for
 </dd>
-<dt><i>engine</i></dt>
+<dt><i>engine</i> (OpenSearchEngine)</dt>
 <dd>
-reference to the search engine object (OpenSearchEngine)
-            or None to remove the keyword
+reference to the search engine object or None to
+            remove the keyword
 </dd>
 </dl>
 <a NAME="OpenSearchManager.setKeywordsForEngine" ID="OpenSearchManager.setKeywordsForEngine"></a>
@@ -675,13 +776,13 @@
 </p>
 <dl>
 
-<dt><i>engine</i></dt>
+<dt><i>engine</i> (OpenSearchEngine)</dt>
 <dd>
-reference to the search engine object (OpenSearchEngine)
+reference to the search engine object
 </dd>
-<dt><i>keywords</i></dt>
+<dt><i>keywords</i> (list of str)</dt>
 <dd>
-list of keywords (list of strings)
+list of keywords
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>