|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.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> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric7.WebBrowser.ImageSearch.ImageSearchEngine</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing the image search engine. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#ImageSearchEngine">ImageSearchEngine</a></td> |
|
39 <td>Class implementing the image search engine.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
|
49 <a NAME="ImageSearchEngine" ID="ImageSearchEngine"></a> |
|
50 <h2>ImageSearchEngine</h2> |
|
51 |
|
52 <p> |
|
53 Class implementing the image search engine. |
|
54 </p> |
|
55 <h3>Derived from</h3> |
|
56 QObject |
|
57 <h3>Class Attributes</h3> |
|
58 |
|
59 <table> |
|
60 <tr><td>None</td></tr> |
|
61 </table> |
|
62 <h3>Class Methods</h3> |
|
63 |
|
64 <table> |
|
65 <tr><td>None</td></tr> |
|
66 </table> |
|
67 <h3>Methods</h3> |
|
68 |
|
69 <table> |
|
70 |
|
71 <tr> |
|
72 <td><a href="#ImageSearchEngine.__init__">ImageSearchEngine</a></td> |
|
73 <td>Constructor</td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td><a href="#ImageSearchEngine.getSearchQuery">getSearchQuery</a></td> |
|
77 <td>Public method to get the image search query URL.</td> |
|
78 </tr> |
|
79 <tr> |
|
80 <td><a href="#ImageSearchEngine.searchEngine">searchEngine</a></td> |
|
81 <td>Public method to get the name of the current search engine.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#ImageSearchEngine.searchEngineNames">searchEngineNames</a></td> |
|
85 <td>Public method to get the list of supported search engines.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#ImageSearchEngine.setSearchEngine">setSearchEngine</a></td> |
|
89 <td>Public method to set the current search engine.</td> |
|
90 </tr> |
|
91 </table> |
|
92 <h3>Static Methods</h3> |
|
93 |
|
94 <table> |
|
95 <tr><td>None</td></tr> |
|
96 </table> |
|
97 |
|
98 <a NAME="ImageSearchEngine.__init__" ID="ImageSearchEngine.__init__"></a> |
|
99 <h4>ImageSearchEngine (Constructor)</h4> |
|
100 <b>ImageSearchEngine</b>(<i>parent=None</i>) |
|
101 |
|
102 <p> |
|
103 Constructor |
|
104 </p> |
|
105 <dl> |
|
106 |
|
107 <dt><i>parent</i> (QObject)</dt> |
|
108 <dd> |
|
109 reference to the parent object |
|
110 </dd> |
|
111 </dl> |
|
112 <a NAME="ImageSearchEngine.getSearchQuery" ID="ImageSearchEngine.getSearchQuery"></a> |
|
113 <h4>ImageSearchEngine.getSearchQuery</h4> |
|
114 <b>getSearchQuery</b>(<i>imageUrl, searchEngine=None</i>) |
|
115 |
|
116 <p> |
|
117 Public method to get the image search query URL. |
|
118 </p> |
|
119 <dl> |
|
120 |
|
121 <dt><i>imageUrl</i> (QUrl)</dt> |
|
122 <dd> |
|
123 URL of the image to search for |
|
124 </dd> |
|
125 <dt><i>searchEngine</i> (str)</dt> |
|
126 <dd> |
|
127 name of the image search engine to be used |
|
128 </dd> |
|
129 </dl> |
|
130 <dl> |
|
131 <dt>Return:</dt> |
|
132 <dd> |
|
133 search query URL |
|
134 </dd> |
|
135 </dl> |
|
136 <dl> |
|
137 <dt>Return Type:</dt> |
|
138 <dd> |
|
139 QUrl |
|
140 </dd> |
|
141 </dl> |
|
142 <a NAME="ImageSearchEngine.searchEngine" ID="ImageSearchEngine.searchEngine"></a> |
|
143 <h4>ImageSearchEngine.searchEngine</h4> |
|
144 <b>searchEngine</b>(<i></i>) |
|
145 |
|
146 <p> |
|
147 Public method to get the name of the current search engine. |
|
148 </p> |
|
149 <dl> |
|
150 <dt>Return:</dt> |
|
151 <dd> |
|
152 name of the current search engine |
|
153 </dd> |
|
154 </dl> |
|
155 <dl> |
|
156 <dt>Return Type:</dt> |
|
157 <dd> |
|
158 str |
|
159 </dd> |
|
160 </dl> |
|
161 <a NAME="ImageSearchEngine.searchEngineNames" ID="ImageSearchEngine.searchEngineNames"></a> |
|
162 <h4>ImageSearchEngine.searchEngineNames</h4> |
|
163 <b>searchEngineNames</b>(<i></i>) |
|
164 |
|
165 <p> |
|
166 Public method to get the list of supported search engines. |
|
167 </p> |
|
168 <dl> |
|
169 <dt>Return:</dt> |
|
170 <dd> |
|
171 list of supported search engines |
|
172 </dd> |
|
173 </dl> |
|
174 <dl> |
|
175 <dt>Return Type:</dt> |
|
176 <dd> |
|
177 list of str |
|
178 </dd> |
|
179 </dl> |
|
180 <a NAME="ImageSearchEngine.setSearchEngine" ID="ImageSearchEngine.setSearchEngine"></a> |
|
181 <h4>ImageSearchEngine.setSearchEngine</h4> |
|
182 <b>setSearchEngine</b>(<i>searchEngine</i>) |
|
183 |
|
184 <p> |
|
185 Public method to set the current search engine. |
|
186 </p> |
|
187 <dl> |
|
188 |
|
189 <dt><i>searchEngine</i> (str)</dt> |
|
190 <dd> |
|
191 name of the search engine |
|
192 </dd> |
|
193 </dl> |
|
194 <div align="right"><a href="#top">Up</a></div> |
|
195 <hr /> |
|
196 </body></html> |