Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.QScintilla.MiniEditor.html

eric6/Documentation/Source/eric6.QScintilla.MiniEditor.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
child 8166
bd5cd5858503
equal deleted inserted replaced
7991:866adc8c315b 8043:0acf98cd089a
513 <dt><i>filename</i></dt> 513 <dt><i>filename</i></dt>
514 <dd> 514 <dd>
515 filename used to determine the associated lexer 515 filename used to determine the associated lexer
516 language (string) 516 language (string)
517 </dd> 517 </dd>
518 <dt><i>pyname=</i></dt> 518 <dt><i>pyname</i></dt>
519 <dd> 519 <dd>
520 name of the pygments lexer to use (string) 520 name of the pygments lexer to use (string)
521 </dd> 521 </dd>
522 </dl> 522 </dl>
523 <a NAME="MiniEditor.__bindName" ID="MiniEditor.__bindName"></a> 523 <a NAME="MiniEditor.__bindName" ID="MiniEditor.__bindName"></a>
534 first line of text to use in the generation process 534 first line of text to use in the generation process
535 (string) 535 (string)
536 </dd> 536 </dd>
537 </dl> 537 </dl>
538 <dl> 538 <dl>
539 <dt>Returns:</dt> 539 <dt>Return:</dt>
540 <dd> 540 <dd>
541 dummy file name to be used for binding a lexer (string) 541 dummy file name to be used for binding a lexer (string)
542 </dd> 542 </dd>
543 </dl> 543 </dl>
544 <a NAME="MiniEditor.__checkActions" ID="MiniEditor.__checkActions"></a> 544 <a NAME="MiniEditor.__checkActions" ID="MiniEditor.__checkActions"></a>
694 694
695 <p> 695 <p>
696 Private method to get the word at the current position. 696 Private method to get the word at the current position.
697 </p> 697 </p>
698 <dl> 698 <dl>
699 <dt>Returns:</dt> 699 <dt>Return:</dt>
700 <dd> 700 <dd>
701 the word at that current position 701 the word at that current position
702 </dd> 702 </dd>
703 </dl> 703 </dl>
704 <a NAME="MiniEditor.__getEditorConfig" ID="MiniEditor.__getEditorConfig"></a> 704 <a NAME="MiniEditor.__getEditorConfig" ID="MiniEditor.__getEditorConfig"></a>
729 <dd> 729 <dd>
730 reference to an EditorConfig object or None 730 reference to an EditorConfig object or None
731 </dd> 731 </dd>
732 </dl> 732 </dl>
733 <dl> 733 <dl>
734 <dt>Returns:</dt> 734 <dt>Return:</dt>
735 <dd> 735 <dd>
736 value of requested setting or None if nothing was found and 736 value of requested setting or None if nothing was found and
737 nodefault parameter was True 737 nodefault parameter was True
738 </dd> 738 </dd>
739 </dl> 739 </dl>
756 <dd> 756 <dd>
757 Preferences option key 757 Preferences option key
758 </dd> 758 </dd>
759 </dl> 759 </dl>
760 <dl> 760 <dl>
761 <dt>Returns:</dt> 761 <dt>Return:</dt>
762 <dd> 762 <dd>
763 override value; None in case nothing is defined 763 override value; None in case nothing is defined
764 </dd> 764 </dd>
765 </dl> 765 </dl>
766 <dl> 766 <dl>
786 <dd> 786 <dd>
787 position to look at 787 position to look at
788 </dd> 788 </dd>
789 </dl> 789 </dl>
790 <dl> 790 <dl>
791 <dt>Returns:</dt> 791 <dt>Return:</dt>
792 <dd> 792 <dd>
793 the word at that position 793 the word at that position
794 </dd> 794 </dd>
795 </dl> 795 </dl>
796 <dl> 796 <dl>
812 812
813 <p> 813 <p>
814 Private method used to setup the Languages context sub menu. 814 Private method used to setup the Languages context sub menu.
815 </p> 815 </p>
816 <dl> 816 <dl>
817 <dt>Returns:</dt> 817 <dt>Return:</dt>
818 <dd> 818 <dd>
819 reference to the generated menu (QMenu) 819 reference to the generated menu (QMenu)
820 </dd> 820 </dd>
821 </dl> 821 </dl>
822 <a NAME="MiniEditor.__languageMenuTriggered" ID="MiniEditor.__languageMenuTriggered"></a> 822 <a NAME="MiniEditor.__languageMenuTriggered" ID="MiniEditor.__languageMenuTriggered"></a>
861 <dd> 861 <dd>
862 name of the file 862 name of the file
863 </dd> 863 </dd>
864 </dl> 864 </dl>
865 <dl> 865 <dl>
866 <dt>Returns:</dt> 866 <dt>Return:</dt>
867 <dd> 867 <dd>
868 EditorConfig dictionary 868 EditorConfig dictionary
869 </dd> 869 </dd>
870 </dl> 870 </dl>
871 <dl> 871 <dl>
905 905
906 <p> 906 <p>
907 Private method to ask the user to save the file, if it was modified. 907 Private method to ask the user to save the file, if it was modified.
908 </p> 908 </p>
909 <dl> 909 <dl>
910 <dt>Returns:</dt> 910 <dt>Return:</dt>
911 <dd> 911 <dd>
912 flag indicating, if it is ok to continue (boolean) 912 flag indicating, if it is ok to continue (boolean)
913 </dd> 913 </dd>
914 </dl> 914 </dl>
915 <a NAME="MiniEditor.__modificationChanged" ID="MiniEditor.__modificationChanged"></a> 915 <a NAME="MiniEditor.__modificationChanged" ID="MiniEditor.__modificationChanged"></a>
1028 1028
1029 <p> 1029 <p>
1030 Private slot to save a file. 1030 Private slot to save a file.
1031 </p> 1031 </p>
1032 <dl> 1032 <dl>
1033 <dt>Returns:</dt> 1033 <dt>Return:</dt>
1034 <dd> 1034 <dd>
1035 flag indicating success (boolean) 1035 flag indicating success (boolean)
1036 </dd> 1036 </dd>
1037 </dl> 1037 </dl>
1038 <a NAME="MiniEditor.__saveAs" ID="MiniEditor.__saveAs"></a> 1038 <a NAME="MiniEditor.__saveAs" ID="MiniEditor.__saveAs"></a>
1041 1041
1042 <p> 1042 <p>
1043 Private slot to save a file with a new name. 1043 Private slot to save a file with a new name.
1044 </p> 1044 </p>
1045 <dl> 1045 <dl>
1046 <dt>Returns:</dt> 1046 <dt>Return:</dt>
1047 <dd> 1047 <dd>
1048 flag indicating success (boolean) 1048 flag indicating success (boolean)
1049 </dd> 1049 </dd>
1050 </dl> 1050 </dl>
1051 <a NAME="MiniEditor.__saveCopy" ID="MiniEditor.__saveCopy"></a> 1051 <a NAME="MiniEditor.__saveCopy" ID="MiniEditor.__saveCopy"></a>
1068 <dd> 1068 <dd>
1069 name of the file to save to 1069 name of the file to save to
1070 </dd> 1070 </dd>
1071 </dl> 1071 </dl>
1072 <dl> 1072 <dl>
1073 <dt>Returns:</dt> 1073 <dt>Return:</dt>
1074 <dd> 1074 <dd>
1075 flag indicating success 1075 flag indicating success
1076 </dd> 1076 </dd>
1077 </dl> 1077 </dl>
1078 <dl> 1078 <dl>
1115 1115
1116 <p> 1116 <p>
1117 Private method to select a specific pygments lexer. 1117 Private method to select a specific pygments lexer.
1118 </p> 1118 </p>
1119 <dl> 1119 <dl>
1120 <dt>Returns:</dt> 1120 <dt>Return:</dt>
1121 <dd> 1121 <dd>
1122 name of the selected pygments lexer 1122 name of the selected pygments lexer
1123 </dd> 1123 </dd>
1124 </dl> 1124 </dl>
1125 <dl> 1125 <dl>
1245 <dd> 1245 <dd>
1246 full pathname of the given file (string) 1246 full pathname of the given file (string)
1247 </dd> 1247 </dd>
1248 </dl> 1248 </dl>
1249 <dl> 1249 <dl>
1250 <dt>Returns:</dt> 1250 <dt>Return:</dt>
1251 <dd> 1251 <dd>
1252 filename part (string) 1252 filename part (string)
1253 </dd> 1253 </dd>
1254 </dl> 1254 </dl>
1255 <a NAME="MiniEditor.__styleNeeded" ID="MiniEditor.__styleNeeded"></a> 1255 <a NAME="MiniEditor.__styleNeeded" ID="MiniEditor.__styleNeeded"></a>
1293 <dd> 1293 <dd>
1294 name of the file to be written to 1294 name of the file to be written to
1295 </dd> 1295 </dd>
1296 </dl> 1296 </dl>
1297 <dl> 1297 <dl>
1298 <dt>Returns:</dt> 1298 <dt>Return:</dt>
1299 <dd> 1299 <dd>
1300 flag indicating success 1300 flag indicating success
1301 </dd> 1301 </dd>
1302 </dl> 1302 </dl>
1303 <dl> 1303 <dl>
1361 1361
1362 <p> 1362 <p>
1363 Public method to fulfill the ViewManager interface. 1363 Public method to fulfill the ViewManager interface.
1364 </p> 1364 </p>
1365 <dl> 1365 <dl>
1366 <dt>Returns:</dt> 1366 <dt>Return:</dt>
1367 <dd> 1367 <dd>
1368 reference to the text edit component (QsciScintillaCompat) 1368 reference to the text edit component (QsciScintillaCompat)
1369 </dd> 1369 </dd>
1370 </dl> 1370 </dl>
1371 <a NAME="MiniEditor.clearSearchIndicators" ID="MiniEditor.clearSearchIndicators"></a> 1371 <a NAME="MiniEditor.clearSearchIndicators" ID="MiniEditor.clearSearchIndicators"></a>
1395 1395
1396 <p> 1396 <p>
1397 Public method to return the name of the file being displayed. 1397 Public method to return the name of the file being displayed.
1398 </p> 1398 </p>
1399 <dl> 1399 <dl>
1400 <dt>Returns:</dt> 1400 <dt>Return:</dt>
1401 <dd> 1401 <dd>
1402 filename of the displayed file (string) 1402 filename of the displayed file (string)
1403 </dd> 1403 </dd>
1404 </dl> 1404 </dl>
1405 <a NAME="MiniEditor.getLanguage" ID="MiniEditor.getLanguage"></a> 1405 <a NAME="MiniEditor.getLanguage" ID="MiniEditor.getLanguage"></a>
1421 flag indicating to normalize some lexer 1421 flag indicating to normalize some lexer
1422 names for Pygments 1422 names for Pygments
1423 </dd> 1423 </dd>
1424 </dl> 1424 </dl>
1425 <dl> 1425 <dl>
1426 <dt>Returns:</dt> 1426 <dt>Return:</dt>
1427 <dd> 1427 <dd>
1428 language of the editor 1428 language of the editor
1429 </dd> 1429 </dd>
1430 </dl> 1430 </dl>
1431 <dl> 1431 <dl>
1447 <dd> 1447 <dd>
1448 list to return (must be 'search' or 'replace') 1448 list to return (must be 'search' or 'replace')
1449 </dd> 1449 </dd>
1450 </dl> 1450 </dl>
1451 <dl> 1451 <dl>
1452 <dt>Returns:</dt> 1452 <dt>Return:</dt>
1453 <dd> 1453 <dd>
1454 the requested history list (list of strings) 1454 the requested history list (list of strings)
1455 </dd> 1455 </dd>
1456 </dl> 1456 </dl>
1457 <a NAME="MiniEditor.gotoLine" ID="MiniEditor.gotoLine"></a> 1457 <a NAME="MiniEditor.gotoLine" ID="MiniEditor.gotoLine"></a>
1465 1465
1466 <dt><i>line</i> (int)</dt> 1466 <dt><i>line</i> (int)</dt>
1467 <dd> 1467 <dd>
1468 line number to go to 1468 line number to go to
1469 </dd> 1469 </dd>
1470 <dt><i>pos=</i> (int)</dt> 1470 <dt><i>pos</i> (int)</dt>
1471 <dd> 1471 <dd>
1472 position in line to go to 1472 position in line to go to
1473 </dd> 1473 </dd>
1474 </dl> 1474 </dl>
1475 <a NAME="MiniEditor.setLanguage" ID="MiniEditor.setLanguage"></a> 1475 <a NAME="MiniEditor.setLanguage" ID="MiniEditor.setLanguage"></a>
1489 <dt><i>initTextDisplay</i></dt> 1489 <dt><i>initTextDisplay</i></dt>
1490 <dd> 1490 <dd>
1491 flag indicating an initialization of the text 1491 flag indicating an initialization of the text
1492 display is required as well (boolean) 1492 display is required as well (boolean)
1493 </dd> 1493 </dd>
1494 <dt><i>pyname=</i></dt> 1494 <dt><i>pyname</i></dt>
1495 <dd> 1495 <dd>
1496 name of the pygments lexer to use (string) 1496 name of the pygments lexer to use (string)
1497 </dd> 1497 </dd>
1498 </dl> 1498 </dl>
1499 <a NAME="MiniEditor.setSearchIndicator" ID="MiniEditor.setSearchIndicator"></a> 1499 <a NAME="MiniEditor.setSearchIndicator" ID="MiniEditor.setSearchIndicator"></a>
1567 <p> 1567 <p>
1568 Public method to determine the selection or the current word for the 1568 Public method to determine the selection or the current word for the
1569 next find operation. 1569 next find operation.
1570 </p> 1570 </p>
1571 <dl> 1571 <dl>
1572 <dt>Returns:</dt> 1572 <dt>Return:</dt>
1573 <dd> 1573 <dd>
1574 selection or current word (string) 1574 selection or current word (string)
1575 </dd> 1575 </dd>
1576 </dl> 1576 </dl>
1577 <div align="right"><a href="#top">Up</a></div> 1577 <div align="right"><a href="#top">Up</a></div>
1587 <h3>Derived from</h3> 1587 <h3>Derived from</h3>
1588 QsciScintillaCompat 1588 QsciScintillaCompat
1589 <h3>Class Attributes</h3> 1589 <h3>Class Attributes</h3>
1590 1590
1591 <table> 1591 <table>
1592 <tr><td>None</td></tr> 1592 <tr><td>EncloseChars</td></tr>
1593 </table> 1593 </table>
1594 <h3>Class Methods</h3> 1594 <h3>Class Methods</h3>
1595 1595
1596 <table> 1596 <table>
1597 <tr><td>None</td></tr> 1597 <tr><td>None</td></tr>
1603 <tr> 1603 <tr>
1604 <td><a href="#MiniScintilla.__init__">MiniScintilla</a></td> 1604 <td><a href="#MiniScintilla.__init__">MiniScintilla</a></td>
1605 <td>Constructor</td> 1605 <td>Constructor</td>
1606 </tr> 1606 </tr>
1607 <tr> 1607 <tr>
1608 <td><a href="#MiniScintilla.encloseSelectedText">encloseSelectedText</a></td>
1609 <td>Local function to enclose the current selection with some characters.</td>
1610 </tr>
1611 <tr>
1608 <td><a href="#MiniScintilla.focusInEvent">focusInEvent</a></td> 1612 <td><a href="#MiniScintilla.focusInEvent">focusInEvent</a></td>
1609 <td>Protected method called when the editor receives focus.</td> 1613 <td>Protected method called when the editor receives focus.</td>
1610 </tr> 1614 </tr>
1611 <tr> 1615 <tr>
1612 <td><a href="#MiniScintilla.focusOutEvent">focusOutEvent</a></td> 1616 <td><a href="#MiniScintilla.focusOutEvent">focusOutEvent</a></td>
1613 <td>Protected method called when the editor loses focus.</td> 1617 <td>Protected method called when the editor loses focus.</td>
1614 </tr> 1618 </tr>
1615 <tr> 1619 <tr>
1616 <td><a href="#MiniScintilla.getFileName">getFileName</a></td> 1620 <td><a href="#MiniScintilla.getFileName">getFileName</a></td>
1617 <td>Public method to return the name of the file being displayed.</td> 1621 <td>Public method to return the name of the file being displayed.</td>
1622 </tr>
1623 <tr>
1624 <td><a href="#MiniScintilla.keyPressEvent">keyPressEvent</a></td>
1625 <td>Protected method to handle the user input a key at a time.</td>
1618 </tr> 1626 </tr>
1619 <tr> 1627 <tr>
1620 <td><a href="#MiniScintilla.removeTrailingWhitespace">removeTrailingWhitespace</a></td> 1628 <td><a href="#MiniScintilla.removeTrailingWhitespace">removeTrailingWhitespace</a></td>
1621 <td>Public method to remove trailing whitespace.</td> 1629 <td>Public method to remove trailing whitespace.</td>
1622 </tr> 1630 </tr>
1634 <p> 1642 <p>
1635 Constructor 1643 Constructor
1636 </p> 1644 </p>
1637 <dl> 1645 <dl>
1638 1646
1639 <dt><i>parent</i></dt> 1647 <dt><i>parent</i> (QWidget)</dt>
1640 <dd> 1648 <dd>
1641 parent widget (QWidget) 1649 parent widget
1650 </dd>
1651 </dl>
1652 <a NAME="MiniScintilla.encloseSelectedText" ID="MiniScintilla.encloseSelectedText"></a>
1653 <h4>MiniScintilla.encloseSelectedText</h4>
1654 <b>encloseSelectedText</b>(<i></i>)
1655
1656 <p>
1657 Local function to enclose the current selection with some
1658 characters.
1659 </p>
1660 <dl>
1661
1662 <dt><i>encString</i> (str)</dt>
1663 <dd>
1664 string to use to enclose the selection
1665 (one or two characters)
1642 </dd> 1666 </dd>
1643 </dl> 1667 </dl>
1644 <a NAME="MiniScintilla.focusInEvent" ID="MiniScintilla.focusInEvent"></a> 1668 <a NAME="MiniScintilla.focusInEvent" ID="MiniScintilla.focusInEvent"></a>
1645 <h4>MiniScintilla.focusInEvent</h4> 1669 <h4>MiniScintilla.focusInEvent</h4>
1646 <b>focusInEvent</b>(<i>event</i>) 1670 <b>focusInEvent</b>(<i>event</i>)
1654 assuming, that it is in the vicinity of the old position after the 1678 assuming, that it is in the vicinity of the old position after the
1655 reread. 1679 reread.
1656 </p> 1680 </p>
1657 <dl> 1681 <dl>
1658 1682
1659 <dt><i>event</i></dt> 1683 <dt><i>event</i> (QFocusEvent)</dt>
1660 <dd> 1684 <dd>
1661 the event object (QFocusEvent) 1685 the event object
1662 </dd> 1686 </dd>
1663 </dl> 1687 </dl>
1664 <a NAME="MiniScintilla.focusOutEvent" ID="MiniScintilla.focusOutEvent"></a> 1688 <a NAME="MiniScintilla.focusOutEvent" ID="MiniScintilla.focusOutEvent"></a>
1665 <h4>MiniScintilla.focusOutEvent</h4> 1689 <h4>MiniScintilla.focusOutEvent</h4>
1666 <b>focusOutEvent</b>(<i>event</i>) 1690 <b>focusOutEvent</b>(<i>event</i>)
1668 <p> 1692 <p>
1669 Protected method called when the editor loses focus. 1693 Protected method called when the editor loses focus.
1670 </p> 1694 </p>
1671 <dl> 1695 <dl>
1672 1696
1673 <dt><i>event</i></dt> 1697 <dt><i>event</i> (QFocusEvent)</dt>
1674 <dd> 1698 <dd>
1675 the event object (QFocusEvent) 1699 the event object
1676 </dd> 1700 </dd>
1677 </dl> 1701 </dl>
1678 <a NAME="MiniScintilla.getFileName" ID="MiniScintilla.getFileName"></a> 1702 <a NAME="MiniScintilla.getFileName" ID="MiniScintilla.getFileName"></a>
1679 <h4>MiniScintilla.getFileName</h4> 1703 <h4>MiniScintilla.getFileName</h4>
1680 <b>getFileName</b>(<i></i>) 1704 <b>getFileName</b>(<i></i>)
1681 1705
1682 <p> 1706 <p>
1683 Public method to return the name of the file being displayed. 1707 Public method to return the name of the file being displayed.
1684 </p> 1708 </p>
1685 <dl> 1709 <dl>
1686 <dt>Returns:</dt> 1710 <dt>Return:</dt>
1687 <dd> 1711 <dd>
1688 filename of the displayed file (string) 1712 filename of the displayed file
1713 </dd>
1714 </dl>
1715 <dl>
1716 <dt>Return Type:</dt>
1717 <dd>
1718 str
1719 </dd>
1720 </dl>
1721 <a NAME="MiniScintilla.keyPressEvent" ID="MiniScintilla.keyPressEvent"></a>
1722 <h4>MiniScintilla.keyPressEvent</h4>
1723 <b>keyPressEvent</b>(<i>ev</i>)
1724
1725 <p>
1726 Protected method to handle the user input a key at a time.
1727 </p>
1728 <dl>
1729
1730 <dt><i>ev</i> (QKeyEvent)</dt>
1731 <dd>
1732 key event
1689 </dd> 1733 </dd>
1690 </dl> 1734 </dl>
1691 <a NAME="MiniScintilla.removeTrailingWhitespace" ID="MiniScintilla.removeTrailingWhitespace"></a> 1735 <a NAME="MiniScintilla.removeTrailingWhitespace" ID="MiniScintilla.removeTrailingWhitespace"></a>
1692 <h4>MiniScintilla.removeTrailingWhitespace</h4> 1736 <h4>MiniScintilla.removeTrailingWhitespace</h4>
1693 <b>removeTrailingWhitespace</b>(<i></i>) 1737 <b>removeTrailingWhitespace</b>(<i></i>)

Mercurial Repository: eric

eric ide

mercurial