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