Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImpl.html
src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImpl.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10070
- 9f5758c0fec1
- child 10628
- 6968d6c31b3e
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.HelpViewer.HelpViewerImpl</h1> | 9 <h1>eric7.HelpViewer.HelpViewerImpl</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the help viewer base class. | 11 Module implementing the help viewer base class. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#HelpViewerImpl">HelpViewerImpl</a></td> | 22 <td><a href="#HelpViewerImpl">HelpViewerImpl</a></td> |
| 25 <td>Class implementing the help viewer base class.</td> | 23 <td>Class implementing the help viewer base class.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="HelpViewerImpl" ID="HelpViewerImpl"></a> | 34 <a NAME="HelpViewerImpl" ID="HelpViewerImpl"></a> |
| 36 <h2>HelpViewerImpl</h2> | 35 <h2>HelpViewerImpl</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing the help viewer base class. | 37 Class implementing the help viewer base class. |
| 40 </p> | 38 </p> |
| 41 <p> | 39 <p> |
| 42 This is the base class of help viewer implementations and defines the | 40 This is the base class of help viewer implementations and defines the |
| 43 interface. Als subclasses must implement the these methods. | 41 interface. Als subclasses must implement the these methods. |
| 44 </p> | 42 </p> |
| 43 | |
| 45 <h3>Signals</h3> | 44 <h3>Signals</h3> |
| 46 <dl> | 45 <dl> |
| 47 | 46 |
| 48 <dt>loadFinished(ok)</dt> | 47 <dt>loadFinished(ok)</dt> |
| 49 <dd> | 48 <dd> |
| 59 </dd> | 58 </dd> |
| 60 </dl> | 59 </dl> |
| 61 <h3>Derived from</h3> | 60 <h3>Derived from</h3> |
| 62 None | 61 None |
| 63 <h3>Class Attributes</h3> | 62 <h3>Class Attributes</h3> |
| 64 | |
| 65 <table> | 63 <table> |
| 66 <tr><td>None</td></tr> | 64 <tr><td>None</td></tr> |
| 67 </table> | 65 </table> |
| 66 | |
| 68 <h3>Class Methods</h3> | 67 <h3>Class Methods</h3> |
| 69 | |
| 70 <table> | 68 <table> |
| 71 <tr><td>None</td></tr> | 69 <tr><td>None</td></tr> |
| 72 </table> | 70 </table> |
| 71 | |
| 73 <h3>Methods</h3> | 72 <h3>Methods</h3> |
| 74 | 73 <table> |
| 75 <table> | |
| 76 | |
| 77 <tr> | 74 <tr> |
| 78 <td><a href="#HelpViewerImpl.__init__">HelpViewerImpl</a></td> | 75 <td><a href="#HelpViewerImpl.__init__">HelpViewerImpl</a></td> |
| 79 <td>Constructor</td> | 76 <td>Constructor</td> |
| 80 </tr> | 77 </tr> |
| 81 <tr> | 78 <tr> |
| 133 <tr> | 130 <tr> |
| 134 <td><a href="#HelpViewerImpl.setScale">setScale</a></td> | 131 <td><a href="#HelpViewerImpl.setScale">setScale</a></td> |
| 135 <td>Public method to set the zoom level.</td> | 132 <td>Public method to set the zoom level.</td> |
| 136 </tr> | 133 </tr> |
| 137 </table> | 134 </table> |
| 135 | |
| 138 <h3>Static Methods</h3> | 136 <h3>Static Methods</h3> |
| 139 | |
| 140 <table> | 137 <table> |
| 141 <tr><td>None</td></tr> | 138 <tr><td>None</td></tr> |
| 142 </table> | 139 </table> |
| 140 | |
| 143 | 141 |
| 144 <a NAME="HelpViewerImpl.__init__" ID="HelpViewerImpl.__init__"></a> | 142 <a NAME="HelpViewerImpl.__init__" ID="HelpViewerImpl.__init__"></a> |
| 145 <h4>HelpViewerImpl (Constructor)</h4> | 143 <h4>HelpViewerImpl (Constructor)</h4> |
| 146 <b>HelpViewerImpl</b>(<i>engine</i>) | 144 <b>HelpViewerImpl</b>(<i>engine</i>) |
| 147 | |
| 148 <p> | 145 <p> |
| 149 Constructor | 146 Constructor |
| 150 </p> | 147 </p> |
| 148 | |
| 151 <dl> | 149 <dl> |
| 152 | 150 |
| 153 <dt><i>engine</i> (QHelpEngine)</dt> | 151 <dt><i>engine</i> (QHelpEngine)</dt> |
| 154 <dd> | 152 <dd> |
| 155 reference to the help engine | 153 reference to the help engine |
| 156 </dd> | 154 </dd> |
| 157 </dl> | 155 </dl> |
| 158 <a NAME="HelpViewerImpl.gotoHistory" ID="HelpViewerImpl.gotoHistory"></a> | 156 <a NAME="HelpViewerImpl.gotoHistory" ID="HelpViewerImpl.gotoHistory"></a> |
| 159 <h4>HelpViewerImpl.gotoHistory</h4> | 157 <h4>HelpViewerImpl.gotoHistory</h4> |
| 160 <b>gotoHistory</b>(<i>index</i>) | 158 <b>gotoHistory</b>(<i>index</i>) |
| 161 | |
| 162 <p> | 159 <p> |
| 163 Public method to step through the history. | 160 Public method to step through the history. |
| 164 </p> | 161 </p> |
| 162 | |
| 165 <dl> | 163 <dl> |
| 166 | 164 |
| 167 <dt><i>index</i> (int)</dt> | 165 <dt><i>index</i> (int)</dt> |
| 168 <dd> | 166 <dd> |
| 169 history index (<0 backward, >0 forward) | 167 history index (<0 backward, >0 forward) |
| 177 </dd> | 175 </dd> |
| 178 </dl> | 176 </dl> |
| 179 <a NAME="HelpViewerImpl.isBackwardAvailable" ID="HelpViewerImpl.isBackwardAvailable"></a> | 177 <a NAME="HelpViewerImpl.isBackwardAvailable" ID="HelpViewerImpl.isBackwardAvailable"></a> |
| 180 <h4>HelpViewerImpl.isBackwardAvailable</h4> | 178 <h4>HelpViewerImpl.isBackwardAvailable</h4> |
| 181 <b>isBackwardAvailable</b>(<i></i>) | 179 <b>isBackwardAvailable</b>(<i></i>) |
| 182 | |
| 183 <p> | 180 <p> |
| 184 Public method to check, if stepping backward through the history is | 181 Public method to check, if stepping backward through the history is |
| 185 available. | 182 available. |
| 186 </p> | 183 </p> |
| 184 | |
| 187 <dl> | 185 <dl> |
| 188 <dt>Return:</dt> | 186 <dt>Return:</dt> |
| 189 <dd> | 187 <dd> |
| 190 flag indicating backward stepping is available | 188 flag indicating backward stepping is available |
| 191 </dd> | 189 </dd> |
| 204 </dd> | 202 </dd> |
| 205 </dl> | 203 </dl> |
| 206 <a NAME="HelpViewerImpl.isEmptyPage" ID="HelpViewerImpl.isEmptyPage"></a> | 204 <a NAME="HelpViewerImpl.isEmptyPage" ID="HelpViewerImpl.isEmptyPage"></a> |
| 207 <h4>HelpViewerImpl.isEmptyPage</h4> | 205 <h4>HelpViewerImpl.isEmptyPage</h4> |
| 208 <b>isEmptyPage</b>(<i></i>) | 206 <b>isEmptyPage</b>(<i></i>) |
| 209 | |
| 210 <p> | 207 <p> |
| 211 Public method to check, if the current page is the empty page. | 208 Public method to check, if the current page is the empty page. |
| 212 </p> | 209 </p> |
| 210 | |
| 213 <dl> | 211 <dl> |
| 214 <dt>Return:</dt> | 212 <dt>Return:</dt> |
| 215 <dd> | 213 <dd> |
| 216 flag indicating an empty page is loaded | 214 flag indicating an empty page is loaded |
| 217 </dd> | 215 </dd> |
| 230 </dd> | 228 </dd> |
| 231 </dl> | 229 </dl> |
| 232 <a NAME="HelpViewerImpl.isForwardAvailable" ID="HelpViewerImpl.isForwardAvailable"></a> | 230 <a NAME="HelpViewerImpl.isForwardAvailable" ID="HelpViewerImpl.isForwardAvailable"></a> |
| 233 <h4>HelpViewerImpl.isForwardAvailable</h4> | 231 <h4>HelpViewerImpl.isForwardAvailable</h4> |
| 234 <b>isForwardAvailable</b>(<i></i>) | 232 <b>isForwardAvailable</b>(<i></i>) |
| 235 | |
| 236 <p> | 233 <p> |
| 237 Public method to check, if stepping forward through the history is | 234 Public method to check, if stepping forward through the history is |
| 238 available. | 235 available. |
| 239 </p> | 236 </p> |
| 237 | |
| 240 <dl> | 238 <dl> |
| 241 <dt>Return:</dt> | 239 <dt>Return:</dt> |
| 242 <dd> | 240 <dd> |
| 243 flag indicating forward stepping is available | 241 flag indicating forward stepping is available |
| 244 </dd> | 242 </dd> |
| 257 </dd> | 255 </dd> |
| 258 </dl> | 256 </dl> |
| 259 <a NAME="HelpViewerImpl.isScaleDownAvailable" ID="HelpViewerImpl.isScaleDownAvailable"></a> | 257 <a NAME="HelpViewerImpl.isScaleDownAvailable" ID="HelpViewerImpl.isScaleDownAvailable"></a> |
| 260 <h4>HelpViewerImpl.isScaleDownAvailable</h4> | 258 <h4>HelpViewerImpl.isScaleDownAvailable</h4> |
| 261 <b>isScaleDownAvailable</b>(<i></i>) | 259 <b>isScaleDownAvailable</b>(<i></i>) |
| 262 | |
| 263 <p> | 260 <p> |
| 264 Public method to check, if the min. zoom level is reached. | 261 Public method to check, if the min. zoom level is reached. |
| 265 </p> | 262 </p> |
| 263 | |
| 266 <dl> | 264 <dl> |
| 267 <dt>Return:</dt> | 265 <dt>Return:</dt> |
| 268 <dd> | 266 <dd> |
| 269 flag indicating scale down is available | 267 flag indicating scale down is available |
| 270 </dd> | 268 </dd> |
| 283 </dd> | 281 </dd> |
| 284 </dl> | 282 </dl> |
| 285 <a NAME="HelpViewerImpl.isScaleUpAvailable" ID="HelpViewerImpl.isScaleUpAvailable"></a> | 283 <a NAME="HelpViewerImpl.isScaleUpAvailable" ID="HelpViewerImpl.isScaleUpAvailable"></a> |
| 286 <h4>HelpViewerImpl.isScaleUpAvailable</h4> | 284 <h4>HelpViewerImpl.isScaleUpAvailable</h4> |
| 287 <b>isScaleUpAvailable</b>(<i></i>) | 285 <b>isScaleUpAvailable</b>(<i></i>) |
| 288 | |
| 289 <p> | 286 <p> |
| 290 Public method to check, if the max. zoom level is reached. | 287 Public method to check, if the max. zoom level is reached. |
| 291 </p> | 288 </p> |
| 289 | |
| 292 <dl> | 290 <dl> |
| 293 <dt>Return:</dt> | 291 <dt>Return:</dt> |
| 294 <dd> | 292 <dd> |
| 295 flag indicating scale up is available | 293 flag indicating scale up is available |
| 296 </dd> | 294 </dd> |
| 309 </dd> | 307 </dd> |
| 310 </dl> | 308 </dl> |
| 311 <a NAME="HelpViewerImpl.link" ID="HelpViewerImpl.link"></a> | 309 <a NAME="HelpViewerImpl.link" ID="HelpViewerImpl.link"></a> |
| 312 <h4>HelpViewerImpl.link</h4> | 310 <h4>HelpViewerImpl.link</h4> |
| 313 <b>link</b>(<i></i>) | 311 <b>link</b>(<i></i>) |
| 314 | |
| 315 <p> | 312 <p> |
| 316 Public method to get the URL of the shown document. | 313 Public method to get the URL of the shown document. |
| 317 </p> | 314 </p> |
| 315 | |
| 318 <dl> | 316 <dl> |
| 319 <dt>Return:</dt> | 317 <dt>Return:</dt> |
| 320 <dd> | 318 <dd> |
| 321 URL of the document | 319 URL of the document |
| 322 </dd> | 320 </dd> |
| 335 </dd> | 333 </dd> |
| 336 </dl> | 334 </dl> |
| 337 <a NAME="HelpViewerImpl.pageTitle" ID="HelpViewerImpl.pageTitle"></a> | 335 <a NAME="HelpViewerImpl.pageTitle" ID="HelpViewerImpl.pageTitle"></a> |
| 338 <h4>HelpViewerImpl.pageTitle</h4> | 336 <h4>HelpViewerImpl.pageTitle</h4> |
| 339 <b>pageTitle</b>(<i></i>) | 337 <b>pageTitle</b>(<i></i>) |
| 340 | |
| 341 <p> | 338 <p> |
| 342 Public method get the page title. | 339 Public method get the page title. |
| 343 </p> | 340 </p> |
| 341 | |
| 344 <dl> | 342 <dl> |
| 345 <dt>Return:</dt> | 343 <dt>Return:</dt> |
| 346 <dd> | 344 <dd> |
| 347 page title | 345 page title |
| 348 </dd> | 346 </dd> |
| 361 </dd> | 359 </dd> |
| 362 </dl> | 360 </dl> |
| 363 <a NAME="HelpViewerImpl.resetScale" ID="HelpViewerImpl.resetScale"></a> | 361 <a NAME="HelpViewerImpl.resetScale" ID="HelpViewerImpl.resetScale"></a> |
| 364 <h4>HelpViewerImpl.resetScale</h4> | 362 <h4>HelpViewerImpl.resetScale</h4> |
| 365 <b>resetScale</b>(<i></i>) | 363 <b>resetScale</b>(<i></i>) |
| 366 | |
| 367 <p> | 364 <p> |
| 368 Public method to reset the zoom level. | 365 Public method to reset the zoom level. |
| 369 </p> | 366 </p> |
| 367 | |
| 370 <dl> | 368 <dl> |
| 371 | 369 |
| 372 <dt>Raises <b>NotImplementedError</b>:</dt> | 370 <dt>Raises <b>NotImplementedError</b>:</dt> |
| 373 <dd> | 371 <dd> |
| 374 raised when not implemented | 372 raised when not implemented |
| 375 </dd> | 373 </dd> |
| 376 </dl> | 374 </dl> |
| 377 <a NAME="HelpViewerImpl.scale" ID="HelpViewerImpl.scale"></a> | 375 <a NAME="HelpViewerImpl.scale" ID="HelpViewerImpl.scale"></a> |
| 378 <h4>HelpViewerImpl.scale</h4> | 376 <h4>HelpViewerImpl.scale</h4> |
| 379 <b>scale</b>(<i></i>) | 377 <b>scale</b>(<i></i>) |
| 380 | |
| 381 <p> | 378 <p> |
| 382 Public method to get the zoom level. | 379 Public method to get the zoom level. |
| 383 </p> | 380 </p> |
| 381 | |
| 384 <dl> | 382 <dl> |
| 385 <dt>Return:</dt> | 383 <dt>Return:</dt> |
| 386 <dd> | 384 <dd> |
| 387 current zoom level | 385 current zoom level |
| 388 </dd> | 386 </dd> |
| 401 </dd> | 399 </dd> |
| 402 </dl> | 400 </dl> |
| 403 <a NAME="HelpViewerImpl.scaleDown" ID="HelpViewerImpl.scaleDown"></a> | 401 <a NAME="HelpViewerImpl.scaleDown" ID="HelpViewerImpl.scaleDown"></a> |
| 404 <h4>HelpViewerImpl.scaleDown</h4> | 402 <h4>HelpViewerImpl.scaleDown</h4> |
| 405 <b>scaleDown</b>(<i></i>) | 403 <b>scaleDown</b>(<i></i>) |
| 406 | |
| 407 <p> | 404 <p> |
| 408 Public method to zoom out. | 405 Public method to zoom out. |
| 409 </p> | 406 </p> |
| 407 | |
| 410 <dl> | 408 <dl> |
| 411 | 409 |
| 412 <dt>Raises <b>NotImplementedError</b>:</dt> | 410 <dt>Raises <b>NotImplementedError</b>:</dt> |
| 413 <dd> | 411 <dd> |
| 414 raised when not implemented | 412 raised when not implemented |
| 415 </dd> | 413 </dd> |
| 416 </dl> | 414 </dl> |
| 417 <a NAME="HelpViewerImpl.scaleUp" ID="HelpViewerImpl.scaleUp"></a> | 415 <a NAME="HelpViewerImpl.scaleUp" ID="HelpViewerImpl.scaleUp"></a> |
| 418 <h4>HelpViewerImpl.scaleUp</h4> | 416 <h4>HelpViewerImpl.scaleUp</h4> |
| 419 <b>scaleUp</b>(<i></i>) | 417 <b>scaleUp</b>(<i></i>) |
| 420 | |
| 421 <p> | 418 <p> |
| 422 Public method to zoom in. | 419 Public method to zoom in. |
| 423 </p> | 420 </p> |
| 421 | |
| 424 <dl> | 422 <dl> |
| 425 | 423 |
| 426 <dt>Raises <b>NotImplementedError</b>:</dt> | 424 <dt>Raises <b>NotImplementedError</b>:</dt> |
| 427 <dd> | 425 <dd> |
| 428 raised when not implemented | 426 raised when not implemented |
| 429 </dd> | 427 </dd> |
| 430 </dl> | 428 </dl> |
| 431 <a NAME="HelpViewerImpl.setLink" ID="HelpViewerImpl.setLink"></a> | 429 <a NAME="HelpViewerImpl.setLink" ID="HelpViewerImpl.setLink"></a> |
| 432 <h4>HelpViewerImpl.setLink</h4> | 430 <h4>HelpViewerImpl.setLink</h4> |
| 433 <b>setLink</b>(<i>url</i>) | 431 <b>setLink</b>(<i>url</i>) |
| 434 | |
| 435 <p> | 432 <p> |
| 436 Public method to set the URL of the document to be shown. | 433 Public method to set the URL of the document to be shown. |
| 437 </p> | 434 </p> |
| 435 | |
| 438 <dl> | 436 <dl> |
| 439 | 437 |
| 440 <dt><i>url</i> (QUrl)</dt> | 438 <dt><i>url</i> (QUrl)</dt> |
| 441 <dd> | 439 <dd> |
| 442 URL of the document | 440 URL of the document |
| 450 </dd> | 448 </dd> |
| 451 </dl> | 449 </dl> |
| 452 <a NAME="HelpViewerImpl.setScale" ID="HelpViewerImpl.setScale"></a> | 450 <a NAME="HelpViewerImpl.setScale" ID="HelpViewerImpl.setScale"></a> |
| 453 <h4>HelpViewerImpl.setScale</h4> | 451 <h4>HelpViewerImpl.setScale</h4> |
| 454 <b>setScale</b>(<i>scale</i>) | 452 <b>setScale</b>(<i>scale</i>) |
| 455 | |
| 456 <p> | 453 <p> |
| 457 Public method to set the zoom level. | 454 Public method to set the zoom level. |
| 458 </p> | 455 </p> |
| 456 | |
| 459 <dl> | 457 <dl> |
| 460 | 458 |
| 461 <dt><i>scale</i> (int)</dt> | 459 <dt><i>scale</i> (int)</dt> |
| 462 <dd> | 460 <dd> |
| 463 zoom level to set | 461 zoom level to set |
