Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
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.OpenSearchManager</h1> 23 <h1>eric6.WebBrowser.OpenSearch.OpenSearchManager</h1>
24
23 <p> 25 <p>
24 Module implementing a manager for open search engines. 26 Module implementing a manager for open search engines.
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="#OpenSearchManager">OpenSearchManager</a></td> 38 <td><a href="#OpenSearchManager">OpenSearchManager</a></td>
34 <td>Class implementing a manager for open search engines.</td> 39 <td>Class implementing a manager for open search engines.</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="OpenSearchManager" ID="OpenSearchManager"></a> 49 <a NAME="OpenSearchManager" ID="OpenSearchManager"></a>
43 <h2>OpenSearchManager</h2> 50 <h2>OpenSearchManager</h2>
51
44 <p> 52 <p>
45 Class implementing a manager for open search engines. 53 Class implementing a manager for open search engines.
46 </p><h3>Signals</h3> 54 </p>
47 <dl> 55 <h3>Signals</h3>
56 <dl>
57
48 <dt>changed()</dt> 58 <dt>changed()</dt>
49 <dd> 59 <dd>
50 emitted to indicate a change 60 emitted to indicate a change
51 </dd><dt>currentEngineChanged()</dt> 61 </dd>
62 <dt>currentEngineChanged()</dt>
52 <dd> 63 <dd>
53 emitted to indicate a change of 64 emitted to indicate a change of
54 the current search engine 65 the current search engine
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>
65 <tr><td>None</td></tr> 78 <tr><td>None</td></tr>
66 </table> 79 </table>
67 <h3>Methods</h3> 80 <h3>Methods</h3>
81
68 <table> 82 <table>
83
69 <tr> 84 <tr>
70 <td><a href="#OpenSearchManager.__init__">OpenSearchManager</a></td> 85 <td><a href="#OpenSearchManager.__init__">OpenSearchManager</a></td>
71 <td>Constructor</td> 86 <td>Constructor</td>
72 </tr><tr> 87 </tr>
88 <tr>
73 <td><a href="#OpenSearchManager.__addEngineByEngine">__addEngineByEngine</a></td> 89 <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> 90 <td>Private method to add a new search engine given a reference to an engine.</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#OpenSearchManager.__addEngineByFile">__addEngineByFile</a></td> 93 <td><a href="#OpenSearchManager.__addEngineByFile">__addEngineByFile</a></td>
77 <td>Private method to add a new search engine given a filename.</td> 94 <td>Private method to add a new search engine given a filename.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#OpenSearchManager.__addEngineByUrl">__addEngineByUrl</a></td> 97 <td><a href="#OpenSearchManager.__addEngineByUrl">__addEngineByUrl</a></td>
80 <td>Private method to add a new search engine given its URL.</td> 98 <td>Private method to add a new search engine given its URL.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#OpenSearchManager.__confirmAddition">__confirmAddition</a></td> 101 <td><a href="#OpenSearchManager.__confirmAddition">__confirmAddition</a></td>
83 <td>Private method to confirm the addition of a new search engine.</td> 102 <td>Private method to confirm the addition of a new search engine.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#OpenSearchManager.__engineFromUrlAvailable">__engineFromUrlAvailable</a></td> 105 <td><a href="#OpenSearchManager.__engineFromUrlAvailable">__engineFromUrlAvailable</a></td>
86 <td>Private slot to add a search engine from the net.</td> 106 <td>Private slot to add a search engine from the net.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#OpenSearchManager.addEngine">addEngine</a></td> 109 <td><a href="#OpenSearchManager.addEngine">addEngine</a></td>
89 <td>Public method to add a new search engine.</td> 110 <td>Public method to add a new search engine.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#OpenSearchManager.addEngineFromForm">addEngineFromForm</a></td> 113 <td><a href="#OpenSearchManager.addEngineFromForm">addEngineFromForm</a></td>
92 <td>Public method to add a new search engine from a form.</td> 114 <td>Public method to add a new search engine from a form.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#OpenSearchManager.allEnginesNames">allEnginesNames</a></td> 117 <td><a href="#OpenSearchManager.allEnginesNames">allEnginesNames</a></td>
95 <td>Public method to get a list of all engine names.</td> 118 <td>Public method to get a list of all engine names.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#OpenSearchManager.close">close</a></td> 121 <td><a href="#OpenSearchManager.close">close</a></td>
98 <td>Public method to close the open search engines manager.</td> 122 <td>Public method to close the open search engines manager.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#OpenSearchManager.convertKeywordSearchToUrl">convertKeywordSearchToUrl</a></td> 125 <td><a href="#OpenSearchManager.convertKeywordSearchToUrl">convertKeywordSearchToUrl</a></td>
101 <td>Public method to get the search URL for a keyword search.</td> 126 <td>Public method to get the search URL for a keyword search.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#OpenSearchManager.currentEngine">currentEngine</a></td> 129 <td><a href="#OpenSearchManager.currentEngine">currentEngine</a></td>
104 <td>Public method to get a reference to the current engine.</td> 130 <td>Public method to get a reference to the current engine.</td>
105 </tr><tr> 131 </tr>
132 <tr>
106 <td><a href="#OpenSearchManager.currentEngineName">currentEngineName</a></td> 133 <td><a href="#OpenSearchManager.currentEngineName">currentEngineName</a></td>
107 <td>Public method to get the name of the current search engine.</td> 134 <td>Public method to get the name of the current search engine.</td>
108 </tr><tr> 135 </tr>
136 <tr>
109 <td><a href="#OpenSearchManager.engine">engine</a></td> 137 <td><a href="#OpenSearchManager.engine">engine</a></td>
110 <td>Public method to get a reference to the named engine.</td> 138 <td>Public method to get a reference to the named engine.</td>
111 </tr><tr> 139 </tr>
140 <tr>
112 <td><a href="#OpenSearchManager.engineExists">engineExists</a></td> 141 <td><a href="#OpenSearchManager.engineExists">engineExists</a></td>
113 <td>Public method to check, if an engine exists.</td> 142 <td>Public method to check, if an engine exists.</td>
114 </tr><tr> 143 </tr>
144 <tr>
115 <td><a href="#OpenSearchManager.engineForKeyword">engineForKeyword</a></td> 145 <td><a href="#OpenSearchManager.engineForKeyword">engineForKeyword</a></td>
116 <td>Public method to get the engine for a keyword.</td> 146 <td>Public method to get the engine for a keyword.</td>
117 </tr><tr> 147 </tr>
148 <tr>
118 <td><a href="#OpenSearchManager.enginesChanged">enginesChanged</a></td> 149 <td><a href="#OpenSearchManager.enginesChanged">enginesChanged</a></td>
119 <td>Public slot to tell the search engine manager, that something has changed.</td> 150 <td>Public slot to tell the search engine manager, that something has changed.</td>
120 </tr><tr> 151 </tr>
152 <tr>
121 <td><a href="#OpenSearchManager.enginesCount">enginesCount</a></td> 153 <td><a href="#OpenSearchManager.enginesCount">enginesCount</a></td>
122 <td>Public method to get the number of available engines.</td> 154 <td>Public method to get the number of available engines.</td>
123 </tr><tr> 155 </tr>
156 <tr>
124 <td><a href="#OpenSearchManager.enginesDirectory">enginesDirectory</a></td> 157 <td><a href="#OpenSearchManager.enginesDirectory">enginesDirectory</a></td>
125 <td>Public method to determine the directory containing the search engine descriptions.</td> 158 <td>Public method to determine the directory containing the search engine descriptions.</td>
126 </tr><tr> 159 </tr>
160 <tr>
127 <td><a href="#OpenSearchManager.generateEngineFileName">generateEngineFileName</a></td> 161 <td><a href="#OpenSearchManager.generateEngineFileName">generateEngineFileName</a></td>
128 <td>Public method to generate a valid engine file name.</td> 162 <td>Public method to generate a valid engine file name.</td>
129 </tr><tr> 163 </tr>
164 <tr>
130 <td><a href="#OpenSearchManager.keywordsForEngine">keywordsForEngine</a></td> 165 <td><a href="#OpenSearchManager.keywordsForEngine">keywordsForEngine</a></td>
131 <td>Public method to get the keywords for a given engine.</td> 166 <td>Public method to get the keywords for a given engine.</td>
132 </tr><tr> 167 </tr>
168 <tr>
133 <td><a href="#OpenSearchManager.load">load</a></td> 169 <td><a href="#OpenSearchManager.load">load</a></td>
134 <td>Public method to load the search engines configuration.</td> 170 <td>Public method to load the search engines configuration.</td>
135 </tr><tr> 171 </tr>
172 <tr>
136 <td><a href="#OpenSearchManager.loadDirectory">loadDirectory</a></td> 173 <td><a href="#OpenSearchManager.loadDirectory">loadDirectory</a></td>
137 <td>Public method to load the search engine definitions from files.</td> 174 <td>Public method to load the search engine definitions from files.</td>
138 </tr><tr> 175 </tr>
176 <tr>
139 <td><a href="#OpenSearchManager.removeEngine">removeEngine</a></td> 177 <td><a href="#OpenSearchManager.removeEngine">removeEngine</a></td>
140 <td>Public method to remove an engine.</td> 178 <td>Public method to remove an engine.</td>
141 </tr><tr> 179 </tr>
180 <tr>
142 <td><a href="#OpenSearchManager.restoreDefaults">restoreDefaults</a></td> 181 <td><a href="#OpenSearchManager.restoreDefaults">restoreDefaults</a></td>
143 <td>Public method to restore the default search engines.</td> 182 <td>Public method to restore the default search engines.</td>
144 </tr><tr> 183 </tr>
184 <tr>
145 <td><a href="#OpenSearchManager.save">save</a></td> 185 <td><a href="#OpenSearchManager.save">save</a></td>
146 <td>Public method to save the search engines configuration.</td> 186 <td>Public method to save the search engines configuration.</td>
147 </tr><tr> 187 </tr>
188 <tr>
148 <td><a href="#OpenSearchManager.saveDirectory">saveDirectory</a></td> 189 <td><a href="#OpenSearchManager.saveDirectory">saveDirectory</a></td>
149 <td>Public method to save the search engine definitions to files.</td> 190 <td>Public method to save the search engine definitions to files.</td>
150 </tr><tr> 191 </tr>
192 <tr>
151 <td><a href="#OpenSearchManager.setCurrentEngine">setCurrentEngine</a></td> 193 <td><a href="#OpenSearchManager.setCurrentEngine">setCurrentEngine</a></td>
152 <td>Public method to set the current engine.</td> 194 <td>Public method to set the current engine.</td>
153 </tr><tr> 195 </tr>
196 <tr>
154 <td><a href="#OpenSearchManager.setCurrentEngineName">setCurrentEngineName</a></td> 197 <td><a href="#OpenSearchManager.setCurrentEngineName">setCurrentEngineName</a></td>
155 <td>Public method to set the current engine by name.</td> 198 <td>Public method to set the current engine by name.</td>
156 </tr><tr> 199 </tr>
200 <tr>
157 <td><a href="#OpenSearchManager.setEngineForKeyword">setEngineForKeyword</a></td> 201 <td><a href="#OpenSearchManager.setEngineForKeyword">setEngineForKeyword</a></td>
158 <td>Public method to set the engine for a keyword.</td> 202 <td>Public method to set the engine for a keyword.</td>
159 </tr><tr> 203 </tr>
204 <tr>
160 <td><a href="#OpenSearchManager.setKeywordsForEngine">setKeywordsForEngine</a></td> 205 <td><a href="#OpenSearchManager.setKeywordsForEngine">setKeywordsForEngine</a></td>
161 <td>Public method to set the keywords for an engine.</td> 206 <td>Public method to set the keywords for an engine.</td>
162 </tr> 207 </tr>
163 </table> 208 </table>
164 <h3>Static Methods</h3> 209 <h3>Static Methods</h3>
210
165 <table> 211 <table>
166 <tr><td>None</td></tr> 212 <tr><td>None</td></tr>
167 </table> 213 </table>
214
168 <a NAME="OpenSearchManager.__init__" ID="OpenSearchManager.__init__"></a> 215 <a NAME="OpenSearchManager.__init__" ID="OpenSearchManager.__init__"></a>
169 <h4>OpenSearchManager (Constructor)</h4> 216 <h4>OpenSearchManager (Constructor)</h4>
170 <b>OpenSearchManager</b>(<i>parent=None</i>) 217 <b>OpenSearchManager</b>(<i>parent=None</i>)
218
171 <p> 219 <p>
172 Constructor 220 Constructor
173 </p><dl> 221 </p>
222 <dl>
223
174 <dt><i>parent</i></dt> 224 <dt><i>parent</i></dt>
175 <dd> 225 <dd>
176 reference to the parent object (QObject) 226 reference to the parent object (QObject)
177 </dd> 227 </dd>
178 </dl><a NAME="OpenSearchManager.__addEngineByEngine" ID="OpenSearchManager.__addEngineByEngine"></a> 228 </dl>
229 <a NAME="OpenSearchManager.__addEngineByEngine" ID="OpenSearchManager.__addEngineByEngine"></a>
179 <h4>OpenSearchManager.__addEngineByEngine</h4> 230 <h4>OpenSearchManager.__addEngineByEngine</h4>
180 <b>__addEngineByEngine</b>(<i>engine</i>) 231 <b>__addEngineByEngine</b>(<i>engine</i>)
232
181 <p> 233 <p>
182 Private method to add a new search engine given a reference to an 234 Private method to add a new search engine given a reference to an
183 engine. 235 engine.
184 </p><dl> 236 </p>
237 <dl>
238
185 <dt><i>engine</i></dt> 239 <dt><i>engine</i></dt>
186 <dd> 240 <dd>
187 reference to an engine object (OpenSearchEngine) 241 reference to an engine object (OpenSearchEngine)
188 </dd> 242 </dd>
189 </dl><dl> 243 </dl>
244 <dl>
190 <dt>Returns:</dt> 245 <dt>Returns:</dt>
191 <dd> 246 <dd>
192 flag indicating success (boolean) 247 flag indicating success (boolean)
193 </dd> 248 </dd>
194 </dl><a NAME="OpenSearchManager.__addEngineByFile" ID="OpenSearchManager.__addEngineByFile"></a> 249 </dl>
250 <a NAME="OpenSearchManager.__addEngineByFile" ID="OpenSearchManager.__addEngineByFile"></a>
195 <h4>OpenSearchManager.__addEngineByFile</h4> 251 <h4>OpenSearchManager.__addEngineByFile</h4>
196 <b>__addEngineByFile</b>(<i>filename</i>) 252 <b>__addEngineByFile</b>(<i>filename</i>)
253
197 <p> 254 <p>
198 Private method to add a new search engine given a filename. 255 Private method to add a new search engine given a filename.
199 </p><dl> 256 </p>
257 <dl>
258
200 <dt><i>filename</i></dt> 259 <dt><i>filename</i></dt>
201 <dd> 260 <dd>
202 name of a file containing the engine definition 261 name of a file containing the engine definition
203 (string) 262 (string)
204 </dd> 263 </dd>
205 </dl><dl> 264 </dl>
265 <dl>
206 <dt>Returns:</dt> 266 <dt>Returns:</dt>
207 <dd> 267 <dd>
208 flag indicating success (boolean) 268 flag indicating success (boolean)
209 </dd> 269 </dd>
210 </dl><a NAME="OpenSearchManager.__addEngineByUrl" ID="OpenSearchManager.__addEngineByUrl"></a> 270 </dl>
271 <a NAME="OpenSearchManager.__addEngineByUrl" ID="OpenSearchManager.__addEngineByUrl"></a>
211 <h4>OpenSearchManager.__addEngineByUrl</h4> 272 <h4>OpenSearchManager.__addEngineByUrl</h4>
212 <b>__addEngineByUrl</b>(<i>url</i>) 273 <b>__addEngineByUrl</b>(<i>url</i>)
274
213 <p> 275 <p>
214 Private method to add a new search engine given its URL. 276 Private method to add a new search engine given its URL.
215 </p><dl> 277 </p>
278 <dl>
279
216 <dt><i>url</i></dt> 280 <dt><i>url</i></dt>
217 <dd> 281 <dd>
218 URL of the engine definition file (QUrl) 282 URL of the engine definition file (QUrl)
219 </dd> 283 </dd>
220 </dl><dl> 284 </dl>
285 <dl>
221 <dt>Returns:</dt> 286 <dt>Returns:</dt>
222 <dd> 287 <dd>
223 flag indicating success (boolean) 288 flag indicating success (boolean)
224 </dd> 289 </dd>
225 </dl><a NAME="OpenSearchManager.__confirmAddition" ID="OpenSearchManager.__confirmAddition"></a> 290 </dl>
291 <a NAME="OpenSearchManager.__confirmAddition" ID="OpenSearchManager.__confirmAddition"></a>
226 <h4>OpenSearchManager.__confirmAddition</h4> 292 <h4>OpenSearchManager.__confirmAddition</h4>
227 <b>__confirmAddition</b>(<i>engine</i>) 293 <b>__confirmAddition</b>(<i>engine</i>)
294
228 <p> 295 <p>
229 Private method to confirm the addition of a new search engine. 296 Private method to confirm the addition of a new search engine.
230 </p><dl> 297 </p>
298 <dl>
299
231 <dt><i>engine</i></dt> 300 <dt><i>engine</i></dt>
232 <dd> 301 <dd>
233 reference to the engine to be added (OpenSearchEngine) 302 reference to the engine to be added (OpenSearchEngine)
234 </dd> 303 </dd>
235 </dl><dl> 304 </dl>
305 <dl>
236 <dt>Returns:</dt> 306 <dt>Returns:</dt>
237 <dd> 307 <dd>
238 flag indicating the engine shall be added (boolean) 308 flag indicating the engine shall be added (boolean)
239 </dd> 309 </dd>
240 </dl><a NAME="OpenSearchManager.__engineFromUrlAvailable" ID="OpenSearchManager.__engineFromUrlAvailable"></a> 310 </dl>
311 <a NAME="OpenSearchManager.__engineFromUrlAvailable" ID="OpenSearchManager.__engineFromUrlAvailable"></a>
241 <h4>OpenSearchManager.__engineFromUrlAvailable</h4> 312 <h4>OpenSearchManager.__engineFromUrlAvailable</h4>
242 <b>__engineFromUrlAvailable</b>(<i>reply</i>) 313 <b>__engineFromUrlAvailable</b>(<i>reply</i>)
314
243 <p> 315 <p>
244 Private slot to add a search engine from the net. 316 Private slot to add a search engine from the net.
245 </p><dl> 317 </p>
318 <dl>
319
246 <dt><i>reply</i> (QNetworkReply)</dt> 320 <dt><i>reply</i> (QNetworkReply)</dt>
247 <dd> 321 <dd>
248 reference to the network reply 322 reference to the network reply
249 </dd> 323 </dd>
250 </dl><a NAME="OpenSearchManager.addEngine" ID="OpenSearchManager.addEngine"></a> 324 </dl>
325 <a NAME="OpenSearchManager.addEngine" ID="OpenSearchManager.addEngine"></a>
251 <h4>OpenSearchManager.addEngine</h4> 326 <h4>OpenSearchManager.addEngine</h4>
252 <b>addEngine</b>(<i>engine</i>) 327 <b>addEngine</b>(<i>engine</i>)
328
253 <p> 329 <p>
254 Public method to add a new search engine. 330 Public method to add a new search engine.
255 </p><dl> 331 </p>
332 <dl>
333
256 <dt><i>engine</i></dt> 334 <dt><i>engine</i></dt>
257 <dd> 335 <dd>
258 URL of the engine definition file (QUrl) or 336 URL of the engine definition file (QUrl) or
259 name of a file containing the engine definition (string) 337 name of a file containing the engine definition (string)
260 or reference to an engine object (OpenSearchEngine) 338 or reference to an engine object (OpenSearchEngine)
261 </dd> 339 </dd>
262 </dl><dl> 340 </dl>
341 <dl>
263 <dt>Returns:</dt> 342 <dt>Returns:</dt>
264 <dd> 343 <dd>
265 flag indicating success (boolean) 344 flag indicating success (boolean)
266 </dd> 345 </dd>
267 </dl><a NAME="OpenSearchManager.addEngineFromForm" ID="OpenSearchManager.addEngineFromForm"></a> 346 </dl>
347 <a NAME="OpenSearchManager.addEngineFromForm" ID="OpenSearchManager.addEngineFromForm"></a>
268 <h4>OpenSearchManager.addEngineFromForm</h4> 348 <h4>OpenSearchManager.addEngineFromForm</h4>
269 <b>addEngineFromForm</b>(<i>res, view</i>) 349 <b>addEngineFromForm</b>(<i>res, view</i>)
350
270 <p> 351 <p>
271 Public method to add a new search engine from a form. 352 Public method to add a new search engine from a form.
272 </p><dl> 353 </p>
354 <dl>
355
273 <dt><i>res</i> (dict or None)</dt> 356 <dt><i>res</i> (dict or None)</dt>
274 <dd> 357 <dd>
275 result of the JavaScript run on by 358 result of the JavaScript run on by
276 WebBrowserView.__addSearchEngine() 359 WebBrowserView.__addSearchEngine()
277 </dd><dt><i>view</i> (WebBrowserView)</dt> 360 </dd>
361 <dt><i>view</i> (WebBrowserView)</dt>
278 <dd> 362 <dd>
279 reference to the web browser view 363 reference to the web browser view
280 </dd> 364 </dd>
281 </dl><a NAME="OpenSearchManager.allEnginesNames" ID="OpenSearchManager.allEnginesNames"></a> 365 </dl>
366 <a NAME="OpenSearchManager.allEnginesNames" ID="OpenSearchManager.allEnginesNames"></a>
282 <h4>OpenSearchManager.allEnginesNames</h4> 367 <h4>OpenSearchManager.allEnginesNames</h4>
283 <b>allEnginesNames</b>(<i></i>) 368 <b>allEnginesNames</b>(<i></i>)
369
284 <p> 370 <p>
285 Public method to get a list of all engine names. 371 Public method to get a list of all engine names.
286 </p><dl> 372 </p>
373 <dl>
287 <dt>Returns:</dt> 374 <dt>Returns:</dt>
288 <dd> 375 <dd>
289 sorted list of all engine names (list of strings) 376 sorted list of all engine names (list of strings)
290 </dd> 377 </dd>
291 </dl><a NAME="OpenSearchManager.close" ID="OpenSearchManager.close"></a> 378 </dl>
379 <a NAME="OpenSearchManager.close" ID="OpenSearchManager.close"></a>
292 <h4>OpenSearchManager.close</h4> 380 <h4>OpenSearchManager.close</h4>
293 <b>close</b>(<i></i>) 381 <b>close</b>(<i></i>)
382
294 <p> 383 <p>
295 Public method to close the open search engines manager. 384 Public method to close the open search engines manager.
296 </p><a NAME="OpenSearchManager.convertKeywordSearchToUrl" ID="OpenSearchManager.convertKeywordSearchToUrl"></a> 385 </p>
386 <a NAME="OpenSearchManager.convertKeywordSearchToUrl" ID="OpenSearchManager.convertKeywordSearchToUrl"></a>
297 <h4>OpenSearchManager.convertKeywordSearchToUrl</h4> 387 <h4>OpenSearchManager.convertKeywordSearchToUrl</h4>
298 <b>convertKeywordSearchToUrl</b>(<i>keywordSearch</i>) 388 <b>convertKeywordSearchToUrl</b>(<i>keywordSearch</i>)
389
299 <p> 390 <p>
300 Public method to get the search URL for a keyword search. 391 Public method to get the search URL for a keyword search.
301 </p><dl> 392 </p>
393 <dl>
394
302 <dt><i>keywordSearch</i></dt> 395 <dt><i>keywordSearch</i></dt>
303 <dd> 396 <dd>
304 search string for keyword search (string) 397 search string for keyword search (string)
305 </dd> 398 </dd>
306 </dl><dl> 399 </dl>
400 <dl>
307 <dt>Returns:</dt> 401 <dt>Returns:</dt>
308 <dd> 402 <dd>
309 search URL (QUrl) 403 search URL (QUrl)
310 </dd> 404 </dd>
311 </dl><a NAME="OpenSearchManager.currentEngine" ID="OpenSearchManager.currentEngine"></a> 405 </dl>
406 <a NAME="OpenSearchManager.currentEngine" ID="OpenSearchManager.currentEngine"></a>
312 <h4>OpenSearchManager.currentEngine</h4> 407 <h4>OpenSearchManager.currentEngine</h4>
313 <b>currentEngine</b>(<i></i>) 408 <b>currentEngine</b>(<i></i>)
409
314 <p> 410 <p>
315 Public method to get a reference to the current engine. 411 Public method to get a reference to the current engine.
316 </p><dl> 412 </p>
413 <dl>
317 <dt>Returns:</dt> 414 <dt>Returns:</dt>
318 <dd> 415 <dd>
319 reference to the current engine (OpenSearchEngine) 416 reference to the current engine (OpenSearchEngine)
320 </dd> 417 </dd>
321 </dl><a NAME="OpenSearchManager.currentEngineName" ID="OpenSearchManager.currentEngineName"></a> 418 </dl>
419 <a NAME="OpenSearchManager.currentEngineName" ID="OpenSearchManager.currentEngineName"></a>
322 <h4>OpenSearchManager.currentEngineName</h4> 420 <h4>OpenSearchManager.currentEngineName</h4>
323 <b>currentEngineName</b>(<i></i>) 421 <b>currentEngineName</b>(<i></i>)
422
324 <p> 423 <p>
325 Public method to get the name of the current search engine. 424 Public method to get the name of the current search engine.
326 </p><dl> 425 </p>
426 <dl>
327 <dt>Returns:</dt> 427 <dt>Returns:</dt>
328 <dd> 428 <dd>
329 name of the current search engine (string) 429 name of the current search engine (string)
330 </dd> 430 </dd>
331 </dl><a NAME="OpenSearchManager.engine" ID="OpenSearchManager.engine"></a> 431 </dl>
432 <a NAME="OpenSearchManager.engine" ID="OpenSearchManager.engine"></a>
332 <h4>OpenSearchManager.engine</h4> 433 <h4>OpenSearchManager.engine</h4>
333 <b>engine</b>(<i>name</i>) 434 <b>engine</b>(<i>name</i>)
435
334 <p> 436 <p>
335 Public method to get a reference to the named engine. 437 Public method to get a reference to the named engine.
336 </p><dl> 438 </p>
439 <dl>
440
337 <dt><i>name</i></dt> 441 <dt><i>name</i></dt>
338 <dd> 442 <dd>
339 name of the engine (string) 443 name of the engine (string)
340 </dd> 444 </dd>
341 </dl><dl> 445 </dl>
446 <dl>
342 <dt>Returns:</dt> 447 <dt>Returns:</dt>
343 <dd> 448 <dd>
344 reference to the engine (OpenSearchEngine) 449 reference to the engine (OpenSearchEngine)
345 </dd> 450 </dd>
346 </dl><a NAME="OpenSearchManager.engineExists" ID="OpenSearchManager.engineExists"></a> 451 </dl>
452 <a NAME="OpenSearchManager.engineExists" ID="OpenSearchManager.engineExists"></a>
347 <h4>OpenSearchManager.engineExists</h4> 453 <h4>OpenSearchManager.engineExists</h4>
348 <b>engineExists</b>(<i>name</i>) 454 <b>engineExists</b>(<i>name</i>)
455
349 <p> 456 <p>
350 Public method to check, if an engine exists. 457 Public method to check, if an engine exists.
351 </p><dl> 458 </p>
459 <dl>
460
352 <dt><i>name</i></dt> 461 <dt><i>name</i></dt>
353 <dd> 462 <dd>
354 name of the engine (string) 463 name of the engine (string)
355 </dd> 464 </dd>
356 </dl><dl> 465 </dl>
466 <dl>
357 <dt>Returns:</dt> 467 <dt>Returns:</dt>
358 <dd> 468 <dd>
359 flag indicating an existing engine (boolean) 469 flag indicating an existing engine (boolean)
360 </dd> 470 </dd>
361 </dl><a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a> 471 </dl>
472 <a NAME="OpenSearchManager.engineForKeyword" ID="OpenSearchManager.engineForKeyword"></a>
362 <h4>OpenSearchManager.engineForKeyword</h4> 473 <h4>OpenSearchManager.engineForKeyword</h4>
363 <b>engineForKeyword</b>(<i>keyword</i>) 474 <b>engineForKeyword</b>(<i>keyword</i>)
475
364 <p> 476 <p>
365 Public method to get the engine for a keyword. 477 Public method to get the engine for a keyword.
366 </p><dl> 478 </p>
479 <dl>
480
367 <dt><i>keyword</i></dt> 481 <dt><i>keyword</i></dt>
368 <dd> 482 <dd>
369 keyword to get engine for (string) 483 keyword to get engine for (string)
370 </dd> 484 </dd>
371 </dl><dl> 485 </dl>
486 <dl>
372 <dt>Returns:</dt> 487 <dt>Returns:</dt>
373 <dd> 488 <dd>
374 reference to the search engine object (OpenSearchEngine) 489 reference to the search engine object (OpenSearchEngine)
375 </dd> 490 </dd>
376 </dl><a NAME="OpenSearchManager.enginesChanged" ID="OpenSearchManager.enginesChanged"></a> 491 </dl>
492 <a NAME="OpenSearchManager.enginesChanged" ID="OpenSearchManager.enginesChanged"></a>
377 <h4>OpenSearchManager.enginesChanged</h4> 493 <h4>OpenSearchManager.enginesChanged</h4>
378 <b>enginesChanged</b>(<i></i>) 494 <b>enginesChanged</b>(<i></i>)
495
379 <p> 496 <p>
380 Public slot to tell the search engine manager, that something has 497 Public slot to tell the search engine manager, that something has
381 changed. 498 changed.
382 </p><a NAME="OpenSearchManager.enginesCount" ID="OpenSearchManager.enginesCount"></a> 499 </p>
500 <a NAME="OpenSearchManager.enginesCount" ID="OpenSearchManager.enginesCount"></a>
383 <h4>OpenSearchManager.enginesCount</h4> 501 <h4>OpenSearchManager.enginesCount</h4>
384 <b>enginesCount</b>(<i></i>) 502 <b>enginesCount</b>(<i></i>)
503
385 <p> 504 <p>
386 Public method to get the number of available engines. 505 Public method to get the number of available engines.
387 </p><dl> 506 </p>
507 <dl>
388 <dt>Returns:</dt> 508 <dt>Returns:</dt>
389 <dd> 509 <dd>
390 number of engines (integer) 510 number of engines (integer)
391 </dd> 511 </dd>
392 </dl><a NAME="OpenSearchManager.enginesDirectory" ID="OpenSearchManager.enginesDirectory"></a> 512 </dl>
513 <a NAME="OpenSearchManager.enginesDirectory" ID="OpenSearchManager.enginesDirectory"></a>
393 <h4>OpenSearchManager.enginesDirectory</h4> 514 <h4>OpenSearchManager.enginesDirectory</h4>
394 <b>enginesDirectory</b>(<i></i>) 515 <b>enginesDirectory</b>(<i></i>)
516
395 <p> 517 <p>
396 Public method to determine the directory containing the search engine 518 Public method to determine the directory containing the search engine
397 descriptions. 519 descriptions.
398 </p><dl> 520 </p>
521 <dl>
399 <dt>Returns:</dt> 522 <dt>Returns:</dt>
400 <dd> 523 <dd>
401 directory name (string) 524 directory name (string)
402 </dd> 525 </dd>
403 </dl><a NAME="OpenSearchManager.generateEngineFileName" ID="OpenSearchManager.generateEngineFileName"></a> 526 </dl>
527 <a NAME="OpenSearchManager.generateEngineFileName" ID="OpenSearchManager.generateEngineFileName"></a>
404 <h4>OpenSearchManager.generateEngineFileName</h4> 528 <h4>OpenSearchManager.generateEngineFileName</h4>
405 <b>generateEngineFileName</b>(<i>engineName</i>) 529 <b>generateEngineFileName</b>(<i>engineName</i>)
530
406 <p> 531 <p>
407 Public method to generate a valid engine file name. 532 Public method to generate a valid engine file name.
408 </p><dl> 533 </p>
534 <dl>
535
409 <dt><i>engineName</i></dt> 536 <dt><i>engineName</i></dt>
410 <dd> 537 <dd>
411 name of the engine (string) 538 name of the engine (string)
412 </dd> 539 </dd>
413 </dl><dl> 540 </dl>
541 <dl>
414 <dt>Returns:</dt> 542 <dt>Returns:</dt>
415 <dd> 543 <dd>
416 valid engine file name (string) 544 valid engine file name (string)
417 </dd> 545 </dd>
418 </dl><a NAME="OpenSearchManager.keywordsForEngine" ID="OpenSearchManager.keywordsForEngine"></a> 546 </dl>
547 <a NAME="OpenSearchManager.keywordsForEngine" ID="OpenSearchManager.keywordsForEngine"></a>
419 <h4>OpenSearchManager.keywordsForEngine</h4> 548 <h4>OpenSearchManager.keywordsForEngine</h4>
420 <b>keywordsForEngine</b>(<i>engine</i>) 549 <b>keywordsForEngine</b>(<i>engine</i>)
550
421 <p> 551 <p>
422 Public method to get the keywords for a given engine. 552 Public method to get the keywords for a given engine.
423 </p><dl> 553 </p>
554 <dl>
555
424 <dt><i>engine</i></dt> 556 <dt><i>engine</i></dt>
425 <dd> 557 <dd>
426 reference to the search engine object (OpenSearchEngine) 558 reference to the search engine object (OpenSearchEngine)
427 </dd> 559 </dd>
428 </dl><dl> 560 </dl>
561 <dl>
429 <dt>Returns:</dt> 562 <dt>Returns:</dt>
430 <dd> 563 <dd>
431 list of keywords (list of strings) 564 list of keywords (list of strings)
432 </dd> 565 </dd>
433 </dl><a NAME="OpenSearchManager.load" ID="OpenSearchManager.load"></a> 566 </dl>
567 <a NAME="OpenSearchManager.load" ID="OpenSearchManager.load"></a>
434 <h4>OpenSearchManager.load</h4> 568 <h4>OpenSearchManager.load</h4>
435 <b>load</b>(<i></i>) 569 <b>load</b>(<i></i>)
570
436 <p> 571 <p>
437 Public method to load the search engines configuration. 572 Public method to load the search engines configuration.
438 </p><a NAME="OpenSearchManager.loadDirectory" ID="OpenSearchManager.loadDirectory"></a> 573 </p>
574 <a NAME="OpenSearchManager.loadDirectory" ID="OpenSearchManager.loadDirectory"></a>
439 <h4>OpenSearchManager.loadDirectory</h4> 575 <h4>OpenSearchManager.loadDirectory</h4>
440 <b>loadDirectory</b>(<i>dirName</i>) 576 <b>loadDirectory</b>(<i>dirName</i>)
577
441 <p> 578 <p>
442 Public method to load the search engine definitions from files. 579 Public method to load the search engine definitions from files.
443 </p><dl> 580 </p>
581 <dl>
582
444 <dt><i>dirName</i></dt> 583 <dt><i>dirName</i></dt>
445 <dd> 584 <dd>
446 name of the directory to load the files from (string) 585 name of the directory to load the files from (string)
447 </dd> 586 </dd>
448 </dl><dl> 587 </dl>
588 <dl>
449 <dt>Returns:</dt> 589 <dt>Returns:</dt>
450 <dd> 590 <dd>
451 flag indicating success (boolean) 591 flag indicating success (boolean)
452 </dd> 592 </dd>
453 </dl><a NAME="OpenSearchManager.removeEngine" ID="OpenSearchManager.removeEngine"></a> 593 </dl>
594 <a NAME="OpenSearchManager.removeEngine" ID="OpenSearchManager.removeEngine"></a>
454 <h4>OpenSearchManager.removeEngine</h4> 595 <h4>OpenSearchManager.removeEngine</h4>
455 <b>removeEngine</b>(<i>name</i>) 596 <b>removeEngine</b>(<i>name</i>)
597
456 <p> 598 <p>
457 Public method to remove an engine. 599 Public method to remove an engine.
458 </p><dl> 600 </p>
601 <dl>
602
459 <dt><i>name</i></dt> 603 <dt><i>name</i></dt>
460 <dd> 604 <dd>
461 name of the engine (string) 605 name of the engine (string)
462 </dd> 606 </dd>
463 </dl><a NAME="OpenSearchManager.restoreDefaults" ID="OpenSearchManager.restoreDefaults"></a> 607 </dl>
608 <a NAME="OpenSearchManager.restoreDefaults" ID="OpenSearchManager.restoreDefaults"></a>
464 <h4>OpenSearchManager.restoreDefaults</h4> 609 <h4>OpenSearchManager.restoreDefaults</h4>
465 <b>restoreDefaults</b>(<i></i>) 610 <b>restoreDefaults</b>(<i></i>)
611
466 <p> 612 <p>
467 Public method to restore the default search engines. 613 Public method to restore the default search engines.
468 </p><a NAME="OpenSearchManager.save" ID="OpenSearchManager.save"></a> 614 </p>
615 <a NAME="OpenSearchManager.save" ID="OpenSearchManager.save"></a>
469 <h4>OpenSearchManager.save</h4> 616 <h4>OpenSearchManager.save</h4>
470 <b>save</b>(<i></i>) 617 <b>save</b>(<i></i>)
618
471 <p> 619 <p>
472 Public method to save the search engines configuration. 620 Public method to save the search engines configuration.
473 </p><a NAME="OpenSearchManager.saveDirectory" ID="OpenSearchManager.saveDirectory"></a> 621 </p>
622 <a NAME="OpenSearchManager.saveDirectory" ID="OpenSearchManager.saveDirectory"></a>
474 <h4>OpenSearchManager.saveDirectory</h4> 623 <h4>OpenSearchManager.saveDirectory</h4>
475 <b>saveDirectory</b>(<i>dirName</i>) 624 <b>saveDirectory</b>(<i>dirName</i>)
625
476 <p> 626 <p>
477 Public method to save the search engine definitions to files. 627 Public method to save the search engine definitions to files.
478 </p><dl> 628 </p>
629 <dl>
630
479 <dt><i>dirName</i></dt> 631 <dt><i>dirName</i></dt>
480 <dd> 632 <dd>
481 name of the directory to write the files to (string) 633 name of the directory to write the files to (string)
482 </dd> 634 </dd>
483 </dl><a NAME="OpenSearchManager.setCurrentEngine" ID="OpenSearchManager.setCurrentEngine"></a> 635 </dl>
636 <a NAME="OpenSearchManager.setCurrentEngine" ID="OpenSearchManager.setCurrentEngine"></a>
484 <h4>OpenSearchManager.setCurrentEngine</h4> 637 <h4>OpenSearchManager.setCurrentEngine</h4>
485 <b>setCurrentEngine</b>(<i>engine</i>) 638 <b>setCurrentEngine</b>(<i>engine</i>)
639
486 <p> 640 <p>
487 Public method to set the current engine. 641 Public method to set the current engine.
488 </p><dl> 642 </p>
643 <dl>
644
489 <dt><i>engine</i></dt> 645 <dt><i>engine</i></dt>
490 <dd> 646 <dd>
491 reference to the new current engine (OpenSearchEngine) 647 reference to the new current engine (OpenSearchEngine)
492 </dd> 648 </dd>
493 </dl><a NAME="OpenSearchManager.setCurrentEngineName" ID="OpenSearchManager.setCurrentEngineName"></a> 649 </dl>
650 <a NAME="OpenSearchManager.setCurrentEngineName" ID="OpenSearchManager.setCurrentEngineName"></a>
494 <h4>OpenSearchManager.setCurrentEngineName</h4> 651 <h4>OpenSearchManager.setCurrentEngineName</h4>
495 <b>setCurrentEngineName</b>(<i>name</i>) 652 <b>setCurrentEngineName</b>(<i>name</i>)
653
496 <p> 654 <p>
497 Public method to set the current engine by name. 655 Public method to set the current engine by name.
498 </p><dl> 656 </p>
657 <dl>
658
499 <dt><i>name</i></dt> 659 <dt><i>name</i></dt>
500 <dd> 660 <dd>
501 name of the new current engine (string) 661 name of the new current engine (string)
502 </dd> 662 </dd>
503 </dl><a NAME="OpenSearchManager.setEngineForKeyword" ID="OpenSearchManager.setEngineForKeyword"></a> 663 </dl>
664 <a NAME="OpenSearchManager.setEngineForKeyword" ID="OpenSearchManager.setEngineForKeyword"></a>
504 <h4>OpenSearchManager.setEngineForKeyword</h4> 665 <h4>OpenSearchManager.setEngineForKeyword</h4>
505 <b>setEngineForKeyword</b>(<i>keyword, engine</i>) 666 <b>setEngineForKeyword</b>(<i>keyword, engine</i>)
667
506 <p> 668 <p>
507 Public method to set the engine for a keyword. 669 Public method to set the engine for a keyword.
508 </p><dl> 670 </p>
671 <dl>
672
509 <dt><i>keyword</i></dt> 673 <dt><i>keyword</i></dt>
510 <dd> 674 <dd>
511 keyword to get engine for (string) 675 keyword to get engine for (string)
512 </dd><dt><i>engine</i></dt> 676 </dd>
677 <dt><i>engine</i></dt>
513 <dd> 678 <dd>
514 reference to the search engine object (OpenSearchEngine) 679 reference to the search engine object (OpenSearchEngine)
515 or None to remove the keyword 680 or None to remove the keyword
516 </dd> 681 </dd>
517 </dl><a NAME="OpenSearchManager.setKeywordsForEngine" ID="OpenSearchManager.setKeywordsForEngine"></a> 682 </dl>
683 <a NAME="OpenSearchManager.setKeywordsForEngine" ID="OpenSearchManager.setKeywordsForEngine"></a>
518 <h4>OpenSearchManager.setKeywordsForEngine</h4> 684 <h4>OpenSearchManager.setKeywordsForEngine</h4>
519 <b>setKeywordsForEngine</b>(<i>engine, keywords</i>) 685 <b>setKeywordsForEngine</b>(<i>engine, keywords</i>)
686
520 <p> 687 <p>
521 Public method to set the keywords for an engine. 688 Public method to set the keywords for an engine.
522 </p><dl> 689 </p>
690 <dl>
691
523 <dt><i>engine</i></dt> 692 <dt><i>engine</i></dt>
524 <dd> 693 <dd>
525 reference to the search engine object (OpenSearchEngine) 694 reference to the search engine object (OpenSearchEngine)
526 </dd><dt><i>keywords</i></dt> 695 </dd>
696 <dt><i>keywords</i></dt>
527 <dd> 697 <dd>
528 list of keywords (list of strings) 698 list of keywords (list of strings)
529 </dd> 699 </dd>
530 </dl> 700 </dl>
531 <div align="right"><a href="#top">Up</a></div> 701 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial