Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial