Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.WebBrowser.WebBrowserWebSearchWidget.html

changeset 4918
71caf42a13d8
child 5722
433187e73c0f
equal deleted inserted replaced
4917:682750cc7bd5 4918:71caf42a13d8
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.WebBrowserWebSearchWidget</h1>
23 <p>
24 Module implementing a web search widget for the web browser.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#WebBrowserWebSearchWidget">WebBrowserWebSearchWidget</a></td>
34 <td>Class implementing a web search widget for the web browser.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="WebBrowserWebSearchWidget" ID="WebBrowserWebSearchWidget"></a>
43 <h2>WebBrowserWebSearchWidget</h2>
44 <p>
45 Class implementing a web search widget for the web browser.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>search(QUrl)</dt>
49 <dd>
50 emitted when the search should be done
51 </dd>
52 </dl>
53 <h3>Derived from</h3>
54 E5ClearableLineEdit
55 <h3>Class Attributes</h3>
56 <table>
57 <tr><td>None</td></tr>
58 </table>
59 <h3>Class Methods</h3>
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Methods</h3>
64 <table>
65 <tr>
66 <td><a href="#WebBrowserWebSearchWidget.__init__">WebBrowserWebSearchWidget</a></td>
67 <td>Constructor</td>
68 </tr><tr>
69 <td><a href="#WebBrowserWebSearchWidget.__addEngineFromUrl">__addEngineFromUrl</a></td>
70 <td>Private slot to add a search engine given its URL.</td>
71 </tr><tr>
72 <td><a href="#WebBrowserWebSearchWidget.__changeCurrentEngine">__changeCurrentEngine</a></td>
73 <td>Private slot to handle the selection of a search engine.</td>
74 </tr><tr>
75 <td><a href="#WebBrowserWebSearchWidget.__completerActivated">__completerActivated</a></td>
76 <td>Private slot handling the selection of an entry from the completer.</td>
77 </tr><tr>
78 <td><a href="#WebBrowserWebSearchWidget.__completerHighlighted">__completerHighlighted</a></td>
79 <td>Private slot handling the highlighting of an entry of the completer.</td>
80 </tr><tr>
81 <td><a href="#WebBrowserWebSearchWidget.__currentEngineChanged">__currentEngineChanged</a></td>
82 <td>Private slot to track a change of the current search engine.</td>
83 </tr><tr>
84 <td><a href="#WebBrowserWebSearchWidget.__engineImageChanged">__engineImageChanged</a></td>
85 <td>Private slot to handle a change of the current search engine icon.</td>
86 </tr><tr>
87 <td><a href="#WebBrowserWebSearchWidget.__getSuggestions">__getSuggestions</a></td>
88 <td>Private slot to get search suggestions from the configured search engine.</td>
89 </tr><tr>
90 <td><a href="#WebBrowserWebSearchWidget.__loadSearches">__loadSearches</a></td>
91 <td>Private method to load the recently performed web searches.</td>
92 </tr><tr>
93 <td><a href="#WebBrowserWebSearchWidget.__newSuggestions">__newSuggestions</a></td>
94 <td>Private slot to receive a new list of suggestions.</td>
95 </tr><tr>
96 <td><a href="#WebBrowserWebSearchWidget.__searchButtonClicked">__searchButtonClicked</a></td>
97 <td>Private slot to show the search menu via the search button.</td>
98 </tr><tr>
99 <td><a href="#WebBrowserWebSearchWidget.__searchNow">__searchNow</a></td>
100 <td>Private slot to perform the web search.</td>
101 </tr><tr>
102 <td><a href="#WebBrowserWebSearchWidget.__setupCompleterMenu">__setupCompleterMenu</a></td>
103 <td>Private method to create the completer menu.</td>
104 </tr><tr>
105 <td><a href="#WebBrowserWebSearchWidget.__showEnginesMenu">__showEnginesMenu</a></td>
106 <td>Private slot to handle the display of the engines menu.</td>
107 </tr><tr>
108 <td><a href="#WebBrowserWebSearchWidget.__showEnginesMenuCallback">__showEnginesMenuCallback</a></td>
109 <td>Private method handling the open search links callback.</td>
110 </tr><tr>
111 <td><a href="#WebBrowserWebSearchWidget.__textEdited">__textEdited</a></td>
112 <td>Private slot to handle changes of the search text.</td>
113 </tr><tr>
114 <td><a href="#WebBrowserWebSearchWidget.clear">clear</a></td>
115 <td>Public method to clear all private data.</td>
116 </tr><tr>
117 <td><a href="#WebBrowserWebSearchWidget.mousePressEvent">mousePressEvent</a></td>
118 <td>Protected method called by a mouse press event.</td>
119 </tr><tr>
120 <td><a href="#WebBrowserWebSearchWidget.openSearchManager">openSearchManager</a></td>
121 <td>Public method to get a reference to the opensearch manager object.</td>
122 </tr><tr>
123 <td><a href="#WebBrowserWebSearchWidget.preferencesChanged">preferencesChanged</a></td>
124 <td>Public method to handle the change of preferences.</td>
125 </tr><tr>
126 <td><a href="#WebBrowserWebSearchWidget.saveSearches">saveSearches</a></td>
127 <td>Public method to save the recently performed web searches.</td>
128 </tr>
129 </table>
130 <h3>Static Methods</h3>
131 <table>
132 <tr><td>None</td></tr>
133 </table>
134 <a NAME="WebBrowserWebSearchWidget.__init__" ID="WebBrowserWebSearchWidget.__init__"></a>
135 <h4>WebBrowserWebSearchWidget (Constructor)</h4>
136 <b>WebBrowserWebSearchWidget</b>(<i>parent=None</i>)
137 <p>
138 Constructor
139 </p><dl>
140 <dt><i>parent</i></dt>
141 <dd>
142 reference to the parent widget (QWidget)
143 </dd>
144 </dl><a NAME="WebBrowserWebSearchWidget.__addEngineFromUrl" ID="WebBrowserWebSearchWidget.__addEngineFromUrl"></a>
145 <h4>WebBrowserWebSearchWidget.__addEngineFromUrl</h4>
146 <b>__addEngineFromUrl</b>(<i></i>)
147 <p>
148 Private slot to add a search engine given its URL.
149 </p><a NAME="WebBrowserWebSearchWidget.__changeCurrentEngine" ID="WebBrowserWebSearchWidget.__changeCurrentEngine"></a>
150 <h4>WebBrowserWebSearchWidget.__changeCurrentEngine</h4>
151 <b>__changeCurrentEngine</b>(<i></i>)
152 <p>
153 Private slot to handle the selection of a search engine.
154 </p><a NAME="WebBrowserWebSearchWidget.__completerActivated" ID="WebBrowserWebSearchWidget.__completerActivated"></a>
155 <h4>WebBrowserWebSearchWidget.__completerActivated</h4>
156 <b>__completerActivated</b>(<i>index</i>)
157 <p>
158 Private slot handling the selection of an entry from the completer.
159 </p><dl>
160 <dt><i>index</i></dt>
161 <dd>
162 index of the item (QModelIndex)
163 </dd>
164 </dl><a NAME="WebBrowserWebSearchWidget.__completerHighlighted" ID="WebBrowserWebSearchWidget.__completerHighlighted"></a>
165 <h4>WebBrowserWebSearchWidget.__completerHighlighted</h4>
166 <b>__completerHighlighted</b>(<i>index</i>)
167 <p>
168 Private slot handling the highlighting of an entry of the completer.
169 </p><dl>
170 <dt><i>index</i></dt>
171 <dd>
172 index of the item (QModelIndex)
173 </dd>
174 </dl><dl>
175 <dt>Returns:</dt>
176 <dd>
177 flah indicating a successful highlighting (boolean)
178 </dd>
179 </dl><a NAME="WebBrowserWebSearchWidget.__currentEngineChanged" ID="WebBrowserWebSearchWidget.__currentEngineChanged"></a>
180 <h4>WebBrowserWebSearchWidget.__currentEngineChanged</h4>
181 <b>__currentEngineChanged</b>(<i></i>)
182 <p>
183 Private slot to track a change of the current search engine.
184 </p><a NAME="WebBrowserWebSearchWidget.__engineImageChanged" ID="WebBrowserWebSearchWidget.__engineImageChanged"></a>
185 <h4>WebBrowserWebSearchWidget.__engineImageChanged</h4>
186 <b>__engineImageChanged</b>(<i></i>)
187 <p>
188 Private slot to handle a change of the current search engine icon.
189 </p><a NAME="WebBrowserWebSearchWidget.__getSuggestions" ID="WebBrowserWebSearchWidget.__getSuggestions"></a>
190 <h4>WebBrowserWebSearchWidget.__getSuggestions</h4>
191 <b>__getSuggestions</b>(<i></i>)
192 <p>
193 Private slot to get search suggestions from the configured search
194 engine.
195 </p><a NAME="WebBrowserWebSearchWidget.__loadSearches" ID="WebBrowserWebSearchWidget.__loadSearches"></a>
196 <h4>WebBrowserWebSearchWidget.__loadSearches</h4>
197 <b>__loadSearches</b>(<i></i>)
198 <p>
199 Private method to load the recently performed web searches.
200 </p><a NAME="WebBrowserWebSearchWidget.__newSuggestions" ID="WebBrowserWebSearchWidget.__newSuggestions"></a>
201 <h4>WebBrowserWebSearchWidget.__newSuggestions</h4>
202 <b>__newSuggestions</b>(<i>suggestions</i>)
203 <p>
204 Private slot to receive a new list of suggestions.
205 </p><dl>
206 <dt><i>suggestions</i></dt>
207 <dd>
208 list of suggestions (list of strings)
209 </dd>
210 </dl><a NAME="WebBrowserWebSearchWidget.__searchButtonClicked" ID="WebBrowserWebSearchWidget.__searchButtonClicked"></a>
211 <h4>WebBrowserWebSearchWidget.__searchButtonClicked</h4>
212 <b>__searchButtonClicked</b>(<i></i>)
213 <p>
214 Private slot to show the search menu via the search button.
215 </p><a NAME="WebBrowserWebSearchWidget.__searchNow" ID="WebBrowserWebSearchWidget.__searchNow"></a>
216 <h4>WebBrowserWebSearchWidget.__searchNow</h4>
217 <b>__searchNow</b>(<i></i>)
218 <p>
219 Private slot to perform the web search.
220 </p><a NAME="WebBrowserWebSearchWidget.__setupCompleterMenu" ID="WebBrowserWebSearchWidget.__setupCompleterMenu"></a>
221 <h4>WebBrowserWebSearchWidget.__setupCompleterMenu</h4>
222 <b>__setupCompleterMenu</b>(<i></i>)
223 <p>
224 Private method to create the completer menu.
225 </p><a NAME="WebBrowserWebSearchWidget.__showEnginesMenu" ID="WebBrowserWebSearchWidget.__showEnginesMenu"></a>
226 <h4>WebBrowserWebSearchWidget.__showEnginesMenu</h4>
227 <b>__showEnginesMenu</b>(<i></i>)
228 <p>
229 Private slot to handle the display of the engines menu.
230 </p><a NAME="WebBrowserWebSearchWidget.__showEnginesMenuCallback" ID="WebBrowserWebSearchWidget.__showEnginesMenuCallback"></a>
231 <h4>WebBrowserWebSearchWidget.__showEnginesMenuCallback</h4>
232 <b>__showEnginesMenuCallback</b>(<i>res</i>)
233 <p>
234 Private method handling the open search links callback.
235 </p><dl>
236 <dt><i>res</i> (list of dict)</dt>
237 <dd>
238 result of the JavaScript
239 </dd>
240 </dl><a NAME="WebBrowserWebSearchWidget.__textEdited" ID="WebBrowserWebSearchWidget.__textEdited"></a>
241 <h4>WebBrowserWebSearchWidget.__textEdited</h4>
242 <b>__textEdited</b>(<i>txt</i>)
243 <p>
244 Private slot to handle changes of the search text.
245 </p><dl>
246 <dt><i>txt</i></dt>
247 <dd>
248 search text (string)
249 </dd>
250 </dl><a NAME="WebBrowserWebSearchWidget.clear" ID="WebBrowserWebSearchWidget.clear"></a>
251 <h4>WebBrowserWebSearchWidget.clear</h4>
252 <b>clear</b>(<i></i>)
253 <p>
254 Public method to clear all private data.
255 </p><a NAME="WebBrowserWebSearchWidget.mousePressEvent" ID="WebBrowserWebSearchWidget.mousePressEvent"></a>
256 <h4>WebBrowserWebSearchWidget.mousePressEvent</h4>
257 <b>mousePressEvent</b>(<i>evt</i>)
258 <p>
259 Protected method called by a mouse press event.
260 </p><dl>
261 <dt><i>evt</i></dt>
262 <dd>
263 reference to the mouse event (QMouseEvent)
264 </dd>
265 </dl><a NAME="WebBrowserWebSearchWidget.openSearchManager" ID="WebBrowserWebSearchWidget.openSearchManager"></a>
266 <h4>WebBrowserWebSearchWidget.openSearchManager</h4>
267 <b>openSearchManager</b>(<i></i>)
268 <p>
269 Public method to get a reference to the opensearch manager object.
270 </p><dl>
271 <dt>Returns:</dt>
272 <dd>
273 reference to the opensearch manager object (OpenSearchManager)
274 </dd>
275 </dl><a NAME="WebBrowserWebSearchWidget.preferencesChanged" ID="WebBrowserWebSearchWidget.preferencesChanged"></a>
276 <h4>WebBrowserWebSearchWidget.preferencesChanged</h4>
277 <b>preferencesChanged</b>(<i></i>)
278 <p>
279 Public method to handle the change of preferences.
280 </p><a NAME="WebBrowserWebSearchWidget.saveSearches" ID="WebBrowserWebSearchWidget.saveSearches"></a>
281 <h4>WebBrowserWebSearchWidget.saveSearches</h4>
282 <b>saveSearches</b>(<i></i>)
283 <p>
284 Public method to save the recently performed web searches.
285 </p>
286 <div align="right"><a href="#top">Up</a></div>
287 <hr />
288 </body></html>

Mercurial Repository: eric

eric ide

mercurial