--- a/eric6/Documentation/Source/eric6.WebBrowser.ImageSearch.ImageSearchEngine.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.ImageSearch.ImageSearchEngine.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,134 +18,174 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.ImageSearch.ImageSearchEngine</h1> + <p> Module implementing the image search engine. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#ImageSearchEngine">ImageSearchEngine</a></td> <td>Class implementing the image search engine.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="ImageSearchEngine" ID="ImageSearchEngine"></a> <h2>ImageSearchEngine</h2> + <p> Class implementing the image search engine. </p> <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="#ImageSearchEngine.__init__">ImageSearchEngine</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#ImageSearchEngine.getSearchQuery">getSearchQuery</a></td> <td>Public method to get the image search query URL.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ImageSearchEngine.searchEngine">searchEngine</a></td> <td>Public method to get the name of the current search engine.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ImageSearchEngine.searchEngineNames">searchEngineNames</a></td> <td>Public method to get the list of supported search engines.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ImageSearchEngine.setSearchEngine">setSearchEngine</a></td> <td>Public method to set the current search engine.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="ImageSearchEngine.__init__" ID="ImageSearchEngine.__init__"></a> <h4>ImageSearchEngine (Constructor)</h4> <b>ImageSearchEngine</b>(<i>parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>parent</i> (QObject)</dt> <dd> reference to the parent object </dd> -</dl><a NAME="ImageSearchEngine.getSearchQuery" ID="ImageSearchEngine.getSearchQuery"></a> +</dl> +<a NAME="ImageSearchEngine.getSearchQuery" ID="ImageSearchEngine.getSearchQuery"></a> <h4>ImageSearchEngine.getSearchQuery</h4> <b>getSearchQuery</b>(<i>imageUrl, searchEngine=None</i>) + <p> Public method to get the image search query URL. -</p><dl> +</p> +<dl> + <dt><i>imageUrl</i> (QUrl)</dt> <dd> URL of the image to search for -</dd><dt><i>searchEngine</i> (str)</dt> +</dd> +<dt><i>searchEngine</i> (str)</dt> <dd> name of the image search engine to be used </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> search query URL </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> QUrl </dd> -</dl><a NAME="ImageSearchEngine.searchEngine" ID="ImageSearchEngine.searchEngine"></a> +</dl> +<a NAME="ImageSearchEngine.searchEngine" ID="ImageSearchEngine.searchEngine"></a> <h4>ImageSearchEngine.searchEngine</h4> <b>searchEngine</b>(<i></i>) + <p> Public method to get the name of the current search engine. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> name of the current search engine </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> -</dl><a NAME="ImageSearchEngine.searchEngineNames" ID="ImageSearchEngine.searchEngineNames"></a> +</dl> +<a NAME="ImageSearchEngine.searchEngineNames" ID="ImageSearchEngine.searchEngineNames"></a> <h4>ImageSearchEngine.searchEngineNames</h4> <b>searchEngineNames</b>(<i></i>) + <p> Public method to get the list of supported search engines. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> list of supported search engines </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> list of str </dd> -</dl><a NAME="ImageSearchEngine.setSearchEngine" ID="ImageSearchEngine.setSearchEngine"></a> +</dl> +<a NAME="ImageSearchEngine.setSearchEngine" ID="ImageSearchEngine.setSearchEngine"></a> <h4>ImageSearchEngine.setSearchEngine</h4> <b>setSearchEngine</b>(<i>searchEngine</i>) + <p> Public method to set the current search engine. -</p><dl> +</p> +<dl> + <dt><i>searchEngine</i> (str)</dt> <dd> name of the search engine