Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.WebBrowser.OpenSearch.OpenSearchManager.html

Documentation/Source/eric6.WebBrowser.OpenSearch.OpenSearchManager.html

changeset 4918
71caf42a13d8
child 6123
39cd368143db
equal deleted inserted replaced
4917:682750cc7bd5 4918:71caf42a13d8
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.OpenSearch.OpenSearchManager</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.OpenSearch.OpenSearchManager</h1>
23 <p>
24 Module implementing a manager for open search engines.
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="#OpenSearchManager">OpenSearchManager</a></td>
34 <td>Class implementing a manager for open search engines.</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="OpenSearchManager" ID="OpenSearchManager"></a>
43 <h2>OpenSearchManager</h2>
44 <p>
45 Class implementing a manager for open search engines.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>changed()</dt>
49 <dd>
50 emitted to indicate a change
51 </dd><dt>currentEngineChanged()</dt>
52 <dd>
53 emitted to indicate a change of
54 the current search engine
55 </dd>
56 </dl>
57 <h3>Derived from</h3>
58 QObject
59 <h3>Class Attributes</h3>
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Class Methods</h3>
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68 <table>
69 <tr>
70 <td><a href="#OpenSearchManager.__init__">OpenSearchManager</a></td>
71 <td>Constructor</td>
72 </tr><tr>
73 <td><a href="#OpenSearchManager.__addEngineByEngine">__addEngineByEngine</a></td>
74 <td>Private method to add a new search engine given a reference to an engine.</td>
75 </tr><tr>
76 <td><a href="#OpenSearchManager.__addEngineByFile">__addEngineByFile</a></td>
77 <td>Private method to add a new search engine given a filename.</td>
78 </tr><tr>
79 <td><a href="#OpenSearchManager.__addEngineByUrl">__addEngineByUrl</a></td>
80 <td>Private method to add a new search engine given its URL.</td>
81 </tr><tr>
82 <td><a href="#OpenSearchManager.__confirmAddition">__confirmAddition</a></td>
83 <td>Private method to confirm the addition of a new search engine.</td>
84 </tr><tr>
85 <td><a href="#OpenSearchManager.__engineFromUrlAvailable">__engineFromUrlAvailable</a></td>
86 <td>Private slot to add a search engine from the net.</td>
87 </tr><tr>
88 <td><a href="#OpenSearchManager.addEngine">addEngine</a></td>
89 <td>Public method to add a new search engine.</td>
90 </tr><tr>
91 <td><a href="#OpenSearchManager.addEngineFromForm">addEngineFromForm</a></td>
92 <td>Public method to add a new search engine from a form.</td>
93 </tr><tr>
94 <td><a href="#OpenSearchManager.allEnginesNames">allEnginesNames</a></td>
95 <td>Public method to get a list of all engine names.</td>
96 </tr><tr>
97 <td><a href="#OpenSearchManager.close">close</a></td>
98 <td>Public method to close the open search engines manager.</td>
99 </tr><tr>
100 <td><a href="#OpenSearchManager.convertKeywordSearchToUrl">convertKeywordSearchToUrl</a></td>
101 <td>Public method to get the search URL for a keyword search.</td>
102 </tr><tr>
103 <td><a href="#OpenSearchManager.currentEngine">currentEngine</a></td>
104 <td>Public method to get a reference to the current engine.</td>
105 </tr><tr>
106 <td><a href="#OpenSearchManager.currentEngineName">currentEngineName</a></td>
107 <td>Public method to get the name of the current search engine.</td>
108 </tr><tr>
109 <td><a href="#OpenSearchManager.engine">engine</a></td>
110 <td>Public method to get a reference to the named engine.</td>
111 </tr><tr>
112 <td><a href="#OpenSearchManager.engineExists">engineExists</a></td>
113 <td>Public method to check, if an engine exists.</td>
114 </tr><tr>
115 <td><a href="#OpenSearchManager.engineForKeyword">engineForKeyword</a></td>
116 <td>Public method to get the engine for a keyword.</td>
117 </tr><tr>
118 <td><a href="#OpenSearchManager.enginesChanged">enginesChanged</a></td>
119 <td>Public slot to tell the search engine manager, that something has changed.</td>
120 </tr><tr>
121 <td><a href="#OpenSearchManager.enginesCount">enginesCount</a></td>
122 <td>Public method to get the number of available engines.</td>
123 </tr><tr>
124 <td><a href="#OpenSearchManager.enginesDirectory">enginesDirectory</a></td>
125 <td>Public method to determine the directory containing the search engine descriptions.</td>
126 </tr><tr>
127 <td><a href="#OpenSearchManager.generateEngineFileName">generateEngineFileName</a></td>
128 <td>Public method to generate a valid engine file name.</td>
129 </tr><tr>
130 <td><a href="#OpenSearchManager.keywordsForEngine">keywordsForEngine</a></td>
131 <td>Public method to get the keywords for a given engine.</td>
132 </tr><tr>
133 <td><a href="#OpenSearchManager.load">load</a></td>
134 <td>Public method to load the search engines configuration.</td>
135 </tr><tr>
136 <td><a href="#OpenSearchManager.loadDirectory">loadDirectory</a></td>
137 <td>Public method to load the search engine definitions from files.</td>
138 </tr><tr>
139 <td><a href="#OpenSearchManager.removeEngine">removeEngine</a></td>
140 <td>Public method to remove an engine.</td>
141 </tr><tr>
142 <td><a href="#OpenSearchManager.restoreDefaults">restoreDefaults</a></td>
143 <td>Public method to restore the default search engines.</td>
144 </tr><tr>
145 <td><a href="#OpenSearchManager.save">save</a></td>
146 <td>Public method to save the search engines configuration.</td>
147 </tr><tr>
148 <td><a href="#OpenSearchManager.saveDirectory">saveDirectory</a></td>
149 <td>Public method to save the search engine definitions to files.</td>
150 </tr><tr>
151 <td><a href="#OpenSearchManager.setCurrentEngine">setCurrentEngine</a></td>
152 <td>Public method to set the current engine.</td>
153 </tr><tr>
154 <td><a href="#OpenSearchManager.setCurrentEngineName">setCurrentEngineName</a></td>
155 <td>Public method to set the current engine by name.</td>
156 </tr><tr>
157 <td><a href="#OpenSearchManager.setEngineForKeyword">setEngineForKeyword</a></td>
158 <td>Public method to set the engine for a keyword.</td>
159 </tr><tr>
160 <td><a href="#OpenSearchManager.setKeywordsForEngine">setKeywordsForEngine</a></td>
161 <td>Public method to set the keywords for an engine.</td>
162 </tr>
163 </table>
164 <h3>Static Methods</h3>
165 <table>
166 <tr><td>None</td></tr>
167 </table>
168 <a NAME="OpenSearchManager.__init__" ID="OpenSearchManager.__init__"></a>
169 <h4>OpenSearchManager (Constructor)</h4>
170 <b>OpenSearchManager</b>(<i>parent=None</i>)
171 <p>
172 Constructor
173 </p><dl>
174 <dt><i>parent</i></dt>
175 <dd>
176 reference to the parent object (QObject)
177 </dd>
178 </dl><a NAME="OpenSearchManager.__addEngineByEngine" ID="OpenSearchManager.__addEngineByEngine"></a>
179 <h4>OpenSearchManager.__addEngineByEngine</h4>
180 <b>__addEngineByEngine</b>(<i>engine</i>)
181 <p>
182 Private method to add a new search engine given a reference to an
183 engine.
184 </p><dl>
185 <dt><i>engine</i></dt>
186 <dd>
187 reference to an engine object (OpenSearchEngine)
188 </dd>
189 </dl><dl>
190 <dt>Returns:</dt>
191 <dd>
192 flag indicating success (boolean)
193 </dd>
194 </dl><a NAME="OpenSearchManager.__addEngineByFile" ID="OpenSearchManager.__addEngineByFile"></a>
195 <h4>OpenSearchManager.__addEngineByFile</h4>
196 <b>__addEngineByFile</b>(<i>filename</i>)
197 <p>
198 Private method to add a new search engine given a filename.
199 </p><dl>
200 <dt><i>filename</i></dt>
201 <dd>
202 name of a file containing the engine definition
203 (string)
204 </dd>
205 </dl><dl>
206 <dt>Returns:</dt>
207 <dd>
208 flag indicating success (boolean)
209 </dd>
210 </dl><a NAME="OpenSearchManager.__addEngineByUrl" ID="OpenSearchManager.__addEngineByUrl"></a>
211 <h4>OpenSearchManager.__addEngineByUrl</h4>
212 <b>__addEngineByUrl</b>(<i>url</i>)
213 <p>
214 Private method to add a new search engine given its URL.
215 </p><dl>
216 <dt><i>url</i></dt>
217 <dd>
218 URL of the engine definition file (QUrl)
219 </dd>
220 </dl><dl>
221 <dt>Returns:</dt>
222 <dd>
223 flag indicating success (boolean)
224 </dd>
225 </dl><a NAME="OpenSearchManager.__confirmAddition" ID="OpenSearchManager.__confirmAddition"></a>
226 <h4>OpenSearchManager.__confirmAddition</h4>
227 <b>__confirmAddition</b>(<i>engine</i>)
228 <p>
229 Private method to confirm the addition of a new search engine.
230 </p><dl>
231 <dt><i>engine</i></dt>
232 <dd>
233 reference to the engine to be added (OpenSearchEngine)
234 </dd>
235 </dl><dl>
236 <dt>Returns:</dt>
237 <dd>
238 flag indicating the engine shall be added (boolean)
239 </dd>
240 </dl><a NAME="OpenSearchManager.__engineFromUrlAvailable" ID="OpenSearchManager.__engineFromUrlAvailable"></a>
241 <h4>OpenSearchManager.__engineFromUrlAvailable</h4>
242 <b>__engineFromUrlAvailable</b>(<i></i>)
243 <p>
244 Private slot to add a search engine from the net.
245 </p><a NAME="OpenSearchManager.addEngine" ID="OpenSearchManager.addEngine"></a>
246 <h4>OpenSearchManager.addEngine</h4>
247 <b>addEngine</b>(<i>engine</i>)
248 <p>
249 Public method to add a new search engine.
250 </p><dl>
251 <dt><i>engine</i></dt>
252 <dd>
253 URL of the engine definition file (QUrl) or
254 name of a file containing the engine definition (string)
255 or reference to an engine object (OpenSearchEngine)
256 </dd>
257 </dl><dl>
258 <dt>Returns:</dt>
259 <dd>
260 flag indicating success (boolean)
261 </dd>
262 </dl><a NAME="OpenSearchManager.addEngineFromForm" ID="OpenSearchManager.addEngineFromForm"></a>
263 <h4>OpenSearchManager.addEngineFromForm</h4>
264 <b>addEngineFromForm</b>(<i>res, view</i>)
265 <p>
266 Public method to add a new search engine from a form.
267 </p><dl>
268 <dt><i>res</i> (dict or None)</dt>
269 <dd>
270 result of the JavaScript run on by
271 WebBrowserView.__addSearchEngine()
272 </dd><dt><i>view</i> (WebBrowserView)</dt>
273 <dd>
274 reference to the web browser view
275 </dd>
276 </dl><a NAME="OpenSearchManager.allEnginesNames" ID="OpenSearchManager.allEnginesNames"></a>
277 <h4>OpenSearchManager.allEnginesNames</h4>
278 <b>allEnginesNames</b>(<i></i>)
279 <p>
280 Public method to get a list of all engine names.
281 </p><dl>
282 <dt>Returns:</dt>
283 <dd>
284 sorted list of all engine names (list of strings)
285 </dd>
286 </dl><a NAME="OpenSearchManager.close" ID="OpenSearchManager.close"></a>
287 <h4>OpenSearchManager.close</h4>
288 <b>close</b>(<i></i>)
289 <p>
290 Public method to close the open search engines manager.
291 </p><a NAME="OpenSearchManager.convertKeywordSearchToUrl" ID="OpenSearchManager.convertKeywordSearchToUrl"></a>
292 <h4>OpenSearchManager.convertKeywordSearchToUrl</h4>
293 <b>convertKeywordSearchToUrl</b>(<i>keywordSearch</i>)
294 <p>
295 Public method to get the search URL for a keyword search.
296 </p><dl>
297 <dt><i>keywordSearch</i></dt>
298 <dd>
299 search string for keyword search (string)
300 </dd>
301 </dl><dl>
302 <dt>Returns:</dt>
303 <dd>
304 search URL (QUrl)
305 </dd>
306 </dl><a NAME="OpenSearchManager.currentEngine" ID="OpenSearchManager.currentEngine"></a>
307 <h4>OpenSearchManager.currentEngine</h4>
308 <b>currentEngine</b>(<i></i>)
309 <p>
310 Public method to get a reference to the current engine.
311 </p><dl>
312 <dt>Returns:</dt>
313 <dd>
314 reference to the current engine (OpenSearchEngine)
315 </dd>
316 </dl><a NAME="OpenSearchManager.currentEngineName" ID="OpenSearchManager.currentEngineName"></a>
317 <h4>OpenSearchManager.currentEngineName</h4>
318 <b>currentEngineName</b>(<i></i>)
319 <p>
320 Public method to get the name of the current search engine.
321 </p><dl>
322 <dt>Returns:</dt>
323 <dd>
324 name of the current search engine (string)
325 </dd>
326 </dl><a NAME="OpenSearchManager.engine" ID="OpenSearchManager.engine"></a>
327 <h4>OpenSearchManager.engine</h4>
328 <b>engine</b>(<i>name</i>)
329 <p>
330 Public method to get a reference to the named engine.
331 </p><dl>
332 <dt><i>name</i></dt>
333 <dd>
334 name of the engine (string)
335 </dd>
336 </dl><dl>
337 <dt>Returns:</dt>
338 <dd>
339 reference to the engine (OpenSearchEngine)
340 </dd>
341 </dl><a NAME="OpenSearchManager.engineExists" ID="OpenSearchManager.engineExists"></a>
342 <h4>OpenSearchManager.engineExists</h4>
343 <b>engineExists</b>(<i>name</i>)
344 <p>
345 Public method to check, if an engine exists.
346 </p><dl>
347 <dt><i>name</i></dt>
348 <dd>
349 name of the engine (string)
350 </dd>
351 </dl><dl>
352 <dt>Returns:</dt>
353 <dd>
354 flag indicating an existing engine (boolean)
355 </dd>
356 </dl><a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a>
357 <h4>OpenSearchManager.engineForKeyword</h4>
358 <b>engineForKeyword</b>(<i>keyword</i>)
359 <p>
360 Public method to get the engine for a keyword.
361 </p><dl>
362 <dt><i>keyword</i></dt>
363 <dd>
364 keyword to get engine for (string)
365 </dd>
366 </dl><dl>
367 <dt>Returns:</dt>
368 <dd>
369 reference to the search engine object (OpenSearchEngine)
370 </dd>
371 </dl><a NAME="OpenSearchManager.enginesChanged" ID="OpenSearchManager.enginesChanged"></a>
372 <h4>OpenSearchManager.enginesChanged</h4>
373 <b>enginesChanged</b>(<i></i>)
374 <p>
375 Public slot to tell the search engine manager, that something has
376 changed.
377 </p><a NAME="OpenSearchManager.enginesCount" ID="OpenSearchManager.enginesCount"></a>
378 <h4>OpenSearchManager.enginesCount</h4>
379 <b>enginesCount</b>(<i></i>)
380 <p>
381 Public method to get the number of available engines.
382 </p><dl>
383 <dt>Returns:</dt>
384 <dd>
385 number of engines (integer)
386 </dd>
387 </dl><a NAME="OpenSearchManager.enginesDirectory" ID="OpenSearchManager.enginesDirectory"></a>
388 <h4>OpenSearchManager.enginesDirectory</h4>
389 <b>enginesDirectory</b>(<i></i>)
390 <p>
391 Public method to determine the directory containing the search engine
392 descriptions.
393 </p><dl>
394 <dt>Returns:</dt>
395 <dd>
396 directory name (string)
397 </dd>
398 </dl><a NAME="OpenSearchManager.generateEngineFileName" ID="OpenSearchManager.generateEngineFileName"></a>
399 <h4>OpenSearchManager.generateEngineFileName</h4>
400 <b>generateEngineFileName</b>(<i>engineName</i>)
401 <p>
402 Public method to generate a valid engine file name.
403 </p><dl>
404 <dt><i>engineName</i></dt>
405 <dd>
406 name of the engine (string)
407 </dd>
408 </dl><dl>
409 <dt>Returns:</dt>
410 <dd>
411 valid engine file name (string)
412 </dd>
413 </dl><a NAME="OpenSearchManager.keywordsForEngine" ID="OpenSearchManager.keywordsForEngine"></a>
414 <h4>OpenSearchManager.keywordsForEngine</h4>
415 <b>keywordsForEngine</b>(<i>engine</i>)
416 <p>
417 Public method to get the keywords for a given engine.
418 </p><dl>
419 <dt><i>engine</i></dt>
420 <dd>
421 reference to the search engine object (OpenSearchEngine)
422 </dd>
423 </dl><dl>
424 <dt>Returns:</dt>
425 <dd>
426 list of keywords (list of strings)
427 </dd>
428 </dl><a NAME="OpenSearchManager.load" ID="OpenSearchManager.load"></a>
429 <h4>OpenSearchManager.load</h4>
430 <b>load</b>(<i></i>)
431 <p>
432 Public method to load the search engines configuration.
433 </p><a NAME="OpenSearchManager.loadDirectory" ID="OpenSearchManager.loadDirectory"></a>
434 <h4>OpenSearchManager.loadDirectory</h4>
435 <b>loadDirectory</b>(<i>dirName</i>)
436 <p>
437 Public method to load the search engine definitions from files.
438 </p><dl>
439 <dt><i>dirName</i></dt>
440 <dd>
441 name of the directory to load the files from (string)
442 </dd>
443 </dl><dl>
444 <dt>Returns:</dt>
445 <dd>
446 flag indicating success (boolean)
447 </dd>
448 </dl><a NAME="OpenSearchManager.removeEngine" ID="OpenSearchManager.removeEngine"></a>
449 <h4>OpenSearchManager.removeEngine</h4>
450 <b>removeEngine</b>(<i>name</i>)
451 <p>
452 Public method to remove an engine.
453 </p><dl>
454 <dt><i>name</i></dt>
455 <dd>
456 name of the engine (string)
457 </dd>
458 </dl><a NAME="OpenSearchManager.restoreDefaults" ID="OpenSearchManager.restoreDefaults"></a>
459 <h4>OpenSearchManager.restoreDefaults</h4>
460 <b>restoreDefaults</b>(<i></i>)
461 <p>
462 Public method to restore the default search engines.
463 </p><a NAME="OpenSearchManager.save" ID="OpenSearchManager.save"></a>
464 <h4>OpenSearchManager.save</h4>
465 <b>save</b>(<i></i>)
466 <p>
467 Public method to save the search engines configuration.
468 </p><a NAME="OpenSearchManager.saveDirectory" ID="OpenSearchManager.saveDirectory"></a>
469 <h4>OpenSearchManager.saveDirectory</h4>
470 <b>saveDirectory</b>(<i>dirName</i>)
471 <p>
472 Public method to save the search engine definitions to files.
473 </p><dl>
474 <dt><i>dirName</i></dt>
475 <dd>
476 name of the directory to write the files to (string)
477 </dd>
478 </dl><a NAME="OpenSearchManager.setCurrentEngine" ID="OpenSearchManager.setCurrentEngine"></a>
479 <h4>OpenSearchManager.setCurrentEngine</h4>
480 <b>setCurrentEngine</b>(<i>engine</i>)
481 <p>
482 Public method to set the current engine.
483 </p><dl>
484 <dt><i>engine</i></dt>
485 <dd>
486 reference to the new current engine (OpenSearchEngine)
487 </dd>
488 </dl><a NAME="OpenSearchManager.setCurrentEngineName" ID="OpenSearchManager.setCurrentEngineName"></a>
489 <h4>OpenSearchManager.setCurrentEngineName</h4>
490 <b>setCurrentEngineName</b>(<i>name</i>)
491 <p>
492 Public method to set the current engine by name.
493 </p><dl>
494 <dt><i>name</i></dt>
495 <dd>
496 name of the new current engine (string)
497 </dd>
498 </dl><a NAME="OpenSearchManager.setEngineForKeyword" ID="OpenSearchManager.setEngineForKeyword"></a>
499 <h4>OpenSearchManager.setEngineForKeyword</h4>
500 <b>setEngineForKeyword</b>(<i>keyword, engine</i>)
501 <p>
502 Public method to set the engine for a keyword.
503 </p><dl>
504 <dt><i>keyword</i></dt>
505 <dd>
506 keyword to get engine for (string)
507 </dd><dt><i>engine</i></dt>
508 <dd>
509 reference to the search engine object (OpenSearchEngine)
510 or None to remove the keyword
511 </dd>
512 </dl><a NAME="OpenSearchManager.setKeywordsForEngine" ID="OpenSearchManager.setKeywordsForEngine"></a>
513 <h4>OpenSearchManager.setKeywordsForEngine</h4>
514 <b>setKeywordsForEngine</b>(<i>engine, keywords</i>)
515 <p>
516 Public method to set the keywords for an engine.
517 </p><dl>
518 <dt><i>engine</i></dt>
519 <dd>
520 reference to the search engine object (OpenSearchEngine)
521 </dd><dt><i>keywords</i></dt>
522 <dd>
523 list of keywords (list of strings)
524 </dd>
525 </dl>
526 <div align="right"><a href="#top">Up</a></div>
527 <hr />
528 </body></html>

Mercurial Repository: eric

eric ide

mercurial