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 10479
856476537696
parent 10428
a071d4065202
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.HelpViewerImplQWE</h1> 9 <h1>eric7.HelpViewer.HelpViewerImplQWE</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
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#HelpViewerImplQWE">HelpViewerImplQWE</a></td> 22 <td><a href="#HelpViewerImplQWE">HelpViewerImplQWE</a></td>
25 <td>Class implementing the QTextBrowser based help viewer class.</td> 23 <td>Class implementing the QTextBrowser based help viewer 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="HelpViewerImplQWE" ID="HelpViewerImplQWE"></a> 34 <a NAME="HelpViewerImplQWE" ID="HelpViewerImplQWE"></a>
36 <h2>HelpViewerImplQWE</h2> 35 <h2>HelpViewerImplQWE</h2>
37
38 <p> 36 <p>
39 Class implementing the QTextBrowser based help viewer class. 37 Class implementing the QTextBrowser based help viewer class.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 HelpViewerImpl, QWebEngineView 41 HelpViewerImpl, QWebEngineView
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>ZoomLevelDefault</td></tr><tr><td>ZoomLevels</td></tr> 44 <tr><td>ZoomLevelDefault</td></tr>
45 <tr><td>ZoomLevels</td></tr>
47 </table> 46 </table>
47
48 <h3>Class Methods</h3> 48 <h3>Class Methods</h3>
49
50 <table> 49 <table>
51 <tr><td>None</td></tr> 50 <tr><td>None</td></tr>
52 </table> 51 </table>
52
53 <h3>Methods</h3> 53 <h3>Methods</h3>
54
55 <table> 54 <table>
56
57 <tr> 55 <tr>
58 <td><a href="#HelpViewerImplQWE.__init__">HelpViewerImplQWE</a></td> 56 <td><a href="#HelpViewerImplQWE.__init__">HelpViewerImplQWE</a></td>
59 <td>Constructor</td> 57 <td>Constructor</td>
60 </tr> 58 </tr>
61 <tr> 59 <tr>
229 <tr> 227 <tr>
230 <td><a href="#HelpViewerImplQWE.setScale">setScale</a></td> 228 <td><a href="#HelpViewerImplQWE.setScale">setScale</a></td>
231 <td>Public method to set the zoom level.</td> 229 <td>Public method to set the zoom level.</td>
232 </tr> 230 </tr>
233 </table> 231 </table>
232
234 <h3>Static Methods</h3> 233 <h3>Static Methods</h3>
235
236 <table> 234 <table>
237 <tr><td>None</td></tr> 235 <tr><td>None</td></tr>
238 </table> 236 </table>
239 237
238
240 <a NAME="HelpViewerImplQWE.__init__" ID="HelpViewerImplQWE.__init__"></a> 239 <a NAME="HelpViewerImplQWE.__init__" ID="HelpViewerImplQWE.__init__"></a>
241 <h4>HelpViewerImplQWE (Constructor)</h4> 240 <h4>HelpViewerImplQWE (Constructor)</h4>
242 <b>HelpViewerImplQWE</b>(<i>engine, parent=None</i>) 241 <b>HelpViewerImplQWE</b>(<i>engine, parent=None</i>)
243
244 <p> 242 <p>
245 Constructor 243 Constructor
246 </p> 244 </p>
245
247 <dl> 246 <dl>
248 247
249 <dt><i>engine</i> (QHelpEngine)</dt> 248 <dt><i>engine</i> (QHelpEngine)</dt>
250 <dd> 249 <dd>
251 reference to the help engine 250 reference to the help engine
256 </dd> 255 </dd>
257 </dl> 256 </dl>
258 <a NAME="HelpViewerImplQWE.__bookmarkPage" ID="HelpViewerImplQWE.__bookmarkPage"></a> 257 <a NAME="HelpViewerImplQWE.__bookmarkPage" ID="HelpViewerImplQWE.__bookmarkPage"></a>
259 <h4>HelpViewerImplQWE.__bookmarkPage</h4> 258 <h4>HelpViewerImplQWE.__bookmarkPage</h4>
260 <b>__bookmarkPage</b>(<i>act</i>) 259 <b>__bookmarkPage</b>(<i>act</i>)
261
262 <p> 260 <p>
263 Private method called by the context menu to bookmark the page. 261 Private method called by the context menu to bookmark the page.
264 </p> 262 </p>
263
265 <dl> 264 <dl>
266 265
267 <dt><i>act</i> (QAction)</dt> 266 <dt><i>act</i> (QAction)</dt>
268 <dd> 267 <dd>
269 reference to the action that triggered 268 reference to the action that triggered
270 </dd> 269 </dd>
271 </dl> 270 </dl>
272 <a NAME="HelpViewerImplQWE.__closeOtherPages" ID="HelpViewerImplQWE.__closeOtherPages"></a> 271 <a NAME="HelpViewerImplQWE.__closeOtherPages" ID="HelpViewerImplQWE.__closeOtherPages"></a>
273 <h4>HelpViewerImplQWE.__closeOtherPages</h4> 272 <h4>HelpViewerImplQWE.__closeOtherPages</h4>
274 <b>__closeOtherPages</b>(<i></i>) 273 <b>__closeOtherPages</b>(<i></i>)
275
276 <p> 274 <p>
277 Private method called by the context menu to close all other pages. 275 Private method called by the context menu to close all other pages.
278 </p> 276 </p>
277
279 <a NAME="HelpViewerImplQWE.__closePage" ID="HelpViewerImplQWE.__closePage"></a> 278 <a NAME="HelpViewerImplQWE.__closePage" ID="HelpViewerImplQWE.__closePage"></a>
280 <h4>HelpViewerImplQWE.__closePage</h4> 279 <h4>HelpViewerImplQWE.__closePage</h4>
281 <b>__closePage</b>(<i></i>) 280 <b>__closePage</b>(<i></i>)
282
283 <p> 281 <p>
284 Private method called by the context menu to close the current page. 282 Private method called by the context menu to close the current page.
285 </p> 283 </p>
284
286 <a NAME="HelpViewerImplQWE.__copyLink" ID="HelpViewerImplQWE.__copyLink"></a> 285 <a NAME="HelpViewerImplQWE.__copyLink" ID="HelpViewerImplQWE.__copyLink"></a>
287 <h4>HelpViewerImplQWE.__copyLink</h4> 286 <h4>HelpViewerImplQWE.__copyLink</h4>
288 <b>__copyLink</b>(<i>act</i>) 287 <b>__copyLink</b>(<i>act</i>)
289
290 <p> 288 <p>
291 Private method called by the context menu to copy a link to the 289 Private method called by the context menu to copy a link to the
292 clipboard. 290 clipboard.
293 </p> 291 </p>
292
294 <dl> 293 <dl>
295 294
296 <dt><i>act</i> (QAction)</dt> 295 <dt><i>act</i> (QAction)</dt>
297 <dd> 296 <dd>
298 reference to the action that triggered 297 reference to the action that triggered
299 </dd> 298 </dd>
300 </dl> 299 </dl>
301 <a NAME="HelpViewerImplQWE.__copyText" ID="HelpViewerImplQWE.__copyText"></a> 300 <a NAME="HelpViewerImplQWE.__copyText" ID="HelpViewerImplQWE.__copyText"></a>
302 <h4>HelpViewerImplQWE.__copyText</h4> 301 <h4>HelpViewerImplQWE.__copyText</h4>
303 <b>__copyText</b>(<i></i>) 302 <b>__copyText</b>(<i></i>)
304
305 <p> 303 <p>
306 Private method called by the context menu to copy selected text to the 304 Private method called by the context menu to copy selected text to the
307 clipboard. 305 clipboard.
308 </p> 306 </p>
307
309 <a NAME="HelpViewerImplQWE.__createContextMenu" ID="HelpViewerImplQWE.__createContextMenu"></a> 308 <a NAME="HelpViewerImplQWE.__createContextMenu" ID="HelpViewerImplQWE.__createContextMenu"></a>
310 <h4>HelpViewerImplQWE.__createContextMenu</h4> 309 <h4>HelpViewerImplQWE.__createContextMenu</h4>
311 <b>__createContextMenu</b>(<i>menu</i>) 310 <b>__createContextMenu</b>(<i>menu</i>)
312
313 <p> 311 <p>
314 Private method to populate the context menu. 312 Private method to populate the context menu.
315 </p> 313 </p>
314
316 <dl> 315 <dl>
317 316
318 <dt><i>menu</i> (QMenu)</dt> 317 <dt><i>menu</i> (QMenu)</dt>
319 <dd> 318 <dd>
320 reference to the menu to be populated 319 reference to the menu to be populated
321 </dd> 320 </dd>
322 </dl> 321 </dl>
323 <a NAME="HelpViewerImplQWE.__createLinkContextMenu" ID="HelpViewerImplQWE.__createLinkContextMenu"></a> 322 <a NAME="HelpViewerImplQWE.__createLinkContextMenu" ID="HelpViewerImplQWE.__createLinkContextMenu"></a>
324 <h4>HelpViewerImplQWE.__createLinkContextMenu</h4> 323 <h4>HelpViewerImplQWE.__createLinkContextMenu</h4>
325 <b>__createLinkContextMenu</b>(<i>menu, contextMenuData</i>) 324 <b>__createLinkContextMenu</b>(<i>menu, contextMenuData</i>)
326
327 <p> 325 <p>
328 Private method to populate the context menu for URLs. 326 Private method to populate the context menu for URLs.
329 </p> 327 </p>
328
330 <dl> 329 <dl>
331 330
332 <dt><i>menu</i> (QMenu)</dt> 331 <dt><i>menu</i> (QMenu)</dt>
333 <dd> 332 <dd>
334 reference to the menu to be populated 333 reference to the menu to be populated
339 </dd> 338 </dd>
340 </dl> 339 </dl>
341 <a NAME="HelpViewerImplQWE.__createNewPage" ID="HelpViewerImplQWE.__createNewPage"></a> 340 <a NAME="HelpViewerImplQWE.__createNewPage" ID="HelpViewerImplQWE.__createNewPage"></a>
342 <h4>HelpViewerImplQWE.__createNewPage</h4> 341 <h4>HelpViewerImplQWE.__createNewPage</h4>
343 <b>__createNewPage</b>(<i></i>) 342 <b>__createNewPage</b>(<i></i>)
344
345 <p> 343 <p>
346 Private method to create a new page object. 344 Private method to create a new page object.
347 </p> 345 </p>
346
348 <a NAME="HelpViewerImplQWE.__levelForScale" ID="HelpViewerImplQWE.__levelForScale"></a> 347 <a NAME="HelpViewerImplQWE.__levelForScale" ID="HelpViewerImplQWE.__levelForScale"></a>
349 <h4>HelpViewerImplQWE.__levelForScale</h4> 348 <h4>HelpViewerImplQWE.__levelForScale</h4>
350 <b>__levelForScale</b>(<i>scale</i>) 349 <b>__levelForScale</b>(<i>scale</i>)
351
352 <p> 350 <p>
353 Private method determining the zoom level index given a zoom factor. 351 Private method determining the zoom level index given a zoom factor.
354 </p> 352 </p>
353
355 <dl> 354 <dl>
356 355
357 <dt><i>scale</i> (int)</dt> 356 <dt><i>scale</i> (int)</dt>
358 <dd> 357 <dd>
359 zoom factor 358 zoom factor
372 </dd> 371 </dd>
373 </dl> 372 </dl>
374 <a NAME="HelpViewerImplQWE.__newWindowRequested" ID="HelpViewerImplQWE.__newWindowRequested"></a> 373 <a NAME="HelpViewerImplQWE.__newWindowRequested" ID="HelpViewerImplQWE.__newWindowRequested"></a>
375 <h4>HelpViewerImplQWE.__newWindowRequested</h4> 374 <h4>HelpViewerImplQWE.__newWindowRequested</h4>
376 <b>__newWindowRequested</b>(<i>request</i>) 375 <b>__newWindowRequested</b>(<i>request</i>)
377
378 <p> 376 <p>
379 Private slot handling new window requests of the web page. 377 Private slot handling new window requests of the web page.
380 </p> 378 </p>
379
381 <dl> 380 <dl>
382 381
383 <dt><i>request</i> (QWebEngineNewWindowRequest)</dt> 382 <dt><i>request</i> (QWebEngineNewWindowRequest)</dt>
384 <dd> 383 <dd>
385 reference to the new window request 384 reference to the new window request
386 </dd> 385 </dd>
387 </dl> 386 </dl>
388 <a NAME="HelpViewerImplQWE.__openLinkInBackgroundPage" ID="HelpViewerImplQWE.__openLinkInBackgroundPage"></a> 387 <a NAME="HelpViewerImplQWE.__openLinkInBackgroundPage" ID="HelpViewerImplQWE.__openLinkInBackgroundPage"></a>
389 <h4>HelpViewerImplQWE.__openLinkInBackgroundPage</h4> 388 <h4>HelpViewerImplQWE.__openLinkInBackgroundPage</h4>
390 <b>__openLinkInBackgroundPage</b>(<i>act</i>) 389 <b>__openLinkInBackgroundPage</b>(<i>act</i>)
391
392 <p> 390 <p>
393 Private method called by the context menu to open a link in a 391 Private method called by the context menu to open a link in a
394 background page. 392 background page.
395 </p> 393 </p>
394
396 <dl> 395 <dl>
397 396
398 <dt><i>act</i> (QAction)</dt> 397 <dt><i>act</i> (QAction)</dt>
399 <dd> 398 <dd>
400 reference to the action that triggered 399 reference to the action that triggered
401 </dd> 400 </dd>
402 </dl> 401 </dl>
403 <a NAME="HelpViewerImplQWE.__openLinkInNewPage" ID="HelpViewerImplQWE.__openLinkInNewPage"></a> 402 <a NAME="HelpViewerImplQWE.__openLinkInNewPage" ID="HelpViewerImplQWE.__openLinkInNewPage"></a>
404 <h4>HelpViewerImplQWE.__openLinkInNewPage</h4> 403 <h4>HelpViewerImplQWE.__openLinkInNewPage</h4>
405 <b>__openLinkInNewPage</b>(<i>act</i>) 404 <b>__openLinkInNewPage</b>(<i>act</i>)
406
407 <p> 405 <p>
408 Private method called by the context menu to open a link in a new page. 406 Private method called by the context menu to open a link in a new page.
409 </p> 407 </p>
408
410 <dl> 409 <dl>
411 410
412 <dt><i>act</i> (QAction)</dt> 411 <dt><i>act</i> (QAction)</dt>
413 <dd> 412 <dd>
414 reference to the action that triggered 413 reference to the action that triggered
415 </dd> 414 </dd>
416 </dl> 415 </dl>
417 <a NAME="HelpViewerImplQWE.__selectAll" ID="HelpViewerImplQWE.__selectAll"></a> 416 <a NAME="HelpViewerImplQWE.__selectAll" ID="HelpViewerImplQWE.__selectAll"></a>
418 <h4>HelpViewerImplQWE.__selectAll</h4> 417 <h4>HelpViewerImplQWE.__selectAll</h4>
419 <b>__selectAll</b>(<i></i>) 418 <b>__selectAll</b>(<i></i>)
420
421 <p> 419 <p>
422 Private method called by the context menu to select all text. 420 Private method called by the context menu to select all text.
423 </p> 421 </p>
422
424 <a NAME="HelpViewerImplQWE.__setRwhvqt" ID="HelpViewerImplQWE.__setRwhvqt"></a> 423 <a NAME="HelpViewerImplQWE.__setRwhvqt" ID="HelpViewerImplQWE.__setRwhvqt"></a>
425 <h4>HelpViewerImplQWE.__setRwhvqt</h4> 424 <h4>HelpViewerImplQWE.__setRwhvqt</h4>
426 <b>__setRwhvqt</b>(<i></i>) 425 <b>__setRwhvqt</b>(<i></i>)
427
428 <p> 426 <p>
429 Private slot to set widget that receives input events. 427 Private slot to set widget that receives input events.
430 </p> 428 </p>
429
431 <a NAME="HelpViewerImplQWE.__showContextMenu" ID="HelpViewerImplQWE.__showContextMenu"></a> 430 <a NAME="HelpViewerImplQWE.__showContextMenu" ID="HelpViewerImplQWE.__showContextMenu"></a>
432 <h4>HelpViewerImplQWE.__showContextMenu</h4> 431 <h4>HelpViewerImplQWE.__showContextMenu</h4>
433 <b>__showContextMenu</b>(<i>pos</i>) 432 <b>__showContextMenu</b>(<i>pos</i>)
434
435 <p> 433 <p>
436 Private slot to show a context menu. 434 Private slot to show a context menu.
437 </p> 435 </p>
436
438 <dl> 437 <dl>
439 438
440 <dt><i>pos</i> (QPoint)</dt> 439 <dt><i>pos</i> (QPoint)</dt>
441 <dd> 440 <dd>
442 position for the context menu 441 position for the context menu
443 </dd> 442 </dd>
444 </dl> 443 </dl>
445 <a NAME="HelpViewerImplQWE.__titleChanged" ID="HelpViewerImplQWE.__titleChanged"></a> 444 <a NAME="HelpViewerImplQWE.__titleChanged" ID="HelpViewerImplQWE.__titleChanged"></a>
446 <h4>HelpViewerImplQWE.__titleChanged</h4> 445 <h4>HelpViewerImplQWE.__titleChanged</h4>
447 <b>__titleChanged</b>(<i></i>) 446 <b>__titleChanged</b>(<i></i>)
448
449 <p> 447 <p>
450 Private method to handle a change of the web page title. 448 Private method to handle a change of the web page title.
451 </p> 449 </p>
450
452 <a NAME="HelpViewerImplQWE._gestureEvent" ID="HelpViewerImplQWE._gestureEvent"></a> 451 <a NAME="HelpViewerImplQWE._gestureEvent" ID="HelpViewerImplQWE._gestureEvent"></a>
453 <h4>HelpViewerImplQWE._gestureEvent</h4> 452 <h4>HelpViewerImplQWE._gestureEvent</h4>
454 <b>_gestureEvent</b>(<i>evt</i>) 453 <b>_gestureEvent</b>(<i>evt</i>)
455
456 <p> 454 <p>
457 Protected method handling gesture events. 455 Protected method handling gesture events.
458 </p> 456 </p>
457
459 <dl> 458 <dl>
460 459
461 <dt><i>evt</i> (QGestureEvent)</dt> 460 <dt><i>evt</i> (QGestureEvent)</dt>
462 <dd> 461 <dd>
463 reference to the gesture event 462 reference to the gesture event
464 </dd> 463 </dd>
465 </dl> 464 </dl>
466 <a NAME="HelpViewerImplQWE._keyPressEvent" ID="HelpViewerImplQWE._keyPressEvent"></a> 465 <a NAME="HelpViewerImplQWE._keyPressEvent" ID="HelpViewerImplQWE._keyPressEvent"></a>
467 <h4>HelpViewerImplQWE._keyPressEvent</h4> 466 <h4>HelpViewerImplQWE._keyPressEvent</h4>
468 <b>_keyPressEvent</b>(<i>evt</i>) 467 <b>_keyPressEvent</b>(<i>evt</i>)
469
470 <p> 468 <p>
471 Protected method called by a key press. 469 Protected method called by a key press.
472 </p> 470 </p>
471
473 <dl> 472 <dl>
474 473
475 <dt><i>evt</i> (QKeyEvent)</dt> 474 <dt><i>evt</i> (QKeyEvent)</dt>
476 <dd> 475 <dd>
477 reference to the key event 476 reference to the key event
478 </dd> 477 </dd>
479 </dl> 478 </dl>
480 <a NAME="HelpViewerImplQWE._mouseReleaseEvent" ID="HelpViewerImplQWE._mouseReleaseEvent"></a> 479 <a NAME="HelpViewerImplQWE._mouseReleaseEvent" ID="HelpViewerImplQWE._mouseReleaseEvent"></a>
481 <h4>HelpViewerImplQWE._mouseReleaseEvent</h4> 480 <h4>HelpViewerImplQWE._mouseReleaseEvent</h4>
482 <b>_mouseReleaseEvent</b>(<i>evt</i>) 481 <b>_mouseReleaseEvent</b>(<i>evt</i>)
483
484 <p> 482 <p>
485 Protected method called by a mouse release event. 483 Protected method called by a mouse release event.
486 </p> 484 </p>
485
487 <dl> 486 <dl>
488 487
489 <dt><i>evt</i> (QMouseEvent)</dt> 488 <dt><i>evt</i> (QMouseEvent)</dt>
490 <dd> 489 <dd>
491 reference to the mouse event 490 reference to the mouse event
492 </dd> 491 </dd>
493 </dl> 492 </dl>
494 <a NAME="HelpViewerImplQWE._wheelEvent" ID="HelpViewerImplQWE._wheelEvent"></a> 493 <a NAME="HelpViewerImplQWE._wheelEvent" ID="HelpViewerImplQWE._wheelEvent"></a>
495 <h4>HelpViewerImplQWE._wheelEvent</h4> 494 <h4>HelpViewerImplQWE._wheelEvent</h4>
496 <b>_wheelEvent</b>(<i>evt</i>) 495 <b>_wheelEvent</b>(<i>evt</i>)
497
498 <p> 496 <p>
499 Protected method to handle wheel events. 497 Protected method to handle wheel events.
500 </p> 498 </p>
499
501 <dl> 500 <dl>
502 501
503 <dt><i>evt</i> (QWheelEvent)</dt> 502 <dt><i>evt</i> (QWheelEvent)</dt>
504 <dd> 503 <dd>
505 reference to the wheel event 504 reference to the wheel event
506 </dd> 505 </dd>
507 </dl> 506 </dl>
508 <a NAME="HelpViewerImplQWE.backward" ID="HelpViewerImplQWE.backward"></a> 507 <a NAME="HelpViewerImplQWE.backward" ID="HelpViewerImplQWE.backward"></a>
509 <h4>HelpViewerImplQWE.backward</h4> 508 <h4>HelpViewerImplQWE.backward</h4>
510 <b>backward</b>(<i></i>) 509 <b>backward</b>(<i></i>)
511
512 <p> 510 <p>
513 Public slot to move backwards in history. 511 Public slot to move backwards in history.
514 </p> 512 </p>
513
515 <a NAME="HelpViewerImplQWE.backwardHistoryCount" ID="HelpViewerImplQWE.backwardHistoryCount"></a> 514 <a NAME="HelpViewerImplQWE.backwardHistoryCount" ID="HelpViewerImplQWE.backwardHistoryCount"></a>
516 <h4>HelpViewerImplQWE.backwardHistoryCount</h4> 515 <h4>HelpViewerImplQWE.backwardHistoryCount</h4>
517 <b>backwardHistoryCount</b>(<i></i>) 516 <b>backwardHistoryCount</b>(<i></i>)
518
519 <p> 517 <p>
520 Public method to get the number of available back history items. 518 Public method to get the number of available back history items.
521 </p> 519 </p>
522 <p> 520 <p>
523 Note: For performance reasons this is limited to the maximum number of 521 Note: For performance reasons this is limited to the maximum number of
524 history items the help viewer is interested in. 522 history items the help viewer is interested in.
525 </p> 523 </p>
524
526 <dl> 525 <dl>
527 <dt>Return:</dt> 526 <dt>Return:</dt>
528 <dd> 527 <dd>
529 count of available back history items 528 count of available back history items
530 </dd> 529 </dd>
536 </dd> 535 </dd>
537 </dl> 536 </dl>
538 <a NAME="HelpViewerImplQWE.clearHistory" ID="HelpViewerImplQWE.clearHistory"></a> 537 <a NAME="HelpViewerImplQWE.clearHistory" ID="HelpViewerImplQWE.clearHistory"></a>
539 <h4>HelpViewerImplQWE.clearHistory</h4> 538 <h4>HelpViewerImplQWE.clearHistory</h4>
540 <b>clearHistory</b>(<i></i>) 539 <b>clearHistory</b>(<i></i>)
541
542 <p> 540 <p>
543 Public method to clear the history. 541 Public method to clear the history.
544 </p> 542 </p>
543
545 <a NAME="HelpViewerImplQWE.event" ID="HelpViewerImplQWE.event"></a> 544 <a NAME="HelpViewerImplQWE.event" ID="HelpViewerImplQWE.event"></a>
546 <h4>HelpViewerImplQWE.event</h4> 545 <h4>HelpViewerImplQWE.event</h4>
547 <b>event</b>(<i>evt</i>) 546 <b>event</b>(<i>evt</i>)
548
549 <p> 547 <p>
550 Public method handling events. 548 Public method handling events.
551 </p> 549 </p>
550
552 <dl> 551 <dl>
553 552
554 <dt><i>evt</i> (QEvent)</dt> 553 <dt><i>evt</i> (QEvent)</dt>
555 <dd> 554 <dd>
556 reference to the event 555 reference to the event
569 </dd> 568 </dd>
570 </dl> 569 </dl>
571 <a NAME="HelpViewerImplQWE.eventFilter" ID="HelpViewerImplQWE.eventFilter"></a> 570 <a NAME="HelpViewerImplQWE.eventFilter" ID="HelpViewerImplQWE.eventFilter"></a>
572 <h4>HelpViewerImplQWE.eventFilter</h4> 571 <h4>HelpViewerImplQWE.eventFilter</h4>
573 <b>eventFilter</b>(<i>obj, evt</i>) 572 <b>eventFilter</b>(<i>obj, evt</i>)
574
575 <p> 573 <p>
576 Public method to process event for other objects. 574 Public method to process event for other objects.
577 </p> 575 </p>
576
578 <dl> 577 <dl>
579 578
580 <dt><i>obj</i> (QObject)</dt> 579 <dt><i>obj</i> (QObject)</dt>
581 <dd> 580 <dd>
582 reference to object to process events for 581 reference to object to process events for
599 </dd> 598 </dd>
600 </dl> 599 </dl>
601 <a NAME="HelpViewerImplQWE.forward" ID="HelpViewerImplQWE.forward"></a> 600 <a NAME="HelpViewerImplQWE.forward" ID="HelpViewerImplQWE.forward"></a>
602 <h4>HelpViewerImplQWE.forward</h4> 601 <h4>HelpViewerImplQWE.forward</h4>
603 <b>forward</b>(<i></i>) 602 <b>forward</b>(<i></i>)
604
605 <p> 603 <p>
606 Public slot to move forward in history. 604 Public slot to move forward in history.
607 </p> 605 </p>
606
608 <a NAME="HelpViewerImplQWE.forwardHistoryCount" ID="HelpViewerImplQWE.forwardHistoryCount"></a> 607 <a NAME="HelpViewerImplQWE.forwardHistoryCount" ID="HelpViewerImplQWE.forwardHistoryCount"></a>
609 <h4>HelpViewerImplQWE.forwardHistoryCount</h4> 608 <h4>HelpViewerImplQWE.forwardHistoryCount</h4>
610 <b>forwardHistoryCount</b>(<i></i>) 609 <b>forwardHistoryCount</b>(<i></i>)
611
612 <p> 610 <p>
613 Public method to get the number of available forward history items. 611 Public method to get the number of available forward history items.
614 </p> 612 </p>
615 <p> 613 <p>
616 Note: For performance reasons this is limited to the maximum number of 614 Note: For performance reasons this is limited to the maximum number of
617 history items the help viewer is interested in. 615 history items the help viewer is interested in.
618 </p> 616 </p>
617
619 <dl> 618 <dl>
620 <dt>Return:</dt> 619 <dt>Return:</dt>
621 <dd> 620 <dd>
622 count of available forward history items 621 count of available forward history items
623 </dd> 622 </dd>
629 </dd> 628 </dd>
630 </dl> 629 </dl>
631 <a NAME="HelpViewerImplQWE.gotoHistory" ID="HelpViewerImplQWE.gotoHistory"></a> 630 <a NAME="HelpViewerImplQWE.gotoHistory" ID="HelpViewerImplQWE.gotoHistory"></a>
632 <h4>HelpViewerImplQWE.gotoHistory</h4> 631 <h4>HelpViewerImplQWE.gotoHistory</h4>
633 <b>gotoHistory</b>(<i>offset</i>) 632 <b>gotoHistory</b>(<i>offset</i>)
634
635 <p> 633 <p>
636 Public method to go to a history item. 634 Public method to go to a history item.
637 </p> 635 </p>
636
638 <dl> 637 <dl>
639 638
640 <dt><i>offset</i> (int)</dt> 639 <dt><i>offset</i> (int)</dt>
641 <dd> 640 <dd>
642 offset of the item with respect to the current page 641 offset of the item with respect to the current page
643 </dd> 642 </dd>
644 </dl> 643 </dl>
645 <a NAME="HelpViewerImplQWE.historyTitle" ID="HelpViewerImplQWE.historyTitle"></a> 644 <a NAME="HelpViewerImplQWE.historyTitle" ID="HelpViewerImplQWE.historyTitle"></a>
646 <h4>HelpViewerImplQWE.historyTitle</h4> 645 <h4>HelpViewerImplQWE.historyTitle</h4>
647 <b>historyTitle</b>(<i>offset</i>) 646 <b>historyTitle</b>(<i>offset</i>)
648
649 <p> 647 <p>
650 Public method to get the title of a history item. 648 Public method to get the title of a history item.
651 </p> 649 </p>
650
652 <dl> 651 <dl>
653 652
654 <dt><i>offset</i> (int)</dt> 653 <dt><i>offset</i> (int)</dt>
655 <dd> 654 <dd>
656 offset of the item with respect to the current page 655 offset of the item with respect to the current page
669 </dd> 668 </dd>
670 </dl> 669 </dl>
671 <a NAME="HelpViewerImplQWE.isBackwardAvailable" ID="HelpViewerImplQWE.isBackwardAvailable"></a> 670 <a NAME="HelpViewerImplQWE.isBackwardAvailable" ID="HelpViewerImplQWE.isBackwardAvailable"></a>
672 <h4>HelpViewerImplQWE.isBackwardAvailable</h4> 671 <h4>HelpViewerImplQWE.isBackwardAvailable</h4>
673 <b>isBackwardAvailable</b>(<i></i>) 672 <b>isBackwardAvailable</b>(<i></i>)
674
675 <p> 673 <p>
676 Public method to check, if stepping backward through the history is 674 Public method to check, if stepping backward through the history is
677 available. 675 available.
678 </p> 676 </p>
677
679 <dl> 678 <dl>
680 <dt>Return:</dt> 679 <dt>Return:</dt>
681 <dd> 680 <dd>
682 flag indicating backward stepping is available 681 flag indicating backward stepping is available
683 </dd> 682 </dd>
689 </dd> 688 </dd>
690 </dl> 689 </dl>
691 <a NAME="HelpViewerImplQWE.isEmptyPage" ID="HelpViewerImplQWE.isEmptyPage"></a> 690 <a NAME="HelpViewerImplQWE.isEmptyPage" ID="HelpViewerImplQWE.isEmptyPage"></a>
692 <h4>HelpViewerImplQWE.isEmptyPage</h4> 691 <h4>HelpViewerImplQWE.isEmptyPage</h4>
693 <b>isEmptyPage</b>(<i></i>) 692 <b>isEmptyPage</b>(<i></i>)
694
695 <p> 693 <p>
696 Public method to check, if the current page is the empty page. 694 Public method to check, if the current page is the empty page.
697 </p> 695 </p>
696
698 <dl> 697 <dl>
699 <dt>Return:</dt> 698 <dt>Return:</dt>
700 <dd> 699 <dd>
701 flag indicating an empty page is loaded 700 flag indicating an empty page is loaded
702 </dd> 701 </dd>
708 </dd> 707 </dd>
709 </dl> 708 </dl>
710 <a NAME="HelpViewerImplQWE.isForwardAvailable" ID="HelpViewerImplQWE.isForwardAvailable"></a> 709 <a NAME="HelpViewerImplQWE.isForwardAvailable" ID="HelpViewerImplQWE.isForwardAvailable"></a>
711 <h4>HelpViewerImplQWE.isForwardAvailable</h4> 710 <h4>HelpViewerImplQWE.isForwardAvailable</h4>
712 <b>isForwardAvailable</b>(<i></i>) 711 <b>isForwardAvailable</b>(<i></i>)
713
714 <p> 712 <p>
715 Public method to check, if stepping forward through the history is 713 Public method to check, if stepping forward through the history is
716 available. 714 available.
717 </p> 715 </p>
716
718 <dl> 717 <dl>
719 <dt>Return:</dt> 718 <dt>Return:</dt>
720 <dd> 719 <dd>
721 flag indicating forward stepping is available 720 flag indicating forward stepping is available
722 </dd> 721 </dd>
728 </dd> 727 </dd>
729 </dl> 728 </dl>
730 <a NAME="HelpViewerImplQWE.isScaleDownAvailable" ID="HelpViewerImplQWE.isScaleDownAvailable"></a> 729 <a NAME="HelpViewerImplQWE.isScaleDownAvailable" ID="HelpViewerImplQWE.isScaleDownAvailable"></a>
731 <h4>HelpViewerImplQWE.isScaleDownAvailable</h4> 730 <h4>HelpViewerImplQWE.isScaleDownAvailable</h4>
732 <b>isScaleDownAvailable</b>(<i></i>) 731 <b>isScaleDownAvailable</b>(<i></i>)
733
734 <p> 732 <p>
735 Public method to check, if the min. zoom level is reached. 733 Public method to check, if the min. zoom level is reached.
736 </p> 734 </p>
735
737 <dl> 736 <dl>
738 <dt>Return:</dt> 737 <dt>Return:</dt>
739 <dd> 738 <dd>
740 flag indicating scale down is available 739 flag indicating scale down is available
741 </dd> 740 </dd>
747 </dd> 746 </dd>
748 </dl> 747 </dl>
749 <a NAME="HelpViewerImplQWE.isScaleUpAvailable" ID="HelpViewerImplQWE.isScaleUpAvailable"></a> 748 <a NAME="HelpViewerImplQWE.isScaleUpAvailable" ID="HelpViewerImplQWE.isScaleUpAvailable"></a>
750 <h4>HelpViewerImplQWE.isScaleUpAvailable</h4> 749 <h4>HelpViewerImplQWE.isScaleUpAvailable</h4>
751 <b>isScaleUpAvailable</b>(<i></i>) 750 <b>isScaleUpAvailable</b>(<i></i>)
752
753 <p> 751 <p>
754 Public method to check, if the max. zoom level is reached. 752 Public method to check, if the max. zoom level is reached.
755 </p> 753 </p>
754
756 <dl> 755 <dl>
757 <dt>Return:</dt> 756 <dt>Return:</dt>
758 <dd> 757 <dd>
759 flag indicating scale up is available 758 flag indicating scale up is available
760 </dd> 759 </dd>
766 </dd> 765 </dd>
767 </dl> 766 </dl>
768 <a NAME="HelpViewerImplQWE.link" ID="HelpViewerImplQWE.link"></a> 767 <a NAME="HelpViewerImplQWE.link" ID="HelpViewerImplQWE.link"></a>
769 <h4>HelpViewerImplQWE.link</h4> 768 <h4>HelpViewerImplQWE.link</h4>
770 <b>link</b>(<i></i>) 769 <b>link</b>(<i></i>)
771
772 <p> 770 <p>
773 Public method to get the URL of the shown document. 771 Public method to get the URL of the shown document.
774 </p> 772 </p>
773
775 <dl> 774 <dl>
776 <dt>Return:</dt> 775 <dt>Return:</dt>
777 <dd> 776 <dd>
778 url URL of the document 777 url URL of the document
779 </dd> 778 </dd>
785 </dd> 784 </dd>
786 </dl> 785 </dl>
787 <a NAME="HelpViewerImplQWE.pageTitle" ID="HelpViewerImplQWE.pageTitle"></a> 786 <a NAME="HelpViewerImplQWE.pageTitle" ID="HelpViewerImplQWE.pageTitle"></a>
788 <h4>HelpViewerImplQWE.pageTitle</h4> 787 <h4>HelpViewerImplQWE.pageTitle</h4>
789 <b>pageTitle</b>(<i></i>) 788 <b>pageTitle</b>(<i></i>)
790
791 <p> 789 <p>
792 Public method get the page title. 790 Public method get the page title.
793 </p> 791 </p>
792
794 <dl> 793 <dl>
795 <dt>Return:</dt> 794 <dt>Return:</dt>
796 <dd> 795 <dd>
797 page title 796 page title
798 </dd> 797 </dd>
804 </dd> 803 </dd>
805 </dl> 804 </dl>
806 <a NAME="HelpViewerImplQWE.reload" ID="HelpViewerImplQWE.reload"></a> 805 <a NAME="HelpViewerImplQWE.reload" ID="HelpViewerImplQWE.reload"></a>
807 <h4>HelpViewerImplQWE.reload</h4> 806 <h4>HelpViewerImplQWE.reload</h4>
808 <b>reload</b>(<i></i>) 807 <b>reload</b>(<i></i>)
809
810 <p> 808 <p>
811 Public slot to reload the current page. 809 Public slot to reload the current page.
812 </p> 810 </p>
811
813 <a NAME="HelpViewerImplQWE.resetScale" ID="HelpViewerImplQWE.resetScale"></a> 812 <a NAME="HelpViewerImplQWE.resetScale" ID="HelpViewerImplQWE.resetScale"></a>
814 <h4>HelpViewerImplQWE.resetScale</h4> 813 <h4>HelpViewerImplQWE.resetScale</h4>
815 <b>resetScale</b>(<i></i>) 814 <b>resetScale</b>(<i></i>)
816
817 <p> 815 <p>
818 Public method to reset the zoom level. 816 Public method to reset the zoom level.
819 </p> 817 </p>
818
820 <a NAME="HelpViewerImplQWE.scale" ID="HelpViewerImplQWE.scale"></a> 819 <a NAME="HelpViewerImplQWE.scale" ID="HelpViewerImplQWE.scale"></a>
821 <h4>HelpViewerImplQWE.scale</h4> 820 <h4>HelpViewerImplQWE.scale</h4>
822 <b>scale</b>(<i></i>) 821 <b>scale</b>(<i></i>)
823
824 <p> 822 <p>
825 Public method to get the zoom level. 823 Public method to get the zoom level.
826 </p> 824 </p>
825
827 <dl> 826 <dl>
828 <dt>Return:</dt> 827 <dt>Return:</dt>
829 <dd> 828 <dd>
830 current zoom level 829 current zoom level
831 </dd> 830 </dd>
837 </dd> 836 </dd>
838 </dl> 837 </dl>
839 <a NAME="HelpViewerImplQWE.scaleDown" ID="HelpViewerImplQWE.scaleDown"></a> 838 <a NAME="HelpViewerImplQWE.scaleDown" ID="HelpViewerImplQWE.scaleDown"></a>
840 <h4>HelpViewerImplQWE.scaleDown</h4> 839 <h4>HelpViewerImplQWE.scaleDown</h4>
841 <b>scaleDown</b>(<i></i>) 840 <b>scaleDown</b>(<i></i>)
842
843 <p> 841 <p>
844 Public method to zoom out. 842 Public method to zoom out.
845 </p> 843 </p>
844
846 <a NAME="HelpViewerImplQWE.scaleUp" ID="HelpViewerImplQWE.scaleUp"></a> 845 <a NAME="HelpViewerImplQWE.scaleUp" ID="HelpViewerImplQWE.scaleUp"></a>
847 <h4>HelpViewerImplQWE.scaleUp</h4> 846 <h4>HelpViewerImplQWE.scaleUp</h4>
848 <b>scaleUp</b>(<i></i>) 847 <b>scaleUp</b>(<i></i>)
849
850 <p> 848 <p>
851 Public method to zoom in. 849 Public method to zoom in.
852 </p> 850 </p>
851
853 <a NAME="HelpViewerImplQWE.setLink" ID="HelpViewerImplQWE.setLink"></a> 852 <a NAME="HelpViewerImplQWE.setLink" ID="HelpViewerImplQWE.setLink"></a>
854 <h4>HelpViewerImplQWE.setLink</h4> 853 <h4>HelpViewerImplQWE.setLink</h4>
855 <b>setLink</b>(<i>url</i>) 854 <b>setLink</b>(<i>url</i>)
856
857 <p> 855 <p>
858 Public method to set the URL of the document to be shown. 856 Public method to set the URL of the document to be shown.
859 </p> 857 </p>
858
860 <dl> 859 <dl>
861 860
862 <dt><i>url</i> (QUrl)</dt> 861 <dt><i>url</i> (QUrl)</dt>
863 <dd> 862 <dd>
864 URL of the document 863 URL of the document
865 </dd> 864 </dd>
866 </dl> 865 </dl>
867 <a NAME="HelpViewerImplQWE.setScale" ID="HelpViewerImplQWE.setScale"></a> 866 <a NAME="HelpViewerImplQWE.setScale" ID="HelpViewerImplQWE.setScale"></a>
868 <h4>HelpViewerImplQWE.setScale</h4> 867 <h4>HelpViewerImplQWE.setScale</h4>
869 <b>setScale</b>(<i>scale</i>) 868 <b>setScale</b>(<i>scale</i>)
870
871 <p> 869 <p>
872 Public method to set the zoom level. 870 Public method to set the zoom level.
873 </p> 871 </p>
872
874 <dl> 873 <dl>
875 874
876 <dt><i>scale</i> (int)</dt> 875 <dt><i>scale</i> (int)</dt>
877 <dd> 876 <dd>
878 zoom level to set 877 zoom level to set

Mercurial Repository: eric

eric ide

mercurial