Documentation/Source/eric6.WebBrowser.ImageSearch.ImageSearchEngine.html

changeset 4956
1496516b0f2c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.WebBrowser.ImageSearch.ImageSearchEngine.html	Wed Apr 27 19:44:22 2016 +0200
@@ -0,0 +1,156 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.WebBrowser.ImageSearch.ImageSearchEngine</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<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 />
+<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>
+<td><a href="#ImageSearchEngine.getSearchQuery">getSearchQuery</a></td>
+<td>Public method to get the image search query URL.</td>
+</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>
+<td><a href="#ImageSearchEngine.searchEngineNames">searchEngineNames</a></td>
+<td>Public method to get the list of supported search engines.</td>
+</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>
+<dt><i>parent</i> (QObject)</dt>
+<dd>
+reference to the parent object
+</dd>
+</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>
+<dt><i>imageUrl</i> (QUrl)</dt>
+<dd>
+URL of the image to search for
+</dd><dt><i>searchEngine</i> (str)</dt>
+<dd>
+name of the image search engine to be used
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+search query URL
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+QUrl
+</dd>
+</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>
+<dt>Returns:</dt>
+<dd>
+name of the current search engine
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</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>
+<dt>Returns:</dt>
+<dd>
+list of supported search engines
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</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>
+<dt><i>searchEngine</i> (str)</dt>
+<dd>
+name of the search engine
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial