Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImplQWE.html
src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImplQWE.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8905
- 986278234c8a
- child 9643
- 10839ab864e0
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.HelpViewer.HelpViewerImplQWE</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.HelpViewer.HelpViewerImplQWE</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the help viewer base class. | |
| 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="#HelpViewerImplQWE">HelpViewerImplQWE</a></td> | |
| 25 <td>Class implementing the QTextBrowser based help viewer class.</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="HelpViewerImplQWE" ID="HelpViewerImplQWE"></a> | |
| 36 <h2>HelpViewerImplQWE</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the QTextBrowser based help viewer class. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 HelpViewerImpl, QWebEngineView | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>ZoomLevelDefault</td></tr><tr><td>ZoomLevels</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#HelpViewerImplQWE.__init__">HelpViewerImplQWE</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#HelpViewerImplQWE.__bookmarkPage">__bookmarkPage</a></td> | |
| 63 <td>Private method called by the context menu to bookmark the page.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#HelpViewerImplQWE.__closeOtherPages">__closeOtherPages</a></td> | |
| 67 <td>Private method called by the context menu to close all other pages.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#HelpViewerImplQWE.__closePage">__closePage</a></td> | |
| 71 <td>Private method called by the context menu to close the current page.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#HelpViewerImplQWE.__copyLink">__copyLink</a></td> | |
| 75 <td>Private method called by the context menu to copy a link to the clipboard.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#HelpViewerImplQWE.__copyText">__copyText</a></td> | |
| 79 <td>Private method called by the context menu to copy selected text to the clipboard.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#HelpViewerImplQWE.__createContextMenu">__createContextMenu</a></td> | |
| 83 <td>Private method to populate the context menu.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#HelpViewerImplQWE.__createLinkContextMenu">__createLinkContextMenu</a></td> | |
| 87 <td>Private method to populate the context menu for URLs.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#HelpViewerImplQWE.__createNewPage">__createNewPage</a></td> | |
| 91 <td>Private method to create a new page object.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#HelpViewerImplQWE.__levelForScale">__levelForScale</a></td> | |
| 95 <td>Private method determining the zoom level index given a zoom factor.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#HelpViewerImplQWE.__newWindowRequested">__newWindowRequested</a></td> | |
| 99 <td>Private slot handling new window requests of the web page.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#HelpViewerImplQWE.__openLinkInBackgroundPage">__openLinkInBackgroundPage</a></td> | |
| 103 <td>Private method called by the context menu to open a link in a background page.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#HelpViewerImplQWE.__openLinkInNewPage">__openLinkInNewPage</a></td> | |
| 107 <td>Private method called by the context menu to open a link in a new page.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#HelpViewerImplQWE.__selectAll">__selectAll</a></td> | |
| 111 <td>Private method called by the context menu to select all text.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#HelpViewerImplQWE.__setRwhvqt">__setRwhvqt</a></td> | |
| 115 <td>Private slot to set widget that receives input events.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#HelpViewerImplQWE.__titleChanged">__titleChanged</a></td> | |
| 119 <td>Private method to handle a change of the web page title.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#HelpViewerImplQWE._contextMenuEvent">_contextMenuEvent</a></td> | |
| 123 <td>Protected method called to create a context menu.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#HelpViewerImplQWE._gestureEvent">_gestureEvent</a></td> | |
| 127 <td>Protected method handling gesture events.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#HelpViewerImplQWE._keyPressEvent">_keyPressEvent</a></td> | |
| 131 <td>Protected method called by a key press.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#HelpViewerImplQWE._mouseReleaseEvent">_mouseReleaseEvent</a></td> | |
| 135 <td>Protected method called by a mouse release event.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#HelpViewerImplQWE._wheelEvent">_wheelEvent</a></td> | |
| 139 <td>Protected method to handle wheel events.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#HelpViewerImplQWE.backward">backward</a></td> | |
| 143 <td>Public slot to move backwards in history.</td> | |
| 144 </tr> | |
| 145 <tr> | |
| 146 <td><a href="#HelpViewerImplQWE.backwardHistoryCount">backwardHistoryCount</a></td> | |
| 147 <td>Public method to get the number of available back history items.</td> | |
| 148 </tr> | |
| 149 <tr> | |
| 150 <td><a href="#HelpViewerImplQWE.clearHistory">clearHistory</a></td> | |
| 151 <td>Public method to clear the history.</td> | |
| 152 </tr> | |
| 153 <tr> | |
| 154 <td><a href="#HelpViewerImplQWE.contextMenuEvent">contextMenuEvent</a></td> | |
| 155 <td>Protected method called to create a context menu.</td> | |
| 156 </tr> | |
| 157 <tr> | |
| 158 <td><a href="#HelpViewerImplQWE.event">event</a></td> | |
| 159 <td>Public method handling events.</td> | |
| 160 </tr> | |
| 161 <tr> | |
| 162 <td><a href="#HelpViewerImplQWE.eventFilter">eventFilter</a></td> | |
| 163 <td>Public method to process event for other objects.</td> | |
| 164 </tr> | |
| 165 <tr> | |
| 166 <td><a href="#HelpViewerImplQWE.forward">forward</a></td> | |
| 167 <td>Public slot to move forward in history.</td> | |
| 168 </tr> | |
| 169 <tr> | |
| 170 <td><a href="#HelpViewerImplQWE.forwardHistoryCount">forwardHistoryCount</a></td> | |
| 171 <td>Public method to get the number of available forward history items.</td> | |
| 172 </tr> | |
| 173 <tr> | |
| 174 <td><a href="#HelpViewerImplQWE.gotoHistory">gotoHistory</a></td> | |
| 175 <td>Public method to go to a history item.</td> | |
| 176 </tr> | |
| 177 <tr> | |
| 178 <td><a href="#HelpViewerImplQWE.historyTitle">historyTitle</a></td> | |
| 179 <td>Public method to get the title of a history item.</td> | |
| 180 </tr> | |
| 181 <tr> | |
| 182 <td><a href="#HelpViewerImplQWE.isBackwardAvailable">isBackwardAvailable</a></td> | |
| 183 <td>Public method to check, if stepping backward through the history is available.</td> | |
| 184 </tr> | |
| 185 <tr> | |
| 186 <td><a href="#HelpViewerImplQWE.isEmptyPage">isEmptyPage</a></td> | |
| 187 <td>Public method to check, if the current page is the empty page.</td> | |
| 188 </tr> | |
| 189 <tr> | |
| 190 <td><a href="#HelpViewerImplQWE.isForwardAvailable">isForwardAvailable</a></td> | |
| 191 <td>Public method to check, if stepping forward through the history is available.</td> | |
| 192 </tr> | |
| 193 <tr> | |
| 194 <td><a href="#HelpViewerImplQWE.isScaleDownAvailable">isScaleDownAvailable</a></td> | |
| 195 <td>Public method to check, if the min.</td> | |
| 196 </tr> | |
| 197 <tr> | |
| 198 <td><a href="#HelpViewerImplQWE.isScaleUpAvailable">isScaleUpAvailable</a></td> | |
| 199 <td>Public method to check, if the max.</td> | |
| 200 </tr> | |
| 201 <tr> | |
| 202 <td><a href="#HelpViewerImplQWE.link">link</a></td> | |
| 203 <td>Public method to get the URL of the shown document.</td> | |
| 204 </tr> | |
| 205 <tr> | |
| 206 <td><a href="#HelpViewerImplQWE.pageTitle">pageTitle</a></td> | |
| 207 <td>Public method get the page title.</td> | |
| 208 </tr> | |
| 209 <tr> | |
| 210 <td><a href="#HelpViewerImplQWE.reload">reload</a></td> | |
| 211 <td>Public slot to reload the current page.</td> | |
| 212 </tr> | |
| 213 <tr> | |
| 214 <td><a href="#HelpViewerImplQWE.resetScale">resetScale</a></td> | |
| 215 <td>Public method to reset the zoom level.</td> | |
| 216 </tr> | |
| 217 <tr> | |
| 218 <td><a href="#HelpViewerImplQWE.scale">scale</a></td> | |
| 219 <td>Public method to get the zoom level.</td> | |
| 220 </tr> | |
| 221 <tr> | |
| 222 <td><a href="#HelpViewerImplQWE.scaleDown">scaleDown</a></td> | |
| 223 <td>Public method to zoom out.</td> | |
| 224 </tr> | |
| 225 <tr> | |
| 226 <td><a href="#HelpViewerImplQWE.scaleUp">scaleUp</a></td> | |
| 227 <td>Public method to zoom in.</td> | |
| 228 </tr> | |
| 229 <tr> | |
| 230 <td><a href="#HelpViewerImplQWE.setLink">setLink</a></td> | |
| 231 <td>Public method to set the URL of the document to be shown.</td> | |
| 232 </tr> | |
| 233 <tr> | |
| 234 <td><a href="#HelpViewerImplQWE.setScale">setScale</a></td> | |
| 235 <td>Public method to set the zoom level.</td> | |
| 236 </tr> | |
| 237 </table> | |
| 238 <h3>Static Methods</h3> | |
| 239 | |
| 240 <table> | |
| 241 <tr><td>None</td></tr> | |
| 242 </table> | |
| 243 | |
| 244 <a NAME="HelpViewerImplQWE.__init__" ID="HelpViewerImplQWE.__init__"></a> | |
| 245 <h4>HelpViewerImplQWE (Constructor)</h4> | |
| 246 <b>HelpViewerImplQWE</b>(<i>engine, parent=None</i>) | |
| 247 | |
| 248 <p> | |
| 249 Constructor | |
| 250 </p> | |
| 251 <dl> | |
| 252 | |
| 253 <dt><i>engine</i> (QHelpEngine)</dt> | |
| 254 <dd> | |
| 255 reference to the help engine | |
| 256 </dd> | |
| 257 <dt><i>parent</i> (QWidget)</dt> | |
| 258 <dd> | |
| 259 reference to the parent widget | |
| 260 </dd> | |
| 261 </dl> | |
| 262 <a NAME="HelpViewerImplQWE.__bookmarkPage" ID="HelpViewerImplQWE.__bookmarkPage"></a> | |
| 263 <h4>HelpViewerImplQWE.__bookmarkPage</h4> | |
| 264 <b>__bookmarkPage</b>(<i>act</i>) | |
| 265 | |
| 266 <p> | |
| 267 Private method called by the context menu to bookmark the page. | |
| 268 </p> | |
| 269 <dl> | |
| 270 | |
| 271 <dt><i>act</i> (QAction)</dt> | |
| 272 <dd> | |
| 273 reference to the action that triggered | |
| 274 </dd> | |
| 275 </dl> | |
| 276 <a NAME="HelpViewerImplQWE.__closeOtherPages" ID="HelpViewerImplQWE.__closeOtherPages"></a> | |
| 277 <h4>HelpViewerImplQWE.__closeOtherPages</h4> | |
| 278 <b>__closeOtherPages</b>(<i></i>) | |
| 279 | |
| 280 <p> | |
| 281 Private method called by the context menu to close all other pages. | |
| 282 </p> | |
| 283 <a NAME="HelpViewerImplQWE.__closePage" ID="HelpViewerImplQWE.__closePage"></a> | |
| 284 <h4>HelpViewerImplQWE.__closePage</h4> | |
| 285 <b>__closePage</b>(<i></i>) | |
| 286 | |
| 287 <p> | |
| 288 Private method called by the context menu to close the current page. | |
| 289 </p> | |
| 290 <a NAME="HelpViewerImplQWE.__copyLink" ID="HelpViewerImplQWE.__copyLink"></a> | |
| 291 <h4>HelpViewerImplQWE.__copyLink</h4> | |
| 292 <b>__copyLink</b>(<i>act</i>) | |
| 293 | |
| 294 <p> | |
| 295 Private method called by the context menu to copy a link to the | |
| 296 clipboard. | |
| 297 </p> | |
| 298 <dl> | |
| 299 | |
| 300 <dt><i>act</i> (QAction)</dt> | |
| 301 <dd> | |
| 302 reference to the action that triggered | |
| 303 </dd> | |
| 304 </dl> | |
| 305 <a NAME="HelpViewerImplQWE.__copyText" ID="HelpViewerImplQWE.__copyText"></a> | |
| 306 <h4>HelpViewerImplQWE.__copyText</h4> | |
| 307 <b>__copyText</b>(<i></i>) | |
| 308 | |
| 309 <p> | |
| 310 Private method called by the context menu to copy selected text to the | |
| 311 clipboard. | |
| 312 </p> | |
| 313 <a NAME="HelpViewerImplQWE.__createContextMenu" ID="HelpViewerImplQWE.__createContextMenu"></a> | |
| 314 <h4>HelpViewerImplQWE.__createContextMenu</h4> | |
| 315 <b>__createContextMenu</b>(<i>menu</i>) | |
| 316 | |
| 317 <p> | |
| 318 Private method to populate the context menu. | |
| 319 </p> | |
| 320 <dl> | |
| 321 | |
| 322 <dt><i>menu</i> (QMenu)</dt> | |
| 323 <dd> | |
| 324 reference to the menu to be populated | |
| 325 </dd> | |
| 326 </dl> | |
| 327 <a NAME="HelpViewerImplQWE.__createLinkContextMenu" ID="HelpViewerImplQWE.__createLinkContextMenu"></a> | |
| 328 <h4>HelpViewerImplQWE.__createLinkContextMenu</h4> | |
| 329 <b>__createLinkContextMenu</b>(<i>menu, contextMenuData</i>) | |
| 330 | |
| 331 <p> | |
| 332 Private method to populate the context menu for URLs. | |
| 333 </p> | |
| 334 <dl> | |
| 335 | |
| 336 <dt><i>menu</i> (QMenu)</dt> | |
| 337 <dd> | |
| 338 reference to the menu to be populated | |
| 339 </dd> | |
| 340 <dt><i>contextMenuData</i> (QWebEngineContextMenuRequest)</dt> | |
| 341 <dd> | |
| 342 data of the last context menu request | |
| 343 </dd> | |
| 344 </dl> | |
| 345 <a NAME="HelpViewerImplQWE.__createNewPage" ID="HelpViewerImplQWE.__createNewPage"></a> | |
| 346 <h4>HelpViewerImplQWE.__createNewPage</h4> | |
| 347 <b>__createNewPage</b>(<i></i>) | |
| 348 | |
| 349 <p> | |
| 350 Private method to create a new page object. | |
| 351 </p> | |
| 352 <a NAME="HelpViewerImplQWE.__levelForScale" ID="HelpViewerImplQWE.__levelForScale"></a> | |
| 353 <h4>HelpViewerImplQWE.__levelForScale</h4> | |
| 354 <b>__levelForScale</b>(<i>scale</i>) | |
| 355 | |
| 356 <p> | |
| 357 Private method determining the zoom level index given a zoom factor. | |
| 358 </p> | |
| 359 <dl> | |
| 360 | |
| 361 <dt><i>scale</i> (int)</dt> | |
| 362 <dd> | |
| 363 zoom factor | |
| 364 </dd> | |
| 365 </dl> | |
| 366 <dl> | |
| 367 <dt>Return:</dt> | |
| 368 <dd> | |
| 369 index of zoom factor | |
| 370 </dd> | |
| 371 </dl> | |
| 372 <dl> | |
| 373 <dt>Return Type:</dt> | |
| 374 <dd> | |
| 375 int | |
| 376 </dd> | |
| 377 </dl> | |
| 378 <a NAME="HelpViewerImplQWE.__newWindowRequested" ID="HelpViewerImplQWE.__newWindowRequested"></a> | |
| 379 <h4>HelpViewerImplQWE.__newWindowRequested</h4> | |
| 380 <b>__newWindowRequested</b>(<i>request</i>) | |
| 381 | |
| 382 <p> | |
| 383 Private slot handling new window requests of the web page. | |
| 384 </p> | |
| 385 <dl> | |
| 386 | |
| 387 <dt><i>request</i> (QWebEngineNewWindowRequest)</dt> | |
| 388 <dd> | |
| 389 reference to the new window request | |
| 390 </dd> | |
| 391 </dl> | |
| 392 <a NAME="HelpViewerImplQWE.__openLinkInBackgroundPage" ID="HelpViewerImplQWE.__openLinkInBackgroundPage"></a> | |
| 393 <h4>HelpViewerImplQWE.__openLinkInBackgroundPage</h4> | |
| 394 <b>__openLinkInBackgroundPage</b>(<i>act</i>) | |
| 395 | |
| 396 <p> | |
| 397 Private method called by the context menu to open a link in a | |
| 398 background page. | |
| 399 </p> | |
| 400 <dl> | |
| 401 | |
| 402 <dt><i>act</i> (QAction)</dt> | |
| 403 <dd> | |
| 404 reference to the action that triggered | |
| 405 </dd> | |
| 406 </dl> | |
| 407 <a NAME="HelpViewerImplQWE.__openLinkInNewPage" ID="HelpViewerImplQWE.__openLinkInNewPage"></a> | |
| 408 <h4>HelpViewerImplQWE.__openLinkInNewPage</h4> | |
| 409 <b>__openLinkInNewPage</b>(<i>act</i>) | |
| 410 | |
| 411 <p> | |
| 412 Private method called by the context menu to open a link in a new page. | |
| 413 </p> | |
| 414 <dl> | |
| 415 | |
| 416 <dt><i>act</i> (QAction)</dt> | |
| 417 <dd> | |
| 418 reference to the action that triggered | |
| 419 </dd> | |
| 420 </dl> | |
| 421 <a NAME="HelpViewerImplQWE.__selectAll" ID="HelpViewerImplQWE.__selectAll"></a> | |
| 422 <h4>HelpViewerImplQWE.__selectAll</h4> | |
| 423 <b>__selectAll</b>(<i></i>) | |
| 424 | |
| 425 <p> | |
| 426 Private method called by the context menu to select all text. | |
| 427 </p> | |
| 428 <a NAME="HelpViewerImplQWE.__setRwhvqt" ID="HelpViewerImplQWE.__setRwhvqt"></a> | |
| 429 <h4>HelpViewerImplQWE.__setRwhvqt</h4> | |
| 430 <b>__setRwhvqt</b>(<i></i>) | |
| 431 | |
| 432 <p> | |
| 433 Private slot to set widget that receives input events. | |
| 434 </p> | |
| 435 <a NAME="HelpViewerImplQWE.__titleChanged" ID="HelpViewerImplQWE.__titleChanged"></a> | |
| 436 <h4>HelpViewerImplQWE.__titleChanged</h4> | |
| 437 <b>__titleChanged</b>(<i></i>) | |
| 438 | |
| 439 <p> | |
| 440 Private method to handle a change of the web page title. | |
| 441 </p> | |
| 442 <a NAME="HelpViewerImplQWE._contextMenuEvent" ID="HelpViewerImplQWE._contextMenuEvent"></a> | |
| 443 <h4>HelpViewerImplQWE._contextMenuEvent</h4> | |
| 444 <b>_contextMenuEvent</b>(<i>evt</i>) | |
| 445 | |
| 446 <p> | |
| 447 Protected method called to create a context menu. | |
| 448 </p> | |
| 449 <dl> | |
| 450 | |
| 451 <dt><i>evt</i></dt> | |
| 452 <dd> | |
| 453 reference to the context menu event object | |
| 454 (QContextMenuEvent) | |
| 455 </dd> | |
| 456 </dl> | |
| 457 <a NAME="HelpViewerImplQWE._gestureEvent" ID="HelpViewerImplQWE._gestureEvent"></a> | |
| 458 <h4>HelpViewerImplQWE._gestureEvent</h4> | |
| 459 <b>_gestureEvent</b>(<i>evt</i>) | |
| 460 | |
| 461 <p> | |
| 462 Protected method handling gesture events. | |
| 463 </p> | |
| 464 <dl> | |
| 465 | |
| 466 <dt><i>evt</i> (QGestureEvent)</dt> | |
| 467 <dd> | |
| 468 reference to the gesture event | |
| 469 </dd> | |
| 470 </dl> | |
| 471 <a NAME="HelpViewerImplQWE._keyPressEvent" ID="HelpViewerImplQWE._keyPressEvent"></a> | |
| 472 <h4>HelpViewerImplQWE._keyPressEvent</h4> | |
| 473 <b>_keyPressEvent</b>(<i>evt</i>) | |
| 474 | |
| 475 <p> | |
| 476 Protected method called by a key press. | |
| 477 </p> | |
| 478 <dl> | |
| 479 | |
| 480 <dt><i>evt</i> (QKeyEvent)</dt> | |
| 481 <dd> | |
| 482 reference to the key event | |
| 483 </dd> | |
| 484 </dl> | |
| 485 <a NAME="HelpViewerImplQWE._mouseReleaseEvent" ID="HelpViewerImplQWE._mouseReleaseEvent"></a> | |
| 486 <h4>HelpViewerImplQWE._mouseReleaseEvent</h4> | |
| 487 <b>_mouseReleaseEvent</b>(<i>evt</i>) | |
| 488 | |
| 489 <p> | |
| 490 Protected method called by a mouse release event. | |
| 491 </p> | |
| 492 <dl> | |
| 493 | |
| 494 <dt><i>evt</i> (QMouseEvent)</dt> | |
| 495 <dd> | |
| 496 reference to the mouse event | |
| 497 </dd> | |
| 498 </dl> | |
| 499 <a NAME="HelpViewerImplQWE._wheelEvent" ID="HelpViewerImplQWE._wheelEvent"></a> | |
| 500 <h4>HelpViewerImplQWE._wheelEvent</h4> | |
| 501 <b>_wheelEvent</b>(<i>evt</i>) | |
| 502 | |
| 503 <p> | |
| 504 Protected method to handle wheel events. | |
| 505 </p> | |
| 506 <dl> | |
| 507 | |
| 508 <dt><i>evt</i> (QWheelEvent)</dt> | |
| 509 <dd> | |
| 510 reference to the wheel event | |
| 511 </dd> | |
| 512 </dl> | |
| 513 <a NAME="HelpViewerImplQWE.backward" ID="HelpViewerImplQWE.backward"></a> | |
| 514 <h4>HelpViewerImplQWE.backward</h4> | |
| 515 <b>backward</b>(<i></i>) | |
| 516 | |
| 517 <p> | |
| 518 Public slot to move backwards in history. | |
| 519 </p> | |
| 520 <a NAME="HelpViewerImplQWE.backwardHistoryCount" ID="HelpViewerImplQWE.backwardHistoryCount"></a> | |
| 521 <h4>HelpViewerImplQWE.backwardHistoryCount</h4> | |
| 522 <b>backwardHistoryCount</b>(<i></i>) | |
| 523 | |
| 524 <p> | |
| 525 Public method to get the number of available back history items. | |
| 526 </p> | |
| 527 <p> | |
| 528 Note: For performance reasons this is limited to the maximum number of | |
| 529 history items the help viewer is interested in. | |
| 530 </p> | |
| 531 <dl> | |
| 532 <dt>Return:</dt> | |
| 533 <dd> | |
| 534 count of available back history items | |
| 535 </dd> | |
| 536 </dl> | |
| 537 <dl> | |
| 538 <dt>Return Type:</dt> | |
| 539 <dd> | |
| 540 int | |
| 541 </dd> | |
| 542 </dl> | |
| 543 <a NAME="HelpViewerImplQWE.clearHistory" ID="HelpViewerImplQWE.clearHistory"></a> | |
| 544 <h4>HelpViewerImplQWE.clearHistory</h4> | |
| 545 <b>clearHistory</b>(<i></i>) | |
| 546 | |
| 547 <p> | |
| 548 Public method to clear the history. | |
| 549 </p> | |
| 550 <a NAME="HelpViewerImplQWE.contextMenuEvent" ID="HelpViewerImplQWE.contextMenuEvent"></a> | |
| 551 <h4>HelpViewerImplQWE.contextMenuEvent</h4> | |
| 552 <b>contextMenuEvent</b>(<i>evt</i>) | |
| 553 | |
| 554 <p> | |
| 555 Protected method called to create a context menu. | |
| 556 </p> | |
| 557 <p> | |
| 558 This method is overridden from QWebEngineView. | |
| 559 </p> | |
| 560 <dl> | |
| 561 | |
| 562 <dt><i>evt</i> (QContextMenuEvent)</dt> | |
| 563 <dd> | |
| 564 reference to the context menu event object | |
| 565 </dd> | |
| 566 </dl> | |
| 567 <a NAME="HelpViewerImplQWE.event" ID="HelpViewerImplQWE.event"></a> | |
| 568 <h4>HelpViewerImplQWE.event</h4> | |
| 569 <b>event</b>(<i>evt</i>) | |
| 570 | |
| 571 <p> | |
| 572 Public method handling events. | |
| 573 </p> | |
| 574 <dl> | |
| 575 | |
| 576 <dt><i>evt</i></dt> | |
| 577 <dd> | |
| 578 reference to the event (QEvent) | |
| 579 </dd> | |
| 580 </dl> | |
| 581 <dl> | |
| 582 <dt>Return:</dt> | |
| 583 <dd> | |
| 584 flag indicating, if the event was handled (boolean) | |
| 585 </dd> | |
| 586 </dl> | |
| 587 <a NAME="HelpViewerImplQWE.eventFilter" ID="HelpViewerImplQWE.eventFilter"></a> | |
| 588 <h4>HelpViewerImplQWE.eventFilter</h4> | |
| 589 <b>eventFilter</b>(<i>obj, evt</i>) | |
| 590 | |
| 591 <p> | |
| 592 Public method to process event for other objects. | |
| 593 </p> | |
| 594 <dl> | |
| 595 | |
| 596 <dt><i>obj</i> (QObject)</dt> | |
| 597 <dd> | |
| 598 reference to object to process events for | |
| 599 </dd> | |
| 600 <dt><i>evt</i> (QEvent)</dt> | |
| 601 <dd> | |
| 602 reference to event to be processed | |
| 603 </dd> | |
| 604 </dl> | |
| 605 <dl> | |
| 606 <dt>Return:</dt> | |
| 607 <dd> | |
| 608 flag indicating that the event should be filtered out | |
| 609 </dd> | |
| 610 </dl> | |
| 611 <dl> | |
| 612 <dt>Return Type:</dt> | |
| 613 <dd> | |
| 614 bool | |
| 615 </dd> | |
| 616 </dl> | |
| 617 <a NAME="HelpViewerImplQWE.forward" ID="HelpViewerImplQWE.forward"></a> | |
| 618 <h4>HelpViewerImplQWE.forward</h4> | |
| 619 <b>forward</b>(<i></i>) | |
| 620 | |
| 621 <p> | |
| 622 Public slot to move forward in history. | |
| 623 </p> | |
| 624 <a NAME="HelpViewerImplQWE.forwardHistoryCount" ID="HelpViewerImplQWE.forwardHistoryCount"></a> | |
| 625 <h4>HelpViewerImplQWE.forwardHistoryCount</h4> | |
| 626 <b>forwardHistoryCount</b>(<i></i>) | |
| 627 | |
| 628 <p> | |
| 629 Public method to get the number of available forward history items. | |
| 630 </p> | |
| 631 <p> | |
| 632 Note: For performance reasons this is limited to the maximum number of | |
| 633 history items the help viewer is interested in. | |
| 634 </p> | |
| 635 <dl> | |
| 636 <dt>Return:</dt> | |
| 637 <dd> | |
| 638 count of available forward history items | |
| 639 </dd> | |
| 640 </dl> | |
| 641 <dl> | |
| 642 <dt>Return Type:</dt> | |
| 643 <dd> | |
| 644 int | |
| 645 </dd> | |
| 646 </dl> | |
| 647 <a NAME="HelpViewerImplQWE.gotoHistory" ID="HelpViewerImplQWE.gotoHistory"></a> | |
| 648 <h4>HelpViewerImplQWE.gotoHistory</h4> | |
| 649 <b>gotoHistory</b>(<i>offset</i>) | |
| 650 | |
| 651 <p> | |
| 652 Public method to go to a history item. | |
| 653 </p> | |
| 654 <dl> | |
| 655 | |
| 656 <dt><i>offset</i> (int)</dt> | |
| 657 <dd> | |
| 658 offset of the item with respect to the current page | |
| 659 </dd> | |
| 660 </dl> | |
| 661 <a NAME="HelpViewerImplQWE.historyTitle" ID="HelpViewerImplQWE.historyTitle"></a> | |
| 662 <h4>HelpViewerImplQWE.historyTitle</h4> | |
| 663 <b>historyTitle</b>(<i>offset</i>) | |
| 664 | |
| 665 <p> | |
| 666 Public method to get the title of a history item. | |
| 667 </p> | |
| 668 <dl> | |
| 669 | |
| 670 <dt><i>offset</i> (int)</dt> | |
| 671 <dd> | |
| 672 offset of the item with respect to the current page | |
| 673 </dd> | |
| 674 </dl> | |
| 675 <dl> | |
| 676 <dt>Return:</dt> | |
| 677 <dd> | |
| 678 title of the requeted item in history | |
| 679 </dd> | |
| 680 </dl> | |
| 681 <dl> | |
| 682 <dt>Return Type:</dt> | |
| 683 <dd> | |
| 684 str | |
| 685 </dd> | |
| 686 </dl> | |
| 687 <a NAME="HelpViewerImplQWE.isBackwardAvailable" ID="HelpViewerImplQWE.isBackwardAvailable"></a> | |
| 688 <h4>HelpViewerImplQWE.isBackwardAvailable</h4> | |
| 689 <b>isBackwardAvailable</b>(<i></i>) | |
| 690 | |
| 691 <p> | |
| 692 Public method to check, if stepping backward through the history is | |
| 693 available. | |
| 694 </p> | |
| 695 <dl> | |
| 696 <dt>Return:</dt> | |
| 697 <dd> | |
| 698 flag indicating backward stepping is available | |
| 699 </dd> | |
| 700 </dl> | |
| 701 <dl> | |
| 702 <dt>Return Type:</dt> | |
| 703 <dd> | |
| 704 bool | |
| 705 </dd> | |
| 706 </dl> | |
| 707 <a NAME="HelpViewerImplQWE.isEmptyPage" ID="HelpViewerImplQWE.isEmptyPage"></a> | |
| 708 <h4>HelpViewerImplQWE.isEmptyPage</h4> | |
| 709 <b>isEmptyPage</b>(<i></i>) | |
| 710 | |
| 711 <p> | |
| 712 Public method to check, if the current page is the empty page. | |
| 713 </p> | |
| 714 <dl> | |
| 715 <dt>Return:</dt> | |
| 716 <dd> | |
| 717 flag indicating an empty page is loaded | |
| 718 </dd> | |
| 719 </dl> | |
| 720 <dl> | |
| 721 <dt>Return Type:</dt> | |
| 722 <dd> | |
| 723 bool | |
| 724 </dd> | |
| 725 </dl> | |
| 726 <a NAME="HelpViewerImplQWE.isForwardAvailable" ID="HelpViewerImplQWE.isForwardAvailable"></a> | |
| 727 <h4>HelpViewerImplQWE.isForwardAvailable</h4> | |
| 728 <b>isForwardAvailable</b>(<i></i>) | |
| 729 | |
| 730 <p> | |
| 731 Public method to check, if stepping forward through the history is | |
| 732 available. | |
| 733 </p> | |
| 734 <dl> | |
| 735 <dt>Return:</dt> | |
| 736 <dd> | |
| 737 flag indicating forward stepping is available | |
| 738 </dd> | |
| 739 </dl> | |
| 740 <dl> | |
| 741 <dt>Return Type:</dt> | |
| 742 <dd> | |
| 743 bool | |
| 744 </dd> | |
| 745 </dl> | |
| 746 <a NAME="HelpViewerImplQWE.isScaleDownAvailable" ID="HelpViewerImplQWE.isScaleDownAvailable"></a> | |
| 747 <h4>HelpViewerImplQWE.isScaleDownAvailable</h4> | |
| 748 <b>isScaleDownAvailable</b>(<i></i>) | |
| 749 | |
| 750 <p> | |
| 751 Public method to check, if the min. zoom level is reached. | |
| 752 </p> | |
| 753 <dl> | |
| 754 <dt>Return:</dt> | |
| 755 <dd> | |
| 756 flag indicating scale down is available | |
| 757 </dd> | |
| 758 </dl> | |
| 759 <dl> | |
| 760 <dt>Return Type:</dt> | |
| 761 <dd> | |
| 762 bool | |
| 763 </dd> | |
| 764 </dl> | |
| 765 <a NAME="HelpViewerImplQWE.isScaleUpAvailable" ID="HelpViewerImplQWE.isScaleUpAvailable"></a> | |
| 766 <h4>HelpViewerImplQWE.isScaleUpAvailable</h4> | |
| 767 <b>isScaleUpAvailable</b>(<i></i>) | |
| 768 | |
| 769 <p> | |
| 770 Public method to check, if the max. zoom level is reached. | |
| 771 </p> | |
| 772 <dl> | |
| 773 <dt>Return:</dt> | |
| 774 <dd> | |
| 775 flag indicating scale up is available | |
| 776 </dd> | |
| 777 </dl> | |
| 778 <dl> | |
| 779 <dt>Return Type:</dt> | |
| 780 <dd> | |
| 781 bool | |
| 782 </dd> | |
| 783 </dl> | |
| 784 <a NAME="HelpViewerImplQWE.link" ID="HelpViewerImplQWE.link"></a> | |
| 785 <h4>HelpViewerImplQWE.link</h4> | |
| 786 <b>link</b>(<i></i>) | |
| 787 | |
| 788 <p> | |
| 789 Public method to get the URL of the shown document. | |
| 790 </p> | |
| 791 <dl> | |
| 792 <dt>Return:</dt> | |
| 793 <dd> | |
| 794 url URL of the document | |
| 795 </dd> | |
| 796 </dl> | |
| 797 <dl> | |
| 798 <dt>Return Type:</dt> | |
| 799 <dd> | |
| 800 QUrl | |
| 801 </dd> | |
| 802 </dl> | |
| 803 <a NAME="HelpViewerImplQWE.pageTitle" ID="HelpViewerImplQWE.pageTitle"></a> | |
| 804 <h4>HelpViewerImplQWE.pageTitle</h4> | |
| 805 <b>pageTitle</b>(<i></i>) | |
| 806 | |
| 807 <p> | |
| 808 Public method get the page title. | |
| 809 </p> | |
| 810 <dl> | |
| 811 <dt>Return:</dt> | |
| 812 <dd> | |
| 813 page title | |
| 814 </dd> | |
| 815 </dl> | |
| 816 <dl> | |
| 817 <dt>Return Type:</dt> | |
| 818 <dd> | |
| 819 str | |
| 820 </dd> | |
| 821 </dl> | |
| 822 <a NAME="HelpViewerImplQWE.reload" ID="HelpViewerImplQWE.reload"></a> | |
| 823 <h4>HelpViewerImplQWE.reload</h4> | |
| 824 <b>reload</b>(<i></i>) | |
| 825 | |
| 826 <p> | |
| 827 Public slot to reload the current page. | |
| 828 </p> | |
| 829 <a NAME="HelpViewerImplQWE.resetScale" ID="HelpViewerImplQWE.resetScale"></a> | |
| 830 <h4>HelpViewerImplQWE.resetScale</h4> | |
| 831 <b>resetScale</b>(<i></i>) | |
| 832 | |
| 833 <p> | |
| 834 Public method to reset the zoom level. | |
| 835 </p> | |
| 836 <a NAME="HelpViewerImplQWE.scale" ID="HelpViewerImplQWE.scale"></a> | |
| 837 <h4>HelpViewerImplQWE.scale</h4> | |
| 838 <b>scale</b>(<i></i>) | |
| 839 | |
| 840 <p> | |
| 841 Public method to get the zoom level. | |
| 842 </p> | |
| 843 <dl> | |
| 844 <dt>Return:</dt> | |
| 845 <dd> | |
| 846 current zoom level | |
| 847 </dd> | |
| 848 </dl> | |
| 849 <dl> | |
| 850 <dt>Return Type:</dt> | |
| 851 <dd> | |
| 852 int | |
| 853 </dd> | |
| 854 </dl> | |
| 855 <a NAME="HelpViewerImplQWE.scaleDown" ID="HelpViewerImplQWE.scaleDown"></a> | |
| 856 <h4>HelpViewerImplQWE.scaleDown</h4> | |
| 857 <b>scaleDown</b>(<i></i>) | |
| 858 | |
| 859 <p> | |
| 860 Public method to zoom out. | |
| 861 </p> | |
| 862 <a NAME="HelpViewerImplQWE.scaleUp" ID="HelpViewerImplQWE.scaleUp"></a> | |
| 863 <h4>HelpViewerImplQWE.scaleUp</h4> | |
| 864 <b>scaleUp</b>(<i></i>) | |
| 865 | |
| 866 <p> | |
| 867 Public method to zoom in. | |
| 868 </p> | |
| 869 <a NAME="HelpViewerImplQWE.setLink" ID="HelpViewerImplQWE.setLink"></a> | |
| 870 <h4>HelpViewerImplQWE.setLink</h4> | |
| 871 <b>setLink</b>(<i>url</i>) | |
| 872 | |
| 873 <p> | |
| 874 Public method to set the URL of the document to be shown. | |
| 875 </p> | |
| 876 <dl> | |
| 877 | |
| 878 <dt><i>url</i> (QUrl)</dt> | |
| 879 <dd> | |
| 880 URL of the document | |
| 881 </dd> | |
| 882 </dl> | |
| 883 <a NAME="HelpViewerImplQWE.setScale" ID="HelpViewerImplQWE.setScale"></a> | |
| 884 <h4>HelpViewerImplQWE.setScale</h4> | |
| 885 <b>setScale</b>(<i>scale</i>) | |
| 886 | |
| 887 <p> | |
| 888 Public method to set the zoom level. | |
| 889 </p> | |
| 890 <dl> | |
| 891 | |
| 892 <dt><i>scale</i> (int)</dt> | |
| 893 <dd> | |
| 894 zoom level to set | |
| 895 </dd> | |
| 896 </dl> | |
| 897 <div align="right"><a href="#top">Up</a></div> | |
| 898 <hr /> | |
| 899 </body></html> |
