Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImplQTB.html
src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImplQTB.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8905
- 986278234c8a
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.HelpViewer.HelpViewerImplQTB</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.HelpViewerImplQTB</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the QTextBrowser based help viewer class. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>AboutBlank</td></tr><tr><td>PageNotFound</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#HelpViewerImplQTB">HelpViewerImplQTB</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="HelpViewerImplQTB" ID="HelpViewerImplQTB"></a> | |
| 36 <h2>HelpViewerImplQTB</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the QTextBrowser based help viewer class. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 HelpViewerImpl, QTextBrowser | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</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="#HelpViewerImplQTB.__init__">HelpViewerImplQTB</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#HelpViewerImplQTB.__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="#HelpViewerImplQTB.__canLoadResource">__canLoadResource</a></td> | |
| 67 <td>Private method to check, if the given resource can be loaded.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#HelpViewerImplQTB.__closeOtherPages">__closeOtherPages</a></td> | |
| 71 <td>Private method called by the context menu to close all other pages.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#HelpViewerImplQTB.__closePage">__closePage</a></td> | |
| 75 <td>Private method called by the context menu to close the current page.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#HelpViewerImplQTB.__copyLink">__copyLink</a></td> | |
| 79 <td>Private method called by the context menu to copy a link to the clipboard.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#HelpViewerImplQTB.__createLinkContextMenu">__createLinkContextMenu</a></td> | |
| 83 <td>Private method to populate the context menu for URLs.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#HelpViewerImplQTB.__openLinkInBackgroundPage">__openLinkInBackgroundPage</a></td> | |
| 87 <td>Private method called by the context menu to open a link in a background page.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#HelpViewerImplQTB.__openLinkInNewPage">__openLinkInNewPage</a></td> | |
| 91 <td>Private method called by the context menu to open a link in a new page.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#HelpViewerImplQTB.__showContextMenu">__showContextMenu</a></td> | |
| 95 <td>Private slot to show the context menu.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#HelpViewerImplQTB.doSetSource">doSetSource</a></td> | |
| 99 <td>Public method to load the data and show it.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#HelpViewerImplQTB.event">event</a></td> | |
| 103 <td>Public method handling events.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#HelpViewerImplQTB.gestureEvent">gestureEvent</a></td> | |
| 107 <td>Protected method handling gesture events.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#HelpViewerImplQTB.gotoHistory">gotoHistory</a></td> | |
| 111 <td>Public method to step through the history.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#HelpViewerImplQTB.isBackwardAvailable">isBackwardAvailable</a></td> | |
| 115 <td>Public method to check, if stepping backward through the history is available.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#HelpViewerImplQTB.isEmptyPage">isEmptyPage</a></td> | |
| 119 <td>Public method to check, if the current page is the empty page.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#HelpViewerImplQTB.isForwardAvailable">isForwardAvailable</a></td> | |
| 123 <td>Public method to check, if stepping forward through the history is available.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#HelpViewerImplQTB.isScaleDownAvailable">isScaleDownAvailable</a></td> | |
| 127 <td>Public method to check, if the min.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#HelpViewerImplQTB.isScaleUpAvailable">isScaleUpAvailable</a></td> | |
| 131 <td>Public method to check, if the max.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#HelpViewerImplQTB.keyPressEvent">keyPressEvent</a></td> | |
| 135 <td>Protected method to handle key press events.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#HelpViewerImplQTB.link">link</a></td> | |
| 139 <td>Public method to get the URL of the shown document.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#HelpViewerImplQTB.loadResource">loadResource</a></td> | |
| 143 <td>Public method to load data of the specified type from the resource with the given name.</td> | |
| 144 </tr> | |
| 145 <tr> | |
| 146 <td><a href="#HelpViewerImplQTB.mousePressEvent">mousePressEvent</a></td> | |
| 147 <td>Protected method called by a mouse press event.</td> | |
| 148 </tr> | |
| 149 <tr> | |
| 150 <td><a href="#HelpViewerImplQTB.mouseReleaseEvent">mouseReleaseEvent</a></td> | |
| 151 <td>Protected method called by a mouse release event.</td> | |
| 152 </tr> | |
| 153 <tr> | |
| 154 <td><a href="#HelpViewerImplQTB.pageTitle">pageTitle</a></td> | |
| 155 <td>Public method get the page title.</td> | |
| 156 </tr> | |
| 157 <tr> | |
| 158 <td><a href="#HelpViewerImplQTB.resetScale">resetScale</a></td> | |
| 159 <td>Public method to reset the zoom level.</td> | |
| 160 </tr> | |
| 161 <tr> | |
| 162 <td><a href="#HelpViewerImplQTB.scale">scale</a></td> | |
| 163 <td>Public method to get the zoom level.</td> | |
| 164 </tr> | |
| 165 <tr> | |
| 166 <td><a href="#HelpViewerImplQTB.scaleDown">scaleDown</a></td> | |
| 167 <td>Public method to zoom out.</td> | |
| 168 </tr> | |
| 169 <tr> | |
| 170 <td><a href="#HelpViewerImplQTB.scaleUp">scaleUp</a></td> | |
| 171 <td>Public method to zoom in.</td> | |
| 172 </tr> | |
| 173 <tr> | |
| 174 <td><a href="#HelpViewerImplQTB.setLink">setLink</a></td> | |
| 175 <td>Public method to set the URL of the document to be shown.</td> | |
| 176 </tr> | |
| 177 <tr> | |
| 178 <td><a href="#HelpViewerImplQTB.setScale">setScale</a></td> | |
| 179 <td>Public method to set the zoom level.</td> | |
| 180 </tr> | |
| 181 <tr> | |
| 182 <td><a href="#HelpViewerImplQTB.wheelEvent">wheelEvent</a></td> | |
| 183 <td>Protected method to handle wheel event to zoom.</td> | |
| 184 </tr> | |
| 185 </table> | |
| 186 <h3>Static Methods</h3> | |
| 187 | |
| 188 <table> | |
| 189 <tr><td>None</td></tr> | |
| 190 </table> | |
| 191 | |
| 192 <a NAME="HelpViewerImplQTB.__init__" ID="HelpViewerImplQTB.__init__"></a> | |
| 193 <h4>HelpViewerImplQTB (Constructor)</h4> | |
| 194 <b>HelpViewerImplQTB</b>(<i>engine, parent=None</i>) | |
| 195 | |
| 196 <p> | |
| 197 Constructor | |
| 198 </p> | |
| 199 <dl> | |
| 200 | |
| 201 <dt><i>engine</i> (QHelpEngine)</dt> | |
| 202 <dd> | |
| 203 reference to the help engine | |
| 204 </dd> | |
| 205 <dt><i>parent</i> (QWidget)</dt> | |
| 206 <dd> | |
| 207 reference to the parent widget | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <a NAME="HelpViewerImplQTB.__bookmarkPage" ID="HelpViewerImplQTB.__bookmarkPage"></a> | |
| 211 <h4>HelpViewerImplQTB.__bookmarkPage</h4> | |
| 212 <b>__bookmarkPage</b>(<i>act</i>) | |
| 213 | |
| 214 <p> | |
| 215 Private method called by the context menu to bookmark the page. | |
| 216 </p> | |
| 217 <dl> | |
| 218 | |
| 219 <dt><i>act</i> (QAction)</dt> | |
| 220 <dd> | |
| 221 reference to the action that triggered | |
| 222 </dd> | |
| 223 </dl> | |
| 224 <a NAME="HelpViewerImplQTB.__canLoadResource" ID="HelpViewerImplQTB.__canLoadResource"></a> | |
| 225 <h4>HelpViewerImplQTB.__canLoadResource</h4> | |
| 226 <b>__canLoadResource</b>(<i>url</i>) | |
| 227 | |
| 228 <p> | |
| 229 Private method to check, if the given resource can be loaded. | |
| 230 </p> | |
| 231 <dl> | |
| 232 | |
| 233 <dt><i>url</i> (QUrl)</dt> | |
| 234 <dd> | |
| 235 URL of resource to be loaded | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <dl> | |
| 239 <dt>Return:</dt> | |
| 240 <dd> | |
| 241 flag indicating, that the given URL can be handled | |
| 242 </dd> | |
| 243 </dl> | |
| 244 <dl> | |
| 245 <dt>Return Type:</dt> | |
| 246 <dd> | |
| 247 bool | |
| 248 </dd> | |
| 249 </dl> | |
| 250 <a NAME="HelpViewerImplQTB.__closeOtherPages" ID="HelpViewerImplQTB.__closeOtherPages"></a> | |
| 251 <h4>HelpViewerImplQTB.__closeOtherPages</h4> | |
| 252 <b>__closeOtherPages</b>(<i></i>) | |
| 253 | |
| 254 <p> | |
| 255 Private method called by the context menu to close all other pages. | |
| 256 </p> | |
| 257 <a NAME="HelpViewerImplQTB.__closePage" ID="HelpViewerImplQTB.__closePage"></a> | |
| 258 <h4>HelpViewerImplQTB.__closePage</h4> | |
| 259 <b>__closePage</b>(<i></i>) | |
| 260 | |
| 261 <p> | |
| 262 Private method called by the context menu to close the current page. | |
| 263 </p> | |
| 264 <a NAME="HelpViewerImplQTB.__copyLink" ID="HelpViewerImplQTB.__copyLink"></a> | |
| 265 <h4>HelpViewerImplQTB.__copyLink</h4> | |
| 266 <b>__copyLink</b>(<i>act</i>) | |
| 267 | |
| 268 <p> | |
| 269 Private method called by the context menu to copy a link to the | |
| 270 clipboard. | |
| 271 </p> | |
| 272 <dl> | |
| 273 | |
| 274 <dt><i>act</i> (QAction)</dt> | |
| 275 <dd> | |
| 276 reference to the action that triggered | |
| 277 </dd> | |
| 278 </dl> | |
| 279 <a NAME="HelpViewerImplQTB.__createLinkContextMenu" ID="HelpViewerImplQTB.__createLinkContextMenu"></a> | |
| 280 <h4>HelpViewerImplQTB.__createLinkContextMenu</h4> | |
| 281 <b>__createLinkContextMenu</b>(<i>menu, linkUrl</i>) | |
| 282 | |
| 283 <p> | |
| 284 Private method to populate the context menu for URLs. | |
| 285 </p> | |
| 286 <dl> | |
| 287 | |
| 288 <dt><i>menu</i> (QMenu)</dt> | |
| 289 <dd> | |
| 290 reference to the menu to be populated | |
| 291 </dd> | |
| 292 <dt><i>linkUrl</i> (QUrl)</dt> | |
| 293 <dd> | |
| 294 URL to create the menu part for | |
| 295 </dd> | |
| 296 </dl> | |
| 297 <a NAME="HelpViewerImplQTB.__openLinkInBackgroundPage" ID="HelpViewerImplQTB.__openLinkInBackgroundPage"></a> | |
| 298 <h4>HelpViewerImplQTB.__openLinkInBackgroundPage</h4> | |
| 299 <b>__openLinkInBackgroundPage</b>(<i>act</i>) | |
| 300 | |
| 301 <p> | |
| 302 Private method called by the context menu to open a link in a | |
| 303 background page. | |
| 304 </p> | |
| 305 <dl> | |
| 306 | |
| 307 <dt><i>act</i> (QAction)</dt> | |
| 308 <dd> | |
| 309 reference to the action that triggered | |
| 310 </dd> | |
| 311 </dl> | |
| 312 <a NAME="HelpViewerImplQTB.__openLinkInNewPage" ID="HelpViewerImplQTB.__openLinkInNewPage"></a> | |
| 313 <h4>HelpViewerImplQTB.__openLinkInNewPage</h4> | |
| 314 <b>__openLinkInNewPage</b>(<i>act</i>) | |
| 315 | |
| 316 <p> | |
| 317 Private method called by the context menu to open a link in a new page. | |
| 318 </p> | |
| 319 <dl> | |
| 320 | |
| 321 <dt><i>act</i> (QAction)</dt> | |
| 322 <dd> | |
| 323 reference to the action that triggered | |
| 324 </dd> | |
| 325 </dl> | |
| 326 <a NAME="HelpViewerImplQTB.__showContextMenu" ID="HelpViewerImplQTB.__showContextMenu"></a> | |
| 327 <h4>HelpViewerImplQTB.__showContextMenu</h4> | |
| 328 <b>__showContextMenu</b>(<i>pos</i>) | |
| 329 | |
| 330 <p> | |
| 331 Private slot to show the context menu. | |
| 332 </p> | |
| 333 <dl> | |
| 334 | |
| 335 <dt><i>pos</i> (QPoint)</dt> | |
| 336 <dd> | |
| 337 position to show the context menu at | |
| 338 </dd> | |
| 339 </dl> | |
| 340 <a NAME="HelpViewerImplQTB.doSetSource" ID="HelpViewerImplQTB.doSetSource"></a> | |
| 341 <h4>HelpViewerImplQTB.doSetSource</h4> | |
| 342 <b>doSetSource</b>(<i>url, type_</i>) | |
| 343 | |
| 344 <p> | |
| 345 Public method to load the data and show it. | |
| 346 </p> | |
| 347 <dl> | |
| 348 | |
| 349 <dt><i>url</i> (QUrl)</dt> | |
| 350 <dd> | |
| 351 URL of resource to load | |
| 352 </dd> | |
| 353 <dt><i>type_</i> (QTextDocument.ResourceType)</dt> | |
| 354 <dd> | |
| 355 type of the resource to load | |
| 356 </dd> | |
| 357 </dl> | |
| 358 <a NAME="HelpViewerImplQTB.event" ID="HelpViewerImplQTB.event"></a> | |
| 359 <h4>HelpViewerImplQTB.event</h4> | |
| 360 <b>event</b>(<i>evt</i>) | |
| 361 | |
| 362 <p> | |
| 363 Public method handling events. | |
| 364 </p> | |
| 365 <dl> | |
| 366 | |
| 367 <dt><i>evt</i> (QEvent)</dt> | |
| 368 <dd> | |
| 369 reference to the event | |
| 370 </dd> | |
| 371 </dl> | |
| 372 <dl> | |
| 373 <dt>Return:</dt> | |
| 374 <dd> | |
| 375 flag indicating the event was handled | |
| 376 </dd> | |
| 377 </dl> | |
| 378 <dl> | |
| 379 <dt>Return Type:</dt> | |
| 380 <dd> | |
| 381 bool | |
| 382 </dd> | |
| 383 </dl> | |
| 384 <a NAME="HelpViewerImplQTB.gestureEvent" ID="HelpViewerImplQTB.gestureEvent"></a> | |
| 385 <h4>HelpViewerImplQTB.gestureEvent</h4> | |
| 386 <b>gestureEvent</b>(<i>evt</i>) | |
| 387 | |
| 388 <p> | |
| 389 Protected method handling gesture events. | |
| 390 </p> | |
| 391 <dl> | |
| 392 | |
| 393 <dt><i>evt</i> (QGestureEvent)</dt> | |
| 394 <dd> | |
| 395 reference to the gesture event | |
| 396 </dd> | |
| 397 </dl> | |
| 398 <a NAME="HelpViewerImplQTB.gotoHistory" ID="HelpViewerImplQTB.gotoHistory"></a> | |
| 399 <h4>HelpViewerImplQTB.gotoHistory</h4> | |
| 400 <b>gotoHistory</b>(<i>index</i>) | |
| 401 | |
| 402 <p> | |
| 403 Public method to step through the history. | |
| 404 </p> | |
| 405 <dl> | |
| 406 | |
| 407 <dt><i>index</i> (int)</dt> | |
| 408 <dd> | |
| 409 history index (<0 backward, >0 forward) | |
| 410 </dd> | |
| 411 </dl> | |
| 412 <a NAME="HelpViewerImplQTB.isBackwardAvailable" ID="HelpViewerImplQTB.isBackwardAvailable"></a> | |
| 413 <h4>HelpViewerImplQTB.isBackwardAvailable</h4> | |
| 414 <b>isBackwardAvailable</b>(<i></i>) | |
| 415 | |
| 416 <p> | |
| 417 Public method to check, if stepping backward through the history is | |
| 418 available. | |
| 419 </p> | |
| 420 <dl> | |
| 421 <dt>Return:</dt> | |
| 422 <dd> | |
| 423 flag indicating backward stepping is available | |
| 424 </dd> | |
| 425 </dl> | |
| 426 <dl> | |
| 427 <dt>Return Type:</dt> | |
| 428 <dd> | |
| 429 bool | |
| 430 </dd> | |
| 431 </dl> | |
| 432 <a NAME="HelpViewerImplQTB.isEmptyPage" ID="HelpViewerImplQTB.isEmptyPage"></a> | |
| 433 <h4>HelpViewerImplQTB.isEmptyPage</h4> | |
| 434 <b>isEmptyPage</b>(<i></i>) | |
| 435 | |
| 436 <p> | |
| 437 Public method to check, if the current page is the empty page. | |
| 438 </p> | |
| 439 <dl> | |
| 440 <dt>Return:</dt> | |
| 441 <dd> | |
| 442 flag indicating an empty page is loaded | |
| 443 </dd> | |
| 444 </dl> | |
| 445 <dl> | |
| 446 <dt>Return Type:</dt> | |
| 447 <dd> | |
| 448 bool | |
| 449 </dd> | |
| 450 </dl> | |
| 451 <a NAME="HelpViewerImplQTB.isForwardAvailable" ID="HelpViewerImplQTB.isForwardAvailable"></a> | |
| 452 <h4>HelpViewerImplQTB.isForwardAvailable</h4> | |
| 453 <b>isForwardAvailable</b>(<i></i>) | |
| 454 | |
| 455 <p> | |
| 456 Public method to check, if stepping forward through the history is | |
| 457 available. | |
| 458 </p> | |
| 459 <dl> | |
| 460 <dt>Return:</dt> | |
| 461 <dd> | |
| 462 flag indicating forward stepping is available | |
| 463 </dd> | |
| 464 </dl> | |
| 465 <dl> | |
| 466 <dt>Return Type:</dt> | |
| 467 <dd> | |
| 468 bool | |
| 469 </dd> | |
| 470 </dl> | |
| 471 <a NAME="HelpViewerImplQTB.isScaleDownAvailable" ID="HelpViewerImplQTB.isScaleDownAvailable"></a> | |
| 472 <h4>HelpViewerImplQTB.isScaleDownAvailable</h4> | |
| 473 <b>isScaleDownAvailable</b>(<i></i>) | |
| 474 | |
| 475 <p> | |
| 476 Public method to check, if the min. zoom level is reached. | |
| 477 </p> | |
| 478 <dl> | |
| 479 <dt>Return:</dt> | |
| 480 <dd> | |
| 481 flag indicating scale down is available | |
| 482 </dd> | |
| 483 </dl> | |
| 484 <dl> | |
| 485 <dt>Return Type:</dt> | |
| 486 <dd> | |
| 487 bool | |
| 488 </dd> | |
| 489 </dl> | |
| 490 <a NAME="HelpViewerImplQTB.isScaleUpAvailable" ID="HelpViewerImplQTB.isScaleUpAvailable"></a> | |
| 491 <h4>HelpViewerImplQTB.isScaleUpAvailable</h4> | |
| 492 <b>isScaleUpAvailable</b>(<i></i>) | |
| 493 | |
| 494 <p> | |
| 495 Public method to check, if the max. zoom level is reached. | |
| 496 </p> | |
| 497 <dl> | |
| 498 <dt>Return:</dt> | |
| 499 <dd> | |
| 500 flag indicating scale up is available | |
| 501 </dd> | |
| 502 </dl> | |
| 503 <dl> | |
| 504 <dt>Return Type:</dt> | |
| 505 <dd> | |
| 506 bool | |
| 507 </dd> | |
| 508 </dl> | |
| 509 <a NAME="HelpViewerImplQTB.keyPressEvent" ID="HelpViewerImplQTB.keyPressEvent"></a> | |
| 510 <h4>HelpViewerImplQTB.keyPressEvent</h4> | |
| 511 <b>keyPressEvent</b>(<i>evt</i>) | |
| 512 | |
| 513 <p> | |
| 514 Protected method to handle key press events. | |
| 515 </p> | |
| 516 <dl> | |
| 517 | |
| 518 <dt><i>evt</i> (QKeyEvent)</dt> | |
| 519 <dd> | |
| 520 reference to the key event | |
| 521 </dd> | |
| 522 </dl> | |
| 523 <a NAME="HelpViewerImplQTB.link" ID="HelpViewerImplQTB.link"></a> | |
| 524 <h4>HelpViewerImplQTB.link</h4> | |
| 525 <b>link</b>(<i></i>) | |
| 526 | |
| 527 <p> | |
| 528 Public method to get the URL of the shown document. | |
| 529 </p> | |
| 530 <dl> | |
| 531 <dt>Return:</dt> | |
| 532 <dd> | |
| 533 URL of the document | |
| 534 </dd> | |
| 535 </dl> | |
| 536 <dl> | |
| 537 <dt>Return Type:</dt> | |
| 538 <dd> | |
| 539 QUrl | |
| 540 </dd> | |
| 541 </dl> | |
| 542 <a NAME="HelpViewerImplQTB.loadResource" ID="HelpViewerImplQTB.loadResource"></a> | |
| 543 <h4>HelpViewerImplQTB.loadResource</h4> | |
| 544 <b>loadResource</b>(<i>type_, name</i>) | |
| 545 | |
| 546 <p> | |
| 547 Public method to load data of the specified type from the resource with | |
| 548 the given name. | |
| 549 </p> | |
| 550 <dl> | |
| 551 | |
| 552 <dt><i>type_</i> (int)</dt> | |
| 553 <dd> | |
| 554 resource type | |
| 555 </dd> | |
| 556 <dt><i>name</i> (QUrl)</dt> | |
| 557 <dd> | |
| 558 resource name | |
| 559 </dd> | |
| 560 </dl> | |
| 561 <dl> | |
| 562 <dt>Return:</dt> | |
| 563 <dd> | |
| 564 byte array containing the loaded data | |
| 565 </dd> | |
| 566 </dl> | |
| 567 <dl> | |
| 568 <dt>Return Type:</dt> | |
| 569 <dd> | |
| 570 QByteArray | |
| 571 </dd> | |
| 572 </dl> | |
| 573 <a NAME="HelpViewerImplQTB.mousePressEvent" ID="HelpViewerImplQTB.mousePressEvent"></a> | |
| 574 <h4>HelpViewerImplQTB.mousePressEvent</h4> | |
| 575 <b>mousePressEvent</b>(<i>evt</i>) | |
| 576 | |
| 577 <p> | |
| 578 Protected method called by a mouse press event. | |
| 579 </p> | |
| 580 <dl> | |
| 581 | |
| 582 <dt><i>evt</i> (QMouseEvent)</dt> | |
| 583 <dd> | |
| 584 reference to the mouse event | |
| 585 </dd> | |
| 586 </dl> | |
| 587 <a NAME="HelpViewerImplQTB.mouseReleaseEvent" ID="HelpViewerImplQTB.mouseReleaseEvent"></a> | |
| 588 <h4>HelpViewerImplQTB.mouseReleaseEvent</h4> | |
| 589 <b>mouseReleaseEvent</b>(<i>evt</i>) | |
| 590 | |
| 591 <p> | |
| 592 Protected method called by a mouse release event. | |
| 593 </p> | |
| 594 <dl> | |
| 595 | |
| 596 <dt><i>evt</i> (QMouseEvent)</dt> | |
| 597 <dd> | |
| 598 reference to the mouse event | |
| 599 </dd> | |
| 600 </dl> | |
| 601 <a NAME="HelpViewerImplQTB.pageTitle" ID="HelpViewerImplQTB.pageTitle"></a> | |
| 602 <h4>HelpViewerImplQTB.pageTitle</h4> | |
| 603 <b>pageTitle</b>(<i></i>) | |
| 604 | |
| 605 <p> | |
| 606 Public method get the page title. | |
| 607 </p> | |
| 608 <dl> | |
| 609 <dt>Return:</dt> | |
| 610 <dd> | |
| 611 page title | |
| 612 </dd> | |
| 613 </dl> | |
| 614 <dl> | |
| 615 <dt>Return Type:</dt> | |
| 616 <dd> | |
| 617 str | |
| 618 </dd> | |
| 619 </dl> | |
| 620 <a NAME="HelpViewerImplQTB.resetScale" ID="HelpViewerImplQTB.resetScale"></a> | |
| 621 <h4>HelpViewerImplQTB.resetScale</h4> | |
| 622 <b>resetScale</b>(<i></i>) | |
| 623 | |
| 624 <p> | |
| 625 Public method to reset the zoom level. | |
| 626 </p> | |
| 627 <a NAME="HelpViewerImplQTB.scale" ID="HelpViewerImplQTB.scale"></a> | |
| 628 <h4>HelpViewerImplQTB.scale</h4> | |
| 629 <b>scale</b>(<i></i>) | |
| 630 | |
| 631 <p> | |
| 632 Public method to get the zoom level. | |
| 633 </p> | |
| 634 <dl> | |
| 635 <dt>Return:</dt> | |
| 636 <dd> | |
| 637 current zoom level | |
| 638 </dd> | |
| 639 </dl> | |
| 640 <dl> | |
| 641 <dt>Return Type:</dt> | |
| 642 <dd> | |
| 643 int | |
| 644 </dd> | |
| 645 </dl> | |
| 646 <a NAME="HelpViewerImplQTB.scaleDown" ID="HelpViewerImplQTB.scaleDown"></a> | |
| 647 <h4>HelpViewerImplQTB.scaleDown</h4> | |
| 648 <b>scaleDown</b>(<i></i>) | |
| 649 | |
| 650 <p> | |
| 651 Public method to zoom out. | |
| 652 </p> | |
| 653 <a NAME="HelpViewerImplQTB.scaleUp" ID="HelpViewerImplQTB.scaleUp"></a> | |
| 654 <h4>HelpViewerImplQTB.scaleUp</h4> | |
| 655 <b>scaleUp</b>(<i></i>) | |
| 656 | |
| 657 <p> | |
| 658 Public method to zoom in. | |
| 659 </p> | |
| 660 <a NAME="HelpViewerImplQTB.setLink" ID="HelpViewerImplQTB.setLink"></a> | |
| 661 <h4>HelpViewerImplQTB.setLink</h4> | |
| 662 <b>setLink</b>(<i>url</i>) | |
| 663 | |
| 664 <p> | |
| 665 Public method to set the URL of the document to be shown. | |
| 666 </p> | |
| 667 <dl> | |
| 668 | |
| 669 <dt><i>url</i> (QUrl)</dt> | |
| 670 <dd> | |
| 671 source of the document | |
| 672 </dd> | |
| 673 </dl> | |
| 674 <a NAME="HelpViewerImplQTB.setScale" ID="HelpViewerImplQTB.setScale"></a> | |
| 675 <h4>HelpViewerImplQTB.setScale</h4> | |
| 676 <b>setScale</b>(<i>scale</i>) | |
| 677 | |
| 678 <p> | |
| 679 Public method to set the zoom level. | |
| 680 </p> | |
| 681 <dl> | |
| 682 | |
| 683 <dt><i>scale</i> (int)</dt> | |
| 684 <dd> | |
| 685 zoom level to set | |
| 686 </dd> | |
| 687 </dl> | |
| 688 <a NAME="HelpViewerImplQTB.wheelEvent" ID="HelpViewerImplQTB.wheelEvent"></a> | |
| 689 <h4>HelpViewerImplQTB.wheelEvent</h4> | |
| 690 <b>wheelEvent</b>(<i>evt</i>) | |
| 691 | |
| 692 <p> | |
| 693 Protected method to handle wheel event to zoom. | |
| 694 </p> | |
| 695 <dl> | |
| 696 | |
| 697 <dt><i>evt</i> (QWheelEvent)</dt> | |
| 698 <dd> | |
| 699 reference to the event object | |
| 700 </dd> | |
| 701 </dl> | |
| 702 <div align="right"><a href="#top">Up</a></div> | |
| 703 <hr /> | |
| 704 </body></html> |
