16 |
16 |
17 a { color: #BA6D36; } |
17 a { color: #BA6D36; } |
18 |
18 |
19 </style> |
19 </style> |
20 </head> |
20 </head> |
21 <body><a NAME="top" ID="top"></a> |
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
22 <h1>eric6.WebBrowser.OpenSearch.OpenSearchEngine</h1> |
23 <h1>eric6.WebBrowser.OpenSearch.OpenSearchEngine</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing the open search engine. |
26 Module implementing the open search engine. |
25 </p> |
27 </p> |
26 <h3>Global Attributes</h3> |
28 <h3>Global Attributes</h3> |
|
29 |
27 <table> |
30 <table> |
28 <tr><td>None</td></tr> |
31 <tr><td>None</td></tr> |
29 </table> |
32 </table> |
30 <h3>Classes</h3> |
33 <h3>Classes</h3> |
|
34 |
31 <table> |
35 <table> |
|
36 |
32 <tr> |
37 <tr> |
33 <td><a href="#OpenSearchEngine">OpenSearchEngine</a></td> |
38 <td><a href="#OpenSearchEngine">OpenSearchEngine</a></td> |
34 <td>Class implementing the open search engine.</td> |
39 <td>Class implementing the open search engine.</td> |
35 </tr> |
40 </tr> |
36 </table> |
41 </table> |
37 <h3>Functions</h3> |
42 <h3>Functions</h3> |
|
43 |
38 <table> |
44 <table> |
39 <tr><td>None</td></tr> |
45 <tr><td>None</td></tr> |
40 </table> |
46 </table> |
41 <hr /><hr /> |
47 <hr /> |
|
48 <hr /> |
42 <a NAME="OpenSearchEngine" ID="OpenSearchEngine"></a> |
49 <a NAME="OpenSearchEngine" ID="OpenSearchEngine"></a> |
43 <h2>OpenSearchEngine</h2> |
50 <h2>OpenSearchEngine</h2> |
|
51 |
44 <p> |
52 <p> |
45 Class implementing the open search engine. |
53 Class implementing the open search engine. |
46 </p><h3>Signals</h3> |
54 </p> |
47 <dl> |
55 <h3>Signals</h3> |
|
56 <dl> |
|
57 |
48 <dt>imageChanged()</dt> |
58 <dt>imageChanged()</dt> |
49 <dd> |
59 <dd> |
50 emitted after the icon has been changed |
60 emitted after the icon has been changed |
51 </dd><dt>suggestions(list of strings)</dt> |
61 </dd> |
|
62 <dt>suggestions(list of strings)</dt> |
52 <dd> |
63 <dd> |
53 emitted after the suggestions have |
64 emitted after the suggestions have |
54 been received |
65 been received |
55 </dd> |
66 </dd> |
56 </dl> |
67 </dl> |
57 <h3>Derived from</h3> |
68 <h3>Derived from</h3> |
58 QObject |
69 QObject |
59 <h3>Class Attributes</h3> |
70 <h3>Class Attributes</h3> |
|
71 |
60 <table> |
72 <table> |
61 <tr><td>None</td></tr> |
73 <tr><td>None</td></tr> |
62 </table> |
74 </table> |
63 <h3>Class Methods</h3> |
75 <h3>Class Methods</h3> |
|
76 |
64 <table> |
77 <table> |
|
78 |
65 <tr> |
79 <tr> |
66 <td><a href="#OpenSearchEngine.parseTemplate">parseTemplate</a></td> |
80 <td><a href="#OpenSearchEngine.parseTemplate">parseTemplate</a></td> |
67 <td>Class method to parse a search template.</td> |
81 <td>Class method to parse a search template.</td> |
68 </tr> |
82 </tr> |
69 </table> |
83 </table> |
70 <h3>Methods</h3> |
84 <h3>Methods</h3> |
|
85 |
71 <table> |
86 <table> |
|
87 |
72 <tr> |
88 <tr> |
73 <td><a href="#OpenSearchEngine.__init__">OpenSearchEngine</a></td> |
89 <td><a href="#OpenSearchEngine.__init__">OpenSearchEngine</a></td> |
74 <td>Constructor</td> |
90 <td>Constructor</td> |
75 </tr><tr> |
91 </tr> |
|
92 <tr> |
76 <td><a href="#OpenSearchEngine.__eq__">__eq__</a></td> |
93 <td><a href="#OpenSearchEngine.__eq__">__eq__</a></td> |
77 <td>Special method implementing the == operator.</td> |
94 <td>Special method implementing the == operator.</td> |
78 </tr><tr> |
95 </tr> |
|
96 <tr> |
79 <td><a href="#OpenSearchEngine.__imageObtained">__imageObtained</a></td> |
97 <td><a href="#OpenSearchEngine.__imageObtained">__imageObtained</a></td> |
80 <td>Private slot to receive the image of the engine.</td> |
98 <td>Private slot to receive the image of the engine.</td> |
81 </tr><tr> |
99 </tr> |
|
100 <tr> |
82 <td><a href="#OpenSearchEngine.__lt__">__lt__</a></td> |
101 <td><a href="#OpenSearchEngine.__lt__">__lt__</a></td> |
83 <td>Special method implementing the < operator.</td> |
102 <td>Special method implementing the < operator.</td> |
84 </tr><tr> |
103 </tr> |
|
104 <tr> |
85 <td><a href="#OpenSearchEngine.__suggestionsObtained">__suggestionsObtained</a></td> |
105 <td><a href="#OpenSearchEngine.__suggestionsObtained">__suggestionsObtained</a></td> |
86 <td>Private slot to receive the suggestions.</td> |
106 <td>Private slot to receive the suggestions.</td> |
87 </tr><tr> |
107 </tr> |
|
108 <tr> |
88 <td><a href="#OpenSearchEngine.description">description</a></td> |
109 <td><a href="#OpenSearchEngine.description">description</a></td> |
89 <td>Public method to get the description of the engine.</td> |
110 <td>Public method to get the description of the engine.</td> |
90 </tr><tr> |
111 </tr> |
|
112 <tr> |
91 <td><a href="#OpenSearchEngine.image">image</a></td> |
113 <td><a href="#OpenSearchEngine.image">image</a></td> |
92 <td>Public method to get the image of the engine.</td> |
114 <td>Public method to get the image of the engine.</td> |
93 </tr><tr> |
115 </tr> |
|
116 <tr> |
94 <td><a href="#OpenSearchEngine.imageUrl">imageUrl</a></td> |
117 <td><a href="#OpenSearchEngine.imageUrl">imageUrl</a></td> |
95 <td>Public method to get the image URL of the engine.</td> |
118 <td>Public method to get the image URL of the engine.</td> |
96 </tr><tr> |
119 </tr> |
|
120 <tr> |
97 <td><a href="#OpenSearchEngine.isValid">isValid</a></td> |
121 <td><a href="#OpenSearchEngine.isValid">isValid</a></td> |
98 <td>Public method to check, if the engine is valid.</td> |
122 <td>Public method to check, if the engine is valid.</td> |
99 </tr><tr> |
123 </tr> |
|
124 <tr> |
100 <td><a href="#OpenSearchEngine.loadImage">loadImage</a></td> |
125 <td><a href="#OpenSearchEngine.loadImage">loadImage</a></td> |
101 <td>Public method to load the image of the engine.</td> |
126 <td>Public method to load the image of the engine.</td> |
102 </tr><tr> |
127 </tr> |
|
128 <tr> |
103 <td><a href="#OpenSearchEngine.name">name</a></td> |
129 <td><a href="#OpenSearchEngine.name">name</a></td> |
104 <td>Public method to get the name of the engine.</td> |
130 <td>Public method to get the name of the engine.</td> |
105 </tr><tr> |
131 </tr> |
|
132 <tr> |
106 <td><a href="#OpenSearchEngine.networkAccessManager">networkAccessManager</a></td> |
133 <td><a href="#OpenSearchEngine.networkAccessManager">networkAccessManager</a></td> |
107 <td>Public method to get a reference to the network access manager object.</td> |
134 <td>Public method to get a reference to the network access manager object.</td> |
108 </tr><tr> |
135 </tr> |
|
136 <tr> |
109 <td><a href="#OpenSearchEngine.providesSuggestions">providesSuggestions</a></td> |
137 <td><a href="#OpenSearchEngine.providesSuggestions">providesSuggestions</a></td> |
110 <td>Public method to check, if the engine provides suggestions.</td> |
138 <td>Public method to check, if the engine provides suggestions.</td> |
111 </tr><tr> |
139 </tr> |
|
140 <tr> |
112 <td><a href="#OpenSearchEngine.requestSuggestions">requestSuggestions</a></td> |
141 <td><a href="#OpenSearchEngine.requestSuggestions">requestSuggestions</a></td> |
113 <td>Public method to request suggestions.</td> |
142 <td>Public method to request suggestions.</td> |
114 </tr><tr> |
143 </tr> |
|
144 <tr> |
115 <td><a href="#OpenSearchEngine.searchMethod">searchMethod</a></td> |
145 <td><a href="#OpenSearchEngine.searchMethod">searchMethod</a></td> |
116 <td>Public method to get the HTTP request method used to perform search requests.</td> |
146 <td>Public method to get the HTTP request method used to perform search requests.</td> |
117 </tr><tr> |
147 </tr> |
|
148 <tr> |
118 <td><a href="#OpenSearchEngine.searchParameters">searchParameters</a></td> |
149 <td><a href="#OpenSearchEngine.searchParameters">searchParameters</a></td> |
119 <td>Public method to get the search parameters of the engine.</td> |
150 <td>Public method to get the search parameters of the engine.</td> |
120 </tr><tr> |
151 </tr> |
|
152 <tr> |
121 <td><a href="#OpenSearchEngine.searchUrl">searchUrl</a></td> |
153 <td><a href="#OpenSearchEngine.searchUrl">searchUrl</a></td> |
122 <td>Public method to get a URL ready for searching.</td> |
154 <td>Public method to get a URL ready for searching.</td> |
123 </tr><tr> |
155 </tr> |
|
156 <tr> |
124 <td><a href="#OpenSearchEngine.searchUrlTemplate">searchUrlTemplate</a></td> |
157 <td><a href="#OpenSearchEngine.searchUrlTemplate">searchUrlTemplate</a></td> |
125 <td>Public method to get the search URL template of the engine.</td> |
158 <td>Public method to get the search URL template of the engine.</td> |
126 </tr><tr> |
159 </tr> |
|
160 <tr> |
127 <td><a href="#OpenSearchEngine.setDescription">setDescription</a></td> |
161 <td><a href="#OpenSearchEngine.setDescription">setDescription</a></td> |
128 <td>Public method to set the engine description.</td> |
162 <td>Public method to set the engine description.</td> |
129 </tr><tr> |
163 </tr> |
|
164 <tr> |
130 <td><a href="#OpenSearchEngine.setImage">setImage</a></td> |
165 <td><a href="#OpenSearchEngine.setImage">setImage</a></td> |
131 <td>Public method to set the image of the engine.</td> |
166 <td>Public method to set the image of the engine.</td> |
132 </tr><tr> |
167 </tr> |
|
168 <tr> |
133 <td><a href="#OpenSearchEngine.setImageUrl">setImageUrl</a></td> |
169 <td><a href="#OpenSearchEngine.setImageUrl">setImageUrl</a></td> |
134 <td>Public method to set the engine image URL.</td> |
170 <td>Public method to set the engine image URL.</td> |
135 </tr><tr> |
171 </tr> |
|
172 <tr> |
136 <td><a href="#OpenSearchEngine.setImageUrlAndLoad">setImageUrlAndLoad</a></td> |
173 <td><a href="#OpenSearchEngine.setImageUrlAndLoad">setImageUrlAndLoad</a></td> |
137 <td>Public method to set the engine image URL.</td> |
174 <td>Public method to set the engine image URL.</td> |
138 </tr><tr> |
175 </tr> |
|
176 <tr> |
139 <td><a href="#OpenSearchEngine.setName">setName</a></td> |
177 <td><a href="#OpenSearchEngine.setName">setName</a></td> |
140 <td>Public method to set the engine name.</td> |
178 <td>Public method to set the engine name.</td> |
141 </tr><tr> |
179 </tr> |
|
180 <tr> |
142 <td><a href="#OpenSearchEngine.setNetworkAccessManager">setNetworkAccessManager</a></td> |
181 <td><a href="#OpenSearchEngine.setNetworkAccessManager">setNetworkAccessManager</a></td> |
143 <td>Public method to set the reference to the network access manager.</td> |
182 <td>Public method to set the reference to the network access manager.</td> |
144 </tr><tr> |
183 </tr> |
|
184 <tr> |
145 <td><a href="#OpenSearchEngine.setSearchMethod">setSearchMethod</a></td> |
185 <td><a href="#OpenSearchEngine.setSearchMethod">setSearchMethod</a></td> |
146 <td>Public method to set the HTTP request method used to perform search requests.</td> |
186 <td>Public method to set the HTTP request method used to perform search requests.</td> |
147 </tr><tr> |
187 </tr> |
|
188 <tr> |
148 <td><a href="#OpenSearchEngine.setSearchParameters">setSearchParameters</a></td> |
189 <td><a href="#OpenSearchEngine.setSearchParameters">setSearchParameters</a></td> |
149 <td>Public method to set the engine search parameters.</td> |
190 <td>Public method to set the engine search parameters.</td> |
150 </tr><tr> |
191 </tr> |
|
192 <tr> |
151 <td><a href="#OpenSearchEngine.setSearchUrlTemplate">setSearchUrlTemplate</a></td> |
193 <td><a href="#OpenSearchEngine.setSearchUrlTemplate">setSearchUrlTemplate</a></td> |
152 <td>Public method to set the engine search URL template.</td> |
194 <td>Public method to set the engine search URL template.</td> |
153 </tr><tr> |
195 </tr> |
|
196 <tr> |
154 <td><a href="#OpenSearchEngine.setSuggestionsMethod">setSuggestionsMethod</a></td> |
197 <td><a href="#OpenSearchEngine.setSuggestionsMethod">setSuggestionsMethod</a></td> |
155 <td>Public method to set the HTTP request method used to perform suggestions requests.</td> |
198 <td>Public method to set the HTTP request method used to perform suggestions requests.</td> |
156 </tr><tr> |
199 </tr> |
|
200 <tr> |
157 <td><a href="#OpenSearchEngine.setSuggestionsParameters">setSuggestionsParameters</a></td> |
201 <td><a href="#OpenSearchEngine.setSuggestionsParameters">setSuggestionsParameters</a></td> |
158 <td>Public method to set the engine suggestions parameters.</td> |
202 <td>Public method to set the engine suggestions parameters.</td> |
159 </tr><tr> |
203 </tr> |
|
204 <tr> |
160 <td><a href="#OpenSearchEngine.setSuggestionsUrlTemplate">setSuggestionsUrlTemplate</a></td> |
205 <td><a href="#OpenSearchEngine.setSuggestionsUrlTemplate">setSuggestionsUrlTemplate</a></td> |
161 <td>Public method to set the engine suggestions URL template.</td> |
206 <td>Public method to set the engine suggestions URL template.</td> |
162 </tr><tr> |
207 </tr> |
|
208 <tr> |
163 <td><a href="#OpenSearchEngine.suggestionsMethod">suggestionsMethod</a></td> |
209 <td><a href="#OpenSearchEngine.suggestionsMethod">suggestionsMethod</a></td> |
164 <td>Public method to get the HTTP request method used to perform suggestions requests.</td> |
210 <td>Public method to get the HTTP request method used to perform suggestions requests.</td> |
165 </tr><tr> |
211 </tr> |
|
212 <tr> |
166 <td><a href="#OpenSearchEngine.suggestionsParameters">suggestionsParameters</a></td> |
213 <td><a href="#OpenSearchEngine.suggestionsParameters">suggestionsParameters</a></td> |
167 <td>Public method to get the suggestions parameters of the engine.</td> |
214 <td>Public method to get the suggestions parameters of the engine.</td> |
168 </tr><tr> |
215 </tr> |
|
216 <tr> |
169 <td><a href="#OpenSearchEngine.suggestionsUrl">suggestionsUrl</a></td> |
217 <td><a href="#OpenSearchEngine.suggestionsUrl">suggestionsUrl</a></td> |
170 <td>Public method to get a URL ready for suggestions.</td> |
218 <td>Public method to get a URL ready for suggestions.</td> |
171 </tr><tr> |
219 </tr> |
|
220 <tr> |
172 <td><a href="#OpenSearchEngine.suggestionsUrlTemplate">suggestionsUrlTemplate</a></td> |
221 <td><a href="#OpenSearchEngine.suggestionsUrlTemplate">suggestionsUrlTemplate</a></td> |
173 <td>Public method to get the search URL template of the engine.</td> |
222 <td>Public method to get the search URL template of the engine.</td> |
174 </tr> |
223 </tr> |
175 </table> |
224 </table> |
176 <h3>Static Methods</h3> |
225 <h3>Static Methods</h3> |
|
226 |
177 <table> |
227 <table> |
178 <tr><td>None</td></tr> |
228 <tr><td>None</td></tr> |
179 </table> |
229 </table> |
|
230 |
180 <a NAME="OpenSearchEngine.parseTemplate" ID="OpenSearchEngine.parseTemplate"></a> |
231 <a NAME="OpenSearchEngine.parseTemplate" ID="OpenSearchEngine.parseTemplate"></a> |
181 <h4>OpenSearchEngine.parseTemplate (class method)</h4> |
232 <h4>OpenSearchEngine.parseTemplate (class method)</h4> |
182 <b>parseTemplate</b>(<i>searchTerm, searchTemplate</i>) |
233 <b>parseTemplate</b>(<i>searchTerm, searchTemplate</i>) |
|
234 |
183 <p> |
235 <p> |
184 Class method to parse a search template. |
236 Class method to parse a search template. |
185 </p><dl> |
237 </p> |
|
238 <dl> |
|
239 |
186 <dt><i>searchTerm</i></dt> |
240 <dt><i>searchTerm</i></dt> |
187 <dd> |
241 <dd> |
188 term to search for (string) |
242 term to search for (string) |
189 </dd><dt><i>searchTemplate</i></dt> |
243 </dd> |
|
244 <dt><i>searchTemplate</i></dt> |
190 <dd> |
245 <dd> |
191 template to be parsed (string) |
246 template to be parsed (string) |
192 </dd> |
247 </dd> |
193 </dl><dl> |
248 </dl> |
|
249 <dl> |
194 <dt>Returns:</dt> |
250 <dt>Returns:</dt> |
195 <dd> |
251 <dd> |
196 parsed template (string) |
252 parsed template (string) |
197 </dd> |
253 </dd> |
198 </dl><a NAME="OpenSearchEngine.__init__" ID="OpenSearchEngine.__init__"></a> |
254 </dl> |
|
255 <a NAME="OpenSearchEngine.__init__" ID="OpenSearchEngine.__init__"></a> |
199 <h4>OpenSearchEngine (Constructor)</h4> |
256 <h4>OpenSearchEngine (Constructor)</h4> |
200 <b>OpenSearchEngine</b>(<i>parent=None</i>) |
257 <b>OpenSearchEngine</b>(<i>parent=None</i>) |
|
258 |
201 <p> |
259 <p> |
202 Constructor |
260 Constructor |
203 </p><dl> |
261 </p> |
|
262 <dl> |
|
263 |
204 <dt><i>parent</i></dt> |
264 <dt><i>parent</i></dt> |
205 <dd> |
265 <dd> |
206 reference to the parent object (QObject) |
266 reference to the parent object (QObject) |
207 </dd> |
267 </dd> |
208 </dl><a NAME="OpenSearchEngine.__eq__" ID="OpenSearchEngine.__eq__"></a> |
268 </dl> |
|
269 <a NAME="OpenSearchEngine.__eq__" ID="OpenSearchEngine.__eq__"></a> |
209 <h4>OpenSearchEngine.__eq__</h4> |
270 <h4>OpenSearchEngine.__eq__</h4> |
210 <b>__eq__</b>(<i>other</i>) |
271 <b>__eq__</b>(<i>other</i>) |
|
272 |
211 <p> |
273 <p> |
212 Special method implementing the == operator. |
274 Special method implementing the == operator. |
213 </p><dl> |
275 </p> |
|
276 <dl> |
|
277 |
214 <dt><i>other</i></dt> |
278 <dt><i>other</i></dt> |
215 <dd> |
279 <dd> |
216 reference to an open search engine (OpenSearchEngine) |
280 reference to an open search engine (OpenSearchEngine) |
217 </dd> |
281 </dd> |
218 </dl><dl> |
282 </dl> |
|
283 <dl> |
219 <dt>Returns:</dt> |
284 <dt>Returns:</dt> |
220 <dd> |
285 <dd> |
221 flag indicating equality (boolean) |
286 flag indicating equality (boolean) |
222 </dd> |
287 </dd> |
223 </dl><a NAME="OpenSearchEngine.__imageObtained" ID="OpenSearchEngine.__imageObtained"></a> |
288 </dl> |
|
289 <a NAME="OpenSearchEngine.__imageObtained" ID="OpenSearchEngine.__imageObtained"></a> |
224 <h4>OpenSearchEngine.__imageObtained</h4> |
290 <h4>OpenSearchEngine.__imageObtained</h4> |
225 <b>__imageObtained</b>(<i>reply</i>) |
291 <b>__imageObtained</b>(<i>reply</i>) |
|
292 |
226 <p> |
293 <p> |
227 Private slot to receive the image of the engine. |
294 Private slot to receive the image of the engine. |
228 </p><dl> |
295 </p> |
|
296 <dl> |
|
297 |
229 <dt><i>reply</i> (QNetworkReply)</dt> |
298 <dt><i>reply</i> (QNetworkReply)</dt> |
230 <dd> |
299 <dd> |
231 reference to the network reply |
300 reference to the network reply |
232 </dd> |
301 </dd> |
233 </dl><a NAME="OpenSearchEngine.__lt__" ID="OpenSearchEngine.__lt__"></a> |
302 </dl> |
|
303 <a NAME="OpenSearchEngine.__lt__" ID="OpenSearchEngine.__lt__"></a> |
234 <h4>OpenSearchEngine.__lt__</h4> |
304 <h4>OpenSearchEngine.__lt__</h4> |
235 <b>__lt__</b>(<i>other</i>) |
305 <b>__lt__</b>(<i>other</i>) |
|
306 |
236 <p> |
307 <p> |
237 Special method implementing the < operator. |
308 Special method implementing the < operator. |
238 </p><dl> |
309 </p> |
|
310 <dl> |
|
311 |
239 <dt><i>other</i></dt> |
312 <dt><i>other</i></dt> |
240 <dd> |
313 <dd> |
241 reference to an open search engine (OpenSearchEngine) |
314 reference to an open search engine (OpenSearchEngine) |
242 </dd> |
315 </dd> |
243 </dl><dl> |
316 </dl> |
|
317 <dl> |
244 <dt>Returns:</dt> |
318 <dt>Returns:</dt> |
245 <dd> |
319 <dd> |
246 flag indicating less than (boolean) |
320 flag indicating less than (boolean) |
247 </dd> |
321 </dd> |
248 </dl><a NAME="OpenSearchEngine.__suggestionsObtained" ID="OpenSearchEngine.__suggestionsObtained"></a> |
322 </dl> |
|
323 <a NAME="OpenSearchEngine.__suggestionsObtained" ID="OpenSearchEngine.__suggestionsObtained"></a> |
249 <h4>OpenSearchEngine.__suggestionsObtained</h4> |
324 <h4>OpenSearchEngine.__suggestionsObtained</h4> |
250 <b>__suggestionsObtained</b>(<i></i>) |
325 <b>__suggestionsObtained</b>(<i></i>) |
|
326 |
251 <p> |
327 <p> |
252 Private slot to receive the suggestions. |
328 Private slot to receive the suggestions. |
253 </p><a NAME="OpenSearchEngine.description" ID="OpenSearchEngine.description"></a> |
329 </p> |
|
330 <a NAME="OpenSearchEngine.description" ID="OpenSearchEngine.description"></a> |
254 <h4>OpenSearchEngine.description</h4> |
331 <h4>OpenSearchEngine.description</h4> |
255 <b>description</b>(<i></i>) |
332 <b>description</b>(<i></i>) |
|
333 |
256 <p> |
334 <p> |
257 Public method to get the description of the engine. |
335 Public method to get the description of the engine. |
258 </p><dl> |
336 </p> |
|
337 <dl> |
259 <dt>Returns:</dt> |
338 <dt>Returns:</dt> |
260 <dd> |
339 <dd> |
261 description of the engine (string) |
340 description of the engine (string) |
262 </dd> |
341 </dd> |
263 </dl><a NAME="OpenSearchEngine.image" ID="OpenSearchEngine.image"></a> |
342 </dl> |
|
343 <a NAME="OpenSearchEngine.image" ID="OpenSearchEngine.image"></a> |
264 <h4>OpenSearchEngine.image</h4> |
344 <h4>OpenSearchEngine.image</h4> |
265 <b>image</b>(<i></i>) |
345 <b>image</b>(<i></i>) |
|
346 |
266 <p> |
347 <p> |
267 Public method to get the image of the engine. |
348 Public method to get the image of the engine. |
268 </p><dl> |
349 </p> |
|
350 <dl> |
269 <dt>Returns:</dt> |
351 <dt>Returns:</dt> |
270 <dd> |
352 <dd> |
271 image of the engine (QImage) |
353 image of the engine (QImage) |
272 </dd> |
354 </dd> |
273 </dl><a NAME="OpenSearchEngine.imageUrl" ID="OpenSearchEngine.imageUrl"></a> |
355 </dl> |
|
356 <a NAME="OpenSearchEngine.imageUrl" ID="OpenSearchEngine.imageUrl"></a> |
274 <h4>OpenSearchEngine.imageUrl</h4> |
357 <h4>OpenSearchEngine.imageUrl</h4> |
275 <b>imageUrl</b>(<i></i>) |
358 <b>imageUrl</b>(<i></i>) |
|
359 |
276 <p> |
360 <p> |
277 Public method to get the image URL of the engine. |
361 Public method to get the image URL of the engine. |
278 </p><dl> |
362 </p> |
|
363 <dl> |
279 <dt>Returns:</dt> |
364 <dt>Returns:</dt> |
280 <dd> |
365 <dd> |
281 image URL of the engine (string) |
366 image URL of the engine (string) |
282 </dd> |
367 </dd> |
283 </dl><a NAME="OpenSearchEngine.isValid" ID="OpenSearchEngine.isValid"></a> |
368 </dl> |
|
369 <a NAME="OpenSearchEngine.isValid" ID="OpenSearchEngine.isValid"></a> |
284 <h4>OpenSearchEngine.isValid</h4> |
370 <h4>OpenSearchEngine.isValid</h4> |
285 <b>isValid</b>(<i></i>) |
371 <b>isValid</b>(<i></i>) |
|
372 |
286 <p> |
373 <p> |
287 Public method to check, if the engine is valid. |
374 Public method to check, if the engine is valid. |
288 </p><dl> |
375 </p> |
|
376 <dl> |
289 <dt>Returns:</dt> |
377 <dt>Returns:</dt> |
290 <dd> |
378 <dd> |
291 flag indicating validity (boolean) |
379 flag indicating validity (boolean) |
292 </dd> |
380 </dd> |
293 </dl><a NAME="OpenSearchEngine.loadImage" ID="OpenSearchEngine.loadImage"></a> |
381 </dl> |
|
382 <a NAME="OpenSearchEngine.loadImage" ID="OpenSearchEngine.loadImage"></a> |
294 <h4>OpenSearchEngine.loadImage</h4> |
383 <h4>OpenSearchEngine.loadImage</h4> |
295 <b>loadImage</b>(<i></i>) |
384 <b>loadImage</b>(<i></i>) |
|
385 |
296 <p> |
386 <p> |
297 Public method to load the image of the engine. |
387 Public method to load the image of the engine. |
298 </p><a NAME="OpenSearchEngine.name" ID="OpenSearchEngine.name"></a> |
388 </p> |
|
389 <a NAME="OpenSearchEngine.name" ID="OpenSearchEngine.name"></a> |
299 <h4>OpenSearchEngine.name</h4> |
390 <h4>OpenSearchEngine.name</h4> |
300 <b>name</b>(<i></i>) |
391 <b>name</b>(<i></i>) |
|
392 |
301 <p> |
393 <p> |
302 Public method to get the name of the engine. |
394 Public method to get the name of the engine. |
303 </p><dl> |
395 </p> |
|
396 <dl> |
304 <dt>Returns:</dt> |
397 <dt>Returns:</dt> |
305 <dd> |
398 <dd> |
306 name of the engine (string) |
399 name of the engine (string) |
307 </dd> |
400 </dd> |
308 </dl><a NAME="OpenSearchEngine.networkAccessManager" ID="OpenSearchEngine.networkAccessManager"></a> |
401 </dl> |
|
402 <a NAME="OpenSearchEngine.networkAccessManager" ID="OpenSearchEngine.networkAccessManager"></a> |
309 <h4>OpenSearchEngine.networkAccessManager</h4> |
403 <h4>OpenSearchEngine.networkAccessManager</h4> |
310 <b>networkAccessManager</b>(<i></i>) |
404 <b>networkAccessManager</b>(<i></i>) |
|
405 |
311 <p> |
406 <p> |
312 Public method to get a reference to the network access manager object. |
407 Public method to get a reference to the network access manager object. |
313 </p><dl> |
408 </p> |
|
409 <dl> |
314 <dt>Returns:</dt> |
410 <dt>Returns:</dt> |
315 <dd> |
411 <dd> |
316 reference to the network access manager object |
412 reference to the network access manager object |
317 (QNetworkAccessManager) |
413 (QNetworkAccessManager) |
318 </dd> |
414 </dd> |
319 </dl><a NAME="OpenSearchEngine.providesSuggestions" ID="OpenSearchEngine.providesSuggestions"></a> |
415 </dl> |
|
416 <a NAME="OpenSearchEngine.providesSuggestions" ID="OpenSearchEngine.providesSuggestions"></a> |
320 <h4>OpenSearchEngine.providesSuggestions</h4> |
417 <h4>OpenSearchEngine.providesSuggestions</h4> |
321 <b>providesSuggestions</b>(<i></i>) |
418 <b>providesSuggestions</b>(<i></i>) |
|
419 |
322 <p> |
420 <p> |
323 Public method to check, if the engine provides suggestions. |
421 Public method to check, if the engine provides suggestions. |
324 </p><dl> |
422 </p> |
|
423 <dl> |
325 <dt>Returns:</dt> |
424 <dt>Returns:</dt> |
326 <dd> |
425 <dd> |
327 flag indicating suggestions are provided (boolean) |
426 flag indicating suggestions are provided (boolean) |
328 </dd> |
427 </dd> |
329 </dl><a NAME="OpenSearchEngine.requestSuggestions" ID="OpenSearchEngine.requestSuggestions"></a> |
428 </dl> |
|
429 <a NAME="OpenSearchEngine.requestSuggestions" ID="OpenSearchEngine.requestSuggestions"></a> |
330 <h4>OpenSearchEngine.requestSuggestions</h4> |
430 <h4>OpenSearchEngine.requestSuggestions</h4> |
331 <b>requestSuggestions</b>(<i>searchTerm</i>) |
431 <b>requestSuggestions</b>(<i>searchTerm</i>) |
|
432 |
332 <p> |
433 <p> |
333 Public method to request suggestions. |
434 Public method to request suggestions. |
334 </p><dl> |
435 </p> |
|
436 <dl> |
|
437 |
335 <dt><i>searchTerm</i></dt> |
438 <dt><i>searchTerm</i></dt> |
336 <dd> |
439 <dd> |
337 term to get suggestions for (string) |
440 term to get suggestions for (string) |
338 </dd> |
441 </dd> |
339 </dl><a NAME="OpenSearchEngine.searchMethod" ID="OpenSearchEngine.searchMethod"></a> |
442 </dl> |
|
443 <a NAME="OpenSearchEngine.searchMethod" ID="OpenSearchEngine.searchMethod"></a> |
340 <h4>OpenSearchEngine.searchMethod</h4> |
444 <h4>OpenSearchEngine.searchMethod</h4> |
341 <b>searchMethod</b>(<i></i>) |
445 <b>searchMethod</b>(<i></i>) |
|
446 |
342 <p> |
447 <p> |
343 Public method to get the HTTP request method used to perform search |
448 Public method to get the HTTP request method used to perform search |
344 requests. |
449 requests. |
345 </p><dl> |
450 </p> |
|
451 <dl> |
346 <dt>Returns:</dt> |
452 <dt>Returns:</dt> |
347 <dd> |
453 <dd> |
348 HTTP request method (string) |
454 HTTP request method (string) |
349 </dd> |
455 </dd> |
350 </dl><a NAME="OpenSearchEngine.searchParameters" ID="OpenSearchEngine.searchParameters"></a> |
456 </dl> |
|
457 <a NAME="OpenSearchEngine.searchParameters" ID="OpenSearchEngine.searchParameters"></a> |
351 <h4>OpenSearchEngine.searchParameters</h4> |
458 <h4>OpenSearchEngine.searchParameters</h4> |
352 <b>searchParameters</b>(<i></i>) |
459 <b>searchParameters</b>(<i></i>) |
|
460 |
353 <p> |
461 <p> |
354 Public method to get the search parameters of the engine. |
462 Public method to get the search parameters of the engine. |
355 </p><dl> |
463 </p> |
|
464 <dl> |
356 <dt>Returns:</dt> |
465 <dt>Returns:</dt> |
357 <dd> |
466 <dd> |
358 search parameters of the engine (list of two tuples) |
467 search parameters of the engine (list of two tuples) |
359 </dd> |
468 </dd> |
360 </dl><a NAME="OpenSearchEngine.searchUrl" ID="OpenSearchEngine.searchUrl"></a> |
469 </dl> |
|
470 <a NAME="OpenSearchEngine.searchUrl" ID="OpenSearchEngine.searchUrl"></a> |
361 <h4>OpenSearchEngine.searchUrl</h4> |
471 <h4>OpenSearchEngine.searchUrl</h4> |
362 <b>searchUrl</b>(<i>searchTerm</i>) |
472 <b>searchUrl</b>(<i>searchTerm</i>) |
|
473 |
363 <p> |
474 <p> |
364 Public method to get a URL ready for searching. |
475 Public method to get a URL ready for searching. |
365 </p><dl> |
476 </p> |
|
477 <dl> |
|
478 |
366 <dt><i>searchTerm</i></dt> |
479 <dt><i>searchTerm</i></dt> |
367 <dd> |
480 <dd> |
368 term to search for (string) |
481 term to search for (string) |
369 </dd> |
482 </dd> |
370 </dl><dl> |
483 </dl> |
|
484 <dl> |
371 <dt>Returns:</dt> |
485 <dt>Returns:</dt> |
372 <dd> |
486 <dd> |
373 URL (QUrl) |
487 URL (QUrl) |
374 </dd> |
488 </dd> |
375 </dl><a NAME="OpenSearchEngine.searchUrlTemplate" ID="OpenSearchEngine.searchUrlTemplate"></a> |
489 </dl> |
|
490 <a NAME="OpenSearchEngine.searchUrlTemplate" ID="OpenSearchEngine.searchUrlTemplate"></a> |
376 <h4>OpenSearchEngine.searchUrlTemplate</h4> |
491 <h4>OpenSearchEngine.searchUrlTemplate</h4> |
377 <b>searchUrlTemplate</b>(<i></i>) |
492 <b>searchUrlTemplate</b>(<i></i>) |
|
493 |
378 <p> |
494 <p> |
379 Public method to get the search URL template of the engine. |
495 Public method to get the search URL template of the engine. |
380 </p><dl> |
496 </p> |
|
497 <dl> |
381 <dt>Returns:</dt> |
498 <dt>Returns:</dt> |
382 <dd> |
499 <dd> |
383 search URL template of the engine (string) |
500 search URL template of the engine (string) |
384 </dd> |
501 </dd> |
385 </dl><a NAME="OpenSearchEngine.setDescription" ID="OpenSearchEngine.setDescription"></a> |
502 </dl> |
|
503 <a NAME="OpenSearchEngine.setDescription" ID="OpenSearchEngine.setDescription"></a> |
386 <h4>OpenSearchEngine.setDescription</h4> |
504 <h4>OpenSearchEngine.setDescription</h4> |
387 <b>setDescription</b>(<i>description</i>) |
505 <b>setDescription</b>(<i>description</i>) |
|
506 |
388 <p> |
507 <p> |
389 Public method to set the engine description. |
508 Public method to set the engine description. |
390 </p><dl> |
509 </p> |
|
510 <dl> |
|
511 |
391 <dt><i>description</i></dt> |
512 <dt><i>description</i></dt> |
392 <dd> |
513 <dd> |
393 description of the engine (string) |
514 description of the engine (string) |
394 </dd> |
515 </dd> |
395 </dl><a NAME="OpenSearchEngine.setImage" ID="OpenSearchEngine.setImage"></a> |
516 </dl> |
|
517 <a NAME="OpenSearchEngine.setImage" ID="OpenSearchEngine.setImage"></a> |
396 <h4>OpenSearchEngine.setImage</h4> |
518 <h4>OpenSearchEngine.setImage</h4> |
397 <b>setImage</b>(<i>image</i>) |
519 <b>setImage</b>(<i>image</i>) |
|
520 |
398 <p> |
521 <p> |
399 Public method to set the image of the engine. |
522 Public method to set the image of the engine. |
400 </p><dl> |
523 </p> |
|
524 <dl> |
|
525 |
401 <dt><i>image</i></dt> |
526 <dt><i>image</i></dt> |
402 <dd> |
527 <dd> |
403 image to be set (QImage) |
528 image to be set (QImage) |
404 </dd> |
529 </dd> |
405 </dl><a NAME="OpenSearchEngine.setImageUrl" ID="OpenSearchEngine.setImageUrl"></a> |
530 </dl> |
|
531 <a NAME="OpenSearchEngine.setImageUrl" ID="OpenSearchEngine.setImageUrl"></a> |
406 <h4>OpenSearchEngine.setImageUrl</h4> |
532 <h4>OpenSearchEngine.setImageUrl</h4> |
407 <b>setImageUrl</b>(<i>imageUrl</i>) |
533 <b>setImageUrl</b>(<i>imageUrl</i>) |
|
534 |
408 <p> |
535 <p> |
409 Public method to set the engine image URL. |
536 Public method to set the engine image URL. |
410 </p><dl> |
537 </p> |
|
538 <dl> |
|
539 |
411 <dt><i>imageUrl</i></dt> |
540 <dt><i>imageUrl</i></dt> |
412 <dd> |
541 <dd> |
413 image URL of the engine (string) |
542 image URL of the engine (string) |
414 </dd> |
543 </dd> |
415 </dl><a NAME="OpenSearchEngine.setImageUrlAndLoad" ID="OpenSearchEngine.setImageUrlAndLoad"></a> |
544 </dl> |
|
545 <a NAME="OpenSearchEngine.setImageUrlAndLoad" ID="OpenSearchEngine.setImageUrlAndLoad"></a> |
416 <h4>OpenSearchEngine.setImageUrlAndLoad</h4> |
546 <h4>OpenSearchEngine.setImageUrlAndLoad</h4> |
417 <b>setImageUrlAndLoad</b>(<i>imageUrl</i>) |
547 <b>setImageUrlAndLoad</b>(<i>imageUrl</i>) |
|
548 |
418 <p> |
549 <p> |
419 Public method to set the engine image URL. |
550 Public method to set the engine image URL. |
420 </p><dl> |
551 </p> |
|
552 <dl> |
|
553 |
421 <dt><i>imageUrl</i></dt> |
554 <dt><i>imageUrl</i></dt> |
422 <dd> |
555 <dd> |
423 image URL of the engine (string) |
556 image URL of the engine (string) |
424 </dd> |
557 </dd> |
425 </dl><a NAME="OpenSearchEngine.setName" ID="OpenSearchEngine.setName"></a> |
558 </dl> |
|
559 <a NAME="OpenSearchEngine.setName" ID="OpenSearchEngine.setName"></a> |
426 <h4>OpenSearchEngine.setName</h4> |
560 <h4>OpenSearchEngine.setName</h4> |
427 <b>setName</b>(<i>name</i>) |
561 <b>setName</b>(<i>name</i>) |
|
562 |
428 <p> |
563 <p> |
429 Public method to set the engine name. |
564 Public method to set the engine name. |
430 </p><dl> |
565 </p> |
|
566 <dl> |
|
567 |
431 <dt><i>name</i></dt> |
568 <dt><i>name</i></dt> |
432 <dd> |
569 <dd> |
433 name of the engine (string) |
570 name of the engine (string) |
434 </dd> |
571 </dd> |
435 </dl><a NAME="OpenSearchEngine.setNetworkAccessManager" ID="OpenSearchEngine.setNetworkAccessManager"></a> |
572 </dl> |
|
573 <a NAME="OpenSearchEngine.setNetworkAccessManager" ID="OpenSearchEngine.setNetworkAccessManager"></a> |
436 <h4>OpenSearchEngine.setNetworkAccessManager</h4> |
574 <h4>OpenSearchEngine.setNetworkAccessManager</h4> |
437 <b>setNetworkAccessManager</b>(<i>networkAccessManager</i>) |
575 <b>setNetworkAccessManager</b>(<i>networkAccessManager</i>) |
|
576 |
438 <p> |
577 <p> |
439 Public method to set the reference to the network access manager. |
578 Public method to set the reference to the network access manager. |
440 </p><dl> |
579 </p> |
|
580 <dl> |
|
581 |
441 <dt><i>networkAccessManager</i></dt> |
582 <dt><i>networkAccessManager</i></dt> |
442 <dd> |
583 <dd> |
443 reference to the network access manager |
584 reference to the network access manager |
444 object (QNetworkAccessManager) |
585 object (QNetworkAccessManager) |
445 </dd> |
586 </dd> |
446 </dl><a NAME="OpenSearchEngine.setSearchMethod" ID="OpenSearchEngine.setSearchMethod"></a> |
587 </dl> |
|
588 <a NAME="OpenSearchEngine.setSearchMethod" ID="OpenSearchEngine.setSearchMethod"></a> |
447 <h4>OpenSearchEngine.setSearchMethod</h4> |
589 <h4>OpenSearchEngine.setSearchMethod</h4> |
448 <b>setSearchMethod</b>(<i>method</i>) |
590 <b>setSearchMethod</b>(<i>method</i>) |
|
591 |
449 <p> |
592 <p> |
450 Public method to set the HTTP request method used to perform search |
593 Public method to set the HTTP request method used to perform search |
451 requests. |
594 requests. |
452 </p><dl> |
595 </p> |
|
596 <dl> |
|
597 |
453 <dt><i>method</i></dt> |
598 <dt><i>method</i></dt> |
454 <dd> |
599 <dd> |
455 HTTP request method (string) |
600 HTTP request method (string) |
456 </dd> |
601 </dd> |
457 </dl><a NAME="OpenSearchEngine.setSearchParameters" ID="OpenSearchEngine.setSearchParameters"></a> |
602 </dl> |
|
603 <a NAME="OpenSearchEngine.setSearchParameters" ID="OpenSearchEngine.setSearchParameters"></a> |
458 <h4>OpenSearchEngine.setSearchParameters</h4> |
604 <h4>OpenSearchEngine.setSearchParameters</h4> |
459 <b>setSearchParameters</b>(<i>searchParameters</i>) |
605 <b>setSearchParameters</b>(<i>searchParameters</i>) |
|
606 |
460 <p> |
607 <p> |
461 Public method to set the engine search parameters. |
608 Public method to set the engine search parameters. |
462 </p><dl> |
609 </p> |
|
610 <dl> |
|
611 |
463 <dt><i>searchParameters</i></dt> |
612 <dt><i>searchParameters</i></dt> |
464 <dd> |
613 <dd> |
465 search parameters of the engine |
614 search parameters of the engine |
466 (list of two tuples) |
615 (list of two tuples) |
467 </dd> |
616 </dd> |
468 </dl><a NAME="OpenSearchEngine.setSearchUrlTemplate" ID="OpenSearchEngine.setSearchUrlTemplate"></a> |
617 </dl> |
|
618 <a NAME="OpenSearchEngine.setSearchUrlTemplate" ID="OpenSearchEngine.setSearchUrlTemplate"></a> |
469 <h4>OpenSearchEngine.setSearchUrlTemplate</h4> |
619 <h4>OpenSearchEngine.setSearchUrlTemplate</h4> |
470 <b>setSearchUrlTemplate</b>(<i>searchUrlTemplate</i>) |
620 <b>setSearchUrlTemplate</b>(<i>searchUrlTemplate</i>) |
|
621 |
471 <p> |
622 <p> |
472 Public method to set the engine search URL template. |
623 Public method to set the engine search URL template. |
473 </p><p> |
624 </p> |
|
625 <p> |
474 The URL template is processed according to the specification: |
626 The URL template is processed according to the specification: |
475 <a |
627 <a |
476 href="http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_URL_template_syntax"> |
628 href="http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_URL_template_syntax"> |
477 http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_URL_template_syntax</a> |
629 http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_URL_template_syntax</a> |
478 </p><p> |
630 </p> |
|
631 <p> |
479 A list of template parameters currently supported and what they are |
632 A list of template parameters currently supported and what they are |
480 replaced with: |
633 replaced with: |
481 <table> |
634 <table> |
482 <tr><td><b>Parameter</b></td><td><b>Value</b></td></tr> |
635 <tr><td><b>Parameter</b></td><td><b>Value</b></td></tr> |
483 <tr><td>{count}</td><td>20</td></tr> |
636 <tr><td>{count}</td><td>20</td></tr> |