Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.HelpBrowserWV.html
Documentation/Source/eric5.Helpviewer.HelpBrowserWV.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Helpviewer.HelpBrowserWV</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Helpviewer.HelpBrowserWV</h1> | |
| 12 <p> | |
| 13 Module implementing the helpbrowser using QWebView. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#HelpBrowser">HelpBrowser</a></td> | |
| 23 <td>Class implementing the helpbrowser widget.</td> | |
| 24 </tr><tr> | |
| 25 <td><a href="#HelpWebPage">HelpWebPage</a></td> | |
| 26 <td>Class implementing an enhanced web page.</td> | |
| 27 </tr><tr> | |
| 28 <td><a href="#JavaScriptEricObject">JavaScriptEricObject</a></td> | |
| 29 <td>Class implementing an external javascript object to search via the startpage.</td> | |
| 30 </tr><tr> | |
| 31 <td><a href="#JavaScriptExternalObject">JavaScriptExternalObject</a></td> | |
| 32 <td>Class implementing an external javascript object to add search providers.</td> | |
| 33 </tr><tr> | |
| 34 <td><a href="#LinkedResource">LinkedResource</a></td> | |
| 35 <td>Class defining a data structure for linked resources.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="HelpBrowser" ID="HelpBrowser"></a> | |
| 44 <h2>HelpBrowser</h2> | |
| 45 <p> | |
| 46 Class implementing the helpbrowser widget. | |
| 47 </p><p> | |
| 48 This is a subclass of the Qt QWebView to implement an | |
| 49 interface compatible with the QTextBrowser based variant. | |
| 50 </p><h4>Signals</h4> | |
| 51 <dl> | |
| 52 <dt>backwardAvailable(bool)</dt> | |
| 53 <dd> | |
| 54 emitted after the current URL has changed | |
| 55 </dd><dt>forwardAvailable(bool)</dt> | |
| 56 <dd> | |
| 57 emitted after the current URL has changed | |
| 58 </dd><dt>highlighted(const QString&)</dt> | |
| 59 <dd> | |
| 60 emitted, when the mouse hovers over a link | |
| 61 </dd><dt>search(const QUrl &)</dt> | |
| 62 <dd> | |
| 63 emitted, when a search is requested | |
| 64 </dd><dt>sourceChanged(const QUrl &)</dt> | |
| 65 <dd> | |
| 66 emitted after the current URL has changed | |
| 67 </dd> | |
| 68 </dl> | |
| 69 <h3>Derived from</h3> | |
| 70 QWebView | |
| 71 <h3>Class Attributes</h3> | |
| 72 <table> | |
| 73 <tr><td>None</td></tr> | |
| 74 </table> | |
| 75 <h3>Methods</h3> | |
| 76 <table> | |
| 77 <tr> | |
| 78 <td><a href="#HelpBrowser.__init__">HelpBrowser</a></td> | |
| 79 <td>Constructor</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#HelpBrowser.__addBookmark">__addBookmark</a></td> | |
| 82 <td>Private slot to bookmark the current link.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#HelpBrowser.__addExternalBinding">__addExternalBinding</a></td> | |
| 85 <td>Private slot to add javascript bindings for adding search providers.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#HelpBrowser.__applyZoom">__applyZoom</a></td> | |
| 88 <td>Private slot to apply the current zoom factor.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#HelpBrowser.__blockImage">__blockImage</a></td> | |
| 91 <td>Private slot to add a block rule for an image URL.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#HelpBrowser.__bookmarkLink">__bookmarkLink</a></td> | |
| 94 <td>Private slot to bookmark a link via the context menu.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#HelpBrowser.__copyImage">__copyImage</a></td> | |
| 97 <td>Private slot to copy an image to the clipboard.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#HelpBrowser.__copyImageLocation">__copyImageLocation</a></td> | |
| 100 <td>Private slot to copy an image location to the clipboard.</td> | |
| 101 </tr><tr> | |
| 102 <td><a href="#HelpBrowser.__copyLink">__copyLink</a></td> | |
| 103 <td>Private slot to copy a link to the clipboard.</td> | |
| 104 </tr><tr> | |
| 105 <td><a href="#HelpBrowser.__currentEngineChanged">__currentEngineChanged</a></td> | |
| 106 <td>Private slot to track a change of the current search engine.</td> | |
| 107 </tr><tr> | |
| 108 <td><a href="#HelpBrowser.__downloadDone">__downloadDone</a></td> | |
| 109 <td>Private slot to handle the done signal of the download dialogs.</td> | |
| 110 </tr><tr> | |
| 111 <td><a href="#HelpBrowser.__downloadImage">__downloadImage</a></td> | |
| 112 <td>Private slot to download an image and save it to disk.</td> | |
| 113 </tr><tr> | |
| 114 <td><a href="#HelpBrowser.__downloadLink">__downloadLink</a></td> | |
| 115 <td>Private slot to download a link and save it to disk.</td> | |
| 116 </tr><tr> | |
| 117 <td><a href="#HelpBrowser.__downloadRequested">__downloadRequested</a></td> | |
| 118 <td>Private slot to handle a download request.</td> | |
| 119 </tr><tr> | |
| 120 <td><a href="#HelpBrowser.__iconChanged">__iconChanged</a></td> | |
| 121 <td>Private slot to handle the icon change.</td> | |
| 122 </tr><tr> | |
| 123 <td><a href="#HelpBrowser.__levelForZoom">__levelForZoom</a></td> | |
| 124 <td>Private method determining the zoom level index given a zoom factor.</td> | |
| 125 </tr><tr> | |
| 126 <td><a href="#HelpBrowser.__linkHovered">__linkHovered</a></td> | |
| 127 <td>Private slot to handle the linkHovered signal.</td> | |
| 128 </tr><tr> | |
| 129 <td><a href="#HelpBrowser.__loadFinished">__loadFinished</a></td> | |
| 130 <td>Private method to handle the loadFinished signal.</td> | |
| 131 </tr><tr> | |
| 132 <td><a href="#HelpBrowser.__loadProgress">__loadProgress</a></td> | |
| 133 <td>Private method to handle the loadProgress signal.</td> | |
| 134 </tr><tr> | |
| 135 <td><a href="#HelpBrowser.__loadStarted">__loadStarted</a></td> | |
| 136 <td>Private method to handle the loadStarted signal.</td> | |
| 137 </tr><tr> | |
| 138 <td><a href="#HelpBrowser.__openLinkInNewTab">__openLinkInNewTab</a></td> | |
| 139 <td>Private method called by the context menu to open a link in a new window.</td> | |
| 140 </tr><tr> | |
| 141 <td><a href="#HelpBrowser.__searchRequested">__searchRequested</a></td> | |
| 142 <td>Private slot to search for some text with a selected search engine.</td> | |
| 143 </tr><tr> | |
| 144 <td><a href="#HelpBrowser.__statusBarMessage">__statusBarMessage</a></td> | |
| 145 <td>Private slot to handle the statusBarMessage signal.</td> | |
| 146 </tr><tr> | |
| 147 <td><a href="#HelpBrowser.__unsupportedContent">__unsupportedContent</a></td> | |
| 148 <td>Private slot to handle the unsupportedContent signal.</td> | |
| 149 </tr><tr> | |
| 150 <td><a href="#HelpBrowser.__urlChanged">__urlChanged</a></td> | |
| 151 <td>Private slot to handle the urlChanged signal.</td> | |
| 152 </tr><tr> | |
| 153 <td><a href="#HelpBrowser.__webInspector">__webInspector</a></td> | |
| 154 <td>Private slot to show the web inspector window.</td> | |
| 155 </tr><tr> | |
| 156 <td><a href="#HelpBrowser.backward">backward</a></td> | |
| 157 <td>Public slot to move backwards in history.</td> | |
| 158 </tr><tr> | |
| 159 <td><a href="#HelpBrowser.clearHistory">clearHistory</a></td> | |
| 160 <td>Public slot to clear the history.</td> | |
| 161 </tr><tr> | |
| 162 <td><a href="#HelpBrowser.contextMenuEvent">contextMenuEvent</a></td> | |
| 163 <td>Protected method called to create a context menu.</td> | |
| 164 </tr><tr> | |
| 165 <td><a href="#HelpBrowser.copy">copy</a></td> | |
| 166 <td>Public slot to copy the selected text.</td> | |
| 167 </tr><tr> | |
| 168 <td><a href="#HelpBrowser.createWindow">createWindow</a></td> | |
| 169 <td>Protected method called, when a new window should be created.</td> | |
| 170 </tr><tr> | |
| 171 <td><a href="#HelpBrowser.documentTitle">documentTitle</a></td> | |
| 172 <td>Public method to return the title of the loaded page.</td> | |
| 173 </tr><tr> | |
| 174 <td><a href="#HelpBrowser.findNextPrev">findNextPrev</a></td> | |
| 175 <td>Public slot to find the next occurrence of a text.</td> | |
| 176 </tr><tr> | |
| 177 <td><a href="#HelpBrowser.forward">forward</a></td> | |
| 178 <td>Public slot to move forward in history.</td> | |
| 179 </tr><tr> | |
| 180 <td><a href="#HelpBrowser.hasSelection">hasSelection</a></td> | |
| 181 <td>Public method to determine, if there is some text selected.</td> | |
| 182 </tr><tr> | |
| 183 <td><a href="#HelpBrowser.home">home</a></td> | |
| 184 <td>Public slot to move to the first page loaded.</td> | |
| 185 </tr><tr> | |
| 186 <td><a href="#HelpBrowser.isBackwardAvailable">isBackwardAvailable</a></td> | |
| 187 <td>Public method to determine, if a backwards move in history is possible.</td> | |
| 188 </tr><tr> | |
| 189 <td><a href="#HelpBrowser.isForwardAvailable">isForwardAvailable</a></td> | |
| 190 <td>Public method to determine, if a forward move in history is possible.</td> | |
| 191 </tr><tr> | |
| 192 <td><a href="#HelpBrowser.isLoading">isLoading</a></td> | |
| 193 <td>Public method to get the loading state.</td> | |
| 194 </tr><tr> | |
| 195 <td><a href="#HelpBrowser.keyPressEvent">keyPressEvent</a></td> | |
| 196 <td>Protected method called by a key press.</td> | |
| 197 </tr><tr> | |
| 198 <td><a href="#HelpBrowser.keyReleaseEvent">keyReleaseEvent</a></td> | |
| 199 <td>Protected method called by a key release.</td> | |
| 200 </tr><tr> | |
| 201 <td><a href="#HelpBrowser.linkedResources">linkedResources</a></td> | |
| 202 <td>Public method to extract linked resources.</td> | |
| 203 </tr><tr> | |
| 204 <td><a href="#HelpBrowser.preferencesChanged">preferencesChanged</a></td> | |
| 205 <td>Public method to indicate a change of the settings.</td> | |
| 206 </tr><tr> | |
| 207 <td><a href="#HelpBrowser.reload">reload</a></td> | |
| 208 <td>Public slot to reload the current page.</td> | |
| 209 </tr><tr> | |
| 210 <td><a href="#HelpBrowser.saveAs">saveAs</a></td> | |
| 211 <td>Public method to save the current page to a file.</td> | |
| 212 </tr><tr> | |
| 213 <td><a href="#HelpBrowser.setSource">setSource</a></td> | |
| 214 <td>Public method used to set the source to be displayed.</td> | |
| 215 </tr><tr> | |
| 216 <td><a href="#HelpBrowser.source">source</a></td> | |
| 217 <td>Public method to return the URL of the loaded page.</td> | |
| 218 </tr><tr> | |
| 219 <td><a href="#HelpBrowser.wheelEvent">wheelEvent</a></td> | |
| 220 <td>Protected method to handle wheel events.</td> | |
| 221 </tr><tr> | |
| 222 <td><a href="#HelpBrowser.zoomIn">zoomIn</a></td> | |
| 223 <td>Public slot to zoom into the page.</td> | |
| 224 </tr><tr> | |
| 225 <td><a href="#HelpBrowser.zoomOut">zoomOut</a></td> | |
| 226 <td>Public slot to zoom out of the page.</td> | |
| 227 </tr><tr> | |
| 228 <td><a href="#HelpBrowser.zoomReset">zoomReset</a></td> | |
| 229 <td>Public method to reset the zoom factor.</td> | |
| 230 </tr> | |
| 231 </table> | |
| 232 <a NAME="HelpBrowser.__init__" ID="HelpBrowser.__init__"></a> | |
| 233 <h4>HelpBrowser (Constructor)</h4> | |
| 234 <b>HelpBrowser</b>(<i>parent = None, name = ""</i>) | |
| 235 <p> | |
| 236 Constructor | |
| 237 </p><dl> | |
| 238 <dt><i>parent</i></dt> | |
| 239 <dd> | |
| 240 parent widget of this window (QWidget) | |
| 241 </dd><dt><i>name</i></dt> | |
| 242 <dd> | |
| 243 name of this window (string) | |
| 244 </dd> | |
| 245 </dl><a NAME="HelpBrowser.__addBookmark" ID="HelpBrowser.__addBookmark"></a> | |
| 246 <h4>HelpBrowser.__addBookmark</h4> | |
| 247 <b>__addBookmark</b>(<i></i>) | |
| 248 <p> | |
| 249 Private slot to bookmark the current link. | |
| 250 </p><a NAME="HelpBrowser.__addExternalBinding" ID="HelpBrowser.__addExternalBinding"></a> | |
| 251 <h4>HelpBrowser.__addExternalBinding</h4> | |
| 252 <b>__addExternalBinding</b>(<i>frame = None</i>) | |
| 253 <p> | |
| 254 Private slot to add javascript bindings for adding search providers. | |
| 255 </p><dl> | |
| 256 <dt><i>frame</i></dt> | |
| 257 <dd> | |
| 258 reference to the web frame (QWebFrame) | |
| 259 </dd> | |
| 260 </dl><a NAME="HelpBrowser.__applyZoom" ID="HelpBrowser.__applyZoom"></a> | |
| 261 <h4>HelpBrowser.__applyZoom</h4> | |
| 262 <b>__applyZoom</b>(<i></i>) | |
| 263 <p> | |
| 264 Private slot to apply the current zoom factor. | |
| 265 </p><a NAME="HelpBrowser.__blockImage" ID="HelpBrowser.__blockImage"></a> | |
| 266 <h4>HelpBrowser.__blockImage</h4> | |
| 267 <b>__blockImage</b>(<i></i>) | |
| 268 <p> | |
| 269 Private slot to add a block rule for an image URL. | |
| 270 </p><a NAME="HelpBrowser.__bookmarkLink" ID="HelpBrowser.__bookmarkLink"></a> | |
| 271 <h4>HelpBrowser.__bookmarkLink</h4> | |
| 272 <b>__bookmarkLink</b>(<i></i>) | |
| 273 <p> | |
| 274 Private slot to bookmark a link via the context menu. | |
| 275 </p><a NAME="HelpBrowser.__copyImage" ID="HelpBrowser.__copyImage"></a> | |
| 276 <h4>HelpBrowser.__copyImage</h4> | |
| 277 <b>__copyImage</b>(<i></i>) | |
| 278 <p> | |
| 279 Private slot to copy an image to the clipboard. | |
| 280 </p><a NAME="HelpBrowser.__copyImageLocation" ID="HelpBrowser.__copyImageLocation"></a> | |
| 281 <h4>HelpBrowser.__copyImageLocation</h4> | |
| 282 <b>__copyImageLocation</b>(<i></i>) | |
| 283 <p> | |
| 284 Private slot to copy an image location to the clipboard. | |
| 285 </p><a NAME="HelpBrowser.__copyLink" ID="HelpBrowser.__copyLink"></a> | |
| 286 <h4>HelpBrowser.__copyLink</h4> | |
| 287 <b>__copyLink</b>(<i></i>) | |
| 288 <p> | |
| 289 Private slot to copy a link to the clipboard. | |
| 290 </p><a NAME="HelpBrowser.__currentEngineChanged" ID="HelpBrowser.__currentEngineChanged"></a> | |
| 291 <h4>HelpBrowser.__currentEngineChanged</h4> | |
| 292 <b>__currentEngineChanged</b>(<i></i>) | |
| 293 <p> | |
| 294 Private slot to track a change of the current search engine. | |
| 295 </p><a NAME="HelpBrowser.__downloadDone" ID="HelpBrowser.__downloadDone"></a> | |
| 296 <h4>HelpBrowser.__downloadDone</h4> | |
| 297 <b>__downloadDone</b>(<i></i>) | |
| 298 <p> | |
| 299 Private slot to handle the done signal of the download dialogs. | |
| 300 </p><a NAME="HelpBrowser.__downloadImage" ID="HelpBrowser.__downloadImage"></a> | |
| 301 <h4>HelpBrowser.__downloadImage</h4> | |
| 302 <b>__downloadImage</b>(<i></i>) | |
| 303 <p> | |
| 304 Private slot to download an image and save it to disk. | |
| 305 </p><a NAME="HelpBrowser.__downloadLink" ID="HelpBrowser.__downloadLink"></a> | |
| 306 <h4>HelpBrowser.__downloadLink</h4> | |
| 307 <b>__downloadLink</b>(<i></i>) | |
| 308 <p> | |
| 309 Private slot to download a link and save it to disk. | |
| 310 </p><a NAME="HelpBrowser.__downloadRequested" ID="HelpBrowser.__downloadRequested"></a> | |
| 311 <h4>HelpBrowser.__downloadRequested</h4> | |
| 312 <b>__downloadRequested</b>(<i>request</i>) | |
| 313 <p> | |
| 314 Private slot to handle a download request. | |
| 315 </p><dl> | |
| 316 <dt><i>request</i></dt> | |
| 317 <dd> | |
| 318 reference to the request object (QNetworkRequest) | |
| 319 </dd> | |
| 320 </dl><a NAME="HelpBrowser.__iconChanged" ID="HelpBrowser.__iconChanged"></a> | |
| 321 <h4>HelpBrowser.__iconChanged</h4> | |
| 322 <b>__iconChanged</b>(<i></i>) | |
| 323 <p> | |
| 324 Private slot to handle the icon change. | |
| 325 </p><a NAME="HelpBrowser.__levelForZoom" ID="HelpBrowser.__levelForZoom"></a> | |
| 326 <h4>HelpBrowser.__levelForZoom</h4> | |
| 327 <b>__levelForZoom</b>(<i>zoom</i>) | |
| 328 <p> | |
| 329 Private method determining the zoom level index given a zoom factor. | |
| 330 </p><dl> | |
| 331 <dt><i>zoom</i></dt> | |
| 332 <dd> | |
| 333 zoom factor (integer) | |
| 334 </dd> | |
| 335 </dl><dl> | |
| 336 <dt>Returns:</dt> | |
| 337 <dd> | |
| 338 index of zoom factor (integer) | |
| 339 </dd> | |
| 340 </dl><a NAME="HelpBrowser.__linkHovered" ID="HelpBrowser.__linkHovered"></a> | |
| 341 <h4>HelpBrowser.__linkHovered</h4> | |
| 342 <b>__linkHovered</b>(<i>link, title, textContent</i>) | |
| 343 <p> | |
| 344 Private slot to handle the linkHovered signal. | |
| 345 </p><dl> | |
| 346 <dt><i>link</i></dt> | |
| 347 <dd> | |
| 348 the URL of the link (string) | |
| 349 </dd><dt><i>title</i></dt> | |
| 350 <dd> | |
| 351 the link title (string) | |
| 352 </dd><dt><i>textContent</i></dt> | |
| 353 <dd> | |
| 354 text content of the link (string) | |
| 355 </dd> | |
| 356 </dl><a NAME="HelpBrowser.__loadFinished" ID="HelpBrowser.__loadFinished"></a> | |
| 357 <h4>HelpBrowser.__loadFinished</h4> | |
| 358 <b>__loadFinished</b>(<i>ok</i>) | |
| 359 <p> | |
| 360 Private method to handle the loadFinished signal. | |
| 361 </p><dl> | |
| 362 <dt><i>ok</i></dt> | |
| 363 <dd> | |
| 364 flag indicating the result (boolean) | |
| 365 </dd> | |
| 366 </dl><a NAME="HelpBrowser.__loadProgress" ID="HelpBrowser.__loadProgress"></a> | |
| 367 <h4>HelpBrowser.__loadProgress</h4> | |
| 368 <b>__loadProgress</b>(<i>progress</i>) | |
| 369 <p> | |
| 370 Private method to handle the loadProgress signal. | |
| 371 </p><dl> | |
| 372 <dt><i>progress</i></dt> | |
| 373 <dd> | |
| 374 progress value (integer) | |
| 375 </dd> | |
| 376 </dl><a NAME="HelpBrowser.__loadStarted" ID="HelpBrowser.__loadStarted"></a> | |
| 377 <h4>HelpBrowser.__loadStarted</h4> | |
| 378 <b>__loadStarted</b>(<i></i>) | |
| 379 <p> | |
| 380 Private method to handle the loadStarted signal. | |
| 381 </p><a NAME="HelpBrowser.__openLinkInNewTab" ID="HelpBrowser.__openLinkInNewTab"></a> | |
| 382 <h4>HelpBrowser.__openLinkInNewTab</h4> | |
| 383 <b>__openLinkInNewTab</b>(<i></i>) | |
| 384 <p> | |
| 385 Private method called by the context menu to open a link in a new window. | |
| 386 </p><a NAME="HelpBrowser.__searchRequested" ID="HelpBrowser.__searchRequested"></a> | |
| 387 <h4>HelpBrowser.__searchRequested</h4> | |
| 388 <b>__searchRequested</b>(<i>act</i>) | |
| 389 <p> | |
| 390 Private slot to search for some text with a selected search engine. | |
| 391 </p><dl> | |
| 392 <dt><i>act</i></dt> | |
| 393 <dd> | |
| 394 reference to the action that triggered this slot (QAction) | |
| 395 </dd> | |
| 396 </dl><a NAME="HelpBrowser.__statusBarMessage" ID="HelpBrowser.__statusBarMessage"></a> | |
| 397 <h4>HelpBrowser.__statusBarMessage</h4> | |
| 398 <b>__statusBarMessage</b>(<i>text</i>) | |
| 399 <p> | |
| 400 Private slot to handle the statusBarMessage signal. | |
| 401 </p><dl> | |
| 402 <dt><i>text</i></dt> | |
| 403 <dd> | |
| 404 text to be shown in the status bar (string) | |
| 405 </dd> | |
| 406 </dl><a NAME="HelpBrowser.__unsupportedContent" ID="HelpBrowser.__unsupportedContent"></a> | |
| 407 <h4>HelpBrowser.__unsupportedContent</h4> | |
| 408 <b>__unsupportedContent</b>(<i>reply, requestFilename = None, download = False</i>) | |
| 409 <p> | |
| 410 Private slot to handle the unsupportedContent signal. | |
| 411 </p><dl> | |
| 412 <dt><i>reply</i></dt> | |
| 413 <dd> | |
| 414 reference to the reply object (QNetworkReply) | |
| 415 </dd><dt><i>requestFilename=</i></dt> | |
| 416 <dd> | |
| 417 indicating to ask for a filename | |
| 418 (boolean or None). If it is None, the behavior is determined | |
| 419 by a configuration option. | |
| 420 </dd><dt><i>download=</i></dt> | |
| 421 <dd> | |
| 422 flag indicating a download operation (boolean) | |
| 423 </dd> | |
| 424 </dl><a NAME="HelpBrowser.__urlChanged" ID="HelpBrowser.__urlChanged"></a> | |
| 425 <h4>HelpBrowser.__urlChanged</h4> | |
| 426 <b>__urlChanged</b>(<i>url</i>) | |
| 427 <p> | |
| 428 Private slot to handle the urlChanged signal. | |
| 429 </p><dl> | |
| 430 <dt><i>url</i></dt> | |
| 431 <dd> | |
| 432 the new url (QUrl) | |
| 433 </dd> | |
| 434 </dl><a NAME="HelpBrowser.__webInspector" ID="HelpBrowser.__webInspector"></a> | |
| 435 <h4>HelpBrowser.__webInspector</h4> | |
| 436 <b>__webInspector</b>(<i></i>) | |
| 437 <p> | |
| 438 Private slot to show the web inspector window. | |
| 439 </p><a NAME="HelpBrowser.backward" ID="HelpBrowser.backward"></a> | |
| 440 <h4>HelpBrowser.backward</h4> | |
| 441 <b>backward</b>(<i></i>) | |
| 442 <p> | |
| 443 Public slot to move backwards in history. | |
| 444 </p><a NAME="HelpBrowser.clearHistory" ID="HelpBrowser.clearHistory"></a> | |
| 445 <h4>HelpBrowser.clearHistory</h4> | |
| 446 <b>clearHistory</b>(<i></i>) | |
| 447 <p> | |
| 448 Public slot to clear the history. | |
| 449 </p><a NAME="HelpBrowser.contextMenuEvent" ID="HelpBrowser.contextMenuEvent"></a> | |
| 450 <h4>HelpBrowser.contextMenuEvent</h4> | |
| 451 <b>contextMenuEvent</b>(<i>evt</i>) | |
| 452 <p> | |
| 453 Protected method called to create a context menu. | |
| 454 </p><p> | |
| 455 This method is overridden from QWebView. | |
| 456 </p><dl> | |
| 457 <dt><i>evt</i></dt> | |
| 458 <dd> | |
| 459 reference to the context menu event object (QContextMenuEvent) | |
| 460 </dd> | |
| 461 </dl><a NAME="HelpBrowser.copy" ID="HelpBrowser.copy"></a> | |
| 462 <h4>HelpBrowser.copy</h4> | |
| 463 <b>copy</b>(<i></i>) | |
| 464 <p> | |
| 465 Public slot to copy the selected text. | |
| 466 </p><a NAME="HelpBrowser.createWindow" ID="HelpBrowser.createWindow"></a> | |
| 467 <h4>HelpBrowser.createWindow</h4> | |
| 468 <b>createWindow</b>(<i>windowType</i>) | |
| 469 <p> | |
| 470 Protected method called, when a new window should be created. | |
| 471 </p><dl> | |
| 472 <dt><i>windowType</i></dt> | |
| 473 <dd> | |
| 474 type of the requested window (QWebPage.WebWindowType) | |
| 475 </dd> | |
| 476 </dl><a NAME="HelpBrowser.documentTitle" ID="HelpBrowser.documentTitle"></a> | |
| 477 <h4>HelpBrowser.documentTitle</h4> | |
| 478 <b>documentTitle</b>(<i></i>) | |
| 479 <p> | |
| 480 Public method to return the title of the loaded page. | |
| 481 </p><dl> | |
| 482 <dt>Returns:</dt> | |
| 483 <dd> | |
| 484 title (string) | |
| 485 </dd> | |
| 486 </dl><a NAME="HelpBrowser.findNextPrev" ID="HelpBrowser.findNextPrev"></a> | |
| 487 <h4>HelpBrowser.findNextPrev</h4> | |
| 488 <b>findNextPrev</b>(<i>txt, case, backwards, wrap</i>) | |
| 489 <p> | |
| 490 Public slot to find the next occurrence of a text. | |
| 491 </p><dl> | |
| 492 <dt><i>txt</i></dt> | |
| 493 <dd> | |
| 494 text to search for (string) | |
| 495 </dd><dt><i>case</i></dt> | |
| 496 <dd> | |
| 497 flag indicating a case sensitive search (boolean) | |
| 498 </dd><dt><i>backwards</i></dt> | |
| 499 <dd> | |
| 500 flag indicating a backwards search (boolean) | |
| 501 </dd><dt><i>wrap</i></dt> | |
| 502 <dd> | |
| 503 flag indicating to wrap around (boolean) | |
| 504 </dd> | |
| 505 </dl><a NAME="HelpBrowser.forward" ID="HelpBrowser.forward"></a> | |
| 506 <h4>HelpBrowser.forward</h4> | |
| 507 <b>forward</b>(<i></i>) | |
| 508 <p> | |
| 509 Public slot to move forward in history. | |
| 510 </p><a NAME="HelpBrowser.hasSelection" ID="HelpBrowser.hasSelection"></a> | |
| 511 <h4>HelpBrowser.hasSelection</h4> | |
| 512 <b>hasSelection</b>(<i></i>) | |
| 513 <p> | |
| 514 Public method to determine, if there is some text selected. | |
| 515 </p><dl> | |
| 516 <dt>Returns:</dt> | |
| 517 <dd> | |
| 518 flag indicating text has been selected (boolean) | |
| 519 </dd> | |
| 520 </dl><a NAME="HelpBrowser.home" ID="HelpBrowser.home"></a> | |
| 521 <h4>HelpBrowser.home</h4> | |
| 522 <b>home</b>(<i></i>) | |
| 523 <p> | |
| 524 Public slot to move to the first page loaded. | |
| 525 </p><a NAME="HelpBrowser.isBackwardAvailable" ID="HelpBrowser.isBackwardAvailable"></a> | |
| 526 <h4>HelpBrowser.isBackwardAvailable</h4> | |
| 527 <b>isBackwardAvailable</b>(<i></i>) | |
| 528 <p> | |
| 529 Public method to determine, if a backwards move in history is possible. | |
| 530 </p><dl> | |
| 531 <dt>Returns:</dt> | |
| 532 <dd> | |
| 533 flag indicating move backwards is possible (boolean) | |
| 534 </dd> | |
| 535 </dl><a NAME="HelpBrowser.isForwardAvailable" ID="HelpBrowser.isForwardAvailable"></a> | |
| 536 <h4>HelpBrowser.isForwardAvailable</h4> | |
| 537 <b>isForwardAvailable</b>(<i></i>) | |
| 538 <p> | |
| 539 Public method to determine, if a forward move in history is possible. | |
| 540 </p><dl> | |
| 541 <dt>Returns:</dt> | |
| 542 <dd> | |
| 543 flag indicating move forward is possible (boolean) | |
| 544 </dd> | |
| 545 </dl><a NAME="HelpBrowser.isLoading" ID="HelpBrowser.isLoading"></a> | |
| 546 <h4>HelpBrowser.isLoading</h4> | |
| 547 <b>isLoading</b>(<i></i>) | |
| 548 <p> | |
| 549 Public method to get the loading state. | |
| 550 </p><dl> | |
| 551 <dt>Returns:</dt> | |
| 552 <dd> | |
| 553 flag indicating the loading state (boolean) | |
| 554 </dd> | |
| 555 </dl><a NAME="HelpBrowser.keyPressEvent" ID="HelpBrowser.keyPressEvent"></a> | |
| 556 <h4>HelpBrowser.keyPressEvent</h4> | |
| 557 <b>keyPressEvent</b>(<i>evt</i>) | |
| 558 <p> | |
| 559 Protected method called by a key press. | |
| 560 </p><p> | |
| 561 This method is overridden from QTextBrowser. | |
| 562 </p><dl> | |
| 563 <dt><i>evt</i></dt> | |
| 564 <dd> | |
| 565 the key event (QKeyEvent) | |
| 566 </dd> | |
| 567 </dl><a NAME="HelpBrowser.keyReleaseEvent" ID="HelpBrowser.keyReleaseEvent"></a> | |
| 568 <h4>HelpBrowser.keyReleaseEvent</h4> | |
| 569 <b>keyReleaseEvent</b>(<i>evt</i>) | |
| 570 <p> | |
| 571 Protected method called by a key release. | |
| 572 </p><p> | |
| 573 This method is overridden from QTextBrowser. | |
| 574 </p><dl> | |
| 575 <dt><i>evt</i></dt> | |
| 576 <dd> | |
| 577 the key event (QKeyEvent) | |
| 578 </dd> | |
| 579 </dl><a NAME="HelpBrowser.linkedResources" ID="HelpBrowser.linkedResources"></a> | |
| 580 <h4>HelpBrowser.linkedResources</h4> | |
| 581 <b>linkedResources</b>(<i>relation = ""</i>) | |
| 582 <p> | |
| 583 Public method to extract linked resources. | |
| 584 </p><dl> | |
| 585 <dt><i>relation</i></dt> | |
| 586 <dd> | |
| 587 relation to extract (string) | |
| 588 </dd> | |
| 589 </dl><dl> | |
| 590 <dt>Returns:</dt> | |
| 591 <dd> | |
| 592 list of linked resources (list of LinkedResource) | |
| 593 </dd> | |
| 594 </dl><a NAME="HelpBrowser.preferencesChanged" ID="HelpBrowser.preferencesChanged"></a> | |
| 595 <h4>HelpBrowser.preferencesChanged</h4> | |
| 596 <b>preferencesChanged</b>(<i></i>) | |
| 597 <p> | |
| 598 Public method to indicate a change of the settings. | |
| 599 </p><a NAME="HelpBrowser.reload" ID="HelpBrowser.reload"></a> | |
| 600 <h4>HelpBrowser.reload</h4> | |
| 601 <b>reload</b>(<i></i>) | |
| 602 <p> | |
| 603 Public slot to reload the current page. | |
| 604 </p><a NAME="HelpBrowser.saveAs" ID="HelpBrowser.saveAs"></a> | |
| 605 <h4>HelpBrowser.saveAs</h4> | |
| 606 <b>saveAs</b>(<i></i>) | |
| 607 <p> | |
| 608 Public method to save the current page to a file. | |
| 609 </p><a NAME="HelpBrowser.setSource" ID="HelpBrowser.setSource"></a> | |
| 610 <h4>HelpBrowser.setSource</h4> | |
| 611 <b>setSource</b>(<i>name</i>) | |
| 612 <p> | |
| 613 Public method used to set the source to be displayed. | |
| 614 </p><dl> | |
| 615 <dt><i>name</i></dt> | |
| 616 <dd> | |
| 617 filename to be shown (QUrl) | |
| 618 </dd> | |
| 619 </dl><a NAME="HelpBrowser.source" ID="HelpBrowser.source"></a> | |
| 620 <h4>HelpBrowser.source</h4> | |
| 621 <b>source</b>(<i></i>) | |
| 622 <p> | |
| 623 Public method to return the URL of the loaded page. | |
| 624 </p><dl> | |
| 625 <dt>Returns:</dt> | |
| 626 <dd> | |
| 627 URL loaded in the help browser (QUrl) | |
| 628 </dd> | |
| 629 </dl><a NAME="HelpBrowser.wheelEvent" ID="HelpBrowser.wheelEvent"></a> | |
| 630 <h4>HelpBrowser.wheelEvent</h4> | |
| 631 <b>wheelEvent</b>(<i>evt</i>) | |
| 632 <p> | |
| 633 Protected method to handle wheel events. | |
| 634 </p><dl> | |
| 635 <dt><i>evt</i></dt> | |
| 636 <dd> | |
| 637 reference to the wheel event (QWheelEvent) | |
| 638 </dd> | |
| 639 </dl><a NAME="HelpBrowser.zoomIn" ID="HelpBrowser.zoomIn"></a> | |
| 640 <h4>HelpBrowser.zoomIn</h4> | |
| 641 <b>zoomIn</b>(<i></i>) | |
| 642 <p> | |
| 643 Public slot to zoom into the page. | |
| 644 </p><a NAME="HelpBrowser.zoomOut" ID="HelpBrowser.zoomOut"></a> | |
| 645 <h4>HelpBrowser.zoomOut</h4> | |
| 646 <b>zoomOut</b>(<i></i>) | |
| 647 <p> | |
| 648 Public slot to zoom out of the page. | |
| 649 </p><a NAME="HelpBrowser.zoomReset" ID="HelpBrowser.zoomReset"></a> | |
| 650 <h4>HelpBrowser.zoomReset</h4> | |
| 651 <b>zoomReset</b>(<i></i>) | |
| 652 <p> | |
| 653 Public method to reset the zoom factor. | |
| 654 </p> | |
| 655 <div align="right"><a href="#top">Up</a></div> | |
| 656 <hr /><hr /> | |
| 657 <a NAME="HelpWebPage" ID="HelpWebPage"></a> | |
| 658 <h2>HelpWebPage</h2> | |
| 659 <p> | |
| 660 Class implementing an enhanced web page. | |
| 661 </p> | |
| 662 <h3>Derived from</h3> | |
| 663 QWebPage | |
| 664 <h3>Class Attributes</h3> | |
| 665 <table> | |
| 666 <tr><td>None</td></tr> | |
| 667 </table> | |
| 668 <h3>Methods</h3> | |
| 669 <table> | |
| 670 <tr> | |
| 671 <td><a href="#HelpWebPage.__init__">HelpWebPage</a></td> | |
| 672 <td>Constructor</td> | |
| 673 </tr><tr> | |
| 674 <td><a href="#HelpWebPage.acceptNavigationRequest">acceptNavigationRequest</a></td> | |
| 675 <td>Protected method to determine, if a request may be accepted.</td> | |
| 676 </tr><tr> | |
| 677 <td><a href="#HelpWebPage.pageAttributeId">pageAttributeId</a></td> | |
| 678 <td>Public method to get the attribute id of the page attribute.</td> | |
| 679 </tr><tr> | |
| 680 <td><a href="#HelpWebPage.populateNetworkRequest">populateNetworkRequest</a></td> | |
| 681 <td>Public method to add data to a network request.</td> | |
| 682 </tr> | |
| 683 </table> | |
| 684 <a NAME="HelpWebPage.__init__" ID="HelpWebPage.__init__"></a> | |
| 685 <h4>HelpWebPage (Constructor)</h4> | |
| 686 <b>HelpWebPage</b>(<i>parent = None</i>) | |
| 687 <p> | |
| 688 Constructor | |
| 689 </p><dl> | |
| 690 <dt><i>parent</i></dt> | |
| 691 <dd> | |
| 692 parent widget of this window (QWidget) | |
| 693 </dd> | |
| 694 </dl><a NAME="HelpWebPage.acceptNavigationRequest" ID="HelpWebPage.acceptNavigationRequest"></a> | |
| 695 <h4>HelpWebPage.acceptNavigationRequest</h4> | |
| 696 <b>acceptNavigationRequest</b>(<i>frame, request, type_</i>) | |
| 697 <p> | |
| 698 Protected method to determine, if a request may be accepted. | |
| 699 </p><dl> | |
| 700 <dt><i>frame</i></dt> | |
| 701 <dd> | |
| 702 reference to the frame sending the request (QWebFrame) | |
| 703 </dd><dt><i>request</i></dt> | |
| 704 <dd> | |
| 705 reference to the request object (QNetworkRequest) | |
| 706 </dd><dt><i>type_</i></dt> | |
| 707 <dd> | |
| 708 type of the navigation request (QWebPage.NavigationType) | |
| 709 </dd> | |
| 710 </dl><dl> | |
| 711 <dt>Returns:</dt> | |
| 712 <dd> | |
| 713 flag indicating acceptance (boolean) | |
| 714 </dd> | |
| 715 </dl><a NAME="HelpWebPage.pageAttributeId" ID="HelpWebPage.pageAttributeId"></a> | |
| 716 <h4>HelpWebPage.pageAttributeId</h4> | |
| 717 <b>pageAttributeId</b>(<i></i>) | |
| 718 <p> | |
| 719 Public method to get the attribute id of the page attribute. | |
| 720 </p><dl> | |
| 721 <dt>Returns:</dt> | |
| 722 <dd> | |
| 723 attribute id of the page attribute (integer) | |
| 724 </dd> | |
| 725 </dl><a NAME="HelpWebPage.populateNetworkRequest" ID="HelpWebPage.populateNetworkRequest"></a> | |
| 726 <h4>HelpWebPage.populateNetworkRequest</h4> | |
| 727 <b>populateNetworkRequest</b>(<i>request</i>) | |
| 728 <p> | |
| 729 Public method to add data to a network request. | |
| 730 </p><dl> | |
| 731 <dt><i>request</i></dt> | |
| 732 <dd> | |
| 733 reference to the network request object (QNetworkRequest) | |
| 734 </dd> | |
| 735 </dl> | |
| 736 <div align="right"><a href="#top">Up</a></div> | |
| 737 <hr /><hr /> | |
| 738 <a NAME="JavaScriptEricObject" ID="JavaScriptEricObject"></a> | |
| 739 <h2>JavaScriptEricObject</h2> | |
| 740 <p> | |
| 741 Class implementing an external javascript object to search via the startpage. | |
| 742 </p> | |
| 743 <h3>Derived from</h3> | |
| 744 QObject | |
| 745 <h3>Class Attributes</h3> | |
| 746 <table> | |
| 747 <tr><td>translations</td></tr> | |
| 748 </table> | |
| 749 <h3>Methods</h3> | |
| 750 <table> | |
| 751 <tr> | |
| 752 <td><a href="#JavaScriptEricObject.providerString">providerString</a></td> | |
| 753 <td>Public method to get a string for the search provider.</td> | |
| 754 </tr><tr> | |
| 755 <td><a href="#JavaScriptEricObject.searchUrl">searchUrl</a></td> | |
| 756 <td>Public method to get the search URL for the given search term.</td> | |
| 757 </tr><tr> | |
| 758 <td><a href="#JavaScriptEricObject.translate">translate</a></td> | |
| 759 <td>Public method to translate the given string.</td> | |
| 760 </tr> | |
| 761 </table> | |
| 762 <a NAME="JavaScriptEricObject.providerString" ID="JavaScriptEricObject.providerString"></a> | |
| 763 <h4>JavaScriptEricObject.providerString</h4> | |
| 764 <b>providerString</b>(<i></i>) | |
| 765 <p> | |
| 766 Public method to get a string for the search provider. | |
| 767 </p><dl> | |
| 768 <dt>Returns:</dt> | |
| 769 <dd> | |
| 770 string for the search provider (string) | |
| 771 </dd> | |
| 772 </dl><a NAME="JavaScriptEricObject.searchUrl" ID="JavaScriptEricObject.searchUrl"></a> | |
| 773 <h4>JavaScriptEricObject.searchUrl</h4> | |
| 774 <b>searchUrl</b>(<i>searchStr</i>) | |
| 775 <p> | |
| 776 Public method to get the search URL for the given search term. | |
| 777 </p><dl> | |
| 778 <dt><i>searchStr</i></dt> | |
| 779 <dd> | |
| 780 search term (string) | |
| 781 </dd> | |
| 782 </dl><dl> | |
| 783 <dt>Returns:</dt> | |
| 784 <dd> | |
| 785 search URL (string) | |
| 786 </dd> | |
| 787 </dl><a NAME="JavaScriptEricObject.translate" ID="JavaScriptEricObject.translate"></a> | |
| 788 <h4>JavaScriptEricObject.translate</h4> | |
| 789 <b>translate</b>(<i>trans</i>) | |
| 790 <p> | |
| 791 Public method to translate the given string. | |
| 792 </p><dl> | |
| 793 <dt><i>trans</i></dt> | |
| 794 <dd> | |
| 795 string to be translated (string) | |
| 796 </dd> | |
| 797 </dl><dl> | |
| 798 <dt>Returns:</dt> | |
| 799 <dd> | |
| 800 translation (string) | |
| 801 </dd> | |
| 802 </dl> | |
| 803 <div align="right"><a href="#top">Up</a></div> | |
| 804 <hr /><hr /> | |
| 805 <a NAME="JavaScriptExternalObject" ID="JavaScriptExternalObject"></a> | |
| 806 <h2>JavaScriptExternalObject</h2> | |
| 807 <p> | |
| 808 Class implementing an external javascript object to add search providers. | |
| 809 </p> | |
| 810 <h3>Derived from</h3> | |
| 811 QObject | |
| 812 <h3>Class Attributes</h3> | |
| 813 <table> | |
| 814 <tr><td>None</td></tr> | |
| 815 </table> | |
| 816 <h3>Methods</h3> | |
| 817 <table> | |
| 818 <tr> | |
| 819 <td><a href="#JavaScriptExternalObject.AddSearchProvider">AddSearchProvider</a></td> | |
| 820 <td>Public slot to add a search provider.</td> | |
| 821 </tr> | |
| 822 </table> | |
| 823 <a NAME="JavaScriptExternalObject.AddSearchProvider" ID="JavaScriptExternalObject.AddSearchProvider"></a> | |
| 824 <h4>JavaScriptExternalObject.AddSearchProvider</h4> | |
| 825 <b>AddSearchProvider</b>(<i>url</i>) | |
| 826 <p> | |
| 827 Public slot to add a search provider. | |
| 828 </p><dl> | |
| 829 <dt><i>url</i></dt> | |
| 830 <dd> | |
| 831 url of the XML file defining the search provider (string) | |
| 832 </dd> | |
| 833 </dl> | |
| 834 <div align="right"><a href="#top">Up</a></div> | |
| 835 <hr /><hr /> | |
| 836 <a NAME="LinkedResource" ID="LinkedResource"></a> | |
| 837 <h2>LinkedResource</h2> | |
| 838 <p> | |
| 839 Class defining a data structure for linked resources. | |
| 840 </p> | |
| 841 <h3>Derived from</h3> | |
| 842 object | |
| 843 <h3>Class Attributes</h3> | |
| 844 <table> | |
| 845 <tr><td>None</td></tr> | |
| 846 </table> | |
| 847 <h3>Methods</h3> | |
| 848 <table> | |
| 849 <tr> | |
| 850 <td><a href="#LinkedResource.__init__">LinkedResource</a></td> | |
| 851 <td>Constructor</td> | |
| 852 </tr> | |
| 853 </table> | |
| 854 <a NAME="LinkedResource.__init__" ID="LinkedResource.__init__"></a> | |
| 855 <h4>LinkedResource (Constructor)</h4> | |
| 856 <b>LinkedResource</b>(<i></i>) | |
| 857 <p> | |
| 858 Constructor | |
| 859 </p> | |
| 860 <div align="right"><a href="#top">Up</a></div> | |
| 861 <hr /> | |
| 862 </body></html> |
