src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserWebSearchWidget.html

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.WebBrowserWebSearchWidget</h1> 9 <h1>eric7.WebBrowser.WebBrowserWebSearchWidget</h1>
10
11 <p> 10 <p>
12 Module implementing a web search widget for the web browser. 11 Module implementing a web search widget for the web browser.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#WebBrowserWebSearchWidget">WebBrowserWebSearchWidget</a></td> 22 <td><a href="#WebBrowserWebSearchWidget">WebBrowserWebSearchWidget</a></td>
25 <td>Class implementing a web search widget for the web browser.</td> 23 <td>Class implementing a web search widget for the web browser.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="WebBrowserWebSearchWidget" ID="WebBrowserWebSearchWidget"></a> 34 <a NAME="WebBrowserWebSearchWidget" ID="WebBrowserWebSearchWidget"></a>
36 <h2>WebBrowserWebSearchWidget</h2> 35 <h2>WebBrowserWebSearchWidget</h2>
37
38 <p> 36 <p>
39 Class implementing a web search widget for the web browser. 37 Class implementing a web search widget for the web browser.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>search(QUrl)</dt> 43 <dt>search(QUrl)</dt>
45 <dd> 44 <dd>
47 </dd> 46 </dd>
48 </dl> 47 </dl>
49 <h3>Derived from</h3> 48 <h3>Derived from</h3>
50 EricClearableLineEdit 49 EricClearableLineEdit
51 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
52 51 <table>
53 <table> 52 <tr><td>None</td></tr>
54 <tr><td>None</td></tr> 53 </table>
55 </table> 54
56 <h3>Class Methods</h3> 55 <h3>Class Methods</h3>
57 56 <table>
58 <table> 57 <tr><td>None</td></tr>
59 <tr><td>None</td></tr> 58 </table>
60 </table> 59
61 <h3>Methods</h3> 60 <h3>Methods</h3>
62 61 <table>
63 <table>
64
65 <tr> 62 <tr>
66 <td><a href="#WebBrowserWebSearchWidget.__init__">WebBrowserWebSearchWidget</a></td> 63 <td><a href="#WebBrowserWebSearchWidget.__init__">WebBrowserWebSearchWidget</a></td>
67 <td>Constructor</td> 64 <td>Constructor</td>
68 </tr> 65 </tr>
69 <tr> 66 <tr>
141 <tr> 138 <tr>
142 <td><a href="#WebBrowserWebSearchWidget.saveSearches">saveSearches</a></td> 139 <td><a href="#WebBrowserWebSearchWidget.saveSearches">saveSearches</a></td>
143 <td>Public method to save the recently performed web searches.</td> 140 <td>Public method to save the recently performed web searches.</td>
144 </tr> 141 </tr>
145 </table> 142 </table>
143
146 <h3>Static Methods</h3> 144 <h3>Static Methods</h3>
147 145 <table>
148 <table> 146 <tr><td>None</td></tr>
149 <tr><td>None</td></tr> 147 </table>
150 </table> 148
151 149
152 <a NAME="WebBrowserWebSearchWidget.__init__" ID="WebBrowserWebSearchWidget.__init__"></a> 150 <a NAME="WebBrowserWebSearchWidget.__init__" ID="WebBrowserWebSearchWidget.__init__"></a>
153 <h4>WebBrowserWebSearchWidget (Constructor)</h4> 151 <h4>WebBrowserWebSearchWidget (Constructor)</h4>
154 <b>WebBrowserWebSearchWidget</b>(<i>mainWindow, parent=None</i>) 152 <b>WebBrowserWebSearchWidget</b>(<i>mainWindow, parent=None</i>)
155
156 <p> 153 <p>
157 Constructor 154 Constructor
158 </p> 155 </p>
156
159 <dl> 157 <dl>
160 158
161 <dt><i>mainWindow</i> (WebBrowserWindow)</dt> 159 <dt><i>mainWindow</i> (WebBrowserWindow)</dt>
162 <dd> 160 <dd>
163 reference to the browser main window 161 reference to the browser main window
168 </dd> 166 </dd>
169 </dl> 167 </dl>
170 <a NAME="WebBrowserWebSearchWidget.__completerActivated" ID="WebBrowserWebSearchWidget.__completerActivated"></a> 168 <a NAME="WebBrowserWebSearchWidget.__completerActivated" ID="WebBrowserWebSearchWidget.__completerActivated"></a>
171 <h4>WebBrowserWebSearchWidget.__completerActivated</h4> 169 <h4>WebBrowserWebSearchWidget.__completerActivated</h4>
172 <b>__completerActivated</b>(<i>index</i>) 170 <b>__completerActivated</b>(<i>index</i>)
173
174 <p> 171 <p>
175 Private slot handling the selection of an entry from the completer. 172 Private slot handling the selection of an entry from the completer.
176 </p> 173 </p>
174
177 <dl> 175 <dl>
178 176
179 <dt><i>index</i> (QModelIndex)</dt> 177 <dt><i>index</i> (QModelIndex)</dt>
180 <dd> 178 <dd>
181 index of the item 179 index of the item
182 </dd> 180 </dd>
183 </dl> 181 </dl>
184 <a NAME="WebBrowserWebSearchWidget.__completerHighlighted" ID="WebBrowserWebSearchWidget.__completerHighlighted"></a> 182 <a NAME="WebBrowserWebSearchWidget.__completerHighlighted" ID="WebBrowserWebSearchWidget.__completerHighlighted"></a>
185 <h4>WebBrowserWebSearchWidget.__completerHighlighted</h4> 183 <h4>WebBrowserWebSearchWidget.__completerHighlighted</h4>
186 <b>__completerHighlighted</b>(<i>index</i>) 184 <b>__completerHighlighted</b>(<i>index</i>)
187
188 <p> 185 <p>
189 Private slot handling the highlighting of an entry of the completer. 186 Private slot handling the highlighting of an entry of the completer.
190 </p> 187 </p>
188
191 <dl> 189 <dl>
192 190
193 <dt><i>index</i> (QModelIndex)</dt> 191 <dt><i>index</i> (QModelIndex)</dt>
194 <dd> 192 <dd>
195 index of the item 193 index of the item
208 </dd> 206 </dd>
209 </dl> 207 </dl>
210 <a NAME="WebBrowserWebSearchWidget.__currentEngineChanged" ID="WebBrowserWebSearchWidget.__currentEngineChanged"></a> 208 <a NAME="WebBrowserWebSearchWidget.__currentEngineChanged" ID="WebBrowserWebSearchWidget.__currentEngineChanged"></a>
211 <h4>WebBrowserWebSearchWidget.__currentEngineChanged</h4> 209 <h4>WebBrowserWebSearchWidget.__currentEngineChanged</h4>
212 <b>__currentEngineChanged</b>(<i></i>) 210 <b>__currentEngineChanged</b>(<i></i>)
213
214 <p> 211 <p>
215 Private slot to track a change of the current search engine. 212 Private slot to track a change of the current search engine.
216 </p> 213 </p>
214
217 <a NAME="WebBrowserWebSearchWidget.__engineImageChanged" ID="WebBrowserWebSearchWidget.__engineImageChanged"></a> 215 <a NAME="WebBrowserWebSearchWidget.__engineImageChanged" ID="WebBrowserWebSearchWidget.__engineImageChanged"></a>
218 <h4>WebBrowserWebSearchWidget.__engineImageChanged</h4> 216 <h4>WebBrowserWebSearchWidget.__engineImageChanged</h4>
219 <b>__engineImageChanged</b>(<i></i>) 217 <b>__engineImageChanged</b>(<i></i>)
220
221 <p> 218 <p>
222 Private slot to handle a change of the current search engine icon. 219 Private slot to handle a change of the current search engine icon.
223 </p> 220 </p>
221
224 <a NAME="WebBrowserWebSearchWidget.__getSuggestions" ID="WebBrowserWebSearchWidget.__getSuggestions"></a> 222 <a NAME="WebBrowserWebSearchWidget.__getSuggestions" ID="WebBrowserWebSearchWidget.__getSuggestions"></a>
225 <h4>WebBrowserWebSearchWidget.__getSuggestions</h4> 223 <h4>WebBrowserWebSearchWidget.__getSuggestions</h4>
226 <b>__getSuggestions</b>(<i></i>) 224 <b>__getSuggestions</b>(<i></i>)
227
228 <p> 225 <p>
229 Private slot to get search suggestions from the configured search 226 Private slot to get search suggestions from the configured search
230 engine. 227 engine.
231 </p> 228 </p>
229
232 <a NAME="WebBrowserWebSearchWidget.__handleEnginesMenuActionTriggered" ID="WebBrowserWebSearchWidget.__handleEnginesMenuActionTriggered"></a> 230 <a NAME="WebBrowserWebSearchWidget.__handleEnginesMenuActionTriggered" ID="WebBrowserWebSearchWidget.__handleEnginesMenuActionTriggered"></a>
233 <h4>WebBrowserWebSearchWidget.__handleEnginesMenuActionTriggered</h4> 231 <h4>WebBrowserWebSearchWidget.__handleEnginesMenuActionTriggered</h4>
234 <b>__handleEnginesMenuActionTriggered</b>(<i>action</i>) 232 <b>__handleEnginesMenuActionTriggered</b>(<i>action</i>)
235
236 <p> 233 <p>
237 Private slot to handle an action of the menu being triggered. 234 Private slot to handle an action of the menu being triggered.
238 </p> 235 </p>
236
239 <dl> 237 <dl>
240 238
241 <dt><i>action</i> (QAction)</dt> 239 <dt><i>action</i> (QAction)</dt>
242 <dd> 240 <dd>
243 reference to the action that triggered 241 reference to the action that triggered
244 </dd> 242 </dd>
245 </dl> 243 </dl>
246 <a NAME="WebBrowserWebSearchWidget.__loadSearches" ID="WebBrowserWebSearchWidget.__loadSearches"></a> 244 <a NAME="WebBrowserWebSearchWidget.__loadSearches" ID="WebBrowserWebSearchWidget.__loadSearches"></a>
247 <h4>WebBrowserWebSearchWidget.__loadSearches</h4> 245 <h4>WebBrowserWebSearchWidget.__loadSearches</h4>
248 <b>__loadSearches</b>(<i></i>) 246 <b>__loadSearches</b>(<i></i>)
249
250 <p> 247 <p>
251 Private method to load the recently performed web searches. 248 Private method to load the recently performed web searches.
252 </p> 249 </p>
250
253 <a NAME="WebBrowserWebSearchWidget.__newSuggestions" ID="WebBrowserWebSearchWidget.__newSuggestions"></a> 251 <a NAME="WebBrowserWebSearchWidget.__newSuggestions" ID="WebBrowserWebSearchWidget.__newSuggestions"></a>
254 <h4>WebBrowserWebSearchWidget.__newSuggestions</h4> 252 <h4>WebBrowserWebSearchWidget.__newSuggestions</h4>
255 <b>__newSuggestions</b>(<i>suggestions</i>) 253 <b>__newSuggestions</b>(<i>suggestions</i>)
256
257 <p> 254 <p>
258 Private slot to receive a new list of suggestions. 255 Private slot to receive a new list of suggestions.
259 </p> 256 </p>
257
260 <dl> 258 <dl>
261 259
262 <dt><i>suggestions</i> (list of str)</dt> 260 <dt><i>suggestions</i> (list of str)</dt>
263 <dd> 261 <dd>
264 list of suggestions 262 list of suggestions
265 </dd> 263 </dd>
266 </dl> 264 </dl>
267 <a NAME="WebBrowserWebSearchWidget.__searchButtonClicked" ID="WebBrowserWebSearchWidget.__searchButtonClicked"></a> 265 <a NAME="WebBrowserWebSearchWidget.__searchButtonClicked" ID="WebBrowserWebSearchWidget.__searchButtonClicked"></a>
268 <h4>WebBrowserWebSearchWidget.__searchButtonClicked</h4> 266 <h4>WebBrowserWebSearchWidget.__searchButtonClicked</h4>
269 <b>__searchButtonClicked</b>(<i></i>) 267 <b>__searchButtonClicked</b>(<i></i>)
270
271 <p> 268 <p>
272 Private slot to show the search menu via the search button. 269 Private slot to show the search menu via the search button.
273 </p> 270 </p>
271
274 <a NAME="WebBrowserWebSearchWidget.__searchNow" ID="WebBrowserWebSearchWidget.__searchNow"></a> 272 <a NAME="WebBrowserWebSearchWidget.__searchNow" ID="WebBrowserWebSearchWidget.__searchNow"></a>
275 <h4>WebBrowserWebSearchWidget.__searchNow</h4> 273 <h4>WebBrowserWebSearchWidget.__searchNow</h4>
276 <b>__searchNow</b>(<i></i>) 274 <b>__searchNow</b>(<i></i>)
277
278 <p> 275 <p>
279 Private slot to perform the web search. 276 Private slot to perform the web search.
280 </p> 277 </p>
278
281 <a NAME="WebBrowserWebSearchWidget.__setupCompleterMenu" ID="WebBrowserWebSearchWidget.__setupCompleterMenu"></a> 279 <a NAME="WebBrowserWebSearchWidget.__setupCompleterMenu" ID="WebBrowserWebSearchWidget.__setupCompleterMenu"></a>
282 <h4>WebBrowserWebSearchWidget.__setupCompleterMenu</h4> 280 <h4>WebBrowserWebSearchWidget.__setupCompleterMenu</h4>
283 <b>__setupCompleterMenu</b>(<i></i>) 281 <b>__setupCompleterMenu</b>(<i></i>)
284
285 <p> 282 <p>
286 Private method to create the completer menu. 283 Private method to create the completer menu.
287 </p> 284 </p>
285
288 <a NAME="WebBrowserWebSearchWidget.__showEnginesMenu" ID="WebBrowserWebSearchWidget.__showEnginesMenu"></a> 286 <a NAME="WebBrowserWebSearchWidget.__showEnginesMenu" ID="WebBrowserWebSearchWidget.__showEnginesMenu"></a>
289 <h4>WebBrowserWebSearchWidget.__showEnginesMenu</h4> 287 <h4>WebBrowserWebSearchWidget.__showEnginesMenu</h4>
290 <b>__showEnginesMenu</b>(<i></i>) 288 <b>__showEnginesMenu</b>(<i></i>)
291
292 <p> 289 <p>
293 Private slot to handle the display of the engines menu. 290 Private slot to handle the display of the engines menu.
294 </p> 291 </p>
292
295 <a NAME="WebBrowserWebSearchWidget.__showEnginesMenuCallback" ID="WebBrowserWebSearchWidget.__showEnginesMenuCallback"></a> 293 <a NAME="WebBrowserWebSearchWidget.__showEnginesMenuCallback" ID="WebBrowserWebSearchWidget.__showEnginesMenuCallback"></a>
296 <h4>WebBrowserWebSearchWidget.__showEnginesMenuCallback</h4> 294 <h4>WebBrowserWebSearchWidget.__showEnginesMenuCallback</h4>
297 <b>__showEnginesMenuCallback</b>(<i>res</i>) 295 <b>__showEnginesMenuCallback</b>(<i>res</i>)
298
299 <p> 296 <p>
300 Private method handling the open search links callback. 297 Private method handling the open search links callback.
301 </p> 298 </p>
299
302 <dl> 300 <dl>
303 301
304 <dt><i>res</i> (list of dict)</dt> 302 <dt><i>res</i> (list of dict)</dt>
305 <dd> 303 <dd>
306 result of the JavaScript 304 result of the JavaScript
307 </dd> 305 </dd>
308 </dl> 306 </dl>
309 <a NAME="WebBrowserWebSearchWidget.__textEdited" ID="WebBrowserWebSearchWidget.__textEdited"></a> 307 <a NAME="WebBrowserWebSearchWidget.__textEdited" ID="WebBrowserWebSearchWidget.__textEdited"></a>
310 <h4>WebBrowserWebSearchWidget.__textEdited</h4> 308 <h4>WebBrowserWebSearchWidget.__textEdited</h4>
311 <b>__textEdited</b>(<i>txt</i>) 309 <b>__textEdited</b>(<i>txt</i>)
312
313 <p> 310 <p>
314 Private slot to handle changes of the search text. 311 Private slot to handle changes of the search text.
315 </p> 312 </p>
313
316 <dl> 314 <dl>
317 315
318 <dt><i>txt</i> (str)</dt> 316 <dt><i>txt</i> (str)</dt>
319 <dd> 317 <dd>
320 search text 318 search text
321 </dd> 319 </dd>
322 </dl> 320 </dl>
323 <a NAME="WebBrowserWebSearchWidget.clear" ID="WebBrowserWebSearchWidget.clear"></a> 321 <a NAME="WebBrowserWebSearchWidget.clear" ID="WebBrowserWebSearchWidget.clear"></a>
324 <h4>WebBrowserWebSearchWidget.clear</h4> 322 <h4>WebBrowserWebSearchWidget.clear</h4>
325 <b>clear</b>(<i></i>) 323 <b>clear</b>(<i></i>)
326
327 <p> 324 <p>
328 Public method to clear all private data. 325 Public method to clear all private data.
329 </p> 326 </p>
327
330 <a NAME="WebBrowserWebSearchWidget.mousePressEvent" ID="WebBrowserWebSearchWidget.mousePressEvent"></a> 328 <a NAME="WebBrowserWebSearchWidget.mousePressEvent" ID="WebBrowserWebSearchWidget.mousePressEvent"></a>
331 <h4>WebBrowserWebSearchWidget.mousePressEvent</h4> 329 <h4>WebBrowserWebSearchWidget.mousePressEvent</h4>
332 <b>mousePressEvent</b>(<i>evt</i>) 330 <b>mousePressEvent</b>(<i>evt</i>)
333
334 <p> 331 <p>
335 Protected method called by a mouse press event. 332 Protected method called by a mouse press event.
336 </p> 333 </p>
334
337 <dl> 335 <dl>
338 336
339 <dt><i>evt</i> (QMouseEvent)</dt> 337 <dt><i>evt</i> (QMouseEvent)</dt>
340 <dd> 338 <dd>
341 reference to the mouse event 339 reference to the mouse event
342 </dd> 340 </dd>
343 </dl> 341 </dl>
344 <a NAME="WebBrowserWebSearchWidget.openSearchManager" ID="WebBrowserWebSearchWidget.openSearchManager"></a> 342 <a NAME="WebBrowserWebSearchWidget.openSearchManager" ID="WebBrowserWebSearchWidget.openSearchManager"></a>
345 <h4>WebBrowserWebSearchWidget.openSearchManager</h4> 343 <h4>WebBrowserWebSearchWidget.openSearchManager</h4>
346 <b>openSearchManager</b>(<i></i>) 344 <b>openSearchManager</b>(<i></i>)
347
348 <p> 345 <p>
349 Public method to get a reference to the opensearch manager object. 346 Public method to get a reference to the opensearch manager object.
350 </p> 347 </p>
348
351 <dl> 349 <dl>
352 <dt>Return:</dt> 350 <dt>Return:</dt>
353 <dd> 351 <dd>
354 reference to the opensearch manager object 352 reference to the opensearch manager object
355 </dd> 353 </dd>
361 </dd> 359 </dd>
362 </dl> 360 </dl>
363 <a NAME="WebBrowserWebSearchWidget.preferencesChanged" ID="WebBrowserWebSearchWidget.preferencesChanged"></a> 361 <a NAME="WebBrowserWebSearchWidget.preferencesChanged" ID="WebBrowserWebSearchWidget.preferencesChanged"></a>
364 <h4>WebBrowserWebSearchWidget.preferencesChanged</h4> 362 <h4>WebBrowserWebSearchWidget.preferencesChanged</h4>
365 <b>preferencesChanged</b>(<i></i>) 363 <b>preferencesChanged</b>(<i></i>)
366
367 <p> 364 <p>
368 Public method to handle the change of preferences. 365 Public method to handle the change of preferences.
369 </p> 366 </p>
367
370 <a NAME="WebBrowserWebSearchWidget.saveSearches" ID="WebBrowserWebSearchWidget.saveSearches"></a> 368 <a NAME="WebBrowserWebSearchWidget.saveSearches" ID="WebBrowserWebSearchWidget.saveSearches"></a>
371 <h4>WebBrowserWebSearchWidget.saveSearches</h4> 369 <h4>WebBrowserWebSearchWidget.saveSearches</h4>
372 <b>saveSearches</b>(<i></i>) 370 <b>saveSearches</b>(<i></i>)
373
374 <p> 371 <p>
375 Public method to save the recently performed web searches. 372 Public method to save the recently performed web searches.
376 </p> 373 </p>
374
377 <div align="right"><a href="#top">Up</a></div> 375 <div align="right"><a href="#top">Up</a></div>
378 <hr /> 376 <hr />
379 </body></html> 377 </body></html>

eric ide

mercurial