Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImpl.html
eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImpl.html
- branch
- eric7
- changeset 8752
- 3c1ea4dfb691
equal
deleted
inserted
replaced
| 8751:4a6c2ccd880f | 8752:3c1ea4dfb691 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.HelpViewer.HelpViewerImpl</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.HelpViewerImpl</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="#HelpViewerImpl">HelpViewerImpl</a></td> | |
| 25 <td>Class implementing the help viewer base 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="HelpViewerImpl" ID="HelpViewerImpl"></a> | |
| 36 <h2>HelpViewerImpl</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the help viewer base class. | |
| 40 </p> | |
| 41 <p> | |
| 42 This is the base class of help viewer implementations and defines the | |
| 43 interface. Als subclasses must implement the these methods. | |
| 44 </p> | |
| 45 <h3>Signals</h3> | |
| 46 <dl> | |
| 47 | |
| 48 <dt>loadFinished(ok)</dt> | |
| 49 <dd> | |
| 50 emitted to indicate the completion of a page load | |
| 51 </dd> | |
| 52 <dt>titleChanged()</dt> | |
| 53 <dd> | |
| 54 emitted to indicate a change of the page title | |
| 55 </dd> | |
| 56 <dt>zoomChanged()</dt> | |
| 57 <dd> | |
| 58 emitted to indicate a change of the zoom level | |
| 59 </dd> | |
| 60 </dl> | |
| 61 <h3>Derived from</h3> | |
| 62 None | |
| 63 <h3>Class Attributes</h3> | |
| 64 | |
| 65 <table> | |
| 66 <tr><td>None</td></tr> | |
| 67 </table> | |
| 68 <h3>Class Methods</h3> | |
| 69 | |
| 70 <table> | |
| 71 <tr><td>None</td></tr> | |
| 72 </table> | |
| 73 <h3>Methods</h3> | |
| 74 | |
| 75 <table> | |
| 76 | |
| 77 <tr> | |
| 78 <td><a href="#HelpViewerImpl.__init__">HelpViewerImpl</a></td> | |
| 79 <td>Constructor</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#HelpViewerImpl.gotoHistory">gotoHistory</a></td> | |
| 83 <td>Public method to step through the history.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#HelpViewerImpl.isBackwardAvailable">isBackwardAvailable</a></td> | |
| 87 <td>Public method to check, if stepping backward through the history is available.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#HelpViewerImpl.isEmptyPage">isEmptyPage</a></td> | |
| 91 <td>Public method to check, if the current page is the empty page.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#HelpViewerImpl.isForwardAvailable">isForwardAvailable</a></td> | |
| 95 <td>Public method to check, if stepping forward through the history is available.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#HelpViewerImpl.isScaleDownAvailable">isScaleDownAvailable</a></td> | |
| 99 <td>Public method to check, if the min.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#HelpViewerImpl.isScaleUpAvailable">isScaleUpAvailable</a></td> | |
| 103 <td>Public method to check, if the max.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#HelpViewerImpl.link">link</a></td> | |
| 107 <td>Public method to get the URL of the shown document.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#HelpViewerImpl.pageTitle">pageTitle</a></td> | |
| 111 <td>Public method get the page title.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#HelpViewerImpl.resetScale">resetScale</a></td> | |
| 115 <td>Public method to reset the zoom level.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#HelpViewerImpl.scale">scale</a></td> | |
| 119 <td>Public method to get the zoom level.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#HelpViewerImpl.scaleDown">scaleDown</a></td> | |
| 123 <td>Public method to zoom out.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#HelpViewerImpl.scaleUp">scaleUp</a></td> | |
| 127 <td>Public method to zoom in.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#HelpViewerImpl.setLink">setLink</a></td> | |
| 131 <td>Public method to set the URL of the document to be shown.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#HelpViewerImpl.setScale">setScale</a></td> | |
| 135 <td>Public method to set the zoom level.</td> | |
| 136 </tr> | |
| 137 </table> | |
| 138 <h3>Static Methods</h3> | |
| 139 | |
| 140 <table> | |
| 141 <tr><td>None</td></tr> | |
| 142 </table> | |
| 143 | |
| 144 <a NAME="HelpViewerImpl.__init__" ID="HelpViewerImpl.__init__"></a> | |
| 145 <h4>HelpViewerImpl (Constructor)</h4> | |
| 146 <b>HelpViewerImpl</b>(<i>engine</i>) | |
| 147 | |
| 148 <p> | |
| 149 Constructor | |
| 150 </p> | |
| 151 <dl> | |
| 152 | |
| 153 <dt><i>engine</i> (QHelpEngine)</dt> | |
| 154 <dd> | |
| 155 reference to the help engine | |
| 156 </dd> | |
| 157 </dl> | |
| 158 <a NAME="HelpViewerImpl.gotoHistory" ID="HelpViewerImpl.gotoHistory"></a> | |
| 159 <h4>HelpViewerImpl.gotoHistory</h4> | |
| 160 <b>gotoHistory</b>(<i>index</i>) | |
| 161 | |
| 162 <p> | |
| 163 Public method to step through the history. | |
| 164 </p> | |
| 165 <dl> | |
| 166 | |
| 167 <dt><i>index</i> (int)</dt> | |
| 168 <dd> | |
| 169 history index (<0 backward, >0 forward) | |
| 170 </dd> | |
| 171 </dl> | |
| 172 <dl> | |
| 173 | |
| 174 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 175 <dd> | |
| 176 raised when not implemented | |
| 177 </dd> | |
| 178 </dl> | |
| 179 <a NAME="HelpViewerImpl.isBackwardAvailable" ID="HelpViewerImpl.isBackwardAvailable"></a> | |
| 180 <h4>HelpViewerImpl.isBackwardAvailable</h4> | |
| 181 <b>isBackwardAvailable</b>(<i></i>) | |
| 182 | |
| 183 <p> | |
| 184 Public method to check, if stepping backward through the history is | |
| 185 available. | |
| 186 </p> | |
| 187 <dl> | |
| 188 <dt>Return:</dt> | |
| 189 <dd> | |
| 190 flag indicating backward stepping is available | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <dl> | |
| 194 <dt>Return Type:</dt> | |
| 195 <dd> | |
| 196 bool | |
| 197 </dd> | |
| 198 </dl> | |
| 199 <dl> | |
| 200 | |
| 201 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 202 <dd> | |
| 203 raised when not implemented | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <a NAME="HelpViewerImpl.isEmptyPage" ID="HelpViewerImpl.isEmptyPage"></a> | |
| 207 <h4>HelpViewerImpl.isEmptyPage</h4> | |
| 208 <b>isEmptyPage</b>(<i></i>) | |
| 209 | |
| 210 <p> | |
| 211 Public method to check, if the current page is the empty page. | |
| 212 </p> | |
| 213 <dl> | |
| 214 <dt>Return:</dt> | |
| 215 <dd> | |
| 216 flag indicating an empty page is loaded | |
| 217 </dd> | |
| 218 </dl> | |
| 219 <dl> | |
| 220 <dt>Return Type:</dt> | |
| 221 <dd> | |
| 222 bool | |
| 223 </dd> | |
| 224 </dl> | |
| 225 <dl> | |
| 226 | |
| 227 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 228 <dd> | |
| 229 raised when not implemented | |
| 230 </dd> | |
| 231 </dl> | |
| 232 <a NAME="HelpViewerImpl.isForwardAvailable" ID="HelpViewerImpl.isForwardAvailable"></a> | |
| 233 <h4>HelpViewerImpl.isForwardAvailable</h4> | |
| 234 <b>isForwardAvailable</b>(<i></i>) | |
| 235 | |
| 236 <p> | |
| 237 Public method to check, if stepping forward through the history is | |
| 238 available. | |
| 239 </p> | |
| 240 <dl> | |
| 241 <dt>Return:</dt> | |
| 242 <dd> | |
| 243 flag indicating forward stepping is available | |
| 244 </dd> | |
| 245 </dl> | |
| 246 <dl> | |
| 247 <dt>Return Type:</dt> | |
| 248 <dd> | |
| 249 bool | |
| 250 </dd> | |
| 251 </dl> | |
| 252 <dl> | |
| 253 | |
| 254 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 255 <dd> | |
| 256 raised when not implemented | |
| 257 </dd> | |
| 258 </dl> | |
| 259 <a NAME="HelpViewerImpl.isScaleDownAvailable" ID="HelpViewerImpl.isScaleDownAvailable"></a> | |
| 260 <h4>HelpViewerImpl.isScaleDownAvailable</h4> | |
| 261 <b>isScaleDownAvailable</b>(<i></i>) | |
| 262 | |
| 263 <p> | |
| 264 Public method to check, if the min. zoom level is reached. | |
| 265 </p> | |
| 266 <dl> | |
| 267 <dt>Return:</dt> | |
| 268 <dd> | |
| 269 flag indicating scale down is available | |
| 270 </dd> | |
| 271 </dl> | |
| 272 <dl> | |
| 273 <dt>Return Type:</dt> | |
| 274 <dd> | |
| 275 bool | |
| 276 </dd> | |
| 277 </dl> | |
| 278 <dl> | |
| 279 | |
| 280 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 281 <dd> | |
| 282 raised when not implemented | |
| 283 </dd> | |
| 284 </dl> | |
| 285 <a NAME="HelpViewerImpl.isScaleUpAvailable" ID="HelpViewerImpl.isScaleUpAvailable"></a> | |
| 286 <h4>HelpViewerImpl.isScaleUpAvailable</h4> | |
| 287 <b>isScaleUpAvailable</b>(<i></i>) | |
| 288 | |
| 289 <p> | |
| 290 Public method to check, if the max. zoom level is reached. | |
| 291 </p> | |
| 292 <dl> | |
| 293 <dt>Return:</dt> | |
| 294 <dd> | |
| 295 flag indicating scale up is available | |
| 296 </dd> | |
| 297 </dl> | |
| 298 <dl> | |
| 299 <dt>Return Type:</dt> | |
| 300 <dd> | |
| 301 bool | |
| 302 </dd> | |
| 303 </dl> | |
| 304 <dl> | |
| 305 | |
| 306 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 307 <dd> | |
| 308 raised when not implemented | |
| 309 </dd> | |
| 310 </dl> | |
| 311 <a NAME="HelpViewerImpl.link" ID="HelpViewerImpl.link"></a> | |
| 312 <h4>HelpViewerImpl.link</h4> | |
| 313 <b>link</b>(<i></i>) | |
| 314 | |
| 315 <p> | |
| 316 Public method to get the URL of the shown document. | |
| 317 </p> | |
| 318 <dl> | |
| 319 <dt>Return:</dt> | |
| 320 <dd> | |
| 321 URL of the document | |
| 322 </dd> | |
| 323 </dl> | |
| 324 <dl> | |
| 325 <dt>Return Type:</dt> | |
| 326 <dd> | |
| 327 QUrl | |
| 328 </dd> | |
| 329 </dl> | |
| 330 <dl> | |
| 331 | |
| 332 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 333 <dd> | |
| 334 raised when not implemented | |
| 335 </dd> | |
| 336 </dl> | |
| 337 <a NAME="HelpViewerImpl.pageTitle" ID="HelpViewerImpl.pageTitle"></a> | |
| 338 <h4>HelpViewerImpl.pageTitle</h4> | |
| 339 <b>pageTitle</b>(<i></i>) | |
| 340 | |
| 341 <p> | |
| 342 Public method get the page title. | |
| 343 </p> | |
| 344 <dl> | |
| 345 <dt>Return:</dt> | |
| 346 <dd> | |
| 347 page title | |
| 348 </dd> | |
| 349 </dl> | |
| 350 <dl> | |
| 351 <dt>Return Type:</dt> | |
| 352 <dd> | |
| 353 str | |
| 354 </dd> | |
| 355 </dl> | |
| 356 <dl> | |
| 357 | |
| 358 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 359 <dd> | |
| 360 raised when not implemented | |
| 361 </dd> | |
| 362 </dl> | |
| 363 <a NAME="HelpViewerImpl.resetScale" ID="HelpViewerImpl.resetScale"></a> | |
| 364 <h4>HelpViewerImpl.resetScale</h4> | |
| 365 <b>resetScale</b>(<i></i>) | |
| 366 | |
| 367 <p> | |
| 368 Public method to reset the zoom level. | |
| 369 </p> | |
| 370 <dl> | |
| 371 | |
| 372 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 373 <dd> | |
| 374 raised when not implemented | |
| 375 </dd> | |
| 376 </dl> | |
| 377 <a NAME="HelpViewerImpl.scale" ID="HelpViewerImpl.scale"></a> | |
| 378 <h4>HelpViewerImpl.scale</h4> | |
| 379 <b>scale</b>(<i></i>) | |
| 380 | |
| 381 <p> | |
| 382 Public method to get the zoom level. | |
| 383 </p> | |
| 384 <dl> | |
| 385 <dt>Return:</dt> | |
| 386 <dd> | |
| 387 current zoom level | |
| 388 </dd> | |
| 389 </dl> | |
| 390 <dl> | |
| 391 <dt>Return Type:</dt> | |
| 392 <dd> | |
| 393 int | |
| 394 </dd> | |
| 395 </dl> | |
| 396 <dl> | |
| 397 | |
| 398 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 399 <dd> | |
| 400 raised when not implemented | |
| 401 </dd> | |
| 402 </dl> | |
| 403 <a NAME="HelpViewerImpl.scaleDown" ID="HelpViewerImpl.scaleDown"></a> | |
| 404 <h4>HelpViewerImpl.scaleDown</h4> | |
| 405 <b>scaleDown</b>(<i></i>) | |
| 406 | |
| 407 <p> | |
| 408 Public method to zoom out. | |
| 409 </p> | |
| 410 <dl> | |
| 411 | |
| 412 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 413 <dd> | |
| 414 raised when not implemented | |
| 415 </dd> | |
| 416 </dl> | |
| 417 <a NAME="HelpViewerImpl.scaleUp" ID="HelpViewerImpl.scaleUp"></a> | |
| 418 <h4>HelpViewerImpl.scaleUp</h4> | |
| 419 <b>scaleUp</b>(<i></i>) | |
| 420 | |
| 421 <p> | |
| 422 Public method to zoom in. | |
| 423 </p> | |
| 424 <dl> | |
| 425 | |
| 426 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 427 <dd> | |
| 428 raised when not implemented | |
| 429 </dd> | |
| 430 </dl> | |
| 431 <a NAME="HelpViewerImpl.setLink" ID="HelpViewerImpl.setLink"></a> | |
| 432 <h4>HelpViewerImpl.setLink</h4> | |
| 433 <b>setLink</b>(<i>url</i>) | |
| 434 | |
| 435 <p> | |
| 436 Public method to set the URL of the document to be shown. | |
| 437 </p> | |
| 438 <dl> | |
| 439 | |
| 440 <dt><i>url</i> (QUrl)</dt> | |
| 441 <dd> | |
| 442 URL of the document | |
| 443 </dd> | |
| 444 </dl> | |
| 445 <dl> | |
| 446 | |
| 447 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 448 <dd> | |
| 449 raised when not implemented | |
| 450 </dd> | |
| 451 </dl> | |
| 452 <a NAME="HelpViewerImpl.setScale" ID="HelpViewerImpl.setScale"></a> | |
| 453 <h4>HelpViewerImpl.setScale</h4> | |
| 454 <b>setScale</b>(<i>scale</i>) | |
| 455 | |
| 456 <p> | |
| 457 Public method to set the zoom level. | |
| 458 </p> | |
| 459 <dl> | |
| 460 | |
| 461 <dt><i>scale</i> (int)</dt> | |
| 462 <dd> | |
| 463 zoom level to set | |
| 464 </dd> | |
| 465 </dl> | |
| 466 <dl> | |
| 467 | |
| 468 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 469 <dd> | |
| 470 raised when not implemented | |
| 471 </dd> | |
| 472 </dl> | |
| 473 <div align="right"><a href="#top">Up</a></div> | |
| 474 <hr /> | |
| 475 </body></html> |
