Documentation/Source/eric5.Tools.TRPreviewer.html

changeset 526
f51eb1f0ab40
parent 513
a5329d7867c5
child 767
27554f80d08f
equal deleted inserted replaced
525:400b72e2602a 526:f51eb1f0ab40
38 <td>Class to store the properties of a translation</td> 38 <td>Class to store the properties of a translation</td>
39 </tr><tr> 39 </tr><tr>
40 <td><a href="#TranslationsDict">TranslationsDict</a></td> 40 <td><a href="#TranslationsDict">TranslationsDict</a></td>
41 <td>Class to store all loaded translations.</td> 41 <td>Class to store all loaded translations.</td>
42 </tr><tr> 42 </tr><tr>
43 <td><a href="#WidgetArea">WidgetArea</a></td>
44 <td>Specialized MDI area to show the loaded widgets.</td>
45 </tr><tr>
43 <td><a href="#WidgetView">WidgetView</a></td> 46 <td><a href="#WidgetView">WidgetView</a></td>
44 <td>Class to show a dynamically loaded widget (or dialog).</td> 47 <td>Class to show a dynamically loaded widget (or dialog).</td>
45 </tr><tr>
46 <td><a href="#WidgetWorkspace">WidgetWorkspace</a></td>
47 <td>Specialized workspace to show the loaded widgets.</td>
48 </tr> 48 </tr>
49 </table> 49 </table>
50 <h3>Functions</h3> 50 <h3>Functions</h3>
51 <table> 51 <table>
52 <tr><td>None</td></tr> 52 <tr><td>None</td></tr>
455 name (language) of the translator to set (string) 455 name (language) of the translator to set (string)
456 </dd> 456 </dd>
457 </dl> 457 </dl>
458 <div align="right"><a href="#top">Up</a></div> 458 <div align="right"><a href="#top">Up</a></div>
459 <hr /><hr /> 459 <hr /><hr />
460 <a NAME="WidgetArea" ID="WidgetArea"></a>
461 <h2>WidgetArea</h2>
462 <p>
463 Specialized MDI area to show the loaded widgets.
464 </p><h4>Signals</h4>
465 <dl>
466 <dt>lastWidgetClosed()</dt>
467 <dd>
468 emitted after last widget was closed
469 </dd>
470 </dl>
471 <h3>Derived from</h3>
472 QMdiArea
473 <h3>Class Attributes</h3>
474 <table>
475 <tr><td>lastWidgetClosed</td></tr><tr><td>rebuildWidgets</td></tr>
476 </table>
477 <h3>Methods</h3>
478 <table>
479 <tr>
480 <td><a href="#WidgetArea.__init__">WidgetArea</a></td>
481 <td>Constructor</td>
482 </tr><tr>
483 <td><a href="#WidgetArea.__findWidget">__findWidget</a></td>
484 <td>Private method to find a specific widget view.</td>
485 </tr><tr>
486 <td><a href="#WidgetArea.__toggleWidget">__toggleWidget</a></td>
487 <td>Private method to toggle a workspace window.</td>
488 </tr><tr>
489 <td><a href="#WidgetArea.closeAllWidgets">closeAllWidgets</a></td>
490 <td>Public slot to close all windows.</td>
491 </tr><tr>
492 <td><a href="#WidgetArea.closeWidget">closeWidget</a></td>
493 <td>Public slot to close the active window.</td>
494 </tr><tr>
495 <td><a href="#WidgetArea.eventFilter">eventFilter</a></td>
496 <td>Protected method called to filter an event.</td>
497 </tr><tr>
498 <td><a href="#WidgetArea.hasWidgets">hasWidgets</a></td>
499 <td>Public method to check for loaded widgets.</td>
500 </tr><tr>
501 <td><a href="#WidgetArea.loadWidget">loadWidget</a></td>
502 <td>Public slot to load a UI file.</td>
503 </tr><tr>
504 <td><a href="#WidgetArea.showWindowMenu">showWindowMenu</a></td>
505 <td>Public method to set up the widgets part of the Window menu.</td>
506 </tr><tr>
507 <td><a href="#WidgetArea.toggleSelectedWidget">toggleSelectedWidget</a></td>
508 <td>Public method to handle the toggle of a window.</td>
509 </tr>
510 </table>
511 <a NAME="WidgetArea.__init__" ID="WidgetArea.__init__"></a>
512 <h4>WidgetArea (Constructor)</h4>
513 <b>WidgetArea</b>(<i>parent = None</i>)
514 <p>
515 Constructor
516 </p><dl>
517 <dt><i>parent</i></dt>
518 <dd>
519 parent widget (QWidget)
520 </dd>
521 </dl><a NAME="WidgetArea.__findWidget" ID="WidgetArea.__findWidget"></a>
522 <h4>WidgetArea.__findWidget</h4>
523 <b>__findWidget</b>(<i>uiFileName</i>)
524 <p>
525 Private method to find a specific widget view.
526 </p><dl>
527 <dt><i>uiFileName</i></dt>
528 <dd>
529 filename of the loaded UI file (string)
530 </dd>
531 </dl><dl>
532 <dt>Returns:</dt>
533 <dd>
534 reference to the widget (WidgetView) or None
535 </dd>
536 </dl><a NAME="WidgetArea.__toggleWidget" ID="WidgetArea.__toggleWidget"></a>
537 <h4>WidgetArea.__toggleWidget</h4>
538 <b>__toggleWidget</b>(<i>w</i>)
539 <p>
540 Private method to toggle a workspace window.
541 </p><dl>
542 <dt><i>w</i></dt>
543 <dd>
544 window to be toggled
545 </dd>
546 </dl><a NAME="WidgetArea.closeAllWidgets" ID="WidgetArea.closeAllWidgets"></a>
547 <h4>WidgetArea.closeAllWidgets</h4>
548 <b>closeAllWidgets</b>(<i></i>)
549 <p>
550 Public slot to close all windows.
551 </p><a NAME="WidgetArea.closeWidget" ID="WidgetArea.closeWidget"></a>
552 <h4>WidgetArea.closeWidget</h4>
553 <b>closeWidget</b>(<i></i>)
554 <p>
555 Public slot to close the active window.
556 </p><a NAME="WidgetArea.eventFilter" ID="WidgetArea.eventFilter"></a>
557 <h4>WidgetArea.eventFilter</h4>
558 <b>eventFilter</b>(<i>obj, ev</i>)
559 <p>
560 Protected method called to filter an event.
561 </p><dl>
562 <dt><i>object</i></dt>
563 <dd>
564 object, that generated the event (QObject)
565 </dd><dt><i>event</i></dt>
566 <dd>
567 the event, that was generated by object (QEvent)
568 </dd>
569 </dl><dl>
570 <dt>Returns:</dt>
571 <dd>
572 flag indicating if event was filtered out
573 </dd>
574 </dl><a NAME="WidgetArea.hasWidgets" ID="WidgetArea.hasWidgets"></a>
575 <h4>WidgetArea.hasWidgets</h4>
576 <b>hasWidgets</b>(<i></i>)
577 <p>
578 Public method to check for loaded widgets.
579 </p><dl>
580 <dt>Returns:</dt>
581 <dd>
582 flag signaling if any widget was loaded (boolean)
583 </dd>
584 </dl><a NAME="WidgetArea.loadWidget" ID="WidgetArea.loadWidget"></a>
585 <h4>WidgetArea.loadWidget</h4>
586 <b>loadWidget</b>(<i>uiFileName</i>)
587 <p>
588 Public slot to load a UI file.
589 </p><dl>
590 <dt><i>uiFileName</i></dt>
591 <dd>
592 name of the UI file to load (string)
593 </dd>
594 </dl><a NAME="WidgetArea.showWindowMenu" ID="WidgetArea.showWindowMenu"></a>
595 <h4>WidgetArea.showWindowMenu</h4>
596 <b>showWindowMenu</b>(<i>windowMenu</i>)
597 <p>
598 Public method to set up the widgets part of the Window menu.
599 </p><dl>
600 <dt><i>windowMenu</i></dt>
601 <dd>
602 reference to the window menu
603 </dd>
604 </dl><a NAME="WidgetArea.toggleSelectedWidget" ID="WidgetArea.toggleSelectedWidget"></a>
605 <h4>WidgetArea.toggleSelectedWidget</h4>
606 <b>toggleSelectedWidget</b>(<i>act</i>)
607 <p>
608 Public method to handle the toggle of a window.
609 </p><dl>
610 <dt><i>act</i></dt>
611 <dd>
612 reference to the action that triggered (QAction)
613 </dd>
614 </dl>
615 <div align="right"><a href="#top">Up</a></div>
616 <hr /><hr />
460 <a NAME="WidgetView" ID="WidgetView"></a> 617 <a NAME="WidgetView" ID="WidgetView"></a>
461 <h2>WidgetView</h2> 618 <h2>WidgetView</h2>
462 <p> 619 <p>
463 Class to show a dynamically loaded widget (or dialog). 620 Class to show a dynamically loaded widget (or dialog).
464 </p> 621 </p>
533 <dd> 690 <dd>
534 filename of the loaded UI file (string) 691 filename of the loaded UI file (string)
535 </dd> 692 </dd>
536 </dl> 693 </dl>
537 <div align="right"><a href="#top">Up</a></div> 694 <div align="right"><a href="#top">Up</a></div>
538 <hr /><hr />
539 <a NAME="WidgetWorkspace" ID="WidgetWorkspace"></a>
540 <h2>WidgetWorkspace</h2>
541 <p>
542 Specialized workspace to show the loaded widgets.
543 </p><h4>Signals</h4>
544 <dl>
545 <dt>lastWidgetClosed()</dt>
546 <dd>
547 emitted after last widget was closed
548 </dd>
549 </dl>
550 <h3>Derived from</h3>
551 QWorkspace
552 <h3>Class Attributes</h3>
553 <table>
554 <tr><td>lastWidgetClosed</td></tr><tr><td>rebuildWidgets</td></tr>
555 </table>
556 <h3>Methods</h3>
557 <table>
558 <tr>
559 <td><a href="#WidgetWorkspace.__init__">WidgetWorkspace</a></td>
560 <td>Constructor</td>
561 </tr><tr>
562 <td><a href="#WidgetWorkspace.__findWidget">__findWidget</a></td>
563 <td>Private method to find a specific widget view.</td>
564 </tr><tr>
565 <td><a href="#WidgetWorkspace.__toggleWidget">__toggleWidget</a></td>
566 <td>Private method to toggle a workspace window.</td>
567 </tr><tr>
568 <td><a href="#WidgetWorkspace.closeAllWidgets">closeAllWidgets</a></td>
569 <td>Public slot to close all windows.</td>
570 </tr><tr>
571 <td><a href="#WidgetWorkspace.closeWidget">closeWidget</a></td>
572 <td>Public slot to close the active window.</td>
573 </tr><tr>
574 <td><a href="#WidgetWorkspace.eventFilter">eventFilter</a></td>
575 <td>Protected method called to filter an event.</td>
576 </tr><tr>
577 <td><a href="#WidgetWorkspace.hasWidgets">hasWidgets</a></td>
578 <td>Public method to check for loaded widgets.</td>
579 </tr><tr>
580 <td><a href="#WidgetWorkspace.loadWidget">loadWidget</a></td>
581 <td>Public slot to load a UI file.</td>
582 </tr><tr>
583 <td><a href="#WidgetWorkspace.showWindowMenu">showWindowMenu</a></td>
584 <td>Public method to set up the widgets part of the Window menu.</td>
585 </tr><tr>
586 <td><a href="#WidgetWorkspace.toggleSelectedWidget">toggleSelectedWidget</a></td>
587 <td>Public method to handle the toggle of a window.</td>
588 </tr>
589 </table>
590 <a NAME="WidgetWorkspace.__init__" ID="WidgetWorkspace.__init__"></a>
591 <h4>WidgetWorkspace (Constructor)</h4>
592 <b>WidgetWorkspace</b>(<i>parent = None</i>)
593 <p>
594 Constructor
595 </p><dl>
596 <dt><i>parent</i></dt>
597 <dd>
598 parent widget (QWidget)
599 </dd>
600 </dl><a NAME="WidgetWorkspace.__findWidget" ID="WidgetWorkspace.__findWidget"></a>
601 <h4>WidgetWorkspace.__findWidget</h4>
602 <b>__findWidget</b>(<i>uiFileName</i>)
603 <p>
604 Private method to find a specific widget view.
605 </p><dl>
606 <dt><i>uiFileName</i></dt>
607 <dd>
608 filename of the loaded UI file (string)
609 </dd>
610 </dl><dl>
611 <dt>Returns:</dt>
612 <dd>
613 reference to the widget (WidgetView) or None
614 </dd>
615 </dl><a NAME="WidgetWorkspace.__toggleWidget" ID="WidgetWorkspace.__toggleWidget"></a>
616 <h4>WidgetWorkspace.__toggleWidget</h4>
617 <b>__toggleWidget</b>(<i>w</i>)
618 <p>
619 Private method to toggle a workspace window.
620 </p><dl>
621 <dt><i>w</i></dt>
622 <dd>
623 window to be toggled
624 </dd>
625 </dl><a NAME="WidgetWorkspace.closeAllWidgets" ID="WidgetWorkspace.closeAllWidgets"></a>
626 <h4>WidgetWorkspace.closeAllWidgets</h4>
627 <b>closeAllWidgets</b>(<i></i>)
628 <p>
629 Public slot to close all windows.
630 </p><a NAME="WidgetWorkspace.closeWidget" ID="WidgetWorkspace.closeWidget"></a>
631 <h4>WidgetWorkspace.closeWidget</h4>
632 <b>closeWidget</b>(<i></i>)
633 <p>
634 Public slot to close the active window.
635 </p><a NAME="WidgetWorkspace.eventFilter" ID="WidgetWorkspace.eventFilter"></a>
636 <h4>WidgetWorkspace.eventFilter</h4>
637 <b>eventFilter</b>(<i>obj, ev</i>)
638 <p>
639 Protected method called to filter an event.
640 </p><dl>
641 <dt><i>object</i></dt>
642 <dd>
643 object, that generated the event (QObject)
644 </dd><dt><i>event</i></dt>
645 <dd>
646 the event, that was generated by object (QEvent)
647 </dd>
648 </dl><dl>
649 <dt>Returns:</dt>
650 <dd>
651 flag indicating if event was filtered out
652 </dd>
653 </dl><a NAME="WidgetWorkspace.hasWidgets" ID="WidgetWorkspace.hasWidgets"></a>
654 <h4>WidgetWorkspace.hasWidgets</h4>
655 <b>hasWidgets</b>(<i></i>)
656 <p>
657 Public method to check for loaded widgets.
658 </p><dl>
659 <dt>Returns:</dt>
660 <dd>
661 flag signaling if any widget was loaded (boolean)
662 </dd>
663 </dl><a NAME="WidgetWorkspace.loadWidget" ID="WidgetWorkspace.loadWidget"></a>
664 <h4>WidgetWorkspace.loadWidget</h4>
665 <b>loadWidget</b>(<i>uiFileName</i>)
666 <p>
667 Public slot to load a UI file.
668 </p><dl>
669 <dt><i>uiFileName</i></dt>
670 <dd>
671 name of the UI file to load (string)
672 </dd>
673 </dl><a NAME="WidgetWorkspace.showWindowMenu" ID="WidgetWorkspace.showWindowMenu"></a>
674 <h4>WidgetWorkspace.showWindowMenu</h4>
675 <b>showWindowMenu</b>(<i>windowMenu</i>)
676 <p>
677 Public method to set up the widgets part of the Window menu.
678 </p><dl>
679 <dt><i>windowMenu</i></dt>
680 <dd>
681 reference to the window menu
682 </dd>
683 </dl><a NAME="WidgetWorkspace.toggleSelectedWidget" ID="WidgetWorkspace.toggleSelectedWidget"></a>
684 <h4>WidgetWorkspace.toggleSelectedWidget</h4>
685 <b>toggleSelectedWidget</b>(<i>act</i>)
686 <p>
687 Public method to handle the toggle of a window.
688 </p><dl>
689 <dt><i>act</i></dt>
690 <dd>
691 reference to the action that triggered (QAction)
692 </dd>
693 </dl>
694 <div align="right"><a href="#top">Up</a></div>
695 <hr /> 695 <hr />
696 </body></html> 696 </body></html>

eric ide

mercurial