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