Documentation/Source/eric5.QScintilla.Editor.html

branch
Py2 comp.
changeset 3484
645c12de6b0c
parent 3456
96232974dcdb
parent 3446
5a670e55adbb
child 3579
eccd12461319
equal deleted inserted replaced
3456:96232974dcdb 3484:645c12de6b0c
288 <td>Private method to get the filename of the file containing coverage info.</td> 288 <td>Private method to get the filename of the file containing coverage info.</td>
289 </tr><tr> 289 </tr><tr>
290 <td><a href="#Editor.__getMacroName">__getMacroName</a></td> 290 <td><a href="#Editor.__getMacroName">__getMacroName</a></td>
291 <td>Private method to select a macro name from the list of macros.</td> 291 <td>Private method to select a macro name from the list of macros.</td>
292 </tr><tr> 292 </tr><tr>
293 <td><a href="#Editor.__getPyVersion">__getPyVersion</a></td>
294 <td>Private method to return the Python main version (2 or 3) or 0 if it's not a Python file at all.</td>
295 </tr><tr>
293 <td><a href="#Editor.__ignoreSpellingAlways">__ignoreSpellingAlways</a></td> 296 <td><a href="#Editor.__ignoreSpellingAlways">__ignoreSpellingAlways</a></td>
294 <td>Private to always ignore the word below the spelling context menu.</td> 297 <td>Private to always ignore the word below the spelling context menu.</td>
295 </tr><tr> 298 </tr><tr>
296 <td><a href="#Editor.__indentLine">__indentLine</a></td> 299 <td><a href="#Editor.__indentLine">__indentLine</a></td>
297 <td>Private method to indent or unindent the current line.</td> 300 <td>Private method to indent or unindent the current line.</td>
324 <td>Private method used to setup the Languages context sub menu.</td> 327 <td>Private method used to setup the Languages context sub menu.</td>
325 </tr><tr> 328 </tr><tr>
326 <td><a href="#Editor.__initContextMenuMargins">__initContextMenuMargins</a></td> 329 <td><a href="#Editor.__initContextMenuMargins">__initContextMenuMargins</a></td>
327 <td>Private method used to setup the context menu for the margins.</td> 330 <td>Private method used to setup the context menu for the margins.</td>
328 </tr><tr> 331 </tr><tr>
332 <td><a href="#Editor.__initContextMenuReopenWithEncoding">__initContextMenuReopenWithEncoding</a></td>
333 <td>Private method used to setup the Reopen With Encoding context sub menu.</td>
334 </tr><tr>
329 <td><a href="#Editor.__initContextMenuResources">__initContextMenuResources</a></td> 335 <td><a href="#Editor.__initContextMenuResources">__initContextMenuResources</a></td>
330 <td>Private method used to setup the Resources context sub menu.</td> 336 <td>Private method used to setup the Resources context sub menu.</td>
331 </tr><tr> 337 </tr><tr>
332 <td><a href="#Editor.__initContextMenuSeparateMargins">__initContextMenuSeparateMargins</a></td> 338 <td><a href="#Editor.__initContextMenuSeparateMargins">__initContextMenuSeparateMargins</a></td>
333 <td>Private method used to setup the context menu for the separated margins.</td> 339 <td>Private method used to setup the context menu for the separated margins.</td>
444 <td>Private slot to remove the word below the context menu to the dictionary.</td> 450 <td>Private slot to remove the word below the context menu to the dictionary.</td>
445 </tr><tr> 451 </tr><tr>
446 <td><a href="#Editor.__removeTrailingWhitespace">__removeTrailingWhitespace</a></td> 452 <td><a href="#Editor.__removeTrailingWhitespace">__removeTrailingWhitespace</a></td>
447 <td>Private method to remove trailing whitespace.</td> 453 <td>Private method to remove trailing whitespace.</td>
448 </tr><tr> 454 </tr><tr>
455 <td><a href="#Editor.__reopenWithEncodingMenuTriggered">__reopenWithEncodingMenuTriggered</a></td>
456 <td>Private method to handle the rereading of the file with a selected encoding.</td>
457 </tr><tr>
449 <td><a href="#Editor.__resetLanguage">__resetLanguage</a></td> 458 <td><a href="#Editor.__resetLanguage">__resetLanguage</a></td>
450 <td>Private method used to reset the language selection.</td> 459 <td>Private method used to reset the language selection.</td>
451 </tr><tr> 460 </tr><tr>
452 <td><a href="#Editor.__resetOnlineChangeTraceInfo">__resetOnlineChangeTraceInfo</a></td> 461 <td><a href="#Editor.__resetOnlineChangeTraceInfo">__resetOnlineChangeTraceInfo</a></td>
453 <td>Private slot to reset the online change trace info.</td> 462 <td>Private slot to reset the online change trace info.</td>
732 <td>Public method called when the editor loses focus.</td> 741 <td>Public method called when the editor loses focus.</td>
733 </tr><tr> 742 </tr><tr>
734 <td><a href="#Editor.gestureEvent">gestureEvent</a></td> 743 <td><a href="#Editor.gestureEvent">gestureEvent</a></td>
735 <td>Protected method handling gesture events.</td> 744 <td>Protected method handling gesture events.</td>
736 </tr><tr> 745 </tr><tr>
746 <td><a href="#Editor.getBookmarkLines">getBookmarkLines</a></td>
747 <td>Public method to get the lines containing a bookmark.</td>
748 </tr><tr>
737 <td><a href="#Editor.getBookmarks">getBookmarks</a></td> 749 <td><a href="#Editor.getBookmarks">getBookmarks</a></td>
738 <td>Public method to retrieve the bookmarks.</td> 750 <td>Public method to retrieve the bookmarks.</td>
739 </tr><tr> 751 </tr><tr>
752 <td><a href="#Editor.getBreakpointLines">getBreakpointLines</a></td>
753 <td>Public method to get the lines containing a breakpoint.</td>
754 </tr><tr>
755 <td><a href="#Editor.getChangeLines">getChangeLines</a></td>
756 <td>Public method to get the lines containing a change.</td>
757 </tr><tr>
740 <td><a href="#Editor.getCompleter">getCompleter</a></td> 758 <td><a href="#Editor.getCompleter">getCompleter</a></td>
741 <td>Public method to retrieve a reference to the completer object.</td> 759 <td>Public method to retrieve a reference to the completer object.</td>
742 </tr><tr> 760 </tr><tr>
761 <td><a href="#Editor.getCoverageLines">getCoverageLines</a></td>
762 <td>Public method to get the lines containing a coverage marker.</td>
763 </tr><tr>
743 <td><a href="#Editor.getCurrentWord">getCurrentWord</a></td> 764 <td><a href="#Editor.getCurrentWord">getCurrentWord</a></td>
744 <td>Public method to get the word at the current position.</td> 765 <td>Public method to get the word at the current position.</td>
745 </tr><tr> 766 </tr><tr>
746 <td><a href="#Editor.getCurrentWordBoundaries">getCurrentWordBoundaries</a></td> 767 <td><a href="#Editor.getCurrentWordBoundaries">getCurrentWordBoundaries</a></td>
747 <td>Public method to get the word boundaries at the current position.</td> 768 <td>Public method to get the word boundaries at the current position.</td>
771 <td>Public method to get a reference to the main context menu or a submenu.</td> 792 <td>Public method to get a reference to the main context menu or a submenu.</td>
772 </tr><tr> 793 </tr><tr>
773 <td><a href="#Editor.getNoName">getNoName</a></td> 794 <td><a href="#Editor.getNoName">getNoName</a></td>
774 <td>Public method to get the display string for an unnamed editor.</td> 795 <td>Public method to get the display string for an unnamed editor.</td>
775 </tr><tr> 796 </tr><tr>
776 <td><a href="#Editor.getPyVersion">getPyVersion</a></td>
777 <td>Public methode to return the Python main version (2 or 3) or 0 if it's not a Python file at all.</td>
778 </tr><tr>
779 <td><a href="#Editor.getSearchText">getSearchText</a></td> 797 <td><a href="#Editor.getSearchText">getSearchText</a></td>
780 <td>Public method to determine the selection or the current word for the next search operation.</td> 798 <td>Public method to determine the selection or the current word for the next search operation.</td>
781 </tr><tr> 799 </tr><tr>
782 <td><a href="#Editor.getSharingStatus">getSharingStatus</a></td> 800 <td><a href="#Editor.getSharingStatus">getSharingStatus</a></td>
783 <td>Public method to get some share status info.</td> 801 <td>Public method to get some share status info.</td>
784 </tr><tr> 802 </tr><tr>
803 <td><a href="#Editor.getSyntaxErrorLines">getSyntaxErrorLines</a></td>
804 <td>Public method to get the lines containing a syntax error.</td>
805 </tr><tr>
785 <td><a href="#Editor.getSyntaxErrors">getSyntaxErrors</a></td> 806 <td><a href="#Editor.getSyntaxErrors">getSyntaxErrors</a></td>
786 <td>Public method to retrieve the syntax error markers.</td> 807 <td>Public method to retrieve the syntax error markers.</td>
787 </tr><tr> 808 </tr><tr>
809 <td><a href="#Editor.getTaskLines">getTaskLines</a></td>
810 <td>Public method to get the lines containing a task.</td>
811 </tr><tr>
812 <td><a href="#Editor.getWarningLines">getWarningLines</a></td>
813 <td>Public method to get the lines containing a warning.</td>
814 </tr><tr>
788 <td><a href="#Editor.getWarnings">getWarnings</a></td> 815 <td><a href="#Editor.getWarnings">getWarnings</a></td>
789 <td>Public method to retrieve the warning markers.</td> 816 <td>Public method to retrieve the warning markers.</td>
790 </tr><tr> 817 </tr><tr>
791 <td><a href="#Editor.getWord">getWord</a></td> 818 <td><a href="#Editor.getWord">getWord</a></td>
792 <td>Public method to get the word at a position.</td> 819 <td>Public method to get the word at a position.</td>
849 <td>Public method to make sure that the highlight is visible.</td> 876 <td>Public method to make sure that the highlight is visible.</td>
850 </tr><tr> 877 </tr><tr>
851 <td><a href="#Editor.indentLineOrSelection">indentLineOrSelection</a></td> 878 <td><a href="#Editor.indentLineOrSelection">indentLineOrSelection</a></td>
852 <td>Public slot to indent the current line or current selection.</td> 879 <td>Public slot to indent the current line or current selection.</td>
853 </tr><tr> 880 </tr><tr>
881 <td><a href="#Editor.isJavascriptFile">isJavascriptFile</a></td>
882 <td>Public method to return a flag indicating a Javascript file.</td>
883 </tr><tr>
854 <td><a href="#Editor.isLastEditPositionAvailable">isLastEditPositionAvailable</a></td> 884 <td><a href="#Editor.isLastEditPositionAvailable">isLastEditPositionAvailable</a></td>
855 <td>Public method to check, if a last edit position is available.</td> 885 <td>Public method to check, if a last edit position is available.</td>
856 </tr><tr> 886 </tr><tr>
857 <td><a href="#Editor.isPy2File">isPy2File</a></td> 887 <td><a href="#Editor.isPy2File">isPy2File</a></td>
858 <td>Public method to return a flag indicating a Python file.</td> 888 <td>Public method to return a flag indicating a Python2 file.</td>
859 </tr><tr> 889 </tr><tr>
860 <td><a href="#Editor.isPy3File">isPy3File</a></td> 890 <td><a href="#Editor.isPy3File">isPy3File</a></td>
861 <td>Public method to return a flag indicating a Python3 file.</td> 891 <td>Public method to return a flag indicating a Python3 file.</td>
862 </tr><tr> 892 </tr><tr>
893 <td><a href="#Editor.isPyFile">isPyFile</a></td>
894 <td>Public method to return a flag indicating a Python (2 or 3) file.</td>
895 </tr><tr>
863 <td><a href="#Editor.isRubyFile">isRubyFile</a></td> 896 <td><a href="#Editor.isRubyFile">isRubyFile</a></td>
864 <td>Public method to return a flag indicating a Ruby file.</td> 897 <td>Public method to return a flag indicating a Ruby file.</td>
865 </tr><tr> 898 </tr><tr>
866 <td><a href="#Editor.isSpellCheckRegion">isSpellCheckRegion</a></td> 899 <td><a href="#Editor.isSpellCheckRegion">isSpellCheckRegion</a></td>
867 <td>Public method to check, if the given position is within a region, that should be spell checked.</td> 900 <td>Public method to check, if the given position is within a region, that should be spell checked.</td>
975 <td>Public method to refresh the code coverage annotations.</td> 1008 <td>Public method to refresh the code coverage annotations.</td>
976 </tr><tr> 1009 </tr><tr>
977 <td><a href="#Editor.removeClone">removeClone</a></td> 1010 <td><a href="#Editor.removeClone">removeClone</a></td>
978 <td>Public method to remove a clone from our list.</td> 1011 <td>Public method to remove a clone from our list.</td>
979 </tr><tr> 1012 </tr><tr>
1013 <td><a href="#Editor.resizeEvent">resizeEvent</a></td>
1014 <td>Protected method handling resize events.</td>
1015 </tr><tr>
980 <td><a href="#Editor.revertToUnmodified">revertToUnmodified</a></td> 1016 <td><a href="#Editor.revertToUnmodified">revertToUnmodified</a></td>
981 <td>Public method to revert back to the last saved state.</td> 1017 <td>Public method to revert back to the last saved state.</td>
982 </tr><tr> 1018 </tr><tr>
983 <td><a href="#Editor.saveFile">saveFile</a></td> 1019 <td><a href="#Editor.saveFile">saveFile</a></td>
984 <td>Public slot to save the text to a file.</td> 1020 <td>Public slot to save the text to a file.</td>
1088 <td><a href="#Editor.unsetAutoCompletionHook">unsetAutoCompletionHook</a></td> 1124 <td><a href="#Editor.unsetAutoCompletionHook">unsetAutoCompletionHook</a></td>
1089 <td>Public method to unset a previously installed autocompletion hook.</td> 1125 <td>Public method to unset a previously installed autocompletion hook.</td>
1090 </tr><tr> 1126 </tr><tr>
1091 <td><a href="#Editor.unsetCallTipHook">unsetCallTipHook</a></td> 1127 <td><a href="#Editor.unsetCallTipHook">unsetCallTipHook</a></td>
1092 <td>Public method to unset a calltip hook.</td> 1128 <td>Public method to unset a calltip hook.</td>
1129 </tr><tr>
1130 <td><a href="#Editor.viewportEvent">viewportEvent</a></td>
1131 <td>Protected method handling event of the viewport.</td>
1093 </tr><tr> 1132 </tr><tr>
1094 <td><a href="#Editor.wheelEvent">wheelEvent</a></td> 1133 <td><a href="#Editor.wheelEvent">wheelEvent</a></td>
1095 <td>Protected method to handle wheel events.</td> 1134 <td>Protected method to handle wheel events.</td>
1096 </tr><tr> 1135 </tr><tr>
1097 <td><a href="#Editor.writeFile">writeFile</a></td> 1136 <td><a href="#Editor.writeFile">writeFile</a></td>
1595 <dt>Returns:</dt> 1634 <dt>Returns:</dt>
1596 <dd> 1635 <dd>
1597 Tuple of macro name and a flag, indicating, if the user 1636 Tuple of macro name and a flag, indicating, if the user
1598 pressed ok or canceled the operation. (string, boolean) 1637 pressed ok or canceled the operation. (string, boolean)
1599 </dd> 1638 </dd>
1639 </dl><a NAME="Editor.__getPyVersion" ID="Editor.__getPyVersion"></a>
1640 <h4>Editor.__getPyVersion</h4>
1641 <b>__getPyVersion</b>(<i></i>)
1642 <p>
1643 Private method to return the Python main version (2 or 3) or 0 if it's
1644 not a Python file at all.
1645 </p><dl>
1646 <dt>Returns:</dt>
1647 <dd>
1648 Python version (2 or 3) or 0 if it's not a Python file (int)
1649 </dd>
1600 </dl><a NAME="Editor.__ignoreSpellingAlways" ID="Editor.__ignoreSpellingAlways"></a> 1650 </dl><a NAME="Editor.__ignoreSpellingAlways" ID="Editor.__ignoreSpellingAlways"></a>
1601 <h4>Editor.__ignoreSpellingAlways</h4> 1651 <h4>Editor.__ignoreSpellingAlways</h4>
1602 <b>__ignoreSpellingAlways</b>(<i></i>) 1652 <b>__ignoreSpellingAlways</b>(<i></i>)
1603 <p> 1653 <p>
1604 Private to always ignore the word below the spelling context menu. 1654 Private to always ignore the word below the spelling context menu.
1704 </dl><a NAME="Editor.__initContextMenuMargins" ID="Editor.__initContextMenuMargins"></a> 1754 </dl><a NAME="Editor.__initContextMenuMargins" ID="Editor.__initContextMenuMargins"></a>
1705 <h4>Editor.__initContextMenuMargins</h4> 1755 <h4>Editor.__initContextMenuMargins</h4>
1706 <b>__initContextMenuMargins</b>(<i></i>) 1756 <b>__initContextMenuMargins</b>(<i></i>)
1707 <p> 1757 <p>
1708 Private method used to setup the context menu for the margins. 1758 Private method used to setup the context menu for the margins.
1709 </p><a NAME="Editor.__initContextMenuResources" ID="Editor.__initContextMenuResources"></a> 1759 </p><a NAME="Editor.__initContextMenuReopenWithEncoding" ID="Editor.__initContextMenuReopenWithEncoding"></a>
1760 <h4>Editor.__initContextMenuReopenWithEncoding</h4>
1761 <b>__initContextMenuReopenWithEncoding</b>(<i></i>)
1762 <p>
1763 Private method used to setup the Reopen With Encoding context sub menu.
1764 </p><dl>
1765 <dt>Returns:</dt>
1766 <dd>
1767 reference to the generated menu (QMenu)
1768 </dd>
1769 </dl><a NAME="Editor.__initContextMenuResources" ID="Editor.__initContextMenuResources"></a>
1710 <h4>Editor.__initContextMenuResources</h4> 1770 <h4>Editor.__initContextMenuResources</h4>
1711 <b>__initContextMenuResources</b>(<i></i>) 1771 <b>__initContextMenuResources</b>(<i></i>)
1712 <p> 1772 <p>
1713 Private method used to setup the Resources context sub menu. 1773 Private method used to setup the Resources context sub menu.
1714 </p><dl> 1774 </p><dl>
1951 <b>__newViewNewSplit</b>(<i></i>) 2011 <b>__newViewNewSplit</b>(<i></i>)
1952 <p> 2012 <p>
1953 Private slot to create a new view to an open document. 2013 Private slot to create a new view to an open document.
1954 </p><a NAME="Editor.__normalizedEncoding" ID="Editor.__normalizedEncoding"></a> 2014 </p><a NAME="Editor.__normalizedEncoding" ID="Editor.__normalizedEncoding"></a>
1955 <h4>Editor.__normalizedEncoding</h4> 2015 <h4>Editor.__normalizedEncoding</h4>
1956 <b>__normalizedEncoding</b>(<i></i>) 2016 <b>__normalizedEncoding</b>(<i>encoding=""</i>)
1957 <p> 2017 <p>
1958 Private method to calculate the normalized encoding string. 2018 Private method to calculate the normalized encoding string.
1959 </p><dl> 2019 </p><dl>
2020 <dt><i>encoding</i></dt>
2021 <dd>
2022 encoding to be normalized (string)
2023 </dd>
2024 </dl><dl>
1960 <dt>Returns:</dt> 2025 <dt>Returns:</dt>
1961 <dd> 2026 <dd>
1962 normalized encoding (string) 2027 normalized encoding (string)
1963 </dd> 2028 </dd>
1964 </dl><a NAME="Editor.__onlineChangeTraceTimerTimeout" ID="Editor.__onlineChangeTraceTimerTimeout"></a> 2029 </dl><a NAME="Editor.__onlineChangeTraceTimerTimeout" ID="Editor.__onlineChangeTraceTimerTimeout"></a>
2072 </p><a NAME="Editor.__removeTrailingWhitespace" ID="Editor.__removeTrailingWhitespace"></a> 2137 </p><a NAME="Editor.__removeTrailingWhitespace" ID="Editor.__removeTrailingWhitespace"></a>
2073 <h4>Editor.__removeTrailingWhitespace</h4> 2138 <h4>Editor.__removeTrailingWhitespace</h4>
2074 <b>__removeTrailingWhitespace</b>(<i></i>) 2139 <b>__removeTrailingWhitespace</b>(<i></i>)
2075 <p> 2140 <p>
2076 Private method to remove trailing whitespace. 2141 Private method to remove trailing whitespace.
2077 </p><a NAME="Editor.__resetLanguage" ID="Editor.__resetLanguage"></a> 2142 </p><a NAME="Editor.__reopenWithEncodingMenuTriggered" ID="Editor.__reopenWithEncodingMenuTriggered"></a>
2143 <h4>Editor.__reopenWithEncodingMenuTriggered</h4>
2144 <b>__reopenWithEncodingMenuTriggered</b>(<i>act</i>)
2145 <p>
2146 Private method to handle the rereading of the file with a selected
2147 encoding.
2148 </p><dl>
2149 <dt><i>act</i></dt>
2150 <dd>
2151 reference to the action that was triggered (QAction)
2152 </dd>
2153 </dl><a NAME="Editor.__resetLanguage" ID="Editor.__resetLanguage"></a>
2078 <h4>Editor.__resetLanguage</h4> 2154 <h4>Editor.__resetLanguage</h4>
2079 <b>__resetLanguage</b>(<i>propagate=True</i>) 2155 <b>__resetLanguage</b>(<i>propagate=True</i>)
2080 <p> 2156 <p>
2081 Private method used to reset the language selection. 2157 Private method used to reset the language selection.
2082 </p><dl> 2158 </p><dl>
2818 </p><dl> 2894 </p><dl>
2819 <dt><i>evt</i></dt> 2895 <dt><i>evt</i></dt>
2820 <dd> 2896 <dd>
2821 reference to the gesture event (QGestureEvent 2897 reference to the gesture event (QGestureEvent
2822 </dd> 2898 </dd>
2899 </dl><a NAME="Editor.getBookmarkLines" ID="Editor.getBookmarkLines"></a>
2900 <h4>Editor.getBookmarkLines</h4>
2901 <b>getBookmarkLines</b>(<i></i>)
2902 <p>
2903 Public method to get the lines containing a bookmark.
2904 </p><dl>
2905 <dt>Returns:</dt>
2906 <dd>
2907 list of lines containing a bookmark (list of integer)
2908 </dd>
2823 </dl><a NAME="Editor.getBookmarks" ID="Editor.getBookmarks"></a> 2909 </dl><a NAME="Editor.getBookmarks" ID="Editor.getBookmarks"></a>
2824 <h4>Editor.getBookmarks</h4> 2910 <h4>Editor.getBookmarks</h4>
2825 <b>getBookmarks</b>(<i></i>) 2911 <b>getBookmarks</b>(<i></i>)
2826 <p> 2912 <p>
2827 Public method to retrieve the bookmarks. 2913 Public method to retrieve the bookmarks.
2829 <dt>Returns:</dt> 2915 <dt>Returns:</dt>
2830 <dd> 2916 <dd>
2831 sorted list of all lines containing a bookmark 2917 sorted list of all lines containing a bookmark
2832 (list of integer) 2918 (list of integer)
2833 </dd> 2919 </dd>
2920 </dl><a NAME="Editor.getBreakpointLines" ID="Editor.getBreakpointLines"></a>
2921 <h4>Editor.getBreakpointLines</h4>
2922 <b>getBreakpointLines</b>(<i></i>)
2923 <p>
2924 Public method to get the lines containing a breakpoint.
2925 </p><dl>
2926 <dt>Returns:</dt>
2927 <dd>
2928 list of lines containing a breakpoint (list of integer)
2929 </dd>
2930 </dl><a NAME="Editor.getChangeLines" ID="Editor.getChangeLines"></a>
2931 <h4>Editor.getChangeLines</h4>
2932 <b>getChangeLines</b>(<i></i>)
2933 <p>
2934 Public method to get the lines containing a change.
2935 </p><dl>
2936 <dt>Returns:</dt>
2937 <dd>
2938 list of lines containing a change (list of integer)
2939 </dd>
2834 </dl><a NAME="Editor.getCompleter" ID="Editor.getCompleter"></a> 2940 </dl><a NAME="Editor.getCompleter" ID="Editor.getCompleter"></a>
2835 <h4>Editor.getCompleter</h4> 2941 <h4>Editor.getCompleter</h4>
2836 <b>getCompleter</b>(<i></i>) 2942 <b>getCompleter</b>(<i></i>)
2837 <p> 2943 <p>
2838 Public method to retrieve a reference to the completer object. 2944 Public method to retrieve a reference to the completer object.
2839 </p><dl> 2945 </p><dl>
2840 <dt>Returns:</dt> 2946 <dt>Returns:</dt>
2841 <dd> 2947 <dd>
2842 the completer object (CompleterBase) 2948 the completer object (CompleterBase)
2843 </dd> 2949 </dd>
2950 </dl><a NAME="Editor.getCoverageLines" ID="Editor.getCoverageLines"></a>
2951 <h4>Editor.getCoverageLines</h4>
2952 <b>getCoverageLines</b>(<i></i>)
2953 <p>
2954 Public method to get the lines containing a coverage marker.
2955 </p><dl>
2956 <dt>Returns:</dt>
2957 <dd>
2958 list of lines containing a coverage marker (list of integer)
2959 </dd>
2844 </dl><a NAME="Editor.getCurrentWord" ID="Editor.getCurrentWord"></a> 2960 </dl><a NAME="Editor.getCurrentWord" ID="Editor.getCurrentWord"></a>
2845 <h4>Editor.getCurrentWord</h4> 2961 <h4>Editor.getCurrentWord</h4>
2846 <b>getCurrentWord</b>(<i></i>) 2962 <b>getCurrentWord</b>(<i></i>)
2847 <p> 2963 <p>
2848 Public method to get the word at the current position. 2964 Public method to get the word at the current position.
2966 Public method to get the display string for an unnamed editor. 3082 Public method to get the display string for an unnamed editor.
2967 </p><dl> 3083 </p><dl>
2968 <dt>Returns:</dt> 3084 <dt>Returns:</dt>
2969 <dd> 3085 <dd>
2970 display string for this unnamed editor (string) 3086 display string for this unnamed editor (string)
2971 </dd>
2972 </dl><a NAME="Editor.getPyVersion" ID="Editor.getPyVersion"></a>
2973 <h4>Editor.getPyVersion</h4>
2974 <b>getPyVersion</b>(<i></i>)
2975 <p>
2976 Public methode to return the Python main version (2 or 3) or 0 if it's
2977 not a Python file at all.
2978 </p><dl>
2979 <dt>Returns:</dt>
2980 <dd>
2981 Python version (2 or 3) or 0 if it's not a Python file (int)
2982 </dd> 3087 </dd>
2983 </dl><a NAME="Editor.getSearchText" ID="Editor.getSearchText"></a> 3088 </dl><a NAME="Editor.getSearchText" ID="Editor.getSearchText"></a>
2984 <h4>Editor.getSearchText</h4> 3089 <h4>Editor.getSearchText</h4>
2985 <b>getSearchText</b>(<i>selectionOnly=False</i>) 3090 <b>getSearchText</b>(<i>selectionOnly=False</i>)
2986 <p> 3091 <p>
3008 tuple indicating, if the editor is sharable, the sharing 3113 tuple indicating, if the editor is sharable, the sharing
3009 status, if it is inside a locally initiated shared edit session 3114 status, if it is inside a locally initiated shared edit session
3010 and if it is inside a remotely initiated shared edit session 3115 and if it is inside a remotely initiated shared edit session
3011 (boolean, boolean, boolean, boolean) 3116 (boolean, boolean, boolean, boolean)
3012 </dd> 3117 </dd>
3118 </dl><a NAME="Editor.getSyntaxErrorLines" ID="Editor.getSyntaxErrorLines"></a>
3119 <h4>Editor.getSyntaxErrorLines</h4>
3120 <b>getSyntaxErrorLines</b>(<i></i>)
3121 <p>
3122 Public method to get the lines containing a syntax error.
3123 </p><dl>
3124 <dt>Returns:</dt>
3125 <dd>
3126 list of lines containing a syntax error (list of integer)
3127 </dd>
3013 </dl><a NAME="Editor.getSyntaxErrors" ID="Editor.getSyntaxErrors"></a> 3128 </dl><a NAME="Editor.getSyntaxErrors" ID="Editor.getSyntaxErrors"></a>
3014 <h4>Editor.getSyntaxErrors</h4> 3129 <h4>Editor.getSyntaxErrors</h4>
3015 <b>getSyntaxErrors</b>(<i></i>) 3130 <b>getSyntaxErrors</b>(<i></i>)
3016 <p> 3131 <p>
3017 Public method to retrieve the syntax error markers. 3132 Public method to retrieve the syntax error markers.
3018 </p><dl> 3133 </p><dl>
3019 <dt>Returns:</dt> 3134 <dt>Returns:</dt>
3020 <dd> 3135 <dd>
3021 sorted list of all lines containing a syntax error 3136 sorted list of all lines containing a syntax error
3022 (list of integer) 3137 (list of integer)
3138 </dd>
3139 </dl><a NAME="Editor.getTaskLines" ID="Editor.getTaskLines"></a>
3140 <h4>Editor.getTaskLines</h4>
3141 <b>getTaskLines</b>(<i></i>)
3142 <p>
3143 Public method to get the lines containing a task.
3144 </p><dl>
3145 <dt>Returns:</dt>
3146 <dd>
3147 list of lines containing a task (list of integer)
3148 </dd>
3149 </dl><a NAME="Editor.getWarningLines" ID="Editor.getWarningLines"></a>
3150 <h4>Editor.getWarningLines</h4>
3151 <b>getWarningLines</b>(<i></i>)
3152 <p>
3153 Public method to get the lines containing a warning.
3154 </p><dl>
3155 <dt>Returns:</dt>
3156 <dd>
3157 list of lines containing a warning (list of integer)
3023 </dd> 3158 </dd>
3024 </dl><a NAME="Editor.getWarnings" ID="Editor.getWarnings"></a> 3159 </dl><a NAME="Editor.getWarnings" ID="Editor.getWarnings"></a>
3025 <h4>Editor.getWarnings</h4> 3160 <h4>Editor.getWarnings</h4>
3026 <b>getWarnings</b>(<i></i>) 3161 <b>getWarnings</b>(<i></i>)
3027 <p> 3162 <p>
3274 </p><a NAME="Editor.indentLineOrSelection" ID="Editor.indentLineOrSelection"></a> 3409 </p><a NAME="Editor.indentLineOrSelection" ID="Editor.indentLineOrSelection"></a>
3275 <h4>Editor.indentLineOrSelection</h4> 3410 <h4>Editor.indentLineOrSelection</h4>
3276 <b>indentLineOrSelection</b>(<i></i>) 3411 <b>indentLineOrSelection</b>(<i></i>)
3277 <p> 3412 <p>
3278 Public slot to indent the current line or current selection. 3413 Public slot to indent the current line or current selection.
3279 </p><a NAME="Editor.isLastEditPositionAvailable" ID="Editor.isLastEditPositionAvailable"></a> 3414 </p><a NAME="Editor.isJavascriptFile" ID="Editor.isJavascriptFile"></a>
3415 <h4>Editor.isJavascriptFile</h4>
3416 <b>isJavascriptFile</b>(<i></i>)
3417 <p>
3418 Public method to return a flag indicating a Javascript file.
3419 </p><dl>
3420 <dt>Returns:</dt>
3421 <dd>
3422 flag indicating a Javascript file (boolean)
3423 </dd>
3424 </dl><a NAME="Editor.isLastEditPositionAvailable" ID="Editor.isLastEditPositionAvailable"></a>
3280 <h4>Editor.isLastEditPositionAvailable</h4> 3425 <h4>Editor.isLastEditPositionAvailable</h4>
3281 <b>isLastEditPositionAvailable</b>(<i></i>) 3426 <b>isLastEditPositionAvailable</b>(<i></i>)
3282 <p> 3427 <p>
3283 Public method to check, if a last edit position is available. 3428 Public method to check, if a last edit position is available.
3284 </p><dl> 3429 </p><dl>
3288 </dd> 3433 </dd>
3289 </dl><a NAME="Editor.isPy2File" ID="Editor.isPy2File"></a> 3434 </dl><a NAME="Editor.isPy2File" ID="Editor.isPy2File"></a>
3290 <h4>Editor.isPy2File</h4> 3435 <h4>Editor.isPy2File</h4>
3291 <b>isPy2File</b>(<i></i>) 3436 <b>isPy2File</b>(<i></i>)
3292 <p> 3437 <p>
3293 Public method to return a flag indicating a Python file. 3438 Public method to return a flag indicating a Python2 file.
3294 </p><dl> 3439 </p><dl>
3295 <dt>Returns:</dt> 3440 <dt>Returns:</dt>
3296 <dd> 3441 <dd>
3297 flag indicating a Python file (boolean) 3442 flag indicating a Python2 file (boolean)
3298 </dd> 3443 </dd>
3299 </dl><a NAME="Editor.isPy3File" ID="Editor.isPy3File"></a> 3444 </dl><a NAME="Editor.isPy3File" ID="Editor.isPy3File"></a>
3300 <h4>Editor.isPy3File</h4> 3445 <h4>Editor.isPy3File</h4>
3301 <b>isPy3File</b>(<i></i>) 3446 <b>isPy3File</b>(<i></i>)
3302 <p> 3447 <p>
3303 Public method to return a flag indicating a Python3 file. 3448 Public method to return a flag indicating a Python3 file.
3304 </p><dl> 3449 </p><dl>
3305 <dt>Returns:</dt> 3450 <dt>Returns:</dt>
3306 <dd> 3451 <dd>
3307 flag indicating a Python3 file (boolean) 3452 flag indicating a Python3 file (boolean)
3453 </dd>
3454 </dl><a NAME="Editor.isPyFile" ID="Editor.isPyFile"></a>
3455 <h4>Editor.isPyFile</h4>
3456 <b>isPyFile</b>(<i></i>)
3457 <p>
3458 Public method to return a flag indicating a Python (2 or 3) file.
3459 </p><dl>
3460 <dt>Returns:</dt>
3461 <dd>
3462 flag indicating a Python (2 or 3) file (boolean)
3308 </dd> 3463 </dd>
3309 </dl><a NAME="Editor.isRubyFile" ID="Editor.isRubyFile"></a> 3464 </dl><a NAME="Editor.isRubyFile" ID="Editor.isRubyFile"></a>
3310 <h4>Editor.isRubyFile</h4> 3465 <h4>Editor.isRubyFile</h4>
3311 <b>isRubyFile</b>(<i></i>) 3466 <b>isRubyFile</b>(<i></i>)
3312 <p> 3467 <p>
3506 <b>projectOpened</b>(<i></i>) 3661 <b>projectOpened</b>(<i></i>)
3507 <p> 3662 <p>
3508 Public slot to handle the opening of a project. 3663 Public slot to handle the opening of a project.
3509 </p><a NAME="Editor.readFile" ID="Editor.readFile"></a> 3664 </p><a NAME="Editor.readFile" ID="Editor.readFile"></a>
3510 <h4>Editor.readFile</h4> 3665 <h4>Editor.readFile</h4>
3511 <b>readFile</b>(<i>fn, createIt=False</i>) 3666 <b>readFile</b>(<i>fn, createIt=False, encoding=""</i>)
3512 <p> 3667 <p>
3513 Public slot to read the text from a file. 3668 Public slot to read the text from a file.
3514 </p><dl> 3669 </p><dl>
3515 <dt><i>fn</i></dt> 3670 <dt><i>fn</i></dt>
3516 <dd> 3671 <dd>
3517 filename to read from (string) 3672 filename to read from (string)
3518 </dd><dt><i>createIt</i></dt> 3673 </dd><dt><i>createIt=</i></dt>
3519 <dd> 3674 <dd>
3520 flag indicating the creation of a new file, if the 3675 flag indicating the creation of a new file, if the
3521 given one doesn't exist (boolean) 3676 given one doesn't exist (boolean)
3677 </dd><dt><i>encoding=</i></dt>
3678 <dd>
3679 encoding to be used to read the file (string)
3680 (Note: this parameter overrides encoding detection)
3522 </dd> 3681 </dd>
3523 </dl><a NAME="Editor.readSettings" ID="Editor.readSettings"></a> 3682 </dl><a NAME="Editor.readSettings" ID="Editor.readSettings"></a>
3524 <h4>Editor.readSettings</h4> 3683 <h4>Editor.readSettings</h4>
3525 <b>readSettings</b>(<i></i>) 3684 <b>readSettings</b>(<i></i>)
3526 <p> 3685 <p>
3557 Public method to remove a clone from our list. 3716 Public method to remove a clone from our list.
3558 </p><dl> 3717 </p><dl>
3559 <dt><i>editor</i></dt> 3718 <dt><i>editor</i></dt>
3560 <dd> 3719 <dd>
3561 reference to the cloned editor (Editor) 3720 reference to the cloned editor (Editor)
3721 </dd>
3722 </dl><a NAME="Editor.resizeEvent" ID="Editor.resizeEvent"></a>
3723 <h4>Editor.resizeEvent</h4>
3724 <b>resizeEvent</b>(<i>evt</i>)
3725 <p>
3726 Protected method handling resize events.
3727 </p><dl>
3728 <dt><i>evt</i></dt>
3729 <dd>
3730 reference to the resize event (QResizeEvent)
3562 </dd> 3731 </dd>
3563 </dl><a NAME="Editor.revertToUnmodified" ID="Editor.revertToUnmodified"></a> 3732 </dl><a NAME="Editor.revertToUnmodified" ID="Editor.revertToUnmodified"></a>
3564 <h4>Editor.revertToUnmodified</h4> 3733 <h4>Editor.revertToUnmodified</h4>
3565 <b>revertToUnmodified</b>(<i></i>) 3734 <b>revertToUnmodified</b>(<i></i>)
3566 <p> 3735 <p>
3906 </p><a NAME="Editor.unsetCallTipHook" ID="Editor.unsetCallTipHook"></a> 4075 </p><a NAME="Editor.unsetCallTipHook" ID="Editor.unsetCallTipHook"></a>
3907 <h4>Editor.unsetCallTipHook</h4> 4076 <h4>Editor.unsetCallTipHook</h4>
3908 <b>unsetCallTipHook</b>(<i></i>) 4077 <b>unsetCallTipHook</b>(<i></i>)
3909 <p> 4078 <p>
3910 Public method to unset a calltip hook. 4079 Public method to unset a calltip hook.
3911 </p><a NAME="Editor.wheelEvent" ID="Editor.wheelEvent"></a> 4080 </p><a NAME="Editor.viewportEvent" ID="Editor.viewportEvent"></a>
4081 <h4>Editor.viewportEvent</h4>
4082 <b>viewportEvent</b>(<i>evt</i>)
4083 <p>
4084 Protected method handling event of the viewport.
4085 </p><dl>
4086 <dt><i>evt</i></dt>
4087 <dd>
4088 reference to the event (QEvent)
4089 </dd>
4090 </dl><dl>
4091 <dt>Returns:</dt>
4092 <dd>
4093 flag indiating that the event was handled (boolean)
4094 </dd>
4095 </dl><a NAME="Editor.wheelEvent" ID="Editor.wheelEvent"></a>
3912 <h4>Editor.wheelEvent</h4> 4096 <h4>Editor.wheelEvent</h4>
3913 <b>wheelEvent</b>(<i>evt</i>) 4097 <b>wheelEvent</b>(<i>evt</i>)
3914 <p> 4098 <p>
3915 Protected method to handle wheel events. 4099 Protected method to handle wheel events.
3916 </p><dl> 4100 </p><dl>

eric ide

mercurial