Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.WebBrowserWebSearchWidget.html

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

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.WebBrowserWebSearchWidget</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.WebBrowser.WebBrowserWebSearchWidget</h1>
24
25 <p>
26 Module implementing a web search widget for the web browser.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#WebBrowserWebSearchWidget">WebBrowserWebSearchWidget</a></td>
39 <td>Class implementing a web search widget for the web browser.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="WebBrowserWebSearchWidget" ID="WebBrowserWebSearchWidget"></a>
50 <h2>WebBrowserWebSearchWidget</h2>
51
52 <p>
53 Class implementing a web search widget for the web browser.
54 </p>
55 <h3>Signals</h3>
56 <dl>
57
58 <dt>search(QUrl)</dt>
59 <dd>
60 emitted when the search should be done
61 </dd>
62 </dl>
63 <h3>Derived from</h3>
64 EricClearableLineEdit
65 <h3>Class Attributes</h3>
66
67 <table>
68 <tr><td>None</td></tr>
69 </table>
70 <h3>Class Methods</h3>
71
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Methods</h3>
76
77 <table>
78
79 <tr>
80 <td><a href="#WebBrowserWebSearchWidget.__init__">WebBrowserWebSearchWidget</a></td>
81 <td>Constructor</td>
82 </tr>
83 <tr>
84 <td><a href="#WebBrowserWebSearchWidget.__completerActivated">__completerActivated</a></td>
85 <td>Private slot handling the selection of an entry from the completer.</td>
86 </tr>
87 <tr>
88 <td><a href="#WebBrowserWebSearchWidget.__completerHighlighted">__completerHighlighted</a></td>
89 <td>Private slot handling the highlighting of an entry of the completer.</td>
90 </tr>
91 <tr>
92 <td><a href="#WebBrowserWebSearchWidget.__currentEngineChanged">__currentEngineChanged</a></td>
93 <td>Private slot to track a change of the current search engine.</td>
94 </tr>
95 <tr>
96 <td><a href="#WebBrowserWebSearchWidget.__engineImageChanged">__engineImageChanged</a></td>
97 <td>Private slot to handle a change of the current search engine icon.</td>
98 </tr>
99 <tr>
100 <td><a href="#WebBrowserWebSearchWidget.__getSuggestions">__getSuggestions</a></td>
101 <td>Private slot to get search suggestions from the configured search engine.</td>
102 </tr>
103 <tr>
104 <td><a href="#WebBrowserWebSearchWidget.__handleEnginesMenuActionTriggered">__handleEnginesMenuActionTriggered</a></td>
105 <td>Private slot to handle an action of the menu being triggered.</td>
106 </tr>
107 <tr>
108 <td><a href="#WebBrowserWebSearchWidget.__loadSearches">__loadSearches</a></td>
109 <td>Private method to load the recently performed web searches.</td>
110 </tr>
111 <tr>
112 <td><a href="#WebBrowserWebSearchWidget.__newSuggestions">__newSuggestions</a></td>
113 <td>Private slot to receive a new list of suggestions.</td>
114 </tr>
115 <tr>
116 <td><a href="#WebBrowserWebSearchWidget.__searchButtonClicked">__searchButtonClicked</a></td>
117 <td>Private slot to show the search menu via the search button.</td>
118 </tr>
119 <tr>
120 <td><a href="#WebBrowserWebSearchWidget.__searchNow">__searchNow</a></td>
121 <td>Private slot to perform the web search.</td>
122 </tr>
123 <tr>
124 <td><a href="#WebBrowserWebSearchWidget.__setupCompleterMenu">__setupCompleterMenu</a></td>
125 <td>Private method to create the completer menu.</td>
126 </tr>
127 <tr>
128 <td><a href="#WebBrowserWebSearchWidget.__showEnginesMenu">__showEnginesMenu</a></td>
129 <td>Private slot to handle the display of the engines menu.</td>
130 </tr>
131 <tr>
132 <td><a href="#WebBrowserWebSearchWidget.__showEnginesMenuCallback">__showEnginesMenuCallback</a></td>
133 <td>Private method handling the open search links callback.</td>
134 </tr>
135 <tr>
136 <td><a href="#WebBrowserWebSearchWidget.__textEdited">__textEdited</a></td>
137 <td>Private slot to handle changes of the search text.</td>
138 </tr>
139 <tr>
140 <td><a href="#WebBrowserWebSearchWidget.clear">clear</a></td>
141 <td>Public method to clear all private data.</td>
142 </tr>
143 <tr>
144 <td><a href="#WebBrowserWebSearchWidget.mousePressEvent">mousePressEvent</a></td>
145 <td>Protected method called by a mouse press event.</td>
146 </tr>
147 <tr>
148 <td><a href="#WebBrowserWebSearchWidget.openSearchManager">openSearchManager</a></td>
149 <td>Public method to get a reference to the opensearch manager object.</td>
150 </tr>
151 <tr>
152 <td><a href="#WebBrowserWebSearchWidget.preferencesChanged">preferencesChanged</a></td>
153 <td>Public method to handle the change of preferences.</td>
154 </tr>
155 <tr>
156 <td><a href="#WebBrowserWebSearchWidget.saveSearches">saveSearches</a></td>
157 <td>Public method to save the recently performed web searches.</td>
158 </tr>
159 </table>
160 <h3>Static Methods</h3>
161
162 <table>
163 <tr><td>None</td></tr>
164 </table>
165
166 <a NAME="WebBrowserWebSearchWidget.__init__" ID="WebBrowserWebSearchWidget.__init__"></a>
167 <h4>WebBrowserWebSearchWidget (Constructor)</h4>
168 <b>WebBrowserWebSearchWidget</b>(<i>mainWindow, parent=None</i>)
169
170 <p>
171 Constructor
172 </p>
173 <dl>
174
175 <dt><i>mainWindow</i> (WebBrowserWindow)</dt>
176 <dd>
177 reference to the browser main window
178 </dd>
179 <dt><i>parent</i> (QWidget)</dt>
180 <dd>
181 reference to the parent widget
182 </dd>
183 </dl>
184 <a NAME="WebBrowserWebSearchWidget.__completerActivated" ID="WebBrowserWebSearchWidget.__completerActivated"></a>
185 <h4>WebBrowserWebSearchWidget.__completerActivated</h4>
186 <b>__completerActivated</b>(<i>index</i>)
187
188 <p>
189 Private slot handling the selection of an entry from the completer.
190 </p>
191 <dl>
192
193 <dt><i>index</i></dt>
194 <dd>
195 index of the item (QModelIndex)
196 </dd>
197 </dl>
198 <a NAME="WebBrowserWebSearchWidget.__completerHighlighted" ID="WebBrowserWebSearchWidget.__completerHighlighted"></a>
199 <h4>WebBrowserWebSearchWidget.__completerHighlighted</h4>
200 <b>__completerHighlighted</b>(<i>index</i>)
201
202 <p>
203 Private slot handling the highlighting of an entry of the completer.
204 </p>
205 <dl>
206
207 <dt><i>index</i></dt>
208 <dd>
209 index of the item (QModelIndex)
210 </dd>
211 </dl>
212 <dl>
213 <dt>Return:</dt>
214 <dd>
215 flah indicating a successful highlighting (boolean)
216 </dd>
217 </dl>
218 <a NAME="WebBrowserWebSearchWidget.__currentEngineChanged" ID="WebBrowserWebSearchWidget.__currentEngineChanged"></a>
219 <h4>WebBrowserWebSearchWidget.__currentEngineChanged</h4>
220 <b>__currentEngineChanged</b>(<i></i>)
221
222 <p>
223 Private slot to track a change of the current search engine.
224 </p>
225 <a NAME="WebBrowserWebSearchWidget.__engineImageChanged" ID="WebBrowserWebSearchWidget.__engineImageChanged"></a>
226 <h4>WebBrowserWebSearchWidget.__engineImageChanged</h4>
227 <b>__engineImageChanged</b>(<i></i>)
228
229 <p>
230 Private slot to handle a change of the current search engine icon.
231 </p>
232 <a NAME="WebBrowserWebSearchWidget.__getSuggestions" ID="WebBrowserWebSearchWidget.__getSuggestions"></a>
233 <h4>WebBrowserWebSearchWidget.__getSuggestions</h4>
234 <b>__getSuggestions</b>(<i></i>)
235
236 <p>
237 Private slot to get search suggestions from the configured search
238 engine.
239 </p>
240 <a NAME="WebBrowserWebSearchWidget.__handleEnginesMenuActionTriggered" ID="WebBrowserWebSearchWidget.__handleEnginesMenuActionTriggered"></a>
241 <h4>WebBrowserWebSearchWidget.__handleEnginesMenuActionTriggered</h4>
242 <b>__handleEnginesMenuActionTriggered</b>(<i>action</i>)
243
244 <p>
245 Private slot to handle an action of the menu being triggered.
246 </p>
247 <dl>
248
249 <dt><i>action</i> (QAction)</dt>
250 <dd>
251 reference to the action that triggered
252 </dd>
253 </dl>
254 <a NAME="WebBrowserWebSearchWidget.__loadSearches" ID="WebBrowserWebSearchWidget.__loadSearches"></a>
255 <h4>WebBrowserWebSearchWidget.__loadSearches</h4>
256 <b>__loadSearches</b>(<i></i>)
257
258 <p>
259 Private method to load the recently performed web searches.
260 </p>
261 <a NAME="WebBrowserWebSearchWidget.__newSuggestions" ID="WebBrowserWebSearchWidget.__newSuggestions"></a>
262 <h4>WebBrowserWebSearchWidget.__newSuggestions</h4>
263 <b>__newSuggestions</b>(<i>suggestions</i>)
264
265 <p>
266 Private slot to receive a new list of suggestions.
267 </p>
268 <dl>
269
270 <dt><i>suggestions</i></dt>
271 <dd>
272 list of suggestions (list of strings)
273 </dd>
274 </dl>
275 <a NAME="WebBrowserWebSearchWidget.__searchButtonClicked" ID="WebBrowserWebSearchWidget.__searchButtonClicked"></a>
276 <h4>WebBrowserWebSearchWidget.__searchButtonClicked</h4>
277 <b>__searchButtonClicked</b>(<i></i>)
278
279 <p>
280 Private slot to show the search menu via the search button.
281 </p>
282 <a NAME="WebBrowserWebSearchWidget.__searchNow" ID="WebBrowserWebSearchWidget.__searchNow"></a>
283 <h4>WebBrowserWebSearchWidget.__searchNow</h4>
284 <b>__searchNow</b>(<i></i>)
285
286 <p>
287 Private slot to perform the web search.
288 </p>
289 <a NAME="WebBrowserWebSearchWidget.__setupCompleterMenu" ID="WebBrowserWebSearchWidget.__setupCompleterMenu"></a>
290 <h4>WebBrowserWebSearchWidget.__setupCompleterMenu</h4>
291 <b>__setupCompleterMenu</b>(<i></i>)
292
293 <p>
294 Private method to create the completer menu.
295 </p>
296 <a NAME="WebBrowserWebSearchWidget.__showEnginesMenu" ID="WebBrowserWebSearchWidget.__showEnginesMenu"></a>
297 <h4>WebBrowserWebSearchWidget.__showEnginesMenu</h4>
298 <b>__showEnginesMenu</b>(<i></i>)
299
300 <p>
301 Private slot to handle the display of the engines menu.
302 </p>
303 <a NAME="WebBrowserWebSearchWidget.__showEnginesMenuCallback" ID="WebBrowserWebSearchWidget.__showEnginesMenuCallback"></a>
304 <h4>WebBrowserWebSearchWidget.__showEnginesMenuCallback</h4>
305 <b>__showEnginesMenuCallback</b>(<i>res</i>)
306
307 <p>
308 Private method handling the open search links callback.
309 </p>
310 <dl>
311
312 <dt><i>res</i> (list of dict)</dt>
313 <dd>
314 result of the JavaScript
315 </dd>
316 </dl>
317 <a NAME="WebBrowserWebSearchWidget.__textEdited" ID="WebBrowserWebSearchWidget.__textEdited"></a>
318 <h4>WebBrowserWebSearchWidget.__textEdited</h4>
319 <b>__textEdited</b>(<i>txt</i>)
320
321 <p>
322 Private slot to handle changes of the search text.
323 </p>
324 <dl>
325
326 <dt><i>txt</i></dt>
327 <dd>
328 search text (string)
329 </dd>
330 </dl>
331 <a NAME="WebBrowserWebSearchWidget.clear" ID="WebBrowserWebSearchWidget.clear"></a>
332 <h4>WebBrowserWebSearchWidget.clear</h4>
333 <b>clear</b>(<i></i>)
334
335 <p>
336 Public method to clear all private data.
337 </p>
338 <a NAME="WebBrowserWebSearchWidget.mousePressEvent" ID="WebBrowserWebSearchWidget.mousePressEvent"></a>
339 <h4>WebBrowserWebSearchWidget.mousePressEvent</h4>
340 <b>mousePressEvent</b>(<i>evt</i>)
341
342 <p>
343 Protected method called by a mouse press event.
344 </p>
345 <dl>
346
347 <dt><i>evt</i></dt>
348 <dd>
349 reference to the mouse event (QMouseEvent)
350 </dd>
351 </dl>
352 <a NAME="WebBrowserWebSearchWidget.openSearchManager" ID="WebBrowserWebSearchWidget.openSearchManager"></a>
353 <h4>WebBrowserWebSearchWidget.openSearchManager</h4>
354 <b>openSearchManager</b>(<i></i>)
355
356 <p>
357 Public method to get a reference to the opensearch manager object.
358 </p>
359 <dl>
360 <dt>Return:</dt>
361 <dd>
362 reference to the opensearch manager object (OpenSearchManager)
363 </dd>
364 </dl>
365 <a NAME="WebBrowserWebSearchWidget.preferencesChanged" ID="WebBrowserWebSearchWidget.preferencesChanged"></a>
366 <h4>WebBrowserWebSearchWidget.preferencesChanged</h4>
367 <b>preferencesChanged</b>(<i></i>)
368
369 <p>
370 Public method to handle the change of preferences.
371 </p>
372 <a NAME="WebBrowserWebSearchWidget.saveSearches" ID="WebBrowserWebSearchWidget.saveSearches"></a>
373 <h4>WebBrowserWebSearchWidget.saveSearches</h4>
374 <b>saveSearches</b>(<i></i>)
375
376 <p>
377 Public method to save the recently performed web searches.
378 </p>
379 <div align="right"><a href="#top">Up</a></div>
380 <hr />
381 </body></html>

Mercurial Repository: eric

eric ide

mercurial