--- a/src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchManager.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchManager.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.OpenSearch.OpenSearchManager</h1>
-
<p>
Module implementing a manager for open search engines.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#OpenSearchManager">OpenSearchManager</a></td>
<td>Class implementing a manager for open search engines.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="OpenSearchManager" ID="OpenSearchManager"></a>
<h2>OpenSearchManager</h2>
-
<p>
Class implementing a manager for open search engines.
</p>
+
<h3>Signals</h3>
<dl>
@@ -54,19 +53,17 @@
<h3>Derived from</h3>
QObject
<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="#OpenSearchManager.__init__">OpenSearchManager</a></td>
<td>Constructor</td>
@@ -192,19 +189,20 @@
<td>Public method to set the keywords for an engine.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="OpenSearchManager.__init__" ID="OpenSearchManager.__init__"></a>
<h4>OpenSearchManager (Constructor)</h4>
<b>OpenSearchManager</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QObject)</dt>
@@ -215,11 +213,11 @@
<a NAME="OpenSearchManager.__addEngineByEngine" ID="OpenSearchManager.__addEngineByEngine"></a>
<h4>OpenSearchManager.__addEngineByEngine</h4>
<b>__addEngineByEngine</b>(<i>engine</i>)
-
<p>
Private method to add a new search engine given a reference to an
engine.
</p>
+
<dl>
<dt><i>engine</i> (OpenSearchEngine)</dt>
@@ -242,10 +240,10 @@
<a NAME="OpenSearchManager.__addEngineByFile" ID="OpenSearchManager.__addEngineByFile"></a>
<h4>OpenSearchManager.__addEngineByFile</h4>
<b>__addEngineByFile</b>(<i>filename</i>)
-
<p>
Private method to add a new search engine given a filename.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -268,10 +266,10 @@
<a NAME="OpenSearchManager.__addEngineByUrl" ID="OpenSearchManager.__addEngineByUrl"></a>
<h4>OpenSearchManager.__addEngineByUrl</h4>
<b>__addEngineByUrl</b>(<i>url</i>)
-
<p>
Private method to add a new search engine given its URL.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -294,10 +292,10 @@
<a NAME="OpenSearchManager.__confirmAddition" ID="OpenSearchManager.__confirmAddition"></a>
<h4>OpenSearchManager.__confirmAddition</h4>
<b>__confirmAddition</b>(<i>engine</i>)
-
<p>
Private method to confirm the addition of a new search engine.
</p>
+
<dl>
<dt><i>engine</i> (OpenSearchEngine)</dt>
@@ -320,10 +318,10 @@
<a NAME="OpenSearchManager.__engineFromUrlAvailable" ID="OpenSearchManager.__engineFromUrlAvailable"></a>
<h4>OpenSearchManager.__engineFromUrlAvailable</h4>
<b>__engineFromUrlAvailable</b>(<i>reply</i>)
-
<p>
Private slot to add a search engine from the net.
</p>
+
<dl>
<dt><i>reply</i> (QNetworkReply)</dt>
@@ -334,10 +332,10 @@
<a NAME="OpenSearchManager.addEngine" ID="OpenSearchManager.addEngine"></a>
<h4>OpenSearchManager.addEngine</h4>
<b>addEngine</b>(<i>engine</i>)
-
<p>
Public method to add a new search engine.
</p>
+
<dl>
<dt><i>engine</i> (str)</dt>
@@ -362,10 +360,10 @@
<a NAME="OpenSearchManager.addEngineFromForm" ID="OpenSearchManager.addEngineFromForm"></a>
<h4>OpenSearchManager.addEngineFromForm</h4>
<b>addEngineFromForm</b>(<i>res, view</i>)
-
<p>
Public method to add a new search engine from a form.
</p>
+
<dl>
<dt><i>res</i> (dict or None)</dt>
@@ -381,10 +379,10 @@
<a NAME="OpenSearchManager.allEnginesNames" ID="OpenSearchManager.allEnginesNames"></a>
<h4>OpenSearchManager.allEnginesNames</h4>
<b>allEnginesNames</b>(<i></i>)
-
<p>
Public method to get a list of all engine names.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -400,17 +398,17 @@
<a NAME="OpenSearchManager.close" ID="OpenSearchManager.close"></a>
<h4>OpenSearchManager.close</h4>
<b>close</b>(<i></i>)
-
<p>
Public method to close the open search engines manager.
</p>
+
<a NAME="OpenSearchManager.convertKeywordSearchToUrl" ID="OpenSearchManager.convertKeywordSearchToUrl"></a>
<h4>OpenSearchManager.convertKeywordSearchToUrl</h4>
<b>convertKeywordSearchToUrl</b>(<i>keywordSearch</i>)
-
<p>
Public method to get the search URL for a keyword search.
</p>
+
<dl>
<dt><i>keywordSearch</i> (str)</dt>
@@ -433,10 +431,10 @@
<a NAME="OpenSearchManager.currentEngine" ID="OpenSearchManager.currentEngine"></a>
<h4>OpenSearchManager.currentEngine</h4>
<b>currentEngine</b>(<i></i>)
-
<p>
Public method to get a reference to the current engine.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -452,10 +450,10 @@
<a NAME="OpenSearchManager.currentEngineName" ID="OpenSearchManager.currentEngineName"></a>
<h4>OpenSearchManager.currentEngineName</h4>
<b>currentEngineName</b>(<i></i>)
-
<p>
Public method to get the name of the current search engine.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -471,10 +469,10 @@
<a NAME="OpenSearchManager.engine" ID="OpenSearchManager.engine"></a>
<h4>OpenSearchManager.engine</h4>
<b>engine</b>(<i>name</i>)
-
<p>
Public method to get a reference to the named engine.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -497,10 +495,10 @@
<a NAME="OpenSearchManager.engineExists" ID="OpenSearchManager.engineExists"></a>
<h4>OpenSearchManager.engineExists</h4>
<b>engineExists</b>(<i>name</i>)
-
<p>
Public method to check, if an engine exists.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -523,10 +521,10 @@
<a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a>
<h4>OpenSearchManager.engineForKeyword</h4>
<b>engineForKeyword</b>(<i>keyword</i>)
-
<p>
Public method to get the engine for a keyword.
</p>
+
<dl>
<dt><i>keyword</i> (str)</dt>
@@ -549,18 +547,18 @@
<a NAME="OpenSearchManager.enginesChanged" ID="OpenSearchManager.enginesChanged"></a>
<h4>OpenSearchManager.enginesChanged</h4>
<b>enginesChanged</b>(<i></i>)
-
<p>
Public slot to tell the search engine manager, that something has
changed.
</p>
+
<a NAME="OpenSearchManager.enginesCount" ID="OpenSearchManager.enginesCount"></a>
<h4>OpenSearchManager.enginesCount</h4>
<b>enginesCount</b>(<i></i>)
-
<p>
Public method to get the number of available engines.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -576,11 +574,11 @@
<a NAME="OpenSearchManager.enginesDirectory" ID="OpenSearchManager.enginesDirectory"></a>
<h4>OpenSearchManager.enginesDirectory</h4>
<b>enginesDirectory</b>(<i></i>)
-
<p>
Public method to determine the directory containing the search engine
descriptions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -596,10 +594,10 @@
<a NAME="OpenSearchManager.generateEngineFileName" ID="OpenSearchManager.generateEngineFileName"></a>
<h4>OpenSearchManager.generateEngineFileName</h4>
<b>generateEngineFileName</b>(<i>engineName</i>)
-
<p>
Public method to generate a valid engine file name.
</p>
+
<dl>
<dt><i>engineName</i> (str)</dt>
@@ -622,10 +620,10 @@
<a NAME="OpenSearchManager.keywordsForEngine" ID="OpenSearchManager.keywordsForEngine"></a>
<h4>OpenSearchManager.keywordsForEngine</h4>
<b>keywordsForEngine</b>(<i>engine</i>)
-
<p>
Public method to get the keywords for a given engine.
</p>
+
<dl>
<dt><i>engine</i> (OpenSearchEngine)</dt>
@@ -648,17 +646,17 @@
<a NAME="OpenSearchManager.load" ID="OpenSearchManager.load"></a>
<h4>OpenSearchManager.load</h4>
<b>load</b>(<i></i>)
-
<p>
Public method to load the search engines configuration.
</p>
+
<a NAME="OpenSearchManager.loadDirectory" ID="OpenSearchManager.loadDirectory"></a>
<h4>OpenSearchManager.loadDirectory</h4>
<b>loadDirectory</b>(<i>dirName</i>)
-
<p>
Public method to load the search engine definitions from files.
</p>
+
<dl>
<dt><i>dirName</i> (str)</dt>
@@ -681,10 +679,10 @@
<a NAME="OpenSearchManager.removeEngine" ID="OpenSearchManager.removeEngine"></a>
<h4>OpenSearchManager.removeEngine</h4>
<b>removeEngine</b>(<i>name</i>)
-
<p>
Public method to remove an engine.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -695,24 +693,24 @@
<a NAME="OpenSearchManager.restoreDefaults" ID="OpenSearchManager.restoreDefaults"></a>
<h4>OpenSearchManager.restoreDefaults</h4>
<b>restoreDefaults</b>(<i></i>)
-
<p>
Public method to restore the default search engines.
</p>
+
<a NAME="OpenSearchManager.save" ID="OpenSearchManager.save"></a>
<h4>OpenSearchManager.save</h4>
<b>save</b>(<i></i>)
-
<p>
Public method to save the search engines configuration.
</p>
+
<a NAME="OpenSearchManager.saveDirectory" ID="OpenSearchManager.saveDirectory"></a>
<h4>OpenSearchManager.saveDirectory</h4>
<b>saveDirectory</b>(<i>dirName</i>)
-
<p>
Public method to save the search engine definitions to files.
</p>
+
<dl>
<dt><i>dirName</i> (str)</dt>
@@ -723,10 +721,10 @@
<a NAME="OpenSearchManager.setCurrentEngine" ID="OpenSearchManager.setCurrentEngine"></a>
<h4>OpenSearchManager.setCurrentEngine</h4>
<b>setCurrentEngine</b>(<i>engine</i>)
-
<p>
Public method to set the current engine.
</p>
+
<dl>
<dt><i>engine</i> (OpenSearchEngine)</dt>
@@ -737,10 +735,10 @@
<a NAME="OpenSearchManager.setCurrentEngineName" ID="OpenSearchManager.setCurrentEngineName"></a>
<h4>OpenSearchManager.setCurrentEngineName</h4>
<b>setCurrentEngineName</b>(<i>name</i>)
-
<p>
Public method to set the current engine by name.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -751,10 +749,10 @@
<a NAME="OpenSearchManager.setEngineForKeyword" ID="OpenSearchManager.setEngineForKeyword"></a>
<h4>OpenSearchManager.setEngineForKeyword</h4>
<b>setEngineForKeyword</b>(<i>keyword, engine</i>)
-
<p>
Public method to set the engine for a keyword.
</p>
+
<dl>
<dt><i>keyword</i> (str)</dt>
@@ -770,10 +768,10 @@
<a NAME="OpenSearchManager.setKeywordsForEngine" ID="OpenSearchManager.setKeywordsForEngine"></a>
<h4>OpenSearchManager.setKeywordsForEngine</h4>
<b>setKeywordsForEngine</b>(<i>engine, keywords</i>)
-
<p>
Public method to set the keywords for an engine.
</p>
+
<dl>
<dt><i>engine</i> (OpenSearchEngine)</dt>
@@ -787,4 +785,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
