|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.WebBrowser.ImageSearch.ImageSearchEngine</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.WebBrowser.ImageSearch.ImageSearchEngine</h1> |
|
23 <p> |
|
24 Module implementing the image search engine. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#ImageSearchEngine">ImageSearchEngine</a></td> |
|
34 <td>Class implementing the image search engine.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="ImageSearchEngine" ID="ImageSearchEngine"></a> |
|
43 <h2>ImageSearchEngine</h2> |
|
44 <p> |
|
45 Class implementing the image search engine. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QObject |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#ImageSearchEngine.__init__">ImageSearchEngine</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#ImageSearchEngine.getSearchQuery">getSearchQuery</a></td> |
|
64 <td>Public method to get the image search query URL.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#ImageSearchEngine.searchEngine">searchEngine</a></td> |
|
67 <td>Public method to get the name of the current search engine.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#ImageSearchEngine.searchEngineNames">searchEngineNames</a></td> |
|
70 <td>Public method to get the list of supported search engines.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#ImageSearchEngine.setSearchEngine">setSearchEngine</a></td> |
|
73 <td>Public method to set the current search engine.</td> |
|
74 </tr> |
|
75 </table> |
|
76 <h3>Static Methods</h3> |
|
77 <table> |
|
78 <tr><td>None</td></tr> |
|
79 </table> |
|
80 <a NAME="ImageSearchEngine.__init__" ID="ImageSearchEngine.__init__"></a> |
|
81 <h4>ImageSearchEngine (Constructor)</h4> |
|
82 <b>ImageSearchEngine</b>(<i>parent=None</i>) |
|
83 <p> |
|
84 Constructor |
|
85 </p><dl> |
|
86 <dt><i>parent</i> (QObject)</dt> |
|
87 <dd> |
|
88 reference to the parent object |
|
89 </dd> |
|
90 </dl><a NAME="ImageSearchEngine.getSearchQuery" ID="ImageSearchEngine.getSearchQuery"></a> |
|
91 <h4>ImageSearchEngine.getSearchQuery</h4> |
|
92 <b>getSearchQuery</b>(<i>imageUrl, searchEngine=None</i>) |
|
93 <p> |
|
94 Public method to get the image search query URL. |
|
95 </p><dl> |
|
96 <dt><i>imageUrl</i> (QUrl)</dt> |
|
97 <dd> |
|
98 URL of the image to search for |
|
99 </dd><dt><i>searchEngine</i> (str)</dt> |
|
100 <dd> |
|
101 name of the image search engine to be used |
|
102 </dd> |
|
103 </dl><dl> |
|
104 <dt>Returns:</dt> |
|
105 <dd> |
|
106 search query URL |
|
107 </dd> |
|
108 </dl><dl> |
|
109 <dt>Return Type:</dt> |
|
110 <dd> |
|
111 QUrl |
|
112 </dd> |
|
113 </dl><a NAME="ImageSearchEngine.searchEngine" ID="ImageSearchEngine.searchEngine"></a> |
|
114 <h4>ImageSearchEngine.searchEngine</h4> |
|
115 <b>searchEngine</b>(<i></i>) |
|
116 <p> |
|
117 Public method to get the name of the current search engine. |
|
118 </p><dl> |
|
119 <dt>Returns:</dt> |
|
120 <dd> |
|
121 name of the current search engine |
|
122 </dd> |
|
123 </dl><dl> |
|
124 <dt>Return Type:</dt> |
|
125 <dd> |
|
126 str |
|
127 </dd> |
|
128 </dl><a NAME="ImageSearchEngine.searchEngineNames" ID="ImageSearchEngine.searchEngineNames"></a> |
|
129 <h4>ImageSearchEngine.searchEngineNames</h4> |
|
130 <b>searchEngineNames</b>(<i></i>) |
|
131 <p> |
|
132 Public method to get the list of supported search engines. |
|
133 </p><dl> |
|
134 <dt>Returns:</dt> |
|
135 <dd> |
|
136 list of supported search engines |
|
137 </dd> |
|
138 </dl><dl> |
|
139 <dt>Return Type:</dt> |
|
140 <dd> |
|
141 list of str |
|
142 </dd> |
|
143 </dl><a NAME="ImageSearchEngine.setSearchEngine" ID="ImageSearchEngine.setSearchEngine"></a> |
|
144 <h4>ImageSearchEngine.setSearchEngine</h4> |
|
145 <b>setSearchEngine</b>(<i>searchEngine</i>) |
|
146 <p> |
|
147 Public method to set the current search engine. |
|
148 </p><dl> |
|
149 <dt><i>searchEngine</i> (str)</dt> |
|
150 <dd> |
|
151 name of the search engine |
|
152 </dd> |
|
153 </dl> |
|
154 <div align="right"><a href="#top">Up</a></div> |
|
155 <hr /> |
|
156 </body></html> |