src/eric7/Documentation/Source/eric7.PdfViewer.PdfViewerWindow.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.PdfViewer.PdfViewerWindow</h1> 9 <h1>eric7.PdfViewer.PdfViewerWindow</h1>
10
11 <p> 10 <p>
12 Module implementing the PDF viewer main window. 11 Module implementing the PDF viewer main window.
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="#PdfViewerWindow">PdfViewerWindow</a></td> 22 <td><a href="#PdfViewerWindow">PdfViewerWindow</a></td>
25 <td>Class implementing the PDF viewer main window.</td> 23 <td>Class implementing the PDF viewer main window.</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="PdfViewerWindow" ID="PdfViewerWindow"></a> 34 <a NAME="PdfViewerWindow" ID="PdfViewerWindow"></a>
36 <h2>PdfViewerWindow</h2> 35 <h2>PdfViewerWindow</h2>
37
38 <p> 36 <p>
39 Class implementing the PDF viewer main window. 37 Class implementing the PDF viewer main window.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>viewerClosed()</dt> 43 <dt>viewerClosed()</dt>
45 <dd> 44 <dd>
47 </dd> 46 </dd>
48 </dl> 47 </dl>
49 <h3>Derived from</h3> 48 <h3>Derived from</h3>
50 EricMainWindow 49 EricMainWindow
51 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
52
53 <table> 51 <table>
54 <tr><td>maxMenuFilePathLen</td></tr><tr><td>windows</td></tr> 52 <tr><td>maxMenuFilePathLen</td></tr>
53 <tr><td>windows</td></tr>
55 </table> 54 </table>
55
56 <h3>Class Methods</h3> 56 <h3>Class Methods</h3>
57
58 <table> 57 <table>
59 <tr><td>None</td></tr> 58 <tr><td>None</td></tr>
60 </table> 59 </table>
60
61 <h3>Methods</h3> 61 <h3>Methods</h3>
62
63 <table> 62 <table>
64
65 <tr> 63 <tr>
66 <td><a href="#PdfViewerWindow.__init__">PdfViewerWindow</a></td> 64 <td><a href="#PdfViewerWindow.__init__">PdfViewerWindow</a></td>
67 <td>Constructor</td> 65 <td>Constructor</td>
68 </tr> 66 </tr>
69 <tr> 67 <tr>
305 <tr> 303 <tr>
306 <td><a href="#PdfViewerWindow.closeEvent">closeEvent</a></td> 304 <td><a href="#PdfViewerWindow.closeEvent">closeEvent</a></td>
307 <td>Protected method handling the close event.</td> 305 <td>Protected method handling the close event.</td>
308 </tr> 306 </tr>
309 </table> 307 </table>
308
310 <h3>Static Methods</h3> 309 <h3>Static Methods</h3>
311
312 <table> 310 <table>
313 <tr><td>None</td></tr> 311 <tr><td>None</td></tr>
314 </table> 312 </table>
315 313
314
316 <a NAME="PdfViewerWindow.__init__" ID="PdfViewerWindow.__init__"></a> 315 <a NAME="PdfViewerWindow.__init__" ID="PdfViewerWindow.__init__"></a>
317 <h4>PdfViewerWindow (Constructor)</h4> 316 <h4>PdfViewerWindow (Constructor)</h4>
318 <b>PdfViewerWindow</b>(<i>fileName="", parent=None, fromEric=False, project=None</i>) 317 <b>PdfViewerWindow</b>(<i>fileName="", parent=None, fromEric=False, project=None</i>)
319
320 <p> 318 <p>
321 Constructor 319 Constructor
322 </p> 320 </p>
321
323 <dl> 322 <dl>
324 323
325 <dt><i>fileName</i> (str)</dt> 324 <dt><i>fileName</i> (str)</dt>
326 <dd> 325 <dd>
327 name of a file to load on startup 326 name of a file to load on startup
341 </dd> 340 </dd>
342 </dl> 341 </dl>
343 <a NAME="PdfViewerWindow.__about" ID="PdfViewerWindow.__about"></a> 342 <a NAME="PdfViewerWindow.__about" ID="PdfViewerWindow.__about"></a>
344 <h4>PdfViewerWindow.__about</h4> 343 <h4>PdfViewerWindow.__about</h4>
345 <b>__about</b>(<i></i>) 344 <b>__about</b>(<i></i>)
346
347 <p> 345 <p>
348 Private slot to show a little About message. 346 Private slot to show a little About message.
349 </p> 347 </p>
348
350 <a NAME="PdfViewerWindow.__aboutQt" ID="PdfViewerWindow.__aboutQt"></a> 349 <a NAME="PdfViewerWindow.__aboutQt" ID="PdfViewerWindow.__aboutQt"></a>
351 <h4>PdfViewerWindow.__aboutQt</h4> 350 <h4>PdfViewerWindow.__aboutQt</h4>
352 <b>__aboutQt</b>(<i></i>) 351 <b>__aboutQt</b>(<i></i>)
353
354 <p> 352 <p>
355 Private slot to handle the About Qt dialog. 353 Private slot to handle the About Qt dialog.
356 </p> 354 </p>
355
357 <a NAME="PdfViewerWindow.__addToRecentList" ID="PdfViewerWindow.__addToRecentList"></a> 356 <a NAME="PdfViewerWindow.__addToRecentList" ID="PdfViewerWindow.__addToRecentList"></a>
358 <h4>PdfViewerWindow.__addToRecentList</h4> 357 <h4>PdfViewerWindow.__addToRecentList</h4>
359 <b>__addToRecentList</b>(<i>fileName</i>) 358 <b>__addToRecentList</b>(<i>fileName</i>)
360
361 <p> 359 <p>
362 Private method to add a file name to the list of recently opened files. 360 Private method to add a file name to the list of recently opened files.
363 </p> 361 </p>
362
364 <dl> 363 <dl>
365 364
366 <dt><i>fileName</i> (str)</dt> 365 <dt><i>fileName</i> (str)</dt>
367 <dd> 366 <dd>
368 name of the file to be added 367 name of the file to be added
369 </dd> 368 </dd>
370 </dl> 369 </dl>
371 <a NAME="PdfViewerWindow.__backInHistory" ID="PdfViewerWindow.__backInHistory"></a> 370 <a NAME="PdfViewerWindow.__backInHistory" ID="PdfViewerWindow.__backInHistory"></a>
372 <h4>PdfViewerWindow.__backInHistory</h4> 371 <h4>PdfViewerWindow.__backInHistory</h4>
373 <b>__backInHistory</b>(<i></i>) 372 <b>__backInHistory</b>(<i></i>)
374
375 <p> 373 <p>
376 Private slot to go back in the view history. 374 Private slot to go back in the view history.
377 </p> 375 </p>
376
378 <a NAME="PdfViewerWindow.__checkActions" ID="PdfViewerWindow.__checkActions"></a> 377 <a NAME="PdfViewerWindow.__checkActions" ID="PdfViewerWindow.__checkActions"></a>
379 <h4>PdfViewerWindow.__checkActions</h4> 378 <h4>PdfViewerWindow.__checkActions</h4>
380 <b>__checkActions</b>(<i></i>) 379 <b>__checkActions</b>(<i></i>)
381
382 <p> 380 <p>
383 Private slot to check some actions for their enable/disable status. 381 Private slot to check some actions for their enable/disable status.
384 </p> 382 </p>
383
385 <a NAME="PdfViewerWindow.__clearRecent" ID="PdfViewerWindow.__clearRecent"></a> 384 <a NAME="PdfViewerWindow.__clearRecent" ID="PdfViewerWindow.__clearRecent"></a>
386 <h4>PdfViewerWindow.__clearRecent</h4> 385 <h4>PdfViewerWindow.__clearRecent</h4>
387 <b>__clearRecent</b>(<i></i>) 386 <b>__clearRecent</b>(<i></i>)
388
389 <p> 387 <p>
390 Private method to clear the list of recently opened files. 388 Private method to clear the list of recently opened files.
391 </p> 389 </p>
390
392 <a NAME="PdfViewerWindow.__closeAll" ID="PdfViewerWindow.__closeAll"></a> 391 <a NAME="PdfViewerWindow.__closeAll" ID="PdfViewerWindow.__closeAll"></a>
393 <h4>PdfViewerWindow.__closeAll</h4> 392 <h4>PdfViewerWindow.__closeAll</h4>
394 <b>__closeAll</b>(<i></i>) 393 <b>__closeAll</b>(<i></i>)
395
396 <p> 394 <p>
397 Private slot to close all windows. 395 Private slot to close all windows.
398 </p> 396 </p>
397
399 <a NAME="PdfViewerWindow.__closeOthers" ID="PdfViewerWindow.__closeOthers"></a> 398 <a NAME="PdfViewerWindow.__closeOthers" ID="PdfViewerWindow.__closeOthers"></a>
400 <h4>PdfViewerWindow.__closeOthers</h4> 399 <h4>PdfViewerWindow.__closeOthers</h4>
401 <b>__closeOthers</b>(<i></i>) 400 <b>__closeOthers</b>(<i></i>)
402
403 <p> 401 <p>
404 Private slot to close all other windows. 402 Private slot to close all other windows.
405 </p> 403 </p>
404
406 <a NAME="PdfViewerWindow.__copyAllText" ID="PdfViewerWindow.__copyAllText"></a> 405 <a NAME="PdfViewerWindow.__copyAllText" ID="PdfViewerWindow.__copyAllText"></a>
407 <h4>PdfViewerWindow.__copyAllText</h4> 406 <h4>PdfViewerWindow.__copyAllText</h4>
408 <b>__copyAllText</b>(<i></i>) 407 <b>__copyAllText</b>(<i></i>)
409
410 <p> 408 <p>
411 Private slot to copy all text of the document to the system clipboard. 409 Private slot to copy all text of the document to the system clipboard.
412 </p> 410 </p>
411
413 <a NAME="PdfViewerWindow.__copyAllTextOfPage" ID="PdfViewerWindow.__copyAllTextOfPage"></a> 412 <a NAME="PdfViewerWindow.__copyAllTextOfPage" ID="PdfViewerWindow.__copyAllTextOfPage"></a>
414 <h4>PdfViewerWindow.__copyAllTextOfPage</h4> 413 <h4>PdfViewerWindow.__copyAllTextOfPage</h4>
415 <b>__copyAllTextOfPage</b>(<i></i>) 414 <b>__copyAllTextOfPage</b>(<i></i>)
416
417 <p> 415 <p>
418 Private slot to copy all text of the current page to the system clipboard. 416 Private slot to copy all text of the current page to the system clipboard.
419 </p> 417 </p>
418
420 <a NAME="PdfViewerWindow.__copyText" ID="PdfViewerWindow.__copyText"></a> 419 <a NAME="PdfViewerWindow.__copyText" ID="PdfViewerWindow.__copyText"></a>
421 <h4>PdfViewerWindow.__copyText</h4> 420 <h4>PdfViewerWindow.__copyText</h4>
422 <b>__copyText</b>(<i></i>) 421 <b>__copyText</b>(<i></i>)
423
424 <p> 422 <p>
425 Private slot to copy the selected text to the system clipboard. 423 Private slot to copy the selected text to the system clipboard.
426 </p> 424 </p>
425
427 <a NAME="PdfViewerWindow.__createStatusBar" ID="PdfViewerWindow.__createStatusBar"></a> 426 <a NAME="PdfViewerWindow.__createStatusBar" ID="PdfViewerWindow.__createStatusBar"></a>
428 <h4>PdfViewerWindow.__createStatusBar</h4> 427 <h4>PdfViewerWindow.__createStatusBar</h4>
429 <b>__createStatusBar</b>(<i></i>) 428 <b>__createStatusBar</b>(<i></i>)
430
431 <p> 429 <p>
432 Private method to initialize the status bar. 430 Private method to initialize the status bar.
433 </p> 431 </p>
432
434 <a NAME="PdfViewerWindow.__displayModeSelected" ID="PdfViewerWindow.__displayModeSelected"></a> 433 <a NAME="PdfViewerWindow.__displayModeSelected" ID="PdfViewerWindow.__displayModeSelected"></a>
435 <h4>PdfViewerWindow.__displayModeSelected</h4> 434 <h4>PdfViewerWindow.__displayModeSelected</h4>
436 <b>__displayModeSelected</b>(<i>act</i>) 435 <b>__displayModeSelected</b>(<i>act</i>)
437
438 <p> 436 <p>
439 Private slot to handle the selection of a display mode. 437 Private slot to handle the selection of a display mode.
440 </p> 438 </p>
439
441 <dl> 440 <dl>
442 441
443 <dt><i>act</i> (QAction)</dt> 442 <dt><i>act</i> (QAction)</dt>
444 <dd> 443 <dd>
445 reference to the triggering action 444 reference to the triggering action
446 </dd> 445 </dd>
447 </dl> 446 </dl>
448 <a NAME="PdfViewerWindow.__endDocument" ID="PdfViewerWindow.__endDocument"></a> 447 <a NAME="PdfViewerWindow.__endDocument" ID="PdfViewerWindow.__endDocument"></a>
449 <h4>PdfViewerWindow.__endDocument</h4> 448 <h4>PdfViewerWindow.__endDocument</h4>
450 <b>__endDocument</b>(<i></i>) 449 <b>__endDocument</b>(<i></i>)
451
452 <p> 450 <p>
453 Private slot to go to the last page of the document. 451 Private slot to go to the last page of the document.
454 </p> 452 </p>
453
455 <a NAME="PdfViewerWindow.__forwardInHistory" ID="PdfViewerWindow.__forwardInHistory"></a> 454 <a NAME="PdfViewerWindow.__forwardInHistory" ID="PdfViewerWindow.__forwardInHistory"></a>
456 <h4>PdfViewerWindow.__forwardInHistory</h4> 455 <h4>PdfViewerWindow.__forwardInHistory</h4>
457 <b>__forwardInHistory</b>(<i></i>) 456 <b>__forwardInHistory</b>(<i></i>)
458
459 <p> 457 <p>
460 Private slot to go forward in the view history. 458 Private slot to go forward in the view history.
461 </p> 459 </p>
460
462 <a NAME="PdfViewerWindow.__getErrorString" ID="PdfViewerWindow.__getErrorString"></a> 461 <a NAME="PdfViewerWindow.__getErrorString" ID="PdfViewerWindow.__getErrorString"></a>
463 <h4>PdfViewerWindow.__getErrorString</h4> 462 <h4>PdfViewerWindow.__getErrorString</h4>
464 <b>__getErrorString</b>(<i>err</i>) 463 <b>__getErrorString</b>(<i>err</i>)
465
466 <p> 464 <p>
467 Private method to get an error string for the given error. 465 Private method to get an error string for the given error.
468 </p> 466 </p>
467
469 <dl> 468 <dl>
470 469
471 <dt><i>err</i> (QPdfDocument.Error)</dt> 470 <dt><i>err</i> (QPdfDocument.Error)</dt>
472 <dd> 471 <dd>
473 error type 472 error type
486 </dd> 485 </dd>
487 </dl> 486 </dl>
488 <a NAME="PdfViewerWindow.__gotoPage" ID="PdfViewerWindow.__gotoPage"></a> 487 <a NAME="PdfViewerWindow.__gotoPage" ID="PdfViewerWindow.__gotoPage"></a>
489 <h4>PdfViewerWindow.__gotoPage</h4> 488 <h4>PdfViewerWindow.__gotoPage</h4>
490 <b>__gotoPage</b>(<i></i>) 489 <b>__gotoPage</b>(<i></i>)
491
492 <p> 490 <p>
493 Private slot to show a dialog to select a page to jump to. 491 Private slot to show a dialog to select a page to jump to.
494 </p> 492 </p>
493
495 <a NAME="PdfViewerWindow.__handleSearchResult" ID="PdfViewerWindow.__handleSearchResult"></a> 494 <a NAME="PdfViewerWindow.__handleSearchResult" ID="PdfViewerWindow.__handleSearchResult"></a>
496 <h4>PdfViewerWindow.__handleSearchResult</h4> 495 <h4>PdfViewerWindow.__handleSearchResult</h4>
497 <b>__handleSearchResult</b>(<i>link</i>) 496 <b>__handleSearchResult</b>(<i>link</i>)
498
499 <p> 497 <p>
500 Private slot to handle the selection of a search result. 498 Private slot to handle the selection of a search result.
501 </p> 499 </p>
500
502 <dl> 501 <dl>
503 502
504 <dt><i>link</i> (QPdfLink)</dt> 503 <dt><i>link</i> (QPdfLink)</dt>
505 <dd> 504 <dd>
506 PDF link to navigate to 505 PDF link to navigate to
507 </dd> 506 </dd>
508 </dl> 507 </dl>
509 <a NAME="PdfViewerWindow.__initActions" ID="PdfViewerWindow.__initActions"></a> 508 <a NAME="PdfViewerWindow.__initActions" ID="PdfViewerWindow.__initActions"></a>
510 <h4>PdfViewerWindow.__initActions</h4> 509 <h4>PdfViewerWindow.__initActions</h4>
511 <b>__initActions</b>(<i></i>) 510 <b>__initActions</b>(<i></i>)
512
513 <p> 511 <p>
514 Private method to define the user interface actions. 512 Private method to define the user interface actions.
515 </p> 513 </p>
514
516 <a NAME="PdfViewerWindow.__initEditActions" ID="PdfViewerWindow.__initEditActions"></a> 515 <a NAME="PdfViewerWindow.__initEditActions" ID="PdfViewerWindow.__initEditActions"></a>
517 <h4>PdfViewerWindow.__initEditActions</h4> 516 <h4>PdfViewerWindow.__initEditActions</h4>
518 <b>__initEditActions</b>(<i></i>) 517 <b>__initEditActions</b>(<i></i>)
519
520 <p> 518 <p>
521 Private method to create the Edit actions. 519 Private method to create the Edit actions.
522 </p> 520 </p>
521
523 <a NAME="PdfViewerWindow.__initFileActions" ID="PdfViewerWindow.__initFileActions"></a> 522 <a NAME="PdfViewerWindow.__initFileActions" ID="PdfViewerWindow.__initFileActions"></a>
524 <h4>PdfViewerWindow.__initFileActions</h4> 523 <h4>PdfViewerWindow.__initFileActions</h4>
525 <b>__initFileActions</b>(<i></i>) 524 <b>__initFileActions</b>(<i></i>)
526
527 <p> 525 <p>
528 Private method to define the file related user interface actions. 526 Private method to define the file related user interface actions.
529 </p> 527 </p>
528
530 <a NAME="PdfViewerWindow.__initGotoActions" ID="PdfViewerWindow.__initGotoActions"></a> 529 <a NAME="PdfViewerWindow.__initGotoActions" ID="PdfViewerWindow.__initGotoActions"></a>
531 <h4>PdfViewerWindow.__initGotoActions</h4> 530 <h4>PdfViewerWindow.__initGotoActions</h4>
532 <b>__initGotoActions</b>(<i></i>) 531 <b>__initGotoActions</b>(<i></i>)
533
534 <p> 532 <p>
535 Private method to define the navigation related user interface actions. 533 Private method to define the navigation related user interface actions.
536 </p> 534 </p>
535
537 <a NAME="PdfViewerWindow.__initHelpActions" ID="PdfViewerWindow.__initHelpActions"></a> 536 <a NAME="PdfViewerWindow.__initHelpActions" ID="PdfViewerWindow.__initHelpActions"></a>
538 <h4>PdfViewerWindow.__initHelpActions</h4> 537 <h4>PdfViewerWindow.__initHelpActions</h4>
539 <b>__initHelpActions</b>(<i></i>) 538 <b>__initHelpActions</b>(<i></i>)
540
541 <p> 539 <p>
542 Private method to create the Help actions. 540 Private method to create the Help actions.
543 </p> 541 </p>
542
544 <a NAME="PdfViewerWindow.__initMenus" ID="PdfViewerWindow.__initMenus"></a> 543 <a NAME="PdfViewerWindow.__initMenus" ID="PdfViewerWindow.__initMenus"></a>
545 <h4>PdfViewerWindow.__initMenus</h4> 544 <h4>PdfViewerWindow.__initMenus</h4>
546 <b>__initMenus</b>(<i></i>) 545 <b>__initMenus</b>(<i></i>)
547
548 <p> 546 <p>
549 Private method to create the menus. 547 Private method to create the menus.
550 </p> 548 </p>
549
551 <a NAME="PdfViewerWindow.__initSettingsActions" ID="PdfViewerWindow.__initSettingsActions"></a> 550 <a NAME="PdfViewerWindow.__initSettingsActions" ID="PdfViewerWindow.__initSettingsActions"></a>
552 <h4>PdfViewerWindow.__initSettingsActions</h4> 551 <h4>PdfViewerWindow.__initSettingsActions</h4>
553 <b>__initSettingsActions</b>(<i></i>) 552 <b>__initSettingsActions</b>(<i></i>)
554
555 <p> 553 <p>
556 Private method to create the Settings actions. 554 Private method to create the Settings actions.
557 </p> 555 </p>
556
558 <a NAME="PdfViewerWindow.__initToolbars" ID="PdfViewerWindow.__initToolbars"></a> 557 <a NAME="PdfViewerWindow.__initToolbars" ID="PdfViewerWindow.__initToolbars"></a>
559 <h4>PdfViewerWindow.__initToolbars</h4> 558 <h4>PdfViewerWindow.__initToolbars</h4>
560 <b>__initToolbars</b>(<i></i>) 559 <b>__initToolbars</b>(<i></i>)
561
562 <p> 560 <p>
563 Private method to create the toolbars. 561 Private method to create the toolbars.
564 </p> 562 </p>
563
565 <a NAME="PdfViewerWindow.__initViewActions" ID="PdfViewerWindow.__initViewActions"></a> 564 <a NAME="PdfViewerWindow.__initViewActions" ID="PdfViewerWindow.__initViewActions"></a>
566 <h4>PdfViewerWindow.__initViewActions</h4> 565 <h4>PdfViewerWindow.__initViewActions</h4>
567 <b>__initViewActions</b>(<i></i>) 566 <b>__initViewActions</b>(<i></i>)
568
569 <p> 567 <p>
570 Private method to define the view related user interface actions. 568 Private method to define the view related user interface actions.
571 </p> 569 </p>
570
572 <a NAME="PdfViewerWindow.__loadPdfFile" ID="PdfViewerWindow.__loadPdfFile"></a> 571 <a NAME="PdfViewerWindow.__loadPdfFile" ID="PdfViewerWindow.__loadPdfFile"></a>
573 <h4>PdfViewerWindow.__loadPdfFile</h4> 572 <h4>PdfViewerWindow.__loadPdfFile</h4>
574 <b>__loadPdfFile</b>(<i>fileName</i>) 573 <b>__loadPdfFile</b>(<i>fileName</i>)
575
576 <p> 574 <p>
577 Private method to load a PDF file. 575 Private method to load a PDF file.
578 </p> 576 </p>
577
579 <dl> 578 <dl>
580 579
581 <dt><i>fileName</i> (str)</dt> 580 <dt><i>fileName</i> (str)</dt>
582 <dd> 581 <dd>
583 path of the PDF file to load 582 path of the PDF file to load
584 </dd> 583 </dd>
585 </dl> 584 </dl>
586 <a NAME="PdfViewerWindow.__loadRecent" ID="PdfViewerWindow.__loadRecent"></a> 585 <a NAME="PdfViewerWindow.__loadRecent" ID="PdfViewerWindow.__loadRecent"></a>
587 <h4>PdfViewerWindow.__loadRecent</h4> 586 <h4>PdfViewerWindow.__loadRecent</h4>
588 <b>__loadRecent</b>(<i></i>) 587 <b>__loadRecent</b>(<i></i>)
589
590 <p> 588 <p>
591 Private method to load the list of recently opened files. 589 Private method to load the list of recently opened files.
592 </p> 590 </p>
591
593 <a NAME="PdfViewerWindow.__nextPage" ID="PdfViewerWindow.__nextPage"></a> 592 <a NAME="PdfViewerWindow.__nextPage" ID="PdfViewerWindow.__nextPage"></a>
594 <h4>PdfViewerWindow.__nextPage</h4> 593 <h4>PdfViewerWindow.__nextPage</h4>
595 <b>__nextPage</b>(<i></i>) 594 <b>__nextPage</b>(<i></i>)
596
597 <p> 595 <p>
598 Private slot to go to the next page. 596 Private slot to go to the next page.
599 </p> 597 </p>
598
600 <a NAME="PdfViewerWindow.__openPdfFile" ID="PdfViewerWindow.__openPdfFile"></a> 599 <a NAME="PdfViewerWindow.__openPdfFile" ID="PdfViewerWindow.__openPdfFile"></a>
601 <h4>PdfViewerWindow.__openPdfFile</h4> 600 <h4>PdfViewerWindow.__openPdfFile</h4>
602 <b>__openPdfFile</b>(<i></i>) 601 <b>__openPdfFile</b>(<i></i>)
603
604 <p> 602 <p>
605 Private slot to open a PDF file. 603 Private slot to open a PDF file.
606 </p> 604 </p>
605
607 <a NAME="PdfViewerWindow.__openPdfFileNewWindow" ID="PdfViewerWindow.__openPdfFileNewWindow"></a> 606 <a NAME="PdfViewerWindow.__openPdfFileNewWindow" ID="PdfViewerWindow.__openPdfFileNewWindow"></a>
608 <h4>PdfViewerWindow.__openPdfFileNewWindow</h4> 607 <h4>PdfViewerWindow.__openPdfFileNewWindow</h4>
609 <b>__openPdfFileNewWindow</b>(<i>fileName=""</i>) 608 <b>__openPdfFileNewWindow</b>(<i>fileName=""</i>)
610
611 <p> 609 <p>
612 Private slot called to open a PDF file in new viewer window. 610 Private slot called to open a PDF file in new viewer window.
613 </p> 611 </p>
612
614 <dl> 613 <dl>
615 614
616 <dt><i>fileName</i> (str (optional))</dt> 615 <dt><i>fileName</i> (str (optional))</dt>
617 <dd> 616 <dd>
618 name of the file to open (defaults to "") 617 name of the file to open (defaults to "")
619 </dd> 618 </dd>
620 </dl> 619 </dl>
621 <a NAME="PdfViewerWindow.__openRecentPdfFile" ID="PdfViewerWindow.__openRecentPdfFile"></a> 620 <a NAME="PdfViewerWindow.__openRecentPdfFile" ID="PdfViewerWindow.__openRecentPdfFile"></a>
622 <h4>PdfViewerWindow.__openRecentPdfFile</h4> 621 <h4>PdfViewerWindow.__openRecentPdfFile</h4>
623 <b>__openRecentPdfFile</b>(<i>act</i>) 622 <b>__openRecentPdfFile</b>(<i>act</i>)
624
625 <p> 623 <p>
626 Private method to open a file from the list of recently opened files. 624 Private method to open a file from the list of recently opened files.
627 </p> 625 </p>
626
628 <dl> 627 <dl>
629 628
630 <dt><i>act</i> (QAction)</dt> 629 <dt><i>act</i> (QAction)</dt>
631 <dd> 630 <dd>
632 reference to the action that triggered 631 reference to the action that triggered
633 </dd> 632 </dd>
634 </dl> 633 </dl>
635 <a NAME="PdfViewerWindow.__pageSelected" ID="PdfViewerWindow.__pageSelected"></a> 634 <a NAME="PdfViewerWindow.__pageSelected" ID="PdfViewerWindow.__pageSelected"></a>
636 <h4>PdfViewerWindow.__pageSelected</h4> 635 <h4>PdfViewerWindow.__pageSelected</h4>
637 <b>__pageSelected</b>(<i>page</i>) 636 <b>__pageSelected</b>(<i>page</i>)
638
639 <p> 637 <p>
640 Private slot to navigate to the given page. 638 Private slot to navigate to the given page.
641 </p> 639 </p>
640
642 <dl> 641 <dl>
643 642
644 <dt><i>page</i> (int)</dt> 643 <dt><i>page</i> (int)</dt>
645 <dd> 644 <dd>
646 index of the page to be shown 645 index of the page to be shown
647 </dd> 646 </dd>
648 </dl> 647 </dl>
649 <a NAME="PdfViewerWindow.__previousPage" ID="PdfViewerWindow.__previousPage"></a> 648 <a NAME="PdfViewerWindow.__previousPage" ID="PdfViewerWindow.__previousPage"></a>
650 <h4>PdfViewerWindow.__previousPage</h4> 649 <h4>PdfViewerWindow.__previousPage</h4>
651 <b>__previousPage</b>(<i></i>) 650 <b>__previousPage</b>(<i></i>)
652
653 <p> 651 <p>
654 Private slot to go to the previous page. 652 Private slot to go to the previous page.
655 </p> 653 </p>
654
656 <a NAME="PdfViewerWindow.__reload" ID="PdfViewerWindow.__reload"></a> 655 <a NAME="PdfViewerWindow.__reload" ID="PdfViewerWindow.__reload"></a>
657 <h4>PdfViewerWindow.__reload</h4> 656 <h4>PdfViewerWindow.__reload</h4>
658 <b>__reload</b>(<i></i>) 657 <b>__reload</b>(<i></i>)
659
660 <p> 658 <p>
661 Private slot to reload the current PDF document. 659 Private slot to reload the current PDF document.
662 </p> 660 </p>
661
663 <a NAME="PdfViewerWindow.__restoreViewerState" ID="PdfViewerWindow.__restoreViewerState"></a> 662 <a NAME="PdfViewerWindow.__restoreViewerState" ID="PdfViewerWindow.__restoreViewerState"></a>
664 <h4>PdfViewerWindow.__restoreViewerState</h4> 663 <h4>PdfViewerWindow.__restoreViewerState</h4>
665 <b>__restoreViewerState</b>(<i></i>) 664 <b>__restoreViewerState</b>(<i></i>)
666
667 <p> 665 <p>
668 Private method to restore the PDF Viewer state data. 666 Private method to restore the PDF Viewer state data.
669 </p> 667 </p>
668
670 <a NAME="PdfViewerWindow.__saveRecent" ID="PdfViewerWindow.__saveRecent"></a> 669 <a NAME="PdfViewerWindow.__saveRecent" ID="PdfViewerWindow.__saveRecent"></a>
671 <h4>PdfViewerWindow.__saveRecent</h4> 670 <h4>PdfViewerWindow.__saveRecent</h4>
672 <b>__saveRecent</b>(<i></i>) 671 <b>__saveRecent</b>(<i></i>)
673
674 <p> 672 <p>
675 Private method to save the list of recently opened files. 673 Private method to save the list of recently opened files.
676 </p> 674 </p>
675
677 <a NAME="PdfViewerWindow.__saveViewerState" ID="PdfViewerWindow.__saveViewerState"></a> 676 <a NAME="PdfViewerWindow.__saveViewerState" ID="PdfViewerWindow.__saveViewerState"></a>
678 <h4>PdfViewerWindow.__saveViewerState</h4> 677 <h4>PdfViewerWindow.__saveViewerState</h4>
679 <b>__saveViewerState</b>(<i></i>) 678 <b>__saveViewerState</b>(<i></i>)
680
681 <p> 679 <p>
682 Private method to save the PDF Viewer state data. 680 Private method to save the PDF Viewer state data.
683 </p> 681 </p>
682
684 <a NAME="PdfViewerWindow.__search" ID="PdfViewerWindow.__search"></a> 683 <a NAME="PdfViewerWindow.__search" ID="PdfViewerWindow.__search"></a>
685 <h4>PdfViewerWindow.__search</h4> 684 <h4>PdfViewerWindow.__search</h4>
686 <b>__search</b>(<i></i>) 685 <b>__search</b>(<i></i>)
687
688 <p> 686 <p>
689 Private slot to initiate a search. 687 Private slot to initiate a search.
690 </p> 688 </p>
689
691 <a NAME="PdfViewerWindow.__setCurrentFile" ID="PdfViewerWindow.__setCurrentFile"></a> 690 <a NAME="PdfViewerWindow.__setCurrentFile" ID="PdfViewerWindow.__setCurrentFile"></a>
692 <h4>PdfViewerWindow.__setCurrentFile</h4> 691 <h4>PdfViewerWindow.__setCurrentFile</h4>
693 <b>__setCurrentFile</b>(<i>fileName</i>) 692 <b>__setCurrentFile</b>(<i>fileName</i>)
694
695 <p> 693 <p>
696 Private method to register the file name of the current file. 694 Private method to register the file name of the current file.
697 </p> 695 </p>
696
698 <dl> 697 <dl>
699 698
700 <dt><i>fileName</i> (str)</dt> 699 <dt><i>fileName</i> (str)</dt>
701 <dd> 700 <dd>
702 name of the file to register 701 name of the file to register
703 </dd> 702 </dd>
704 </dl> 703 </dl>
705 <a NAME="PdfViewerWindow.__setDisplayMode" ID="PdfViewerWindow.__setDisplayMode"></a> 704 <a NAME="PdfViewerWindow.__setDisplayMode" ID="PdfViewerWindow.__setDisplayMode"></a>
706 <h4>PdfViewerWindow.__setDisplayMode</h4> 705 <h4>PdfViewerWindow.__setDisplayMode</h4>
707 <b>__setDisplayMode</b>(<i></i>) 706 <b>__setDisplayMode</b>(<i></i>)
708
709 <p> 707 <p>
710 Private method to set the display mode iaw. configuration. 708 Private method to set the display mode iaw. configuration.
711 </p> 709 </p>
710
712 <a NAME="PdfViewerWindow.__setViewerTitle" ID="PdfViewerWindow.__setViewerTitle"></a> 711 <a NAME="PdfViewerWindow.__setViewerTitle" ID="PdfViewerWindow.__setViewerTitle"></a>
713 <h4>PdfViewerWindow.__setViewerTitle</h4> 712 <h4>PdfViewerWindow.__setViewerTitle</h4>
714 <b>__setViewerTitle</b>(<i>title</i>) 713 <b>__setViewerTitle</b>(<i>title</i>)
715
716 <p> 714 <p>
717 Private method to set the viewer title. 715 Private method to set the viewer title.
718 </p> 716 </p>
717
719 <dl> 718 <dl>
720 719
721 <dt><i>title</i> (str)</dt> 720 <dt><i>title</i> (str)</dt>
722 <dd> 721 <dd>
723 title to be set 722 title to be set
724 </dd> 723 </dd>
725 </dl> 724 </dl>
726 <a NAME="PdfViewerWindow.__showDocumentProperties" ID="PdfViewerWindow.__showDocumentProperties"></a> 725 <a NAME="PdfViewerWindow.__showDocumentProperties" ID="PdfViewerWindow.__showDocumentProperties"></a>
727 <h4>PdfViewerWindow.__showDocumentProperties</h4> 726 <h4>PdfViewerWindow.__showDocumentProperties</h4>
728 <b>__showDocumentProperties</b>(<i></i>) 727 <b>__showDocumentProperties</b>(<i></i>)
729
730 <p> 728 <p>
731 Private slot to open a dialog showing the document properties. 729 Private slot to open a dialog showing the document properties.
732 </p> 730 </p>
731
733 <a NAME="PdfViewerWindow.__showFileMenu" ID="PdfViewerWindow.__showFileMenu"></a> 732 <a NAME="PdfViewerWindow.__showFileMenu" ID="PdfViewerWindow.__showFileMenu"></a>
734 <h4>PdfViewerWindow.__showFileMenu</h4> 733 <h4>PdfViewerWindow.__showFileMenu</h4>
735 <b>__showFileMenu</b>(<i></i>) 734 <b>__showFileMenu</b>(<i></i>)
736
737 <p> 735 <p>
738 Private slot to modify the file menu before being shown. 736 Private slot to modify the file menu before being shown.
739 </p> 737 </p>
738
740 <a NAME="PdfViewerWindow.__showPreferences" ID="PdfViewerWindow.__showPreferences"></a> 739 <a NAME="PdfViewerWindow.__showPreferences" ID="PdfViewerWindow.__showPreferences"></a>
741 <h4>PdfViewerWindow.__showPreferences</h4> 740 <h4>PdfViewerWindow.__showPreferences</h4>
742 <b>__showPreferences</b>(<i></i>) 741 <b>__showPreferences</b>(<i></i>)
743
744 <p> 742 <p>
745 Private slot to set the preferences. 743 Private slot to set the preferences.
746 </p> 744 </p>
745
747 <a NAME="PdfViewerWindow.__showRecentMenu" ID="PdfViewerWindow.__showRecentMenu"></a> 746 <a NAME="PdfViewerWindow.__showRecentMenu" ID="PdfViewerWindow.__showRecentMenu"></a>
748 <h4>PdfViewerWindow.__showRecentMenu</h4> 747 <h4>PdfViewerWindow.__showRecentMenu</h4>
749 <b>__showRecentMenu</b>(<i></i>) 748 <b>__showRecentMenu</b>(<i></i>)
750
751 <p> 749 <p>
752 Private slot to set up the recent files menu. 750 Private slot to set up the recent files menu.
753 </p> 751 </p>
752
754 <a NAME="PdfViewerWindow.__startDocument" ID="PdfViewerWindow.__startDocument"></a> 753 <a NAME="PdfViewerWindow.__startDocument" ID="PdfViewerWindow.__startDocument"></a>
755 <h4>PdfViewerWindow.__startDocument</h4> 754 <h4>PdfViewerWindow.__startDocument</h4>
756 <b>__startDocument</b>(<i></i>) 755 <b>__startDocument</b>(<i></i>)
757
758 <p> 756 <p>
759 Private slot to go to the first page of the document. 757 Private slot to go to the first page of the document.
760 </p> 758 </p>
759
761 <a NAME="PdfViewerWindow.__tocActivated" ID="PdfViewerWindow.__tocActivated"></a> 760 <a NAME="PdfViewerWindow.__tocActivated" ID="PdfViewerWindow.__tocActivated"></a>
762 <h4>PdfViewerWindow.__tocActivated</h4> 761 <h4>PdfViewerWindow.__tocActivated</h4>
763 <b>__tocActivated</b>(<i>page, zoomFactor</i>) 762 <b>__tocActivated</b>(<i>page, zoomFactor</i>)
764
765 <p> 763 <p>
766 Private slot to handle the selection of a ToC topic. 764 Private slot to handle the selection of a ToC topic.
767 </p> 765 </p>
766
768 <dl> 767 <dl>
769 768
770 <dt><i>page</i> (int)</dt> 769 <dt><i>page</i> (int)</dt>
771 <dd> 770 <dd>
772 page number 771 page number
777 </dd> 776 </dd>
778 </dl> 777 </dl>
779 <a NAME="PdfViewerWindow.__toggleFullScreen" ID="PdfViewerWindow.__toggleFullScreen"></a> 778 <a NAME="PdfViewerWindow.__toggleFullScreen" ID="PdfViewerWindow.__toggleFullScreen"></a>
780 <h4>PdfViewerWindow.__toggleFullScreen</h4> 779 <h4>PdfViewerWindow.__toggleFullScreen</h4>
781 <b>__toggleFullScreen</b>(<i>on</i>) 780 <b>__toggleFullScreen</b>(<i>on</i>)
782
783 <p> 781 <p>
784 Private slot to toggle the full screen mode. 782 Private slot to toggle the full screen mode.
785 </p> 783 </p>
784
786 <dl> 785 <dl>
787 786
788 <dt><i>on</i> (bool)</dt> 787 <dt><i>on</i> (bool)</dt>
789 <dd> 788 <dd>
790 flag indicating to activate full screen mode 789 flag indicating to activate full screen mode
791 </dd> 790 </dd>
792 </dl> 791 </dl>
793 <a NAME="PdfViewerWindow.__toggleOpenRecentNew" ID="PdfViewerWindow.__toggleOpenRecentNew"></a> 792 <a NAME="PdfViewerWindow.__toggleOpenRecentNew" ID="PdfViewerWindow.__toggleOpenRecentNew"></a>
794 <h4>PdfViewerWindow.__toggleOpenRecentNew</h4> 793 <h4>PdfViewerWindow.__toggleOpenRecentNew</h4>
795 <b>__toggleOpenRecentNew</b>(<i>on</i>) 794 <b>__toggleOpenRecentNew</b>(<i>on</i>)
796
797 <p> 795 <p>
798 Private slot to toggle the 'Open Recent File in New Window' action. 796 Private slot to toggle the 'Open Recent File in New Window' action.
799 </p> 797 </p>
798
800 <dl> 799 <dl>
801 800
802 <dt><i>on</i> (bool)</dt> 801 <dt><i>on</i> (bool)</dt>
803 <dd> 802 <dd>
804 desired state of the action 803 desired state of the action
805 </dd> 804 </dd>
806 </dl> 805 </dl>
807 <a NAME="PdfViewerWindow.__toggleSideBar" ID="PdfViewerWindow.__toggleSideBar"></a> 806 <a NAME="PdfViewerWindow.__toggleSideBar" ID="PdfViewerWindow.__toggleSideBar"></a>
808 <h4>PdfViewerWindow.__toggleSideBar</h4> 807 <h4>PdfViewerWindow.__toggleSideBar</h4>
809 <b>__toggleSideBar</b>(<i>visible</i>) 808 <b>__toggleSideBar</b>(<i>visible</i>)
810
811 <p> 809 <p>
812 Private slot to togle the sidebar (info) widget. 810 Private slot to togle the sidebar (info) widget.
813 </p> 811 </p>
812
814 <dl> 813 <dl>
815 814
816 <dt><i>visible</i> (bool)</dt> 815 <dt><i>visible</i> (bool)</dt>
817 <dd> 816 <dd>
818 desired state of the sidebar 817 desired state of the sidebar
819 </dd> 818 </dd>
820 </dl> 819 </dl>
821 <a NAME="PdfViewerWindow.__whatsThis" ID="PdfViewerWindow.__whatsThis"></a> 820 <a NAME="PdfViewerWindow.__whatsThis" ID="PdfViewerWindow.__whatsThis"></a>
822 <h4>PdfViewerWindow.__whatsThis</h4> 821 <h4>PdfViewerWindow.__whatsThis</h4>
823 <b>__whatsThis</b>(<i></i>) 822 <b>__whatsThis</b>(<i></i>)
824
825 <p> 823 <p>
826 Private slot called in to enter Whats This mode. 824 Private slot called in to enter Whats This mode.
827 </p> 825 </p>
826
828 <a NAME="PdfViewerWindow.__zoomIn" ID="PdfViewerWindow.__zoomIn"></a> 827 <a NAME="PdfViewerWindow.__zoomIn" ID="PdfViewerWindow.__zoomIn"></a>
829 <h4>PdfViewerWindow.__zoomIn</h4> 828 <h4>PdfViewerWindow.__zoomIn</h4>
830 <b>__zoomIn</b>(<i></i>) 829 <b>__zoomIn</b>(<i></i>)
831
832 <p> 830 <p>
833 Private slot to zoom into the view. 831 Private slot to zoom into the view.
834 </p> 832 </p>
833
835 <a NAME="PdfViewerWindow.__zoomModeChanged" ID="PdfViewerWindow.__zoomModeChanged"></a> 834 <a NAME="PdfViewerWindow.__zoomModeChanged" ID="PdfViewerWindow.__zoomModeChanged"></a>
836 <h4>PdfViewerWindow.__zoomModeChanged</h4> 835 <h4>PdfViewerWindow.__zoomModeChanged</h4>
837 <b>__zoomModeChanged</b>(<i>zoomMode</i>) 836 <b>__zoomModeChanged</b>(<i>zoomMode</i>)
838
839 <p> 837 <p>
840 Private slot to handle a change of the zoom mode. 838 Private slot to handle a change of the zoom mode.
841 </p> 839 </p>
840
842 <dl> 841 <dl>
843 842
844 <dt><i>zoomMode</i> (QPdfView.ZoomMode)</dt> 843 <dt><i>zoomMode</i> (QPdfView.ZoomMode)</dt>
845 <dd> 844 <dd>
846 new zoom mode 845 new zoom mode
847 </dd> 846 </dd>
848 </dl> 847 </dl>
849 <a NAME="PdfViewerWindow.__zoomOut" ID="PdfViewerWindow.__zoomOut"></a> 848 <a NAME="PdfViewerWindow.__zoomOut" ID="PdfViewerWindow.__zoomOut"></a>
850 <h4>PdfViewerWindow.__zoomOut</h4> 849 <h4>PdfViewerWindow.__zoomOut</h4>
851 <b>__zoomOut</b>(<i></i>) 850 <b>__zoomOut</b>(<i></i>)
852
853 <p> 851 <p>
854 Private slot to zoom out of the view. 852 Private slot to zoom out of the view.
855 </p> 853 </p>
854
856 <a NAME="PdfViewerWindow.__zoomPageWidth" ID="PdfViewerWindow.__zoomPageWidth"></a> 855 <a NAME="PdfViewerWindow.__zoomPageWidth" ID="PdfViewerWindow.__zoomPageWidth"></a>
857 <h4>PdfViewerWindow.__zoomPageWidth</h4> 856 <h4>PdfViewerWindow.__zoomPageWidth</h4>
858 <b>__zoomPageWidth</b>(<i>checked</i>) 857 <b>__zoomPageWidth</b>(<i>checked</i>)
859
860 <p> 858 <p>
861 Private slot to fit the page width. 859 Private slot to fit the page width.
862 </p> 860 </p>
861
863 <dl> 862 <dl>
864 863
865 <dt><i>checked</i> (bool)</dt> 864 <dt><i>checked</i> (bool)</dt>
866 <dd> 865 <dd>
867 flag indicating the check state 866 flag indicating the check state
868 </dd> 867 </dd>
869 </dl> 868 </dl>
870 <a NAME="PdfViewerWindow.__zoomReset" ID="PdfViewerWindow.__zoomReset"></a> 869 <a NAME="PdfViewerWindow.__zoomReset" ID="PdfViewerWindow.__zoomReset"></a>
871 <h4>PdfViewerWindow.__zoomReset</h4> 870 <h4>PdfViewerWindow.__zoomReset</h4>
872 <b>__zoomReset</b>(<i></i>) 871 <b>__zoomReset</b>(<i></i>)
873
874 <p> 872 <p>
875 Private slot to reset the zoom factor of the view. 873 Private slot to reset the zoom factor of the view.
876 </p> 874 </p>
875
877 <a NAME="PdfViewerWindow.__zoomWholePage" ID="PdfViewerWindow.__zoomWholePage"></a> 876 <a NAME="PdfViewerWindow.__zoomWholePage" ID="PdfViewerWindow.__zoomWholePage"></a>
878 <h4>PdfViewerWindow.__zoomWholePage</h4> 877 <h4>PdfViewerWindow.__zoomWholePage</h4>
879 <b>__zoomWholePage</b>(<i>checked</i>) 878 <b>__zoomWholePage</b>(<i>checked</i>)
880
881 <p> 879 <p>
882 Private slot to fit the page width. 880 Private slot to fit the page width.
883 </p> 881 </p>
882
884 <dl> 883 <dl>
885 884
886 <dt><i>checked</i> (bool)</dt> 885 <dt><i>checked</i> (bool)</dt>
887 <dd> 886 <dd>
888 flag indicating the check state 887 flag indicating the check state
889 </dd> 888 </dd>
890 </dl> 889 </dl>
891 <a NAME="PdfViewerWindow.closeEvent" ID="PdfViewerWindow.closeEvent"></a> 890 <a NAME="PdfViewerWindow.closeEvent" ID="PdfViewerWindow.closeEvent"></a>
892 <h4>PdfViewerWindow.closeEvent</h4> 891 <h4>PdfViewerWindow.closeEvent</h4>
893 <b>closeEvent</b>(<i>evt</i>) 892 <b>closeEvent</b>(<i>evt</i>)
894
895 <p> 893 <p>
896 Protected method handling the close event. 894 Protected method handling the close event.
897 </p> 895 </p>
896
898 <dl> 897 <dl>
899 898
900 <dt><i>evt</i> (QCloseEvent)</dt> 899 <dt><i>evt</i> (QCloseEvent)</dt>
901 <dd> 900 <dd>
902 reference to the close event 901 reference to the close event

eric ide

mercurial