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