Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.IconEditor.IconEditorGrid.html

src/eric7/Documentation/Source/eric7.IconEditor.IconEditorGrid.html

branch
eric7
changeset 10428
a071d4065202
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
10427:3733e2b23cf7 10428:a071d4065202
92 <p> 92 <p>
93 Constructor 93 Constructor
94 </p> 94 </p>
95 <dl> 95 <dl>
96 96
97 <dt><i>grid</i></dt> 97 <dt><i>grid</i> (IconEditorGrid)</dt>
98 <dd> 98 <dd>
99 reference to the icon editor grid (IconEditorGrid) 99 reference to the icon editor grid
100 </dd> 100 </dd>
101 <dt><i>text</i></dt> 101 <dt><i>text</i> (str)</dt>
102 <dd> 102 <dd>
103 text for the undo command (string) 103 text for the undo command
104 </dd> 104 </dd>
105 <dt><i>oldImage</i></dt> 105 <dt><i>oldImage</i> (QImage)</dt>
106 <dd> 106 <dd>
107 copy of the icon before the changes were applied 107 copy of the icon before the changes were applied
108 (QImage) 108 </dd>
109 </dd> 109 <dt><i>parent</i> (QUndoCommand)</dt>
110 <dt><i>parent</i></dt> 110 <dd>
111 <dd> 111 reference to the parent command
112 reference to the parent command (QUndoCommand)
113 </dd> 112 </dd>
114 </dl> 113 </dl>
115 <a NAME="IconEditCommand.redo" ID="IconEditCommand.redo"></a> 114 <a NAME="IconEditCommand.redo" ID="IconEditCommand.redo"></a>
116 <h4>IconEditCommand.redo</h4> 115 <h4>IconEditCommand.redo</h4>
117 <b>redo</b>(<i></i>) 116 <b>redo</b>(<i></i>)
126 <p> 125 <p>
127 Public method to set the image after the changes were applied. 126 Public method to set the image after the changes were applied.
128 </p> 127 </p>
129 <dl> 128 <dl>
130 129
131 <dt><i>image</i></dt> 130 <dt><i>image</i> (QImage)</dt>
132 <dd> 131 <dd>
133 copy of the icon after the changes were applied (QImage) 132 copy of the icon after the changes were applied
134 </dd> 133 </dd>
135 </dl> 134 </dl>
136 <a NAME="IconEditCommand.undo" ID="IconEditCommand.undo"></a> 135 <a NAME="IconEditCommand.undo" ID="IconEditCommand.undo"></a>
137 <h4>IconEditCommand.undo</h4> 136 <h4>IconEditCommand.undo</h4>
138 <b>undo</b>(<i></i>) 137 <b>undo</b>(<i></i>)
446 <p> 445 <p>
447 Constructor 446 Constructor
448 </p> 447 </p>
449 <dl> 448 <dl>
450 449
451 <dt><i>parent</i></dt> 450 <dt><i>parent</i> (QWidget)</dt>
452 <dd> 451 <dd>
453 reference to the parent widget (QWidget) 452 reference to the parent widget
454 </dd> 453 </dd>
455 </dl> 454 </dl>
456 <a NAME="IconEditorGrid.__checkClipboard" ID="IconEditorGrid.__checkClipboard"></a> 455 <a NAME="IconEditorGrid.__checkClipboard" ID="IconEditorGrid.__checkClipboard"></a>
457 <h4>IconEditorGrid.__checkClipboard</h4> 456 <h4>IconEditorGrid.__checkClipboard</h4>
458 <b>__checkClipboard</b>(<i></i>) 457 <b>__checkClipboard</b>(<i></i>)
468 <p> 467 <p>
469 Private slot to handle the undo stack clean state change. 468 Private slot to handle the undo stack clean state change.
470 </p> 469 </p>
471 <dl> 470 <dl>
472 471
473 <dt><i>clean</i></dt> 472 <dt><i>clean</i> (bool)</dt>
474 <dd> 473 <dd>
475 flag indicating the clean state (boolean) 474 flag indicating the clean state
476 </dd> 475 </dd>
477 </dl> 476 </dl>
478 <a NAME="IconEditorGrid.__clipboardImage" ID="IconEditorGrid.__clipboardImage"></a> 477 <a NAME="IconEditorGrid.__clipboardImage" ID="IconEditorGrid.__clipboardImage"></a>
479 <h4>IconEditorGrid.__clipboardImage</h4> 478 <h4>IconEditorGrid.__clipboardImage</h4>
480 <b>__clipboardImage</b>(<i></i>) 479 <b>__clipboardImage</b>(<i></i>)
484 </p> 483 </p>
485 <dl> 484 <dl>
486 <dt>Return:</dt> 485 <dt>Return:</dt>
487 <dd> 486 <dd>
488 tuple with the image (QImage) and a flag indicating a 487 tuple with the image (QImage) and a flag indicating a
489 valid image (boolean) 488 valid image
489 </dd>
490 </dl>
491 <dl>
492 <dt>Return Type:</dt>
493 <dd>
494 bool
490 </dd> 495 </dd>
491 </dl> 496 </dl>
492 <a NAME="IconEditorGrid.__drawFlood" ID="IconEditorGrid.__drawFlood"></a> 497 <a NAME="IconEditorGrid.__drawFlood" ID="IconEditorGrid.__drawFlood"></a>
493 <h4>IconEditorGrid.__drawFlood</h4> 498 <h4>IconEditorGrid.__drawFlood</h4>
494 <b>__drawFlood</b>(<i>i, j, oldColor, doUpdate=True</i>) 499 <b>__drawFlood</b>(<i>i, j, oldColor, doUpdate=True</i>)
496 <p> 501 <p>
497 Private method to perform a flood fill operation. 502 Private method to perform a flood fill operation.
498 </p> 503 </p>
499 <dl> 504 <dl>
500 505
501 <dt><i>i</i></dt> 506 <dt><i>i</i> (int)</dt>
502 <dd> 507 <dd>
503 x-value in image coordinates (integer) 508 x-value in image coordinates
504 </dd> 509 </dd>
505 <dt><i>j</i></dt> 510 <dt><i>j</i> (int)</dt>
506 <dd> 511 <dd>
507 y-value in image coordinates (integer) 512 y-value in image coordinates
508 </dd> 513 </dd>
509 <dt><i>oldColor</i></dt> 514 <dt><i>oldColor</i> (QColor)</dt>
510 <dd> 515 <dd>
511 reference to the color at position i, j (QColor) 516 reference to the color at position i, j
512 </dd> 517 </dd>
513 <dt><i>doUpdate</i></dt> 518 <dt><i>doUpdate</i> (bool)</dt>
514 <dd> 519 <dd>
515 flag indicating an update is requested (boolean) 520 flag indicating an update is requested
516 (used for speed optimizations) 521 (used for speed optimizations)
517 </dd> 522 </dd>
518 </dl> 523 </dl>
519 <a NAME="IconEditorGrid.__drawPasteRect" ID="IconEditorGrid.__drawPasteRect"></a> 524 <a NAME="IconEditorGrid.__drawPasteRect" ID="IconEditorGrid.__drawPasteRect"></a>
520 <h4>IconEditorGrid.__drawPasteRect</h4> 525 <h4>IconEditorGrid.__drawPasteRect</h4>
523 <p> 528 <p>
524 Private slot to draw a rectangle for signaling a paste operation. 529 Private slot to draw a rectangle for signaling a paste operation.
525 </p> 530 </p>
526 <dl> 531 <dl>
527 532
528 <dt><i>pos</i></dt> 533 <dt><i>pos</i> (QPoint)</dt>
529 <dd> 534 <dd>
530 widget position of the paste rectangle (QPoint) 535 widget position of the paste rectangle
531 </dd> 536 </dd>
532 </dl> 537 </dl>
533 <a NAME="IconEditorGrid.__drawTool" ID="IconEditorGrid.__drawTool"></a> 538 <a NAME="IconEditorGrid.__drawTool" ID="IconEditorGrid.__drawTool"></a>
534 <h4>IconEditorGrid.__drawTool</h4> 539 <h4>IconEditorGrid.__drawTool</h4>
535 <b>__drawTool</b>(<i>pos, mark</i>) 540 <b>__drawTool</b>(<i>pos, mark</i>)
538 Private method to perform a draw operation depending of the current 543 Private method to perform a draw operation depending of the current
539 tool. 544 tool.
540 </p> 545 </p>
541 <dl> 546 <dl>
542 547
543 <dt><i>pos</i></dt> 548 <dt><i>pos</i> (QPoint)</dt>
544 <dd> 549 <dd>
545 widget coordinate to perform the draw operation at (QPoint) 550 widget coordinate to perform the draw operation at
546 </dd> 551 </dd>
547 <dt><i>mark</i></dt> 552 <dt><i>mark</i> (bool)</dt>
548 <dd> 553 <dd>
549 flag indicating a mark operation (boolean) 554 flag indicating a mark operation
550 </dd> 555 </dd>
551 </dl> 556 </dl>
552 <dl> 557 <dl>
553 <dt>Return:</dt> 558 <dt>Return:</dt>
554 <dd> 559 <dd>
555 flag indicating a successful draw (boolean) 560 flag indicating a successful draw
561 </dd>
562 </dl>
563 <dl>
564 <dt>Return Type:</dt>
565 <dd>
566 bool
556 </dd> 567 </dd>
557 </dl> 568 </dl>
558 <a NAME="IconEditorGrid.__getSelectionImage" ID="IconEditorGrid.__getSelectionImage"></a> 569 <a NAME="IconEditorGrid.__getSelectionImage" ID="IconEditorGrid.__getSelectionImage"></a>
559 <h4>IconEditorGrid.__getSelectionImage</h4> 570 <h4>IconEditorGrid.__getSelectionImage</h4>
560 <b>__getSelectionImage</b>(<i>cut</i>) 571 <b>__getSelectionImage</b>(<i>cut</i>)
562 <p> 573 <p>
563 Private method to get an image from the selection. 574 Private method to get an image from the selection.
564 </p> 575 </p>
565 <dl> 576 <dl>
566 577
567 <dt><i>cut</i></dt> 578 <dt><i>cut</i> (bool)</dt>
568 <dd> 579 <dd>
569 flag indicating to cut the selection (boolean) 580 flag indicating to cut the selection
570 </dd> 581 </dd>
571 </dl> 582 </dl>
572 <dl> 583 <dl>
573 <dt>Return:</dt> 584 <dt>Return:</dt>
574 <dd> 585 <dd>
575 image of the selection (QImage) 586 image of the selection
587 </dd>
588 </dl>
589 <dl>
590 <dt>Return Type:</dt>
591 <dd>
592 QImage
576 </dd> 593 </dd>
577 </dl> 594 </dl>
578 <a NAME="IconEditorGrid.__imageCoordinates" ID="IconEditorGrid.__imageCoordinates"></a> 595 <a NAME="IconEditorGrid.__imageCoordinates" ID="IconEditorGrid.__imageCoordinates"></a>
579 <h4>IconEditorGrid.__imageCoordinates</h4> 596 <h4>IconEditorGrid.__imageCoordinates</h4>
580 <b>__imageCoordinates</b>(<i>pos</i>) 597 <b>__imageCoordinates</b>(<i>pos</i>)
582 <p> 599 <p>
583 Private method to convert from widget to image coordinates. 600 Private method to convert from widget to image coordinates.
584 </p> 601 </p>
585 <dl> 602 <dl>
586 603
587 <dt><i>pos</i></dt> 604 <dt><i>pos</i> (QPoint)</dt>
588 <dd> 605 <dd>
589 widget coordinate (QPoint) 606 widget coordinate
590 </dd> 607 </dd>
591 </dl> 608 </dl>
592 <dl> 609 <dl>
593 <dt>Return:</dt> 610 <dt>Return:</dt>
594 <dd> 611 <dd>
595 tuple with the image coordinates (tuple of two integers) 612 tuple with the image coordinates
613 </dd>
614 </dl>
615 <dl>
616 <dt>Return Type:</dt>
617 <dd>
618 tuple of (int, int)
596 </dd> 619 </dd>
597 </dl> 620 </dl>
598 <a NAME="IconEditorGrid.__initCursors" ID="IconEditorGrid.__initCursors"></a> 621 <a NAME="IconEditorGrid.__initCursors" ID="IconEditorGrid.__initCursors"></a>
599 <h4>IconEditorGrid.__initCursors</h4> 622 <h4>IconEditorGrid.__initCursors</h4>
600 <b>__initCursors</b>(<i></i>) 623 <b>__initCursors</b>(<i></i>)
617 <p> 640 <p>
618 Private method to check, if a pixel is marked. 641 Private method to check, if a pixel is marked.
619 </p> 642 </p>
620 <dl> 643 <dl>
621 644
622 <dt><i>i</i></dt> 645 <dt><i>i</i> (int)</dt>
623 <dd> 646 <dd>
624 x-value in image coordinates (integer) 647 x-value in image coordinates
625 </dd> 648 </dd>
626 <dt><i>j</i></dt> 649 <dt><i>j</i> (int)</dt>
627 <dd> 650 <dd>
628 y-value in image coordinates (integer) 651 y-value in image coordinates
629 </dd> 652 </dd>
630 </dl> 653 </dl>
631 <dl> 654 <dl>
632 <dt>Return:</dt> 655 <dt>Return:</dt>
633 <dd> 656 <dd>
634 flag indicating a marked pixel (boolean) 657 flag indicating a marked pixel
658 </dd>
659 </dl>
660 <dl>
661 <dt>Return Type:</dt>
662 <dd>
663 bool
635 </dd> 664 </dd>
636 </dl> 665 </dl>
637 <a NAME="IconEditorGrid.__pixelRect" ID="IconEditorGrid.__pixelRect"></a> 666 <a NAME="IconEditorGrid.__pixelRect" ID="IconEditorGrid.__pixelRect"></a>
638 <h4>IconEditorGrid.__pixelRect</h4> 667 <h4>IconEditorGrid.__pixelRect</h4>
639 <b>__pixelRect</b>(<i>i, j</i>) 668 <b>__pixelRect</b>(<i>i, j</i>)
641 <p> 670 <p>
642 Private method to determine the rectangle for a given pixel coordinate. 671 Private method to determine the rectangle for a given pixel coordinate.
643 </p> 672 </p>
644 <dl> 673 <dl>
645 674
646 <dt><i>i</i></dt> 675 <dt><i>i</i> (int)</dt>
647 <dd> 676 <dd>
648 x-coordinate of the pixel in the image (integer) 677 x-coordinate of the pixel in the image
649 </dd> 678 </dd>
650 <dt><i>j</i></dt> 679 <dt><i>j</i> (int)</dt>
651 <dd> 680 <dd>
652 y-coordinate of the pixel in the image (integer) 681 y-coordinate of the pixel in the image
653 </dd> 682 </dd>
654 </dl> 683 </dl>
655 <dl> 684 <dl>
656 <dt>Return:</dt> 685 <dt>Return:</dt>
657 <dd> 686 <dd>
658 rectangle for the given pixel coordinates (QRect) 687 rectangle for the given pixel coordinates
688 </dd>
689 </dl>
690 <dl>
691 <dt>Return Type:</dt>
692 <dd>
693 QRect
659 </dd> 694 </dd>
660 </dl> 695 </dl>
661 <a NAME="IconEditorGrid.__setImagePixel" ID="IconEditorGrid.__setImagePixel"></a> 696 <a NAME="IconEditorGrid.__setImagePixel" ID="IconEditorGrid.__setImagePixel"></a>
662 <h4>IconEditorGrid.__setImagePixel</h4> 697 <h4>IconEditorGrid.__setImagePixel</h4>
663 <b>__setImagePixel</b>(<i>pos, opaque</i>) 698 <b>__setImagePixel</b>(<i>pos, opaque</i>)
665 <p> 700 <p>
666 Private slot to set or erase a pixel. 701 Private slot to set or erase a pixel.
667 </p> 702 </p>
668 <dl> 703 <dl>
669 704
670 <dt><i>pos</i></dt> 705 <dt><i>pos</i> (QPoint)</dt>
671 <dd> 706 <dd>
672 position of the pixel in the widget (QPoint) 707 position of the pixel in the widget
673 </dd> 708 </dd>
674 <dt><i>opaque</i></dt> 709 <dt><i>opaque</i> (bool)</dt>
675 <dd> 710 <dd>
676 flag indicating a set operation (boolean) 711 flag indicating a set operation
677 </dd> 712 </dd>
678 </dl> 713 </dl>
679 <a NAME="IconEditorGrid.__unMark" ID="IconEditorGrid.__unMark"></a> 714 <a NAME="IconEditorGrid.__unMark" ID="IconEditorGrid.__unMark"></a>
680 <h4>IconEditorGrid.__unMark</h4> 715 <h4>IconEditorGrid.__unMark</h4>
681 <b>__unMark</b>(<i></i>) 716 <b>__unMark</b>(<i></i>)
690 <p> 725 <p>
691 Private slot to update parts of the widget. 726 Private slot to update parts of the widget.
692 </p> 727 </p>
693 <dl> 728 <dl>
694 729
695 <dt><i>ipos1</i></dt> 730 <dt><i>ipos1</i> (QPoint)</dt>
696 <dd> 731 <dd>
697 top, left position for the update in image coordinates 732 top, left position for the update in image coordinates
698 (QPoint) 733 </dd>
699 </dd> 734 <dt><i>ipos2</i> (QPoint)</dt>
700 <dt><i>ipos2</i></dt>
701 <dd> 735 <dd>
702 bottom, right position for the update in image 736 bottom, right position for the update in image
703 coordinates (QPoint) 737 coordinates
704 </dd> 738 </dd>
705 </dl> 739 </dl>
706 <a NAME="IconEditorGrid.__updatePreviewPixmap" ID="IconEditorGrid.__updatePreviewPixmap"></a> 740 <a NAME="IconEditorGrid.__updatePreviewPixmap" ID="IconEditorGrid.__updatePreviewPixmap"></a>
707 <h4>IconEditorGrid.__updatePreviewPixmap</h4> 741 <h4>IconEditorGrid.__updatePreviewPixmap</h4>
708 <b>__updatePreviewPixmap</b>(<i></i>) 742 <b>__updatePreviewPixmap</b>(<i></i>)
717 <p> 751 <p>
718 Private slot to update parts of the widget. 752 Private slot to update parts of the widget.
719 </p> 753 </p>
720 <dl> 754 <dl>
721 755
722 <dt><i>pos1</i></dt> 756 <dt><i>pos1</i> (QPoint)</dt>
723 <dd> 757 <dd>
724 top, left position for the update in widget coordinates 758 top, left position for the update in widget coordinates
725 (QPoint) 759 </dd>
726 </dd> 760 <dt><i>pos2</i> (QPoint)</dt>
727 <dt><i>pos2</i></dt>
728 <dd> 761 <dd>
729 bottom, right position for the update in widget 762 bottom, right position for the update in widget
730 coordinates (QPoint) 763 coordinates
731 </dd> 764 </dd>
732 </dl> 765 </dl>
733 <a NAME="IconEditorGrid.canPaste" ID="IconEditorGrid.canPaste"></a> 766 <a NAME="IconEditorGrid.canPaste" ID="IconEditorGrid.canPaste"></a>
734 <h4>IconEditorGrid.canPaste</h4> 767 <h4>IconEditorGrid.canPaste</h4>
735 <b>canPaste</b>(<i></i>) 768 <b>canPaste</b>(<i></i>)
738 Public slot to check the availability of the paste operation. 771 Public slot to check the availability of the paste operation.
739 </p> 772 </p>
740 <dl> 773 <dl>
741 <dt>Return:</dt> 774 <dt>Return:</dt>
742 <dd> 775 <dd>
743 flag indicating availability of paste (boolean) 776 flag indicating availability of paste
777 </dd>
778 </dl>
779 <dl>
780 <dt>Return Type:</dt>
781 <dd>
782 bool
744 </dd> 783 </dd>
745 </dl> 784 </dl>
746 <a NAME="IconEditorGrid.canRedo" ID="IconEditorGrid.canRedo"></a> 785 <a NAME="IconEditorGrid.canRedo" ID="IconEditorGrid.canRedo"></a>
747 <h4>IconEditorGrid.canRedo</h4> 786 <h4>IconEditorGrid.canRedo</h4>
748 <b>canRedo</b>(<i></i>) 787 <b>canRedo</b>(<i></i>)
751 Public method to return the redo status. 790 Public method to return the redo status.
752 </p> 791 </p>
753 <dl> 792 <dl>
754 <dt>Return:</dt> 793 <dt>Return:</dt>
755 <dd> 794 <dd>
756 flag indicating the availability of redo (boolean) 795 flag indicating the availability of redo
796 </dd>
797 </dl>
798 <dl>
799 <dt>Return Type:</dt>
800 <dd>
801 bool
757 </dd> 802 </dd>
758 </dl> 803 </dl>
759 <a NAME="IconEditorGrid.canUndo" ID="IconEditorGrid.canUndo"></a> 804 <a NAME="IconEditorGrid.canUndo" ID="IconEditorGrid.canUndo"></a>
760 <h4>IconEditorGrid.canUndo</h4> 805 <h4>IconEditorGrid.canUndo</h4>
761 <b>canUndo</b>(<i></i>) 806 <b>canUndo</b>(<i></i>)
764 Public method to return the undo status. 809 Public method to return the undo status.
765 </p> 810 </p>
766 <dl> 811 <dl>
767 <dt>Return:</dt> 812 <dt>Return:</dt>
768 <dd> 813 <dd>
769 flag indicating the availability of undo (boolean) 814 flag indicating the availability of undo
815 </dd>
816 </dl>
817 <dl>
818 <dt>Return Type:</dt>
819 <dd>
820 bool
770 </dd> 821 </dd>
771 </dl> 822 </dl>
772 <a NAME="IconEditorGrid.compositingMode" ID="IconEditorGrid.compositingMode"></a> 823 <a NAME="IconEditorGrid.compositingMode" ID="IconEditorGrid.compositingMode"></a>
773 <h4>IconEditorGrid.compositingMode</h4> 824 <h4>IconEditorGrid.compositingMode</h4>
774 <b>compositingMode</b>(<i></i>) 825 <b>compositingMode</b>(<i></i>)
777 Public method to get the compositing mode. 828 Public method to get the compositing mode.
778 </p> 829 </p>
779 <dl> 830 <dl>
780 <dt>Return:</dt> 831 <dt>Return:</dt>
781 <dd> 832 <dd>
782 compositing mode (QPainter.CompositionMode) 833 compositing mode
834 </dd>
835 </dl>
836 <dl>
837 <dt>Return Type:</dt>
838 <dd>
839 QPainter.CompositionMode
783 </dd> 840 </dd>
784 </dl> 841 </dl>
785 <a NAME="IconEditorGrid.editClear" ID="IconEditorGrid.editClear"></a> 842 <a NAME="IconEditorGrid.editClear" ID="IconEditorGrid.editClear"></a>
786 <h4>IconEditorGrid.editClear</h4> 843 <h4>IconEditorGrid.editClear</h4>
787 <b>editClear</b>(<i></i>) 844 <b>editClear</b>(<i></i>)
817 <p> 874 <p>
818 Public slot to paste an image from the clipboard. 875 Public slot to paste an image from the clipboard.
819 </p> 876 </p>
820 <dl> 877 <dl>
821 878
822 <dt><i>pasting</i></dt> 879 <dt><i>pasting</i> (bool)</dt>
823 <dd> 880 <dd>
824 flag indicating part two of the paste operation 881 flag indicating part two of the paste operation
825 (boolean)
826 </dd> 882 </dd>
827 </dl> 883 </dl>
828 <a NAME="IconEditorGrid.editPasteAsNew" ID="IconEditorGrid.editPasteAsNew"></a> 884 <a NAME="IconEditorGrid.editPasteAsNew" ID="IconEditorGrid.editPasteAsNew"></a>
829 <h4>IconEditorGrid.editPasteAsNew</h4> 885 <h4>IconEditorGrid.editPasteAsNew</h4>
830 <b>editPasteAsNew</b>(<i></i>) 886 <b>editPasteAsNew</b>(<i></i>)
875 Public method to get a copy of the icon image. 931 Public method to get a copy of the icon image.
876 </p> 932 </p>
877 <dl> 933 <dl>
878 <dt>Return:</dt> 934 <dt>Return:</dt>
879 <dd> 935 <dd>
880 copy of the icon image (QImage) 936 copy of the icon image
937 </dd>
938 </dl>
939 <dl>
940 <dt>Return Type:</dt>
941 <dd>
942 QImage
881 </dd> 943 </dd>
882 </dl> 944 </dl>
883 <a NAME="IconEditorGrid.iconSize" ID="IconEditorGrid.iconSize"></a> 945 <a NAME="IconEditorGrid.iconSize" ID="IconEditorGrid.iconSize"></a>
884 <h4>IconEditorGrid.iconSize</h4> 946 <h4>IconEditorGrid.iconSize</h4>
885 <b>iconSize</b>(<i></i>) 947 <b>iconSize</b>(<i></i>)
888 Public method to get the size of the icon. 950 Public method to get the size of the icon.
889 </p> 951 </p>
890 <dl> 952 <dl>
891 <dt>Return:</dt> 953 <dt>Return:</dt>
892 <dd> 954 <dd>
893 width and height of the image as a tuple (integer, integer) 955 width and height of the image as a tuple
956 </dd>
957 </dl>
958 <dl>
959 <dt>Return Type:</dt>
960 <dd>
961 tuple of (int, int)
894 </dd> 962 </dd>
895 </dl> 963 </dl>
896 <a NAME="IconEditorGrid.isDirty" ID="IconEditorGrid.isDirty"></a> 964 <a NAME="IconEditorGrid.isDirty" ID="IconEditorGrid.isDirty"></a>
897 <h4>IconEditorGrid.isDirty</h4> 965 <h4>IconEditorGrid.isDirty</h4>
898 <b>isDirty</b>(<i></i>) 966 <b>isDirty</b>(<i></i>)
901 Public method to check the dirty status. 969 Public method to check the dirty status.
902 </p> 970 </p>
903 <dl> 971 <dl>
904 <dt>Return:</dt> 972 <dt>Return:</dt>
905 <dd> 973 <dd>
906 flag indicating a modified status (boolean) 974 flag indicating a modified status
975 </dd>
976 </dl>
977 <dl>
978 <dt>Return Type:</dt>
979 <dd>
980 bool
907 </dd> 981 </dd>
908 </dl> 982 </dl>
909 <a NAME="IconEditorGrid.isGridEnabled" ID="IconEditorGrid.isGridEnabled"></a> 983 <a NAME="IconEditorGrid.isGridEnabled" ID="IconEditorGrid.isGridEnabled"></a>
910 <h4>IconEditorGrid.isGridEnabled</h4> 984 <h4>IconEditorGrid.isGridEnabled</h4>
911 <b>isGridEnabled</b>(<i></i>) 985 <b>isGridEnabled</b>(<i></i>)
914 Public method to get the grid lines status. 988 Public method to get the grid lines status.
915 </p> 989 </p>
916 <dl> 990 <dl>
917 <dt>Return:</dt> 991 <dt>Return:</dt>
918 <dd> 992 <dd>
919 enabled status of the grid lines (boolean) 993 enabled status of the grid lines
994 </dd>
995 </dl>
996 <dl>
997 <dt>Return Type:</dt>
998 <dd>
999 bool
920 </dd> 1000 </dd>
921 </dl> 1001 </dl>
922 <a NAME="IconEditorGrid.isSelectionAvailable" ID="IconEditorGrid.isSelectionAvailable"></a> 1002 <a NAME="IconEditorGrid.isSelectionAvailable" ID="IconEditorGrid.isSelectionAvailable"></a>
923 <h4>IconEditorGrid.isSelectionAvailable</h4> 1003 <h4>IconEditorGrid.isSelectionAvailable</h4>
924 <b>isSelectionAvailable</b>(<i></i>) 1004 <b>isSelectionAvailable</b>(<i></i>)
927 Public method to check the availability of a selection. 1007 Public method to check the availability of a selection.
928 </p> 1008 </p>
929 <dl> 1009 <dl>
930 <dt>Return:</dt> 1010 <dt>Return:</dt>
931 <dd> 1011 <dd>
932 flag indicating the availability of a selection (boolean) 1012 flag indicating the availability of a selection
1013 </dd>
1014 </dl>
1015 <dl>
1016 <dt>Return Type:</dt>
1017 <dd>
1018 bool
933 </dd> 1019 </dd>
934 </dl> 1020 </dl>
935 <a NAME="IconEditorGrid.mouseMoveEvent" ID="IconEditorGrid.mouseMoveEvent"></a> 1021 <a NAME="IconEditorGrid.mouseMoveEvent" ID="IconEditorGrid.mouseMoveEvent"></a>
936 <h4>IconEditorGrid.mouseMoveEvent</h4> 1022 <h4>IconEditorGrid.mouseMoveEvent</h4>
937 <b>mouseMoveEvent</b>(<i>evt</i>) 1023 <b>mouseMoveEvent</b>(<i>evt</i>)
939 <p> 1025 <p>
940 Protected method to handle mouse move events. 1026 Protected method to handle mouse move events.
941 </p> 1027 </p>
942 <dl> 1028 <dl>
943 1029
944 <dt><i>evt</i></dt> 1030 <dt><i>evt</i> (QMouseEvent)</dt>
945 <dd> 1031 <dd>
946 reference to the mouse event object (QMouseEvent) 1032 reference to the mouse event object
947 </dd> 1033 </dd>
948 </dl> 1034 </dl>
949 <a NAME="IconEditorGrid.mousePressEvent" ID="IconEditorGrid.mousePressEvent"></a> 1035 <a NAME="IconEditorGrid.mousePressEvent" ID="IconEditorGrid.mousePressEvent"></a>
950 <h4>IconEditorGrid.mousePressEvent</h4> 1036 <h4>IconEditorGrid.mousePressEvent</h4>
951 <b>mousePressEvent</b>(<i>evt</i>) 1037 <b>mousePressEvent</b>(<i>evt</i>)
953 <p> 1039 <p>
954 Protected method to handle mouse button press events. 1040 Protected method to handle mouse button press events.
955 </p> 1041 </p>
956 <dl> 1042 <dl>
957 1043
958 <dt><i>evt</i></dt> 1044 <dt><i>evt</i> (QMouseEvent)</dt>
959 <dd> 1045 <dd>
960 reference to the mouse event object (QMouseEvent) 1046 reference to the mouse event object
961 </dd> 1047 </dd>
962 </dl> 1048 </dl>
963 <a NAME="IconEditorGrid.mouseReleaseEvent" ID="IconEditorGrid.mouseReleaseEvent"></a> 1049 <a NAME="IconEditorGrid.mouseReleaseEvent" ID="IconEditorGrid.mouseReleaseEvent"></a>
964 <h4>IconEditorGrid.mouseReleaseEvent</h4> 1050 <h4>IconEditorGrid.mouseReleaseEvent</h4>
965 <b>mouseReleaseEvent</b>(<i>evt</i>) 1051 <b>mouseReleaseEvent</b>(<i>evt</i>)
967 <p> 1053 <p>
968 Protected method to handle mouse button release events. 1054 Protected method to handle mouse button release events.
969 </p> 1055 </p>
970 <dl> 1056 <dl>
971 1057
972 <dt><i>evt</i></dt> 1058 <dt><i>evt</i> (QMouseEvent)</dt>
973 <dd> 1059 <dd>
974 reference to the mouse event object (QMouseEvent) 1060 reference to the mouse event object
975 </dd> 1061 </dd>
976 </dl> 1062 </dl>
977 <a NAME="IconEditorGrid.paintEvent" ID="IconEditorGrid.paintEvent"></a> 1063 <a NAME="IconEditorGrid.paintEvent" ID="IconEditorGrid.paintEvent"></a>
978 <h4>IconEditorGrid.paintEvent</h4> 1064 <h4>IconEditorGrid.paintEvent</h4>
979 <b>paintEvent</b>(<i>evt</i>) 1065 <b>paintEvent</b>(<i>evt</i>)
981 <p> 1067 <p>
982 Protected method called to repaint some of the widget. 1068 Protected method called to repaint some of the widget.
983 </p> 1069 </p>
984 <dl> 1070 <dl>
985 1071
986 <dt><i>evt</i></dt> 1072 <dt><i>evt</i> (QPaintEvent)</dt>
987 <dd> 1073 <dd>
988 reference to the paint event object (QPaintEvent) 1074 reference to the paint event object
989 </dd> 1075 </dd>
990 </dl> 1076 </dl>
991 <a NAME="IconEditorGrid.penColor" ID="IconEditorGrid.penColor"></a> 1077 <a NAME="IconEditorGrid.penColor" ID="IconEditorGrid.penColor"></a>
992 <h4>IconEditorGrid.penColor</h4> 1078 <h4>IconEditorGrid.penColor</h4>
993 <b>penColor</b>(<i></i>) 1079 <b>penColor</b>(<i></i>)
996 Public method to get the current drawing color. 1082 Public method to get the current drawing color.
997 </p> 1083 </p>
998 <dl> 1084 <dl>
999 <dt>Return:</dt> 1085 <dt>Return:</dt>
1000 <dd> 1086 <dd>
1001 current drawing color (QColor) 1087 current drawing color
1088 </dd>
1089 </dl>
1090 <dl>
1091 <dt>Return Type:</dt>
1092 <dd>
1093 QColor
1002 </dd> 1094 </dd>
1003 </dl> 1095 </dl>
1004 <a NAME="IconEditorGrid.previewPixmap" ID="IconEditorGrid.previewPixmap"></a> 1096 <a NAME="IconEditorGrid.previewPixmap" ID="IconEditorGrid.previewPixmap"></a>
1005 <h4>IconEditorGrid.previewPixmap</h4> 1097 <h4>IconEditorGrid.previewPixmap</h4>
1006 <b>previewPixmap</b>(<i></i>) 1098 <b>previewPixmap</b>(<i></i>)
1009 Public method to generate a preview pixmap. 1101 Public method to generate a preview pixmap.
1010 </p> 1102 </p>
1011 <dl> 1103 <dl>
1012 <dt>Return:</dt> 1104 <dt>Return:</dt>
1013 <dd> 1105 <dd>
1014 preview pixmap (QPixmap) 1106 preview pixmap
1107 </dd>
1108 </dl>
1109 <dl>
1110 <dt>Return Type:</dt>
1111 <dd>
1112 QPixmap
1015 </dd> 1113 </dd>
1016 </dl> 1114 </dl>
1017 <a NAME="IconEditorGrid.setCompositingMode" ID="IconEditorGrid.setCompositingMode"></a> 1115 <a NAME="IconEditorGrid.setCompositingMode" ID="IconEditorGrid.setCompositingMode"></a>
1018 <h4>IconEditorGrid.setCompositingMode</h4> 1116 <h4>IconEditorGrid.setCompositingMode</h4>
1019 <b>setCompositingMode</b>(<i>mode</i>) 1117 <b>setCompositingMode</b>(<i>mode</i>)
1021 <p> 1119 <p>
1022 Public method to set the compositing mode. 1120 Public method to set the compositing mode.
1023 </p> 1121 </p>
1024 <dl> 1122 <dl>
1025 1123
1026 <dt><i>mode</i></dt> 1124 <dt><i>mode</i> (QPainter.CompositionMode)</dt>
1027 <dd> 1125 <dd>
1028 compositing mode to set (QPainter.CompositionMode) 1126 compositing mode to set
1029 </dd> 1127 </dd>
1030 </dl> 1128 </dl>
1031 <a NAME="IconEditorGrid.setDirty" ID="IconEditorGrid.setDirty"></a> 1129 <a NAME="IconEditorGrid.setDirty" ID="IconEditorGrid.setDirty"></a>
1032 <h4>IconEditorGrid.setDirty</h4> 1130 <h4>IconEditorGrid.setDirty</h4>
1033 <b>setDirty</b>(<i>dirty, setCleanState=False</i>) 1131 <b>setDirty</b>(<i>dirty, setCleanState=False</i>)
1035 <p> 1133 <p>
1036 Public slot to set the dirty flag. 1134 Public slot to set the dirty flag.
1037 </p> 1135 </p>
1038 <dl> 1136 <dl>
1039 1137
1040 <dt><i>dirty</i></dt> 1138 <dt><i>dirty</i> (bool)</dt>
1041 <dd> 1139 <dd>
1042 flag indicating the new modification status (boolean) 1140 flag indicating the new modification status
1043 </dd> 1141 </dd>
1044 <dt><i>setCleanState</i></dt> 1142 <dt><i>setCleanState</i> (bool)</dt>
1045 <dd> 1143 <dd>
1046 flag indicating to set the undo stack to clean 1144 flag indicating to set the undo stack to clean
1047 (boolean)
1048 </dd> 1145 </dd>
1049 </dl> 1146 </dl>
1050 <a NAME="IconEditorGrid.setGridEnabled" ID="IconEditorGrid.setGridEnabled"></a> 1147 <a NAME="IconEditorGrid.setGridEnabled" ID="IconEditorGrid.setGridEnabled"></a>
1051 <h4>IconEditorGrid.setGridEnabled</h4> 1148 <h4>IconEditorGrid.setGridEnabled</h4>
1052 <b>setGridEnabled</b>(<i>enable</i>) 1149 <b>setGridEnabled</b>(<i>enable</i>)
1054 <p> 1151 <p>
1055 Public method to enable the display of grid lines. 1152 Public method to enable the display of grid lines.
1056 </p> 1153 </p>
1057 <dl> 1154 <dl>
1058 1155
1059 <dt><i>enable</i></dt> 1156 <dt><i>enable</i> (bool)</dt>
1060 <dd> 1157 <dd>
1061 enabled status of the grid lines (boolean) 1158 enabled status of the grid lines
1062 </dd> 1159 </dd>
1063 </dl> 1160 </dl>
1064 <a NAME="IconEditorGrid.setIconImage" ID="IconEditorGrid.setIconImage"></a> 1161 <a NAME="IconEditorGrid.setIconImage" ID="IconEditorGrid.setIconImage"></a>
1065 <h4>IconEditorGrid.setIconImage</h4> 1162 <h4>IconEditorGrid.setIconImage</h4>
1066 <b>setIconImage</b>(<i>newImage, undoRedo=False, clearUndo=False</i>) 1163 <b>setIconImage</b>(<i>newImage, undoRedo=False, clearUndo=False</i>)
1068 <p> 1165 <p>
1069 Public method to set a new icon image. 1166 Public method to set a new icon image.
1070 </p> 1167 </p>
1071 <dl> 1168 <dl>
1072 1169
1073 <dt><i>newImage</i></dt> 1170 <dt><i>newImage</i> (QImage)</dt>
1074 <dd> 1171 <dd>
1075 reference to the new image (QImage) 1172 reference to the new image
1076 </dd> 1173 </dd>
1077 <dt><i>undoRedo</i></dt> 1174 <dt><i>undoRedo</i> (bool)</dt>
1078 <dd> 1175 <dd>
1079 flag indicating an undo or redo operation (boolean) 1176 flag indicating an undo or redo operation
1080 </dd> 1177 </dd>
1081 <dt><i>clearUndo</i></dt> 1178 <dt><i>clearUndo</i> (bool)</dt>
1082 <dd> 1179 <dd>
1083 flag indicating to clear the undo stack (boolean) 1180 flag indicating to clear the undo stack
1084 </dd> 1181 </dd>
1085 </dl> 1182 </dl>
1086 <a NAME="IconEditorGrid.setPenColor" ID="IconEditorGrid.setPenColor"></a> 1183 <a NAME="IconEditorGrid.setPenColor" ID="IconEditorGrid.setPenColor"></a>
1087 <h4>IconEditorGrid.setPenColor</h4> 1184 <h4>IconEditorGrid.setPenColor</h4>
1088 <b>setPenColor</b>(<i>newColor</i>) 1185 <b>setPenColor</b>(<i>newColor</i>)
1090 <p> 1187 <p>
1091 Public method to set the drawing color. 1188 Public method to set the drawing color.
1092 </p> 1189 </p>
1093 <dl> 1190 <dl>
1094 1191
1095 <dt><i>newColor</i></dt> 1192 <dt><i>newColor</i> (QColor)</dt>
1096 <dd> 1193 <dd>
1097 reference to the new color (QColor) 1194 reference to the new color
1098 </dd> 1195 </dd>
1099 </dl> 1196 </dl>
1100 <a NAME="IconEditorGrid.setTool" ID="IconEditorGrid.setTool"></a> 1197 <a NAME="IconEditorGrid.setTool" ID="IconEditorGrid.setTool"></a>
1101 <h4>IconEditorGrid.setTool</h4> 1198 <h4>IconEditorGrid.setTool</h4>
1102 <b>setTool</b>(<i>tool</i>) 1199 <b>setTool</b>(<i>tool</i>)
1118 <p> 1215 <p>
1119 Public method to set the zoom factor in percent. 1216 Public method to set the zoom factor in percent.
1120 </p> 1217 </p>
1121 <dl> 1218 <dl>
1122 1219
1123 <dt><i>newZoom</i></dt> 1220 <dt><i>newZoom</i> (int)</dt>
1124 <dd> 1221 <dd>
1125 zoom factor (integer >= 100) 1222 zoom factor (>= 100)
1126 </dd> 1223 </dd>
1127 </dl> 1224 </dl>
1128 <a NAME="IconEditorGrid.shutdown" ID="IconEditorGrid.shutdown"></a> 1225 <a NAME="IconEditorGrid.shutdown" ID="IconEditorGrid.shutdown"></a>
1129 <h4>IconEditorGrid.shutdown</h4> 1226 <h4>IconEditorGrid.shutdown</h4>
1130 <b>shutdown</b>(<i></i>) 1227 <b>shutdown</b>(<i></i>)
1140 Public method to report the size hint. 1237 Public method to report the size hint.
1141 </p> 1238 </p>
1142 <dl> 1239 <dl>
1143 <dt>Return:</dt> 1240 <dt>Return:</dt>
1144 <dd> 1241 <dd>
1145 size hint (QSize) 1242 size hint
1243 </dd>
1244 </dl>
1245 <dl>
1246 <dt>Return Type:</dt>
1247 <dd>
1248 QSize
1146 </dd> 1249 </dd>
1147 </dl> 1250 </dl>
1148 <a NAME="IconEditorGrid.tool" ID="IconEditorGrid.tool"></a> 1251 <a NAME="IconEditorGrid.tool" ID="IconEditorGrid.tool"></a>
1149 <h4>IconEditorGrid.tool</h4> 1252 <h4>IconEditorGrid.tool</h4>
1150 <b>tool</b>(<i></i>) 1253 <b>tool</b>(<i></i>)
1172 Public method to get the current zoom factor in percent. 1275 Public method to get the current zoom factor in percent.
1173 </p> 1276 </p>
1174 <dl> 1277 <dl>
1175 <dt>Return:</dt> 1278 <dt>Return:</dt>
1176 <dd> 1279 <dd>
1177 zoom factor (integer) 1280 zoom factor
1281 </dd>
1282 </dl>
1283 <dl>
1284 <dt>Return Type:</dt>
1285 <dd>
1286 int
1178 </dd> 1287 </dd>
1179 </dl> 1288 </dl>
1180 <div align="right"><a href="#top">Up</a></div> 1289 <div align="right"><a href="#top">Up</a></div>
1181 <hr /> 1290 <hr />
1182 <hr /> 1291 <hr />

Mercurial Repository: eric

eric ide

mercurial