--- a/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,20 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.Editor</h1>
-
<p>
Module implementing the editor component of the eric IDE.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>EditorAutoCompletionListID</td></tr><tr><td>ReferenceItem</td></tr><tr><td>ReferencesListID</td></tr><tr><td>TemplateCompletionListID</td></tr>
+<tr><td>EditorAutoCompletionListID</td></tr>
+<tr><td>ReferenceItem</td></tr>
+<tr><td>ReferencesListID</td></tr>
+<tr><td>TemplateCompletionListID</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#Editor">Editor</a></td>
<td>Class implementing the editor component of the eric IDE.</td>
@@ -33,19 +34,20 @@
<td>Class defining the kind of warnings supported by the Editor class.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="Editor" ID="Editor"></a>
<h2>Editor</h2>
-
<p>
Class implementing the editor component of the eric IDE.
</p>
+
<h3>Signals</h3>
<dl>
@@ -173,19 +175,24 @@
<h3>Derived from</h3>
QsciScintillaCompat
<h3>Class Attributes</h3>
-
<table>
-<tr><td>CancelEditToken</td></tr><tr><td>EncloseChars</td></tr><tr><td>EndEditToken</td></tr><tr><td>RequestSyncToken</td></tr><tr><td>Separator</td></tr><tr><td>StartEditToken</td></tr><tr><td>SyncToken</td></tr><tr><td>VcsConflictMarkerLineRegExpList</td></tr>
+<tr><td>CancelEditToken</td></tr>
+<tr><td>EncloseChars</td></tr>
+<tr><td>EndEditToken</td></tr>
+<tr><td>RequestSyncToken</td></tr>
+<tr><td>Separator</td></tr>
+<tr><td>StartEditToken</td></tr>
+<tr><td>SyncToken</td></tr>
+<tr><td>VcsConflictMarkerLineRegExpList</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#Editor.__init__">Editor</a></td>
<td>Constructor</td>
@@ -1839,19 +1846,20 @@
<td>Public method to write the text to a file.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="Editor.__init__" ID="Editor.__init__"></a>
<h4>Editor (Constructor)</h4>
<b>Editor</b>(<i>dbs, fn="", vm=None, filetype="", editor=None, tv=None, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>dbs</i> (DebugServer)</dt>
@@ -1894,17 +1902,17 @@
<a NAME="Editor.__aboutToShowContextMenu" ID="Editor.__aboutToShowContextMenu"></a>
<h4>Editor.__aboutToShowContextMenu</h4>
<b>__aboutToShowContextMenu</b>(<i></i>)
-
<p>
Private slot handling the aboutToShow signal of the context menu.
</p>
+
<a NAME="Editor.__addBreakPoint" ID="Editor.__addBreakPoint"></a>
<h4>Editor.__addBreakPoint</h4>
<b>__addBreakPoint</b>(<i>line, temporary</i>)
-
<p>
Private method to add a new breakpoint.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -1919,10 +1927,10 @@
<a NAME="Editor.__addBreakPoints" ID="Editor.__addBreakPoints"></a>
<h4>Editor.__addBreakPoints</h4>
<b>__addBreakPoints</b>(<i>parentIndex, start, end</i>)
-
<p>
Private slot to add breakpoints.
</p>
+
<dl>
<dt><i>parentIndex</i> (QModelIndex)</dt>
@@ -1941,54 +1949,54 @@
<a NAME="Editor.__addFileAliasResource" ID="Editor.__addFileAliasResource"></a>
<h4>Editor.__addFileAliasResource</h4>
<b>__addFileAliasResource</b>(<i></i>)
-
<p>
Private method to handle the Add aliased file context menu action.
</p>
+
<a NAME="Editor.__addFileResource" ID="Editor.__addFileResource"></a>
<h4>Editor.__addFileResource</h4>
<b>__addFileResource</b>(<i></i>)
-
<p>
Private method to handle the Add file context menu action.
</p>
+
<a NAME="Editor.__addFileResources" ID="Editor.__addFileResources"></a>
<h4>Editor.__addFileResources</h4>
<b>__addFileResources</b>(<i></i>)
-
<p>
Private method to handle the Add files context menu action.
</p>
+
<a NAME="Editor.__addLocalizedResource" ID="Editor.__addLocalizedResource"></a>
<h4>Editor.__addLocalizedResource</h4>
<b>__addLocalizedResource</b>(<i></i>)
-
<p>
Private method to handle the Add localized resource context menu
action.
</p>
+
<a NAME="Editor.__addResourceFrame" ID="Editor.__addResourceFrame"></a>
<h4>Editor.__addResourceFrame</h4>
<b>__addResourceFrame</b>(<i></i>)
-
<p>
Private method to handle the Add resource frame context menu action.
</p>
+
<a NAME="Editor.__addToSpellingDictionary" ID="Editor.__addToSpellingDictionary"></a>
<h4>Editor.__addToSpellingDictionary</h4>
<b>__addToSpellingDictionary</b>(<i></i>)
-
<p>
Private slot to add the word below the spelling context menu to the
dictionary.
</p>
+
<a NAME="Editor.__adjustedCallTipPosition" ID="Editor.__adjustedCallTipPosition"></a>
<h4>Editor.__adjustedCallTipPosition</h4>
<b>__adjustedCallTipPosition</b>(<i>ctshift, pos</i>)
-
<p>
Private method to calculate an adjusted position for showing calltips.
</p>
+
<dl>
<dt><i>ctshift</i> (int)</dt>
@@ -2015,10 +2023,10 @@
<a NAME="Editor.__applyTemplate" ID="Editor.__applyTemplate"></a>
<h4>Editor.__applyTemplate</h4>
<b>__applyTemplate</b>(<i>templateName, language</i>)
-
<p>
Private method to apply a template by name.
</p>
+
<dl>
<dt><i>templateName</i> (str)</dt>
@@ -2034,10 +2042,10 @@
<a NAME="Editor.__autoComplete" ID="Editor.__autoComplete"></a>
<h4>Editor.__autoComplete</h4>
<b>__autoComplete</b>(<i>auto=True, context=None</i>)
-
<p>
Private method to start auto-completion via plug-ins.
</p>
+
<dl>
<dt><i>auto</i> (bool)</dt>
@@ -2052,14 +2060,13 @@
<a NAME="Editor.__autocompletionCancelled" ID="Editor.__autocompletionCancelled"></a>
<h4>Editor.__autocompletionCancelled</h4>
<b>__autocompletionCancelled</b>(<i></i>)
-
<p>
Private slot to handle the cancellation of an auto-completion list.
</p>
+
<a NAME="Editor.__autosave" ID="Editor.__autosave"></a>
<h4>Editor.__autosave</h4>
<b>__autosave</b>(<i></i>)
-
<p>
Private slot to save the contents of the editor automatically.
</p>
@@ -2067,20 +2074,21 @@
It is only saved by the autosave timer after an initial save (i.e. it already
has a name).
</p>
+
<a NAME="Editor.__autosaveEnable" ID="Editor.__autosaveEnable"></a>
<h4>Editor.__autosaveEnable</h4>
<b>__autosaveEnable</b>(<i></i>)
-
<p>
Private slot handling the autosave enable context menu action.
</p>
+
<a NAME="Editor.__bindCompleter" ID="Editor.__bindCompleter"></a>
<h4>Editor.__bindCompleter</h4>
<b>__bindCompleter</b>(<i>filename</i>)
-
<p>
Private method to set the correct typing completer depending on language.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -2092,10 +2100,10 @@
<a NAME="Editor.__bindLexer" ID="Editor.__bindLexer"></a>
<h4>Editor.__bindLexer</h4>
<b>__bindLexer</b>(<i>filename, pyname=""</i>)
-
<p>
Private method to set the correct lexer depending on language.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -2111,10 +2119,10 @@
<a NAME="Editor.__bindName" ID="Editor.__bindName"></a>
<h4>Editor.__bindName</h4>
<b>__bindName</b>(<i>line0</i>)
-
<p>
Private method to generate a dummy filename for binding a lexer.
</p>
+
<dl>
<dt><i>line0</i> (str)</dt>
@@ -2137,25 +2145,25 @@
<a NAME="Editor.__boxCommentLine" ID="Editor.__boxCommentLine"></a>
<h4>Editor.__boxCommentLine</h4>
<b>__boxCommentLine</b>(<i></i>)
-
<p>
Private slot to box comment the current line.
</p>
+
<a NAME="Editor.__boxCommentSelection" ID="Editor.__boxCommentSelection"></a>
<h4>Editor.__boxCommentSelection</h4>
<b>__boxCommentSelection</b>(<i></i>)
-
<p>
Private slot to box comment the current selection.
</p>
+
<a NAME="Editor.__breakPointDataAboutToBeChanged" ID="Editor.__breakPointDataAboutToBeChanged"></a>
<h4>Editor.__breakPointDataAboutToBeChanged</h4>
<b>__breakPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>)
-
<p>
Private slot to handle the dataAboutToBeChanged signal of the
breakpoint model.
</p>
+
<dl>
<dt><i>startIndex</i> (QModelIndex)</dt>
@@ -2170,11 +2178,11 @@
<a NAME="Editor.__calculateChanges" ID="Editor.__calculateChanges"></a>
<h4>Editor.__calculateChanges</h4>
<b>__calculateChanges</b>(<i>old, new</i>)
-
<p>
Private method to determine change commands to convert old text into
new text.
</p>
+
<dl>
<dt><i>old</i> (str)</dt>
@@ -2201,24 +2209,24 @@
<a NAME="Editor.__callTip" ID="Editor.__callTip"></a>
<h4>Editor.__callTip</h4>
<b>__callTip</b>(<i></i>)
-
<p>
Private method to show call tips provided by a plugin.
</p>
+
<a NAME="Editor.__cancelMouseHoverHelp" ID="Editor.__cancelMouseHoverHelp"></a>
<h4>Editor.__cancelMouseHoverHelp</h4>
<b>__cancelMouseHoverHelp</b>(<i></i>)
-
<p>
Private slot cancelling the display of mouse hover help.
</p>
+
<a NAME="Editor.__changeBreakPoints" ID="Editor.__changeBreakPoints"></a>
<h4>Editor.__changeBreakPoints</h4>
<b>__changeBreakPoints</b>(<i>startIndex, endIndex</i>)
-
<p>
Private slot to set changed breakpoints.
</p>
+
<dl>
<dt><i>startIndex</i> (QModelIndex)</dt>
@@ -2233,10 +2241,10 @@
<a NAME="Editor.__charAdded" ID="Editor.__charAdded"></a>
<h4>Editor.__charAdded</h4>
<b>__charAdded</b>(<i>charNumber</i>)
-
<p>
Private slot called to handle the user entering a character.
</p>
+
<dl>
<dt><i>charNumber</i> (int)</dt>
@@ -2247,52 +2255,52 @@
<a NAME="Editor.__checkEncoding" ID="Editor.__checkEncoding"></a>
<h4>Editor.__checkEncoding</h4>
<b>__checkEncoding</b>(<i></i>)
-
<p>
Private method to check the selected encoding of the encodings submenu.
</p>
+
<a NAME="Editor.__checkEol" ID="Editor.__checkEol"></a>
<h4>Editor.__checkEol</h4>
<b>__checkEol</b>(<i></i>)
-
<p>
Private method to check the selected eol type of the eol submenu.
</p>
+
<a NAME="Editor.__checkLanguage" ID="Editor.__checkLanguage"></a>
<h4>Editor.__checkLanguage</h4>
<b>__checkLanguage</b>(<i></i>)
-
<p>
Private method to check the selected language of the language submenu.
</p>
+
<a NAME="Editor.__checkSpellLanguage" ID="Editor.__checkSpellLanguage"></a>
<h4>Editor.__checkSpellLanguage</h4>
<b>__checkSpellLanguage</b>(<i></i>)
-
<p>
Private slot to check the selected spell check language action.
</p>
+
<a NAME="Editor.__checkSpellingSelection" ID="Editor.__checkSpellingSelection"></a>
<h4>Editor.__checkSpellingSelection</h4>
<b>__checkSpellingSelection</b>(<i></i>)
-
<p>
Private slot to spell check the current selection.
</p>
+
<a NAME="Editor.__checkSpellingWord" ID="Editor.__checkSpellingWord"></a>
<h4>Editor.__checkSpellingWord</h4>
<b>__checkSpellingWord</b>(<i></i>)
-
<p>
Private slot to check the word below the spelling context menu.
</p>
+
<a NAME="Editor.__clearBreakpoints" ID="Editor.__clearBreakpoints"></a>
<h4>Editor.__clearBreakpoints</h4>
<b>__clearBreakpoints</b>(<i>fileName</i>)
-
<p>
Private method to clear all breakpoints.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -2303,17 +2311,17 @@
<a NAME="Editor.__clearCompletionsCache" ID="Editor.__clearCompletionsCache"></a>
<h4>Editor.__clearCompletionsCache</h4>
<b>__clearCompletionsCache</b>(<i></i>)
-
<p>
Private method to clear the auto-completions cache.
</p>
+
<a NAME="Editor.__clearTypedWarning" ID="Editor.__clearTypedWarning"></a>
<h4>Editor.__clearTypedWarning</h4>
<b>__clearTypedWarning</b>(<i>warningKind</i>)
-
<p>
Private method to clear warnings of a specific kind.
</p>
+
<dl>
<dt><i>warningKind</i> (EditorWarningKind)</dt>
@@ -2324,32 +2332,32 @@
<a NAME="Editor.__codeCoverageHideAnnotations" ID="Editor.__codeCoverageHideAnnotations"></a>
<h4>Editor.__codeCoverageHideAnnotations</h4>
<b>__codeCoverageHideAnnotations</b>(<i></i>)
-
<p>
Private method to handle the hide code coverage annotations context
menu action.
</p>
+
<a NAME="Editor.__commentLine" ID="Editor.__commentLine"></a>
<h4>Editor.__commentLine</h4>
<b>__commentLine</b>(<i></i>)
-
<p>
Private slot to comment the current line.
</p>
+
<a NAME="Editor.__commentSelection" ID="Editor.__commentSelection"></a>
<h4>Editor.__commentSelection</h4>
<b>__commentSelection</b>(<i></i>)
-
<p>
Private slot to comment the current selection.
</p>
+
<a NAME="Editor.__completionListSelected" ID="Editor.__completionListSelected"></a>
<h4>Editor.__completionListSelected</h4>
<b>__completionListSelected</b>(<i>listId, txt</i>)
-
<p>
Private slot to handle the selection from the completion list.
</p>
+
<dl>
<dt><i>listId</i> (int)</dt>
@@ -2364,32 +2372,32 @@
<a NAME="Editor.__contextClose" ID="Editor.__contextClose"></a>
<h4>Editor.__contextClose</h4>
<b>__contextClose</b>(<i></i>)
-
<p>
Private slot handling the close context menu entry.
</p>
+
<a NAME="Editor.__contextMenuCollapseFoldWithChildren" ID="Editor.__contextMenuCollapseFoldWithChildren"></a>
<h4>Editor.__contextMenuCollapseFoldWithChildren</h4>
<b>__contextMenuCollapseFoldWithChildren</b>(<i></i>)
-
<p>
Private slot to handle the context menu collapse with children action.
</p>
+
<a NAME="Editor.__contextMenuExpandFoldWithChildren" ID="Editor.__contextMenuExpandFoldWithChildren"></a>
<h4>Editor.__contextMenuExpandFoldWithChildren</h4>
<b>__contextMenuExpandFoldWithChildren</b>(<i></i>)
-
<p>
Private slot to handle the context menu expand with children action.
</p>
+
<a NAME="Editor.__contextMenuSpellingTriggered" ID="Editor.__contextMenuSpellingTriggered"></a>
<h4>Editor.__contextMenuSpellingTriggered</h4>
<b>__contextMenuSpellingTriggered</b>(<i>action</i>)
-
<p>
Private slot to handle the selection of a suggestion of the spelling
context menu.
</p>
+
<dl>
<dt><i>action</i> (QAction)</dt>
@@ -2400,38 +2408,38 @@
<a NAME="Editor.__contextSave" ID="Editor.__contextSave"></a>
<h4>Editor.__contextSave</h4>
<b>__contextSave</b>(<i></i>)
-
<p>
Private slot handling the save context menu entry.
</p>
+
<a NAME="Editor.__contextSaveAs" ID="Editor.__contextSaveAs"></a>
<h4>Editor.__contextSaveAs</h4>
<b>__contextSaveAs</b>(<i></i>)
-
<p>
Private slot handling the save as context menu entry.
</p>
+
<a NAME="Editor.__contextSaveCopy" ID="Editor.__contextSaveCopy"></a>
<h4>Editor.__contextSaveCopy</h4>
<b>__contextSaveCopy</b>(<i></i>)
-
<p>
Private slot handling the save copy context menu entry.
</p>
+
<a NAME="Editor.__convertTabs" ID="Editor.__convertTabs"></a>
<h4>Editor.__convertTabs</h4>
<b>__convertTabs</b>(<i></i>)
-
<p>
Private slot to automatically convert tabulators to spaces upon loading.
</p>
+
<a NAME="Editor.__createChangeMarkerPixmap" ID="Editor.__createChangeMarkerPixmap"></a>
<h4>Editor.__createChangeMarkerPixmap</h4>
<b>__createChangeMarkerPixmap</b>(<i>key, size=16</i>)
-
<p>
Private method to create a pixmap for the change markers.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2458,7 +2466,6 @@
<a NAME="Editor.__cursorPositionChanged" ID="Editor.__cursorPositionChanged"></a>
<h4>Editor.__cursorPositionChanged</h4>
<b>__cursorPositionChanged</b>(<i>line, index</i>)
-
<p>
Private slot to handle the cursorPositionChanged signal.
</p>
@@ -2466,6 +2473,7 @@
It emits the signal cursorChanged with parameters fileName,
line and pos.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -2480,10 +2488,10 @@
<a NAME="Editor.__delayedDocstringMenuPopup" ID="Editor.__delayedDocstringMenuPopup"></a>
<h4>Editor.__delayedDocstringMenuPopup</h4>
<b>__delayedDocstringMenuPopup</b>(<i>cursorPosition</i>)
-
<p>
Private method to test, if the user might want to insert a docstring.
</p>
+
<dl>
<dt><i>cursorPosition</i> (tuple of (int, int))</dt>
@@ -2494,17 +2502,17 @@
<a NAME="Editor.__deleteAllChangeMarkers" ID="Editor.__deleteAllChangeMarkers"></a>
<h4>Editor.__deleteAllChangeMarkers</h4>
<b>__deleteAllChangeMarkers</b>(<i></i>)
-
<p>
Private slot to delete all change markers.
</p>
+
<a NAME="Editor.__deleteBreakPoints" ID="Editor.__deleteBreakPoints"></a>
<h4>Editor.__deleteBreakPoints</h4>
<b>__deleteBreakPoints</b>(<i>parentIndex, start, end</i>)
-
<p>
Private slot to delete breakpoints.
</p>
+
<dl>
<dt><i>parentIndex</i> (QModelIndex)</dt>
@@ -2523,17 +2531,17 @@
<a NAME="Editor.__deselectAll" ID="Editor.__deselectAll"></a>
<h4>Editor.__deselectAll</h4>
<b>__deselectAll</b>(<i></i>)
-
<p>
Private slot handling the deselect all context menu action.
</p>
+
<a NAME="Editor.__dispatchCommand" ID="Editor.__dispatchCommand"></a>
<h4>Editor.__dispatchCommand</h4>
<b>__dispatchCommand</b>(<i>command</i>)
-
<p>
Private method to dispatch received commands.
</p>
+
<dl>
<dt><i>command</i> (str)</dt>
@@ -2544,10 +2552,10 @@
<a NAME="Editor.__encodingChanged" ID="Editor.__encodingChanged"></a>
<h4>Editor.__encodingChanged</h4>
<b>__encodingChanged</b>(<i>encoding, propagate=True</i>)
-
<p>
Private slot to handle a change of the encoding.
</p>
+
<dl>
<dt><i>encoding</i> (str)</dt>
@@ -2562,10 +2570,10 @@
<a NAME="Editor.__encodingsMenuTriggered" ID="Editor.__encodingsMenuTriggered"></a>
<h4>Editor.__encodingsMenuTriggered</h4>
<b>__encodingsMenuTriggered</b>(<i>act</i>)
-
<p>
Private method to handle the selection of an encoding.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -2576,17 +2584,17 @@
<a NAME="Editor.__eolChanged" ID="Editor.__eolChanged"></a>
<h4>Editor.__eolChanged</h4>
<b>__eolChanged</b>(<i></i>)
-
<p>
Private slot to handle a change of the eol mode.
</p>
+
<a NAME="Editor.__eolMenuTriggered" ID="Editor.__eolMenuTriggered"></a>
<h4>Editor.__eolMenuTriggered</h4>
<b>__eolMenuTriggered</b>(<i>act</i>)
-
<p>
Private method to handle the selection of an eol type.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -2597,17 +2605,17 @@
<a NAME="Editor.__executeSelection" ID="Editor.__executeSelection"></a>
<h4>Editor.__executeSelection</h4>
<b>__executeSelection</b>(<i></i>)
-
<p>
Private slot to execute the selected text in the shell window.
</p>
+
<a NAME="Editor.__getAcText" ID="Editor.__getAcText"></a>
<h4>Editor.__getAcText</h4>
<b>__getAcText</b>(<i></i>)
-
<p>
Private method to get the text from cursor position for autocompleting.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2623,11 +2631,11 @@
<a NAME="Editor.__getCharacter" ID="Editor.__getCharacter"></a>
<h4>Editor.__getCharacter</h4>
<b>__getCharacter</b>(<i>pos</i>)
-
<p>
Private method to get the character to the left of the current position
in the current line.
</p>
+
<dl>
<dt><i>pos</i> (int)</dt>
@@ -2651,11 +2659,11 @@
<a NAME="Editor.__getCodeCoverageFile" ID="Editor.__getCodeCoverageFile"></a>
<h4>Editor.__getCodeCoverageFile</h4>
<b>__getCodeCoverageFile</b>(<i></i>)
-
<p>
Private method to get the file name of the file containing coverage
info.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2671,7 +2679,6 @@
<a NAME="Editor.__getEditorConfig" ID="Editor.__getEditorConfig"></a>
<h4>Editor.__getEditorConfig</h4>
<b>__getEditorConfig</b>(<i>option, nodefault=False, config=None</i>)
-
<p>
Private method to get the requested option via EditorConfig.
</p>
@@ -2681,6 +2688,7 @@
the Preferences option key. The mapping to the EditorConfig option name
will be done within this method.
</p>
+
<dl>
<dt><i>option</i> (str)</dt>
@@ -2713,10 +2721,10 @@
<a NAME="Editor.__getMacroName" ID="Editor.__getMacroName"></a>
<h4>Editor.__getMacroName</h4>
<b>__getMacroName</b>(<i></i>)
-
<p>
Private method to select a macro name from the list of macros.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2733,10 +2741,10 @@
<a NAME="Editor.__getOverrideValue" ID="Editor.__getOverrideValue"></a>
<h4>Editor.__getOverrideValue</h4>
<b>__getOverrideValue</b>(<i>option</i>)
-
<p>
Private method to get an override value for the current file type.
</p>
+
<dl>
<dt><i>option</i> (str)</dt>
@@ -2759,11 +2767,11 @@
<a NAME="Editor.__getPyVersion" ID="Editor.__getPyVersion"></a>
<h4>Editor.__getPyVersion</h4>
<b>__getPyVersion</b>(<i></i>)
-
<p>
Private method to return the Python main version or 0 if it's
not a Python file at all.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2779,10 +2787,10 @@
<a NAME="Editor.__getSaveFileName" ID="Editor.__getSaveFileName"></a>
<h4>Editor.__getSaveFileName</h4>
<b>__getSaveFileName</b>(<i>path=None</i>)
-
<p>
Private method to get the name of the file to be saved.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -2805,17 +2813,17 @@
<a NAME="Editor.__ignoreSpellingAlways" ID="Editor.__ignoreSpellingAlways"></a>
<h4>Editor.__ignoreSpellingAlways</h4>
<b>__ignoreSpellingAlways</b>(<i></i>)
-
<p>
Private to always ignore the word below the spelling context menu.
</p>
+
<a NAME="Editor.__indentLine" ID="Editor.__indentLine"></a>
<h4>Editor.__indentLine</h4>
<b>__indentLine</b>(<i>indent=True</i>)
-
<p>
Private method to indent or unindent the current line.
</p>
+
<dl>
<dt><i>indent</i> (bool)</dt>
@@ -2828,10 +2836,10 @@
<a NAME="Editor.__indentSelection" ID="Editor.__indentSelection"></a>
<h4>Editor.__indentSelection</h4>
<b>__indentSelection</b>(<i>indent=True</i>)
-
<p>
Private method to indent or unindent the current selection.
</p>
+
<dl>
<dt><i>indent</i> (bool)</dt>
@@ -2844,17 +2852,17 @@
<a NAME="Editor.__initContextMenu" ID="Editor.__initContextMenu"></a>
<h4>Editor.__initContextMenu</h4>
<b>__initContextMenu</b>(<i></i>)
-
<p>
Private method used to setup the context menu.
</p>
+
<a NAME="Editor.__initContextMenuAutocompletion" ID="Editor.__initContextMenuAutocompletion"></a>
<h4>Editor.__initContextMenuAutocompletion</h4>
<b>__initContextMenuAutocompletion</b>(<i></i>)
-
<p>
Private method used to setup the Checks context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2870,10 +2878,10 @@
<a NAME="Editor.__initContextMenuChecks" ID="Editor.__initContextMenuChecks"></a>
<h4>Editor.__initContextMenuChecks</h4>
<b>__initContextMenuChecks</b>(<i></i>)
-
<p>
Private method used to setup the Checks context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2889,10 +2897,10 @@
<a NAME="Editor.__initContextMenuEncodings" ID="Editor.__initContextMenuEncodings"></a>
<h4>Editor.__initContextMenuEncodings</h4>
<b>__initContextMenuEncodings</b>(<i></i>)
-
<p>
Private method used to setup the Encodings context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2908,10 +2916,10 @@
<a NAME="Editor.__initContextMenuEol" ID="Editor.__initContextMenuEol"></a>
<h4>Editor.__initContextMenuEol</h4>
<b>__initContextMenuEol</b>(<i></i>)
-
<p>
Private method to setup the eol context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2927,10 +2935,10 @@
<a NAME="Editor.__initContextMenuFormatting" ID="Editor.__initContextMenuFormatting"></a>
<h4>Editor.__initContextMenuFormatting</h4>
<b>__initContextMenuFormatting</b>(<i></i>)
-
<p>
Private method used to setup the Code Formatting context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2946,10 +2954,10 @@
<a NAME="Editor.__initContextMenuGraphics" ID="Editor.__initContextMenuGraphics"></a>
<h4>Editor.__initContextMenuGraphics</h4>
<b>__initContextMenuGraphics</b>(<i></i>)
-
<p>
Private method used to setup the diagrams context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2965,10 +2973,10 @@
<a NAME="Editor.__initContextMenuLanguages" ID="Editor.__initContextMenuLanguages"></a>
<h4>Editor.__initContextMenuLanguages</h4>
<b>__initContextMenuLanguages</b>(<i></i>)
-
<p>
Private method used to setup the Languages context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2984,17 +2992,17 @@
<a NAME="Editor.__initContextMenuMargins" ID="Editor.__initContextMenuMargins"></a>
<h4>Editor.__initContextMenuMargins</h4>
<b>__initContextMenuMargins</b>(<i></i>)
-
<p>
Private method used to setup the context menu for the margins.
</p>
+
<a NAME="Editor.__initContextMenuReopenWithEncoding" ID="Editor.__initContextMenuReopenWithEncoding"></a>
<h4>Editor.__initContextMenuReopenWithEncoding</h4>
<b>__initContextMenuReopenWithEncoding</b>(<i></i>)
-
<p>
Private method used to setup the Reopen With Encoding context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -3010,10 +3018,10 @@
<a NAME="Editor.__initContextMenuResources" ID="Editor.__initContextMenuResources"></a>
<h4>Editor.__initContextMenuResources</h4>
<b>__initContextMenuResources</b>(<i></i>)
-
<p>
Private method used to setup the Resources context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -3029,10 +3037,10 @@
<a NAME="Editor.__initContextMenuShow" ID="Editor.__initContextMenuShow"></a>
<h4>Editor.__initContextMenuShow</h4>
<b>__initContextMenuShow</b>(<i></i>)
-
<p>
Private method used to setup the Show context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -3048,10 +3056,10 @@
<a NAME="Editor.__initContextMenuSpellCheck" ID="Editor.__initContextMenuSpellCheck"></a>
<h4>Editor.__initContextMenuSpellCheck</h4>
<b>__initContextMenuSpellCheck</b>(<i></i>)
-
<p>
Private method used to setup the spell checking context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -3067,10 +3075,10 @@
<a NAME="Editor.__initContextMenuSpellLanguages" ID="Editor.__initContextMenuSpellLanguages"></a>
<h4>Editor.__initContextMenuSpellLanguages</h4>
<b>__initContextMenuSpellLanguages</b>(<i></i>)
-
<p>
Private method to setup the spell checking languages context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -3086,10 +3094,10 @@
<a NAME="Editor.__initContextMenuTools" ID="Editor.__initContextMenuTools"></a>
<h4>Editor.__initContextMenuTools</h4>
<b>__initContextMenuTools</b>(<i></i>)
-
<p>
Private method used to setup the Tools context sub menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -3105,33 +3113,33 @@
<a NAME="Editor.__initOnlineChangeTrace" ID="Editor.__initOnlineChangeTrace"></a>
<h4>Editor.__initOnlineChangeTrace</h4>
<b>__initOnlineChangeTrace</b>(<i></i>)
-
<p>
Private slot to initialize the online change trace.
</p>
+
<a NAME="Editor.__initOnlineSyntaxCheck" ID="Editor.__initOnlineSyntaxCheck"></a>
<h4>Editor.__initOnlineSyntaxCheck</h4>
<b>__initOnlineSyntaxCheck</b>(<i></i>)
-
<p>
Private slot to initialize the online syntax check.
</p>
+
<a NAME="Editor.__insertDocstring" ID="Editor.__insertDocstring"></a>
<h4>Editor.__insertDocstring</h4>
<b>__insertDocstring</b>(<i></i>)
-
<p>
Private slot to generate and insert a docstring for the function under
the cursor.
</p>
+
<a NAME="Editor.__isCommentedLine" ID="Editor.__isCommentedLine"></a>
<h4>Editor.__isCommentedLine</h4>
<b>__isCommentedLine</b>(<i>line, commentStr</i>)
-
<p>
Private method to check, if the given line is a comment line as
produced by the configured comment rules.
</p>
+
<dl>
<dt><i>line</i> (str)</dt>
@@ -3158,11 +3166,11 @@
<a NAME="Editor.__isStartChar" ID="Editor.__isStartChar"></a>
<h4>Editor.__isStartChar</h4>
<b>__isStartChar</b>(<i>ch</i>)
-
<p>
Private method to check, if a character is an autocompletion start
character.
</p>
+
<dl>
<dt><i>ch</i> (str)</dt>
@@ -3185,10 +3193,10 @@
<a NAME="Editor.__isStreamCommentedLine" ID="Editor.__isStreamCommentedLine"></a>
<h4>Editor.__isStreamCommentedLine</h4>
<b>__isStreamCommentedLine</b>(<i>line, streamCommentStr</i>)
-
<p>
Private method to check, if the line is commented by a stream comment.
</p>
+
<dl>
<dt><i>line</i> (str)</dt>
@@ -3216,10 +3224,10 @@
<a NAME="Editor.__languageChanged" ID="Editor.__languageChanged"></a>
<h4>Editor.__languageChanged</h4>
<b>__languageChanged</b>(<i>language, propagate=True</i>)
-
<p>
Private method handling a change of a connected editor's language.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -3234,10 +3242,10 @@
<a NAME="Editor.__languageMenuTriggered" ID="Editor.__languageMenuTriggered"></a>
<h4>Editor.__languageMenuTriggered</h4>
<b>__languageMenuTriggered</b>(<i>act</i>)
-
<p>
Private method to handle the selection of a lexer language.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -3248,33 +3256,33 @@
<a NAME="Editor.__lmBbookmarks" ID="Editor.__lmBbookmarks"></a>
<h4>Editor.__lmBbookmarks</h4>
<b>__lmBbookmarks</b>(<i></i>)
-
<p>
Private method to handle the 'LMB toggles bookmark' context menu
action.
</p>
+
<a NAME="Editor.__lmBbreakpoints" ID="Editor.__lmBbreakpoints"></a>
<h4>Editor.__lmBbreakpoints</h4>
<b>__lmBbreakpoints</b>(<i></i>)
-
<p>
Private method to handle the 'LMB toggles breakpoint' context menu
action.
</p>
+
<a NAME="Editor.__loadDiagram" ID="Editor.__loadDiagram"></a>
<h4>Editor.__loadDiagram</h4>
<b>__loadDiagram</b>(<i></i>)
-
<p>
Private slot to load a diagram from file.
</p>
+
<a NAME="Editor.__loadEditorConfig" ID="Editor.__loadEditorConfig"></a>
<h4>Editor.__loadEditorConfig</h4>
<b>__loadEditorConfig</b>(<i>fileName=""</i>)
-
<p>
Private method to load the EditorConfig properties.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -3285,11 +3293,11 @@
<a NAME="Editor.__loadEditorConfigObject" ID="Editor.__loadEditorConfigObject"></a>
<h4>Editor.__loadEditorConfigObject</h4>
<b>__loadEditorConfigObject</b>(<i>fileName</i>)
-
<p>
Private method to load the EditorConfig properties for the given
file name.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -3312,10 +3320,10 @@
<a NAME="Editor.__marginClicked" ID="Editor.__marginClicked"></a>
<h4>Editor.__marginClicked</h4>
<b>__marginClicked</b>(<i>margin, line, modifiers</i>)
-
<p>
Private slot to handle the marginClicked signal.
</p>
+
<dl>
<dt><i>margin</i> (int)</dt>
@@ -3334,10 +3342,10 @@
<a NAME="Editor.__marginNumber" ID="Editor.__marginNumber"></a>
<h4>Editor.__marginNumber</h4>
<b>__marginNumber</b>(<i>xPos</i>)
-
<p>
Private method to calculate the margin number based on a x position.
</p>
+
<dl>
<dt><i>xPos</i> (int)</dt>
@@ -3360,37 +3368,36 @@
<a NAME="Editor.__markOccurrences" ID="Editor.__markOccurrences"></a>
<h4>Editor.__markOccurrences</h4>
<b>__markOccurrences</b>(<i></i>)
-
<p>
Private method to mark all occurrences of the current word.
</p>
+
<a NAME="Editor.__menuClearBreakpoints" ID="Editor.__menuClearBreakpoints"></a>
<h4>Editor.__menuClearBreakpoints</h4>
<b>__menuClearBreakpoints</b>(<i></i>)
-
<p>
Private slot to handle the 'Clear all breakpoints' context menu action.
</p>
+
<a NAME="Editor.__menuToggleBreakpointEnabled" ID="Editor.__menuToggleBreakpointEnabled"></a>
<h4>Editor.__menuToggleBreakpointEnabled</h4>
<b>__menuToggleBreakpointEnabled</b>(<i></i>)
-
<p>
Private slot to handle the 'Enable/Disable breakpoint' context menu
action.
</p>
+
<a NAME="Editor.__menuToggleTemporaryBreakpoint" ID="Editor.__menuToggleTemporaryBreakpoint"></a>
<h4>Editor.__menuToggleTemporaryBreakpoint</h4>
<b>__menuToggleTemporaryBreakpoint</b>(<i></i>)
-
<p>
Private slot to handle the 'Toggle temporary breakpoint' context menu
action.
</p>
+
<a NAME="Editor.__modificationChanged" ID="Editor.__modificationChanged"></a>
<h4>Editor.__modificationChanged</h4>
<b>__modificationChanged</b>(<i>m</i>)
-
<p>
Private slot to handle the modificationChanged signal.
</p>
@@ -3398,6 +3405,7 @@
It emits the signal modificationStatusChanged with parameters
m and self.
</p>
+
<dl>
<dt><i>m</i> (bool)</dt>
@@ -3408,17 +3416,17 @@
<a NAME="Editor.__modificationReadOnly" ID="Editor.__modificationReadOnly"></a>
<h4>Editor.__modificationReadOnly</h4>
<b>__modificationReadOnly</b>(<i></i>)
-
<p>
Private slot to handle the modificationAttempted signal.
</p>
+
<a NAME="Editor.__modified" ID="Editor.__modified"></a>
<h4>Editor.__modified</h4>
<b>__modified</b>(<i>pos, mtype, text, length, linesAdded, line, foldNow, foldPrev, token, annotationLinesAdded, </i>)
-
<p>
Private method to handle changes of the number of lines.
</p>
+
<dl>
<dt><i>pos</i> (int)</dt>
@@ -3465,24 +3473,24 @@
<a NAME="Editor.__newView" ID="Editor.__newView"></a>
<h4>Editor.__newView</h4>
<b>__newView</b>(<i></i>)
-
<p>
Private slot to create a new view to an open document.
</p>
+
<a NAME="Editor.__newViewNewSplit" ID="Editor.__newViewNewSplit"></a>
<h4>Editor.__newViewNewSplit</h4>
<b>__newViewNewSplit</b>(<i></i>)
-
<p>
Private slot to create a new view to an open document.
</p>
+
<a NAME="Editor.__normalizedEncoding" ID="Editor.__normalizedEncoding"></a>
<h4>Editor.__normalizedEncoding</h4>
<b>__normalizedEncoding</b>(<i>encoding=""</i>)
-
<p>
Private method to calculate the normalized encoding string.
</p>
+
<dl>
<dt><i>encoding</i> (str)</dt>
@@ -3505,14 +3513,13 @@
<a NAME="Editor.__onlineChangeTraceTimerTimeout" ID="Editor.__onlineChangeTraceTimerTimeout"></a>
<h4>Editor.__onlineChangeTraceTimerTimeout</h4>
<b>__onlineChangeTraceTimerTimeout</b>(<i></i>)
-
<p>
Private slot to mark added and changed lines.
</p>
+
<a NAME="Editor.__performFormatWithBlack" ID="Editor.__performFormatWithBlack"></a>
<h4>Editor.__performFormatWithBlack</h4>
<b>__performFormatWithBlack</b>(<i>action</i>)
-
<p>
Private method to format the source code using the 'Black' tool.
</p>
@@ -3526,6 +3533,7 @@
changes is generated</li>
</ul>
</p>
+
<dl>
<dt><i>action</i> (BlackFormattingAction)</dt>
@@ -3536,7 +3544,6 @@
<a NAME="Editor.__performImportSortingWithIsort" ID="Editor.__performImportSortingWithIsort"></a>
<h4>Editor.__performImportSortingWithIsort</h4>
<b>__performImportSortingWithIsort</b>(<i>action</i>)
-
<p>
Private method to sort the import statements using the 'isort' tool.
</p>
@@ -3550,6 +3557,7 @@
changes is generated</li>
</ul>
</p>
+
<dl>
<dt><i>action</i> (IsortFormattingAction)</dt>
@@ -3560,11 +3568,11 @@
<a NAME="Editor.__popupDocstringMenu" ID="Editor.__popupDocstringMenu"></a>
<h4>Editor.__popupDocstringMenu</h4>
<b>__popupDocstringMenu</b>(<i>lastLineText, lastCursorPosition</i>)
-
<p>
Private method to pop up a menu asking the user, if a docstring should be
inserted.
</p>
+
<dl>
<dt><i>lastLineText</i> (str)</dt>
@@ -3580,10 +3588,10 @@
<a NAME="Editor.__printPreview" ID="Editor.__printPreview"></a>
<h4>Editor.__printPreview</h4>
<b>__printPreview</b>(<i>printer</i>)
-
<p>
Private slot to generate a print preview.
</p>
+
<dl>
<dt><i>printer</i> (QScintilla.Printer.Printer)</dt>
@@ -3594,10 +3602,10 @@
<a NAME="Editor.__processEndEditCommand" ID="Editor.__processEndEditCommand"></a>
<h4>Editor.__processEndEditCommand</h4>
<b>__processEndEditCommand</b>(<i>argsString</i>)
-
<p>
Private slot to process a remote EndEdit command.
</p>
+
<dl>
<dt><i>argsString</i> (str)</dt>
@@ -3608,10 +3616,10 @@
<a NAME="Editor.__processFlags" ID="Editor.__processFlags"></a>
<h4>Editor.__processFlags</h4>
<b>__processFlags</b>(<i></i>)
-
<p>
Private method to extract flags and process them.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -3627,10 +3635,10 @@
<a NAME="Editor.__processRequestSyncCommand" ID="Editor.__processRequestSyncCommand"></a>
<h4>Editor.__processRequestSyncCommand</h4>
<b>__processRequestSyncCommand</b>(<i>argsString</i>)
-
<p>
Private slot to process a remote RequestSync command.
</p>
+
<dl>
<dt><i>argsString</i> (str)</dt>
@@ -3641,10 +3649,10 @@
<a NAME="Editor.__processStartEditCommand" ID="Editor.__processStartEditCommand"></a>
<h4>Editor.__processStartEditCommand</h4>
<b>__processStartEditCommand</b>(<i>argsString</i>)
-
<p>
Private slot to process a remote StartEdit command.
</p>
+
<dl>
<dt><i>argsString</i> (str)</dt>
@@ -3655,10 +3663,10 @@
<a NAME="Editor.__processSyncCommand" ID="Editor.__processSyncCommand"></a>
<h4>Editor.__processSyncCommand</h4>
<b>__processSyncCommand</b>(<i>argsString</i>)
-
<p>
Private slot to process a remote Sync command.
</p>
+
<dl>
<dt><i>argsString</i> (str)</dt>
@@ -3669,10 +3677,10 @@
<a NAME="Editor.__processSyntaxCheckError" ID="Editor.__processSyntaxCheckError"></a>
<h4>Editor.__processSyntaxCheckError</h4>
<b>__processSyntaxCheckError</b>(<i>fn, msg</i>)
-
<p>
Private slot to report an error message of a syntax check.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -3687,10 +3695,10 @@
<a NAME="Editor.__processSyntaxCheckResult" ID="Editor.__processSyntaxCheckResult"></a>
<h4>Editor.__processSyntaxCheckResult</h4>
<b>__processSyntaxCheckResult</b>(<i>fn, problems</i>)
-
<p>
Private slot to report the resulting messages of a syntax check.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -3708,54 +3716,54 @@
<a NAME="Editor.__projectPropertiesChanged" ID="Editor.__projectPropertiesChanged"></a>
<h4>Editor.__projectPropertiesChanged</h4>
<b>__projectPropertiesChanged</b>(<i></i>)
-
<p>
Private slot to handle changes of the project properties.
</p>
+
<a NAME="Editor.__refreshAnnotations" ID="Editor.__refreshAnnotations"></a>
<h4>Editor.__refreshAnnotations</h4>
<b>__refreshAnnotations</b>(<i></i>)
-
<p>
Private method to refresh the annotations.
</p>
+
<a NAME="Editor.__registerImages" ID="Editor.__registerImages"></a>
<h4>Editor.__registerImages</h4>
<b>__registerImages</b>(<i></i>)
-
<p>
Private method to register images for autocompletion lists.
</p>
+
<a NAME="Editor.__reinitOnlineChangeTrace" ID="Editor.__reinitOnlineChangeTrace"></a>
<h4>Editor.__reinitOnlineChangeTrace</h4>
<b>__reinitOnlineChangeTrace</b>(<i></i>)
-
<p>
Private slot to re-initialize the online change trace.
</p>
+
<a NAME="Editor.__removeFromSpellingDictionary" ID="Editor.__removeFromSpellingDictionary"></a>
<h4>Editor.__removeFromSpellingDictionary</h4>
<b>__removeFromSpellingDictionary</b>(<i></i>)
-
<p>
Private slot to remove the word below the context menu to the
dictionary.
</p>
+
<a NAME="Editor.__removeTrailingWhitespace" ID="Editor.__removeTrailingWhitespace"></a>
<h4>Editor.__removeTrailingWhitespace</h4>
<b>__removeTrailingWhitespace</b>(<i></i>)
-
<p>
Private method to remove trailing whitespace.
</p>
+
<a NAME="Editor.__reopenWithEncodingMenuTriggered" ID="Editor.__reopenWithEncodingMenuTriggered"></a>
<h4>Editor.__reopenWithEncodingMenuTriggered</h4>
<b>__reopenWithEncodingMenuTriggered</b>(<i>act</i>)
-
<p>
Private method to handle the rereading of the file with a selected
encoding.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -3766,10 +3774,10 @@
<a NAME="Editor.__replaceLeadingUnderscores" ID="Editor.__replaceLeadingUnderscores"></a>
<h4>Editor.__replaceLeadingUnderscores</h4>
<b>__replaceLeadingUnderscores</b>(<i>txt</i>)
-
<p>
Private method to replace the first two underlines for invers sorting.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -3792,10 +3800,10 @@
<a NAME="Editor.__resetLanguage" ID="Editor.__resetLanguage"></a>
<h4>Editor.__resetLanguage</h4>
<b>__resetLanguage</b>(<i>propagate=True</i>)
-
<p>
Private method used to reset the language selection.
</p>
+
<dl>
<dt><i>propagate</i> (bool)</dt>
@@ -3806,38 +3814,38 @@
<a NAME="Editor.__resetOnlineChangeTraceTimer" ID="Editor.__resetOnlineChangeTraceTimer"></a>
<h4>Editor.__resetOnlineChangeTraceTimer</h4>
<b>__resetOnlineChangeTraceTimer</b>(<i></i>)
-
<p>
Private method to reset the online syntax check timer.
</p>
+
<a NAME="Editor.__resetOnlineSyntaxCheckTimer" ID="Editor.__resetOnlineSyntaxCheckTimer"></a>
<h4>Editor.__resetOnlineSyntaxCheckTimer</h4>
<b>__resetOnlineSyntaxCheckTimer</b>(<i></i>)
-
<p>
Private method to reset the online syntax check timer.
</p>
+
<a NAME="Editor.__resizeLinenoMargin" ID="Editor.__resizeLinenoMargin"></a>
<h4>Editor.__resizeLinenoMargin</h4>
<b>__resizeLinenoMargin</b>(<i></i>)
-
<p>
Private slot to resize the line numbers margin.
</p>
+
<a NAME="Editor.__restoreBreakpoints" ID="Editor.__restoreBreakpoints"></a>
<h4>Editor.__restoreBreakpoints</h4>
<b>__restoreBreakpoints</b>(<i></i>)
-
<p>
Private method to restore the breakpoints.
</p>
+
<a NAME="Editor.__saveDeviceFile" ID="Editor.__saveDeviceFile"></a>
<h4>Editor.__saveDeviceFile</h4>
<b>__saveDeviceFile</b>(<i>saveas=False</i>)
-
<p>
Private method to save the text to a file on the connected device.
</p>
+
<dl>
<dt><i>saveas</i> (bool (optional))</dt>
@@ -3860,17 +3868,17 @@
<a NAME="Editor.__saveLastEditPosition" ID="Editor.__saveLastEditPosition"></a>
<h4>Editor.__saveLastEditPosition</h4>
<b>__saveLastEditPosition</b>(<i></i>)
-
<p>
Private slot to record the last edit position.
</p>
+
<a NAME="Editor.__searchCurrentWord" ID="Editor.__searchCurrentWord"></a>
<h4>Editor.__searchCurrentWord</h4>
<b>__searchCurrentWord</b>(<i>forward=True</i>)
-
<p>
Private slot to search the next occurrence of the current word.
</p>
+
<dl>
<dt><i>forward</i> (bool)</dt>
@@ -3881,17 +3889,17 @@
<a NAME="Editor.__selectAll" ID="Editor.__selectAll"></a>
<h4>Editor.__selectAll</h4>
<b>__selectAll</b>(<i></i>)
-
<p>
Private slot handling the select all context menu action.
</p>
+
<a NAME="Editor.__selectPygmentsLexer" ID="Editor.__selectPygmentsLexer"></a>
<h4>Editor.__selectPygmentsLexer</h4>
<b>__selectPygmentsLexer</b>(<i></i>)
-
<p>
Private method to select a specific pygments lexer.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -3907,10 +3915,10 @@
<a NAME="Editor.__send" ID="Editor.__send"></a>
<h4>Editor.__send</h4>
<b>__send</b>(<i>token, args=None</i>)
-
<p>
Private method to send an editor command to remote editors.
</p>
+
<dl>
<dt><i>token</i> (str)</dt>
@@ -3925,10 +3933,10 @@
<a NAME="Editor.__setAnnotation" ID="Editor.__setAnnotation"></a>
<h4>Editor.__setAnnotation</h4>
<b>__setAnnotation</b>(<i>line</i>)
-
<p>
Private method to set the annotations for the given line.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -3939,59 +3947,59 @@
<a NAME="Editor.__setAnnotationStyles" ID="Editor.__setAnnotationStyles"></a>
<h4>Editor.__setAnnotationStyles</h4>
<b>__setAnnotationStyles</b>(<i></i>)
-
<p>
Private slot to define the style used by inline annotations.
</p>
+
<a NAME="Editor.__setAutoCompletion" ID="Editor.__setAutoCompletion"></a>
<h4>Editor.__setAutoCompletion</h4>
<b>__setAutoCompletion</b>(<i></i>)
-
<p>
Private method to configure the autocompletion function.
</p>
+
<a NAME="Editor.__setCallTips" ID="Editor.__setCallTips"></a>
<h4>Editor.__setCallTips</h4>
<b>__setCallTips</b>(<i></i>)
-
<p>
Private method to configure the calltips function.
</p>
+
<a NAME="Editor.__setEolMode" ID="Editor.__setEolMode"></a>
<h4>Editor.__setEolMode</h4>
<b>__setEolMode</b>(<i></i>)
-
<p>
Private method to configure the eol mode of the editor.
</p>
+
<a NAME="Editor.__setLineMarkerColours" ID="Editor.__setLineMarkerColours"></a>
<h4>Editor.__setLineMarkerColours</h4>
<b>__setLineMarkerColours</b>(<i></i>)
-
<p>
Private method to set the line marker colours.
</p>
+
<a NAME="Editor.__setMarginsDisplay" ID="Editor.__setMarginsDisplay"></a>
<h4>Editor.__setMarginsDisplay</h4>
<b>__setMarginsDisplay</b>(<i></i>)
-
<p>
Private method to configure margins 0 and 2.
</p>
+
<a NAME="Editor.__setSpelling" ID="Editor.__setSpelling"></a>
<h4>Editor.__setSpelling</h4>
<b>__setSpelling</b>(<i></i>)
-
<p>
Private method to initialize the spell checking functionality.
</p>
+
<a NAME="Editor.__setSpellingLanguage" ID="Editor.__setSpellingLanguage"></a>
<h4>Editor.__setSpellingLanguage</h4>
<b>__setSpellingLanguage</b>(<i>language, pwl="", pel=""</i>)
-
<p>
Private method to set the spell checking language.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -4010,24 +4018,24 @@
<a NAME="Editor.__setTabAndIndent" ID="Editor.__setTabAndIndent"></a>
<h4>Editor.__setTabAndIndent</h4>
<b>__setTabAndIndent</b>(<i></i>)
-
<p>
Private method to set indentation size and style and tab width.
</p>
+
<a NAME="Editor.__setTextDisplay" ID="Editor.__setTextDisplay"></a>
<h4>Editor.__setTextDisplay</h4>
<b>__setTextDisplay</b>(<i></i>)
-
<p>
Private method to configure the text display.
</p>
+
<a NAME="Editor.__shouldAutosave" ID="Editor.__shouldAutosave"></a>
<h4>Editor.__shouldAutosave</h4>
<b>__shouldAutosave</b>(<i></i>)
-
<p>
Private method to check the autosave flags.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -4043,45 +4051,45 @@
<a NAME="Editor.__showApplicationDiagram" ID="Editor.__showApplicationDiagram"></a>
<h4>Editor.__showApplicationDiagram</h4>
<b>__showApplicationDiagram</b>(<i></i>)
-
<p>
Private method to handle the Imports Diagram context menu action.
</p>
+
<a NAME="Editor.__showClassDiagram" ID="Editor.__showClassDiagram"></a>
<h4>Editor.__showClassDiagram</h4>
<b>__showClassDiagram</b>(<i></i>)
-
<p>
Private method to handle the Class Diagram context menu action.
</p>
+
<a NAME="Editor.__showCodeCoverage" ID="Editor.__showCodeCoverage"></a>
<h4>Editor.__showCodeCoverage</h4>
<b>__showCodeCoverage</b>(<i></i>)
-
<p>
Private method to handle the code coverage context menu action.
</p>
+
<a NAME="Editor.__showCodeInfo" ID="Editor.__showCodeInfo"></a>
<h4>Editor.__showCodeInfo</h4>
<b>__showCodeInfo</b>(<i></i>)
-
<p>
Private slot to handle the context menu action to show code info.
</p>
+
<a NAME="Editor.__showCodeMetrics" ID="Editor.__showCodeMetrics"></a>
<h4>Editor.__showCodeMetrics</h4>
<b>__showCodeMetrics</b>(<i></i>)
-
<p>
Private method to handle the code metrics context menu action.
</p>
+
<a NAME="Editor.__showCompletionsList" ID="Editor.__showCompletionsList"></a>
<h4>Editor.__showCompletionsList</h4>
<b>__showCompletionsList</b>(<i>completions</i>)
-
<p>
Private method to show the completions list.
</p>
+
<dl>
<dt><i>completions</i> (list of str or set of str)</dt>
@@ -4092,10 +4100,10 @@
<a NAME="Editor.__showContextMenu" ID="Editor.__showContextMenu"></a>
<h4>Editor.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>pos</i>)
-
<p>
Private slot to show a context menu.
</p>
+
<dl>
<dt><i>pos</i> (QPoint)</dt>
@@ -4106,65 +4114,65 @@
<a NAME="Editor.__showContextMenuAutocompletion" ID="Editor.__showContextMenuAutocompletion"></a>
<h4>Editor.__showContextMenuAutocompletion</h4>
<b>__showContextMenuAutocompletion</b>(<i></i>)
-
<p>
Private slot called before the autocompletion menu is shown.
</p>
+
<a NAME="Editor.__showContextMenuChecks" ID="Editor.__showContextMenuChecks"></a>
<h4>Editor.__showContextMenuChecks</h4>
<b>__showContextMenuChecks</b>(<i></i>)
-
<p>
Private slot handling the aboutToShow signal of the checks context
menu.
</p>
+
<a NAME="Editor.__showContextMenuEncodings" ID="Editor.__showContextMenuEncodings"></a>
<h4>Editor.__showContextMenuEncodings</h4>
<b>__showContextMenuEncodings</b>(<i></i>)
-
<p>
Private slot handling the aboutToShow signal of the encodings context
menu.
</p>
+
<a NAME="Editor.__showContextMenuEol" ID="Editor.__showContextMenuEol"></a>
<h4>Editor.__showContextMenuEol</h4>
<b>__showContextMenuEol</b>(<i></i>)
-
<p>
Private slot handling the aboutToShow signal of the eol context menu.
</p>
+
<a NAME="Editor.__showContextMenuFormatting" ID="Editor.__showContextMenuFormatting"></a>
<h4>Editor.__showContextMenuFormatting</h4>
<b>__showContextMenuFormatting</b>(<i></i>)
-
<p>
Private slot handling the aboutToShow signal of the code formatting context
menu.
</p>
+
<a NAME="Editor.__showContextMenuGraphics" ID="Editor.__showContextMenuGraphics"></a>
<h4>Editor.__showContextMenuGraphics</h4>
<b>__showContextMenuGraphics</b>(<i></i>)
-
<p>
Private slot handling the aboutToShow signal of the diagrams context
menu.
</p>
+
<a NAME="Editor.__showContextMenuLanguages" ID="Editor.__showContextMenuLanguages"></a>
<h4>Editor.__showContextMenuLanguages</h4>
<b>__showContextMenuLanguages</b>(<i></i>)
-
<p>
Private slot handling the aboutToShow signal of the languages context
menu.
</p>
+
<a NAME="Editor.__showContextMenuMargin" ID="Editor.__showContextMenuMargin"></a>
<h4>Editor.__showContextMenuMargin</h4>
<b>__showContextMenuMargin</b>(<i>menu</i>)
-
<p>
Private slot handling the aboutToShow signal of the margins context
menu.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -4175,64 +4183,64 @@
<a NAME="Editor.__showContextMenuResources" ID="Editor.__showContextMenuResources"></a>
<h4>Editor.__showContextMenuResources</h4>
<b>__showContextMenuResources</b>(<i></i>)
-
<p>
Private slot handling the aboutToShow signal of the resources context
menu.
</p>
+
<a NAME="Editor.__showContextMenuShow" ID="Editor.__showContextMenuShow"></a>
<h4>Editor.__showContextMenuShow</h4>
<b>__showContextMenuShow</b>(<i></i>)
-
<p>
Private slot called before the show menu is shown.
</p>
+
<a NAME="Editor.__showContextMenuSpellCheck" ID="Editor.__showContextMenuSpellCheck"></a>
<h4>Editor.__showContextMenuSpellCheck</h4>
<b>__showContextMenuSpellCheck</b>(<i></i>)
-
<p>
Private slot handling the aboutToShow signal of the spell check
context menu.
</p>
+
<a NAME="Editor.__showContextMenuSpellLanguages" ID="Editor.__showContextMenuSpellLanguages"></a>
<h4>Editor.__showContextMenuSpellLanguages</h4>
<b>__showContextMenuSpellLanguages</b>(<i></i>)
-
<p>
Private slot handling the aboutToShow signal of the spell check
languages context menu.
</p>
+
<a NAME="Editor.__showContextMenuSpelling" ID="Editor.__showContextMenuSpelling"></a>
<h4>Editor.__showContextMenuSpelling</h4>
<b>__showContextMenuSpelling</b>(<i></i>)
-
<p>
Private slot to set up the spelling menu before it is shown.
</p>
+
<a NAME="Editor.__showContextMenuTools" ID="Editor.__showContextMenuTools"></a>
<h4>Editor.__showContextMenuTools</h4>
<b>__showContextMenuTools</b>(<i></i>)
-
<p>
Private slot handling the aboutToShow signal of the tools context
menu.
</p>
+
<a NAME="Editor.__showImportsDiagram" ID="Editor.__showImportsDiagram"></a>
<h4>Editor.__showImportsDiagram</h4>
<b>__showImportsDiagram</b>(<i></i>)
-
<p>
Private method to handle the Imports Diagram context menu action.
</p>
+
<a NAME="Editor.__showMouseHoverHelp" ID="Editor.__showMouseHoverHelp"></a>
<h4>Editor.__showMouseHoverHelp</h4>
<b>__showMouseHoverHelp</b>(<i>pos, x, y</i>)
-
<p>
Private slot showing code information about the symbol under the
cursor.
</p>
+
<dl>
<dt><i>pos</i> (int)</dt>
@@ -4251,25 +4259,25 @@
<a NAME="Editor.__showPackageDiagram" ID="Editor.__showPackageDiagram"></a>
<h4>Editor.__showPackageDiagram</h4>
<b>__showPackageDiagram</b>(<i></i>)
-
<p>
Private method to handle the Package Diagram context menu action.
</p>
+
<a NAME="Editor.__showProfileData" ID="Editor.__showProfileData"></a>
<h4>Editor.__showProfileData</h4>
<b>__showProfileData</b>(<i></i>)
-
<p>
Private method to handle the show profile data context menu action.
</p>
+
<a NAME="Editor.__showSyntaxError" ID="Editor.__showSyntaxError"></a>
<h4>Editor.__showSyntaxError</h4>
<b>__showSyntaxError</b>(<i>line=-1</i>)
-
<p>
Private slot to handle the 'Show syntax error message'
context menu action.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -4280,10 +4288,10 @@
<a NAME="Editor.__showWarning" ID="Editor.__showWarning"></a>
<h4>Editor.__showWarning</h4>
<b>__showWarning</b>(<i>line=-1</i>)
-
<p>
Private slot to handle the 'Show warning' context menu action.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -4294,10 +4302,10 @@
<a NAME="Editor.__spellCharAdded" ID="Editor.__spellCharAdded"></a>
<h4>Editor.__spellCharAdded</h4>
<b>__spellCharAdded</b>(<i>charNumber</i>)
-
<p>
Private slot called to handle the user entering a character.
</p>
+
<dl>
<dt><i>charNumber</i> (int)</dt>
@@ -4308,10 +4316,10 @@
<a NAME="Editor.__spellLanguageChanged" ID="Editor.__spellLanguageChanged"></a>
<h4>Editor.__spellLanguageChanged</h4>
<b>__spellLanguageChanged</b>(<i>language, propagate=True</i>)
-
<p>
Private slot to handle a change of the spell check language.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -4326,10 +4334,10 @@
<a NAME="Editor.__spellLanguagesMenuTriggered" ID="Editor.__spellLanguagesMenuTriggered"></a>
<h4>Editor.__spellLanguagesMenuTriggered</h4>
<b>__spellLanguagesMenuTriggered</b>(<i>act</i>)
-
<p>
Private method to handle the selection of a spell check language.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -4340,38 +4348,38 @@
<a NAME="Editor.__streamCommentLine" ID="Editor.__streamCommentLine"></a>
<h4>Editor.__streamCommentLine</h4>
<b>__streamCommentLine</b>(<i></i>)
-
<p>
Private slot to stream comment the current line.
</p>
+
<a NAME="Editor.__streamCommentSelection" ID="Editor.__streamCommentSelection"></a>
<h4>Editor.__streamCommentSelection</h4>
<b>__streamCommentSelection</b>(<i></i>)
-
<p>
Private slot to comment the current selection.
</p>
+
<a NAME="Editor.__streamUncommentLine" ID="Editor.__streamUncommentLine"></a>
<h4>Editor.__streamUncommentLine</h4>
<b>__streamUncommentLine</b>(<i></i>)
-
<p>
Private slot to stream uncomment the current line.
</p>
+
<a NAME="Editor.__streamUncommentSelection" ID="Editor.__streamUncommentSelection"></a>
<h4>Editor.__streamUncommentSelection</h4>
<b>__streamUncommentSelection</b>(<i></i>)
-
<p>
Private slot to stream uncomment the current selection.
</p>
+
<a NAME="Editor.__styleNeeded" ID="Editor.__styleNeeded"></a>
<h4>Editor.__styleNeeded</h4>
<b>__styleNeeded</b>(<i>position</i>)
-
<p>
Private slot to handle the need for more styling.
</p>
+
<dl>
<dt><i>position</i> (int)</dt>
@@ -4382,7 +4390,6 @@
<a NAME="Editor.__textChanged" ID="Editor.__textChanged"></a>
<h4>Editor.__textChanged</h4>
<b>__textChanged</b>(<i></i>)
-
<p>
Private slot to handle a change of the editor text.
</p>
@@ -4391,17 +4398,17 @@
is run in order to ensure, that cursor position has been updated
by the underlying Scintilla editor.
</p>
+
<a NAME="Editor.__toggleAutoCompletionEnable" ID="Editor.__toggleAutoCompletionEnable"></a>
<h4>Editor.__toggleAutoCompletionEnable</h4>
<b>__toggleAutoCompletionEnable</b>(<i></i>)
-
<p>
Private slot to handle the Enable Autocompletion context menu entry.
</p>
+
<a NAME="Editor.__toggleBlockComment" ID="Editor.__toggleBlockComment"></a>
<h4>Editor.__toggleBlockComment</h4>
<b>__toggleBlockComment</b>(<i></i>)
-
<p>
Private slot to toggle the comment of a block.
</p>
@@ -4411,13 +4418,14 @@
is no selected text and the current line is not commented, it will be commented.
If is commented, the comment block will be removed.
</p>
+
<a NAME="Editor.__toggleBreakpoint" ID="Editor.__toggleBreakpoint"></a>
<h4>Editor.__toggleBreakpoint</h4>
<b>__toggleBreakpoint</b>(<i>line, temporary=False</i>)
-
<p>
Private method to toggle a breakpoint.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -4432,10 +4440,10 @@
<a NAME="Editor.__toggleBreakpointEnabled" ID="Editor.__toggleBreakpointEnabled"></a>
<h4>Editor.__toggleBreakpointEnabled</h4>
<b>__toggleBreakpointEnabled</b>(<i>line</i>)
-
<p>
Private method to toggle a breakpoints enabled status.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -4446,7 +4454,6 @@
<a NAME="Editor.__toggleStreamComment" ID="Editor.__toggleStreamComment"></a>
<h4>Editor.__toggleStreamComment</h4>
<b>__toggleStreamComment</b>(<i></i>)
-
<p>
Private slot to toggle the comment of a block.
</p>
@@ -4456,31 +4463,31 @@
is no selected text and the current line is not commented, it will be commented.
If is commented, the comment block will be removed.
</p>
+
<a NAME="Editor.__toggleTypingAids" ID="Editor.__toggleTypingAids"></a>
<h4>Editor.__toggleTypingAids</h4>
<b>__toggleTypingAids</b>(<i></i>)
-
<p>
Private slot to toggle the typing aids.
</p>
+
<a NAME="Editor.__uncommentLine" ID="Editor.__uncommentLine"></a>
<h4>Editor.__uncommentLine</h4>
<b>__uncommentLine</b>(<i></i>)
-
<p>
Private slot to uncomment the current line.
</p>
+
<a NAME="Editor.__uncommentSelection" ID="Editor.__uncommentSelection"></a>
<h4>Editor.__uncommentSelection</h4>
<b>__uncommentSelection</b>(<i></i>)
-
<p>
Private slot to uncomment the current selection.
</p>
+
<a NAME="Editor.__updateReadOnly" ID="Editor.__updateReadOnly"></a>
<h4>Editor.__updateReadOnly</h4>
<b>__updateReadOnly</b>(<i>bForce=True</i>)
-
<p>
Private method to update the readOnly information for this editor.
</p>
@@ -4490,6 +4497,7 @@
initialization time. A signal is emitted after the
caption change.
</p>
+
<dl>
<dt><i>bForce</i> (bool)</dt>
@@ -4501,10 +4509,10 @@
<a NAME="Editor.addCallTipHook" ID="Editor.addCallTipHook"></a>
<h4>Editor.addCallTipHook</h4>
<b>addCallTipHook</b>(<i>key, func</i>)
-
<p>
Public method to set a calltip provider.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -4523,10 +4531,10 @@
<a NAME="Editor.addClone" ID="Editor.addClone"></a>
<h4>Editor.addClone</h4>
<b>addClone</b>(<i>editor</i>)
-
<p>
Public method to add a clone to our list.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -4537,10 +4545,10 @@
<a NAME="Editor.addCompletionListHook" ID="Editor.addCompletionListHook"></a>
<h4>Editor.addCompletionListHook</h4>
<b>addCompletionListHook</b>(<i>key, func, asynchroneous=False</i>)
-
<p>
Public method to set an auto-completion list provider.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -4564,17 +4572,17 @@
<a NAME="Editor.addedToProject" ID="Editor.addedToProject"></a>
<h4>Editor.addedToProject</h4>
<b>addedToProject</b>(<i></i>)
-
<p>
Public method to signal, that this editor has been added to a project.
</p>
+
<a NAME="Editor.autoComplete" ID="Editor.autoComplete"></a>
<h4>Editor.autoComplete</h4>
<b>autoComplete</b>(<i>auto=False, context=True</i>)
-
<p>
Public method to start auto-completion.
</p>
+
<dl>
<dt><i>auto</i> (bool)</dt>
@@ -4589,31 +4597,31 @@
<a NAME="Editor.autoCompleteQScintilla" ID="Editor.autoCompleteQScintilla"></a>
<h4>Editor.autoCompleteQScintilla</h4>
<b>autoCompleteQScintilla</b>(<i></i>)
-
<p>
Public method to perform an autocompletion using QScintilla methods.
</p>
+
<a NAME="Editor.boxCommentLineOrSelection" ID="Editor.boxCommentLineOrSelection"></a>
<h4>Editor.boxCommentLineOrSelection</h4>
<b>boxCommentLineOrSelection</b>(<i></i>)
-
<p>
Public slot to box comment the current line or current selection.
</p>
+
<a NAME="Editor.callTip" ID="Editor.callTip"></a>
<h4>Editor.callTip</h4>
<b>callTip</b>(<i></i>)
-
<p>
Public method to show calltips.
</p>
+
<a NAME="Editor.canAutoCompleteFromAPIs" ID="Editor.canAutoCompleteFromAPIs"></a>
<h4>Editor.canAutoCompleteFromAPIs</h4>
<b>canAutoCompleteFromAPIs</b>(<i></i>)
-
<p>
Public method to check for API availablity.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -4629,10 +4637,10 @@
<a NAME="Editor.canProvideCallTipps" ID="Editor.canProvideCallTipps"></a>
<h4>Editor.canProvideCallTipps</h4>
<b>canProvideCallTipps</b>(<i></i>)
-
<p>
Public method to test the calltips availability.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -4648,10 +4656,10 @@
<a NAME="Editor.canProvideDynamicAutoCompletion" ID="Editor.canProvideDynamicAutoCompletion"></a>
<h4>Editor.canProvideDynamicAutoCompletion</h4>
<b>canProvideDynamicAutoCompletion</b>(<i></i>)
-
<p>
Public method to test the dynamic auto-completion availability.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -4667,10 +4675,10 @@
<a NAME="Editor.cancelSharedEdit" ID="Editor.cancelSharedEdit"></a>
<h4>Editor.cancelSharedEdit</h4>
<b>cancelSharedEdit</b>(<i>send=True</i>)
-
<p>
Public method to cancel a shared edit session for the editor.
</p>
+
<dl>
<dt><i>send</i> (bool)</dt>
@@ -4681,7 +4689,6 @@
<a NAME="Editor.changeEvent" ID="Editor.changeEvent"></a>
<h4>Editor.changeEvent</h4>
<b>changeEvent</b>(<i>evt</i>)
-
<p>
Protected method called to process an event.
</p>
@@ -4692,6 +4699,7 @@
other modes. This is to make the editor windows work nicer
with the QWorkspace.
</p>
+
<dl>
<dt><i>evt</i> (QEvent)</dt>
@@ -4702,10 +4710,10 @@
<a NAME="Editor.checkDirty" ID="Editor.checkDirty"></a>
<h4>Editor.checkDirty</h4>
<b>checkDirty</b>(<i></i>)
-
<p>
Public method to check dirty status and open a message window.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -4721,10 +4729,10 @@
<a NAME="Editor.checkReadOnly" ID="Editor.checkReadOnly"></a>
<h4>Editor.checkReadOnly</h4>
<b>checkReadOnly</b>(<i></i>)
-
<p>
Public method to check the 'read only' state.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -4740,43 +4748,42 @@
<a NAME="Editor.checkRereadFile" ID="Editor.checkRereadFile"></a>
<h4>Editor.checkRereadFile</h4>
<b>checkRereadFile</b>(<i></i>)
-
<p>
Public slot to check, if the file needs to be re-read, and refresh it if
needed.
</p>
+
<a NAME="Editor.checkSpelling" ID="Editor.checkSpelling"></a>
<h4>Editor.checkSpelling</h4>
<b>checkSpelling</b>(<i></i>)
-
<p>
Public slot to perform an interactive spell check of the document.
</p>
+
<a NAME="Editor.checkSyntax" ID="Editor.checkSyntax"></a>
<h4>Editor.checkSyntax</h4>
<b>checkSyntax</b>(<i></i>)
-
<p>
Public method to perform an automatic syntax check of the file.
</p>
+
<a NAME="Editor.clearAllHighlights" ID="Editor.clearAllHighlights"></a>
<h4>Editor.clearAllHighlights</h4>
<b>clearAllHighlights</b>(<i></i>)
-
<p>
Public method to clear all highlights.
</p>
+
<a NAME="Editor.clearBookmarks" ID="Editor.clearBookmarks"></a>
<h4>Editor.clearBookmarks</h4>
<b>clearBookmarks</b>(<i></i>)
-
<p>
Public slot to handle the 'Clear all bookmarks' context menu action.
</p>
+
<a NAME="Editor.clearBreakpoint" ID="Editor.clearBreakpoint"></a>
<h4>Editor.clearBreakpoint</h4>
<b>clearBreakpoint</b>(<i>line</i>)
-
<p>
Public method to clear a breakpoint.
</p>
@@ -4784,6 +4791,7 @@
Note: This doesn't clear the breakpoint in the debugger,
it just deletes it from the editor internal list of breakpoints.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -4794,38 +4802,38 @@
<a NAME="Editor.clearChangeMarkers" ID="Editor.clearChangeMarkers"></a>
<h4>Editor.clearChangeMarkers</h4>
<b>clearChangeMarkers</b>(<i></i>)
-
<p>
Public method to clear all change markers.
</p>
+
<a NAME="Editor.clearCodeWarnings" ID="Editor.clearCodeWarnings"></a>
<h4>Editor.clearCodeWarnings</h4>
<b>clearCodeWarnings</b>(<i></i>)
-
<p>
Public slot to clear all code warnings.
</p>
+
<a NAME="Editor.clearErrorWarnings" ID="Editor.clearErrorWarnings"></a>
<h4>Editor.clearErrorWarnings</h4>
<b>clearErrorWarnings</b>(<i></i>)
-
<p>
Public slot to clear all error warnings.
</p>
+
<a NAME="Editor.clearFlakesWarnings" ID="Editor.clearFlakesWarnings"></a>
<h4>Editor.clearFlakesWarnings</h4>
<b>clearFlakesWarnings</b>(<i></i>)
-
<p>
Public slot to clear all pyflakes warnings.
</p>
+
<a NAME="Editor.clearHighlight" ID="Editor.clearHighlight"></a>
<h4>Editor.clearHighlight</h4>
<b>clearHighlight</b>(<i>startLine, startIndex, endLine, endIndex</i>)
-
<p>
Public method to clear a text highlight.
</p>
+
<dl>
<dt><i>startLine</i> (int)</dt>
@@ -4848,57 +4856,56 @@
<a NAME="Editor.clearInfoWarnings" ID="Editor.clearInfoWarnings"></a>
<h4>Editor.clearInfoWarnings</h4>
<b>clearInfoWarnings</b>(<i></i>)
-
<p>
Public slot to clear all info warnings.
</p>
+
<a NAME="Editor.clearSearchIndicators" ID="Editor.clearSearchIndicators"></a>
<h4>Editor.clearSearchIndicators</h4>
<b>clearSearchIndicators</b>(<i></i>)
-
<p>
Public method to clear all search indicators.
</p>
+
<a NAME="Editor.clearSearchSelectionHighlight" ID="Editor.clearSearchSelectionHighlight"></a>
<h4>Editor.clearSearchSelectionHighlight</h4>
<b>clearSearchSelectionHighlight</b>(<i></i>)
-
<p>
Public method to clear all highlights.
</p>
+
<a NAME="Editor.clearStyleWarnings" ID="Editor.clearStyleWarnings"></a>
<h4>Editor.clearStyleWarnings</h4>
<b>clearStyleWarnings</b>(<i></i>)
-
<p>
Public slot to clear all style warnings.
</p>
+
<a NAME="Editor.clearStyles" ID="Editor.clearStyles"></a>
<h4>Editor.clearStyles</h4>
<b>clearStyles</b>(<i></i>)
-
<p>
Public method to set the styles according the selected Qt style
or the selected editor colours.
</p>
+
<a NAME="Editor.clearSyntaxError" ID="Editor.clearSyntaxError"></a>
<h4>Editor.clearSyntaxError</h4>
<b>clearSyntaxError</b>(<i></i>)
-
<p>
Public slot to handle the 'Clear all syntax error' context menu action.
</p>
+
<a NAME="Editor.clearWarnings" ID="Editor.clearWarnings"></a>
<h4>Editor.clearWarnings</h4>
<b>clearWarnings</b>(<i></i>)
-
<p>
Public slot to clear all warnings.
</p>
+
<a NAME="Editor.close" ID="Editor.close"></a>
<h4>Editor.close</h4>
<b>close</b>(<i></i>)
-
<p>
Public method called when the window gets closed.
</p>
@@ -4907,6 +4914,7 @@
ViewManager.closeEditor, which in turn calls our closeIt
method.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -4922,18 +4930,18 @@
<a NAME="Editor.closeIt" ID="Editor.closeIt"></a>
<h4>Editor.closeIt</h4>
<b>closeIt</b>(<i></i>)
-
<p>
Public method called by the viewmanager to finally get rid of us.
</p>
+
<a NAME="Editor.codeCoverageShowAnnotations" ID="Editor.codeCoverageShowAnnotations"></a>
<h4>Editor.codeCoverageShowAnnotations</h4>
<b>codeCoverageShowAnnotations</b>(<i>silent=False, coverageFile=None</i>)
-
<p>
Public method to handle the show code coverage annotations context
menu action.
</p>
+
<dl>
<dt><i>silent</i> (bool (optional))</dt>
@@ -4950,10 +4958,10 @@
<a NAME="Editor.collapseFoldWithChildren" ID="Editor.collapseFoldWithChildren"></a>
<h4>Editor.collapseFoldWithChildren</h4>
<b>collapseFoldWithChildren</b>(<i>line=-1</i>)
-
<p>
Public method to collapse the current fold including its children.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -4964,7 +4972,6 @@
<a NAME="Editor.commentLineOrSelection" ID="Editor.commentLineOrSelection"></a>
<h4>Editor.commentLineOrSelection</h4>
<b>commentLineOrSelection</b>(<i></i>)
-
<p>
Public slot to comment the current line or current selection.
</p>
@@ -4973,14 +4980,15 @@
Otherwise a stream comment is used if that is supported. If none of
these are supported, the request is ignored silently.
</p>
+
<a NAME="Editor.completionsListReady" ID="Editor.completionsListReady"></a>
<h4>Editor.completionsListReady</h4>
<b>completionsListReady</b>(<i>completions, acText</i>)
-
<p>
Public method to show the completions determined by a completions
provider.
</p>
+
<dl>
<dt><i>completions</i> (list of str or set of str)</dt>
@@ -4995,7 +5003,6 @@
<a NAME="Editor.convertEols" ID="Editor.convertEols"></a>
<h4>Editor.convertEols</h4>
<b>convertEols</b>(<i>eolMode</i>)
-
<p>
Public method to convert the end-of-line marker.
</p>
@@ -5003,6 +5010,7 @@
This variant of the method emits a signal to update the IDE after
the original method was called.
</p>
+
<dl>
<dt><i>eolMode</i> (QsciScintilla.EolMode)</dt>
@@ -5013,11 +5021,11 @@
<a NAME="Editor.curLineHasBreakpoint" ID="Editor.curLineHasBreakpoint"></a>
<h4>Editor.curLineHasBreakpoint</h4>
<b>curLineHasBreakpoint</b>(<i></i>)
-
<p>
Public method to check for the presence of a breakpoint at the current
line.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5033,10 +5041,10 @@
<a NAME="Editor.determineFileType" ID="Editor.determineFileType"></a>
<h4>Editor.determineFileType</h4>
<b>determineFileType</b>(<i></i>)
-
<p>
Public method to determine the file type using various tests.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5052,10 +5060,10 @@
<a NAME="Editor.dragEnterEvent" ID="Editor.dragEnterEvent"></a>
<h4>Editor.dragEnterEvent</h4>
<b>dragEnterEvent</b>(<i>event</i>)
-
<p>
Protected method to handle the drag enter event.
</p>
+
<dl>
<dt><i>event</i> (QDragEnterEvent)</dt>
@@ -5066,10 +5074,10 @@
<a NAME="Editor.dragLeaveEvent" ID="Editor.dragLeaveEvent"></a>
<h4>Editor.dragLeaveEvent</h4>
<b>dragLeaveEvent</b>(<i>event</i>)
-
<p>
Protected method to handle the drag leave event.
</p>
+
<dl>
<dt><i>event</i> (QDragLeaveEvent)</dt>
@@ -5080,10 +5088,10 @@
<a NAME="Editor.dragMoveEvent" ID="Editor.dragMoveEvent"></a>
<h4>Editor.dragMoveEvent</h4>
<b>dragMoveEvent</b>(<i>event</i>)
-
<p>
Protected method to handle the drag move event.
</p>
+
<dl>
<dt><i>event</i> (QDragMoveEvent)</dt>
@@ -5094,10 +5102,10 @@
<a NAME="Editor.dropEvent" ID="Editor.dropEvent"></a>
<h4>Editor.dropEvent</h4>
<b>dropEvent</b>(<i>event</i>)
-
<p>
Protected method to handle the drop event.
</p>
+
<dl>
<dt><i>event</i> (QDropEvent)</dt>
@@ -5108,10 +5116,10 @@
<a NAME="Editor.editorCommand" ID="Editor.editorCommand"></a>
<h4>Editor.editorCommand</h4>
<b>editorCommand</b>(<i>cmd</i>)
-
<p>
Public method to perform a simple editor command.
</p>
+
<dl>
<dt><i>cmd</i> (int)</dt>
@@ -5122,11 +5130,11 @@
<a NAME="Editor.encloseSelectedText" ID="Editor.encloseSelectedText"></a>
<h4>Editor.encloseSelectedText</h4>
<b>encloseSelectedText</b>(<i></i>)
-
<p>
Local function to enclose the current selection with some
characters.
</p>
+
<dl>
<dt><i>encString</i> (str)</dt>
@@ -5138,10 +5146,10 @@
<a NAME="Editor.ensureVisible" ID="Editor.ensureVisible"></a>
<h4>Editor.ensureVisible</h4>
<b>ensureVisible</b>(<i>line, expand=False</i>)
-
<p>
Public method to ensure, that the specified line is visible.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -5156,11 +5164,11 @@
<a NAME="Editor.ensureVisibleTop" ID="Editor.ensureVisibleTop"></a>
<h4>Editor.ensureVisibleTop</h4>
<b>ensureVisibleTop</b>(<i>line, expand=False</i>)
-
<p>
Public method to ensure, that the specified line is visible at the top
of the editor.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -5175,10 +5183,10 @@
<a NAME="Editor.event" ID="Editor.event"></a>
<h4>Editor.event</h4>
<b>event</b>(<i>evt</i>)
-
<p>
Public method handling events.
</p>
+
<dl>
<dt><i>evt</i> (QEvent)</dt>
@@ -5201,10 +5209,10 @@
<a NAME="Editor.expandFoldWithChildren" ID="Editor.expandFoldWithChildren"></a>
<h4>Editor.expandFoldWithChildren</h4>
<b>expandFoldWithChildren</b>(<i>line=-1</i>)
-
<p>
Public method to expand the current fold including its children.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -5215,17 +5223,17 @@
<a NAME="Editor.expandTabs" ID="Editor.expandTabs"></a>
<h4>Editor.expandTabs</h4>
<b>expandTabs</b>(<i></i>)
-
<p>
Public slot to expand tabulators to spaces.
</p>
+
<a NAME="Editor.exportFile" ID="Editor.exportFile"></a>
<h4>Editor.exportFile</h4>
<b>exportFile</b>(<i>exporterFormat</i>)
-
<p>
Public method to export the file.
</p>
+
<dl>
<dt><i>exporterFormat</i> (str)</dt>
@@ -5236,17 +5244,17 @@
<a NAME="Editor.extractTasks" ID="Editor.extractTasks"></a>
<h4>Editor.extractTasks</h4>
<b>extractTasks</b>(<i></i>)
-
<p>
Public slot to extract all tasks.
</p>
+
<a NAME="Editor.fileRenamed" ID="Editor.fileRenamed"></a>
<h4>Editor.fileRenamed</h4>
<b>fileRenamed</b>(<i>fn</i>)
-
<p>
Public slot to handle the editorRenamed signal.
</p>
+
<dl>
<dt><i>fn</i> (str.)</dt>
@@ -5257,7 +5265,6 @@
<a NAME="Editor.focusInEvent" ID="Editor.focusInEvent"></a>
<h4>Editor.focusInEvent</h4>
<b>focusInEvent</b>(<i>event</i>)
-
<p>
Protected method called when the editor receives focus.
</p>
@@ -5267,6 +5274,7 @@
assuming, that it is in the vicinity of the old position after the
reread.
</p>
+
<dl>
<dt><i>event</i> (QFocusEvent)</dt>
@@ -5277,10 +5285,10 @@
<a NAME="Editor.focusOutEvent" ID="Editor.focusOutEvent"></a>
<h4>Editor.focusOutEvent</h4>
<b>focusOutEvent</b>(<i>event</i>)
-
<p>
Protected method called when the editor loses focus.
</p>
+
<dl>
<dt><i>event</i> (QFocusEvent)</dt>
@@ -5291,10 +5299,10 @@
<a NAME="Editor.gestureEvent" ID="Editor.gestureEvent"></a>
<h4>Editor.gestureEvent</h4>
<b>gestureEvent</b>(<i>evt</i>)
-
<p>
Protected method handling gesture events.
</p>
+
<dl>
<dt><i>evt</i> (QGestureEvent)</dt>
@@ -5305,10 +5313,10 @@
<a NAME="Editor.getApiLanguage" ID="Editor.getApiLanguage"></a>
<h4>Editor.getApiLanguage</h4>
<b>getApiLanguage</b>(<i></i>)
-
<p>
Public method to get the API language of the editor.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5324,10 +5332,10 @@
<a NAME="Editor.getBookmarkLines" ID="Editor.getBookmarkLines"></a>
<h4>Editor.getBookmarkLines</h4>
<b>getBookmarkLines</b>(<i></i>)
-
<p>
Public method to get the lines containing a bookmark.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5343,10 +5351,10 @@
<a NAME="Editor.getBookmarks" ID="Editor.getBookmarks"></a>
<h4>Editor.getBookmarks</h4>
<b>getBookmarks</b>(<i></i>)
-
<p>
Public method to retrieve the bookmarks.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5362,10 +5370,10 @@
<a NAME="Editor.getBreakpointLines" ID="Editor.getBreakpointLines"></a>
<h4>Editor.getBreakpointLines</h4>
<b>getBreakpointLines</b>(<i></i>)
-
<p>
Public method to get the lines containing a breakpoint.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5381,10 +5389,10 @@
<a NAME="Editor.getCallTipHook" ID="Editor.getCallTipHook"></a>
<h4>Editor.getCallTipHook</h4>
<b>getCallTipHook</b>(<i>key</i>)
-
<p>
Public method to get the registered calltip provider.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -5407,10 +5415,10 @@
<a NAME="Editor.getChangeLines" ID="Editor.getChangeLines"></a>
<h4>Editor.getChangeLines</h4>
<b>getChangeLines</b>(<i></i>)
-
<p>
Public method to get the lines containing a change.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5426,10 +5434,10 @@
<a NAME="Editor.getCompleter" ID="Editor.getCompleter"></a>
<h4>Editor.getCompleter</h4>
<b>getCompleter</b>(<i></i>)
-
<p>
Public method to retrieve a reference to the completer object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5445,10 +5453,10 @@
<a NAME="Editor.getCompletionListHook" ID="Editor.getCompletionListHook"></a>
<h4>Editor.getCompletionListHook</h4>
<b>getCompletionListHook</b>(<i>key</i>)
-
<p>
Public method to get the registered completion list provider.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -5471,10 +5479,10 @@
<a NAME="Editor.getCoverageLines" ID="Editor.getCoverageLines"></a>
<h4>Editor.getCoverageLines</h4>
<b>getCoverageLines</b>(<i></i>)
-
<p>
Public method to get the lines containing a coverage marker.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5490,10 +5498,10 @@
<a NAME="Editor.getCurrentWord" ID="Editor.getCurrentWord"></a>
<h4>Editor.getCurrentWord</h4>
<b>getCurrentWord</b>(<i></i>)
-
<p>
Public method to get the word at the current position.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5509,10 +5517,10 @@
<a NAME="Editor.getCurrentWordBoundaries" ID="Editor.getCurrentWordBoundaries"></a>
<h4>Editor.getCurrentWordBoundaries</h4>
<b>getCurrentWordBoundaries</b>(<i></i>)
-
<p>
Public method to get the word boundaries at the current position.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5528,10 +5536,10 @@
<a NAME="Editor.getDocstringGenerator" ID="Editor.getDocstringGenerator"></a>
<h4>Editor.getDocstringGenerator</h4>
<b>getDocstringGenerator</b>(<i></i>)
-
<p>
Public method to get a reference to the docstring generator.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5547,10 +5555,10 @@
<a NAME="Editor.getEditorConfig" ID="Editor.getEditorConfig"></a>
<h4>Editor.getEditorConfig</h4>
<b>getEditorConfig</b>(<i>option</i>)
-
<p>
Public method to get the requested option via EditorConfig.
</p>
+
<dl>
<dt><i>option</i> (str)</dt>
@@ -5573,10 +5581,10 @@
<a NAME="Editor.getEncoding" ID="Editor.getEncoding"></a>
<h4>Editor.getEncoding</h4>
<b>getEncoding</b>(<i></i>)
-
<p>
Public method to return the current encoding.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5592,10 +5600,10 @@
<a NAME="Editor.getFileName" ID="Editor.getFileName"></a>
<h4>Editor.getFileName</h4>
<b>getFileName</b>(<i></i>)
-
<p>
Public method to return the name of the file being displayed.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5611,10 +5619,10 @@
<a NAME="Editor.getFileType" ID="Editor.getFileType"></a>
<h4>Editor.getFileType</h4>
<b>getFileType</b>(<i></i>)
-
<p>
Public method to return the type of the file being displayed.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5630,11 +5638,11 @@
<a NAME="Editor.getFileTypeByFlag" ID="Editor.getFileTypeByFlag"></a>
<h4>Editor.getFileTypeByFlag</h4>
<b>getFileTypeByFlag</b>(<i></i>)
-
<p>
Public method to return the type of the file, if it was set by an
eflag: marker.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5651,10 +5659,10 @@
<a NAME="Editor.getHighlightPosition" ID="Editor.getHighlightPosition"></a>
<h4>Editor.getHighlightPosition</h4>
<b>getHighlightPosition</b>(<i></i>)
-
<p>
Public method to return the position of the highlight bar.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5670,10 +5678,10 @@
<a NAME="Editor.getLanguage" ID="Editor.getLanguage"></a>
<h4>Editor.getLanguage</h4>
<b>getLanguage</b>(<i>normalized=True, forPygments=False</i>)
-
<p>
Public method to retrieve the language of the editor.
</p>
+
<dl>
<dt><i>normalized</i> (bool)</dt>
@@ -5702,10 +5710,10 @@
<a NAME="Editor.getLexer" ID="Editor.getLexer"></a>
<h4>Editor.getLexer</h4>
<b>getLexer</b>(<i></i>)
-
<p>
Public method to retrieve a reference to the lexer object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5721,10 +5729,10 @@
<a NAME="Editor.getMenu" ID="Editor.getMenu"></a>
<h4>Editor.getMenu</h4>
<b>getMenu</b>(<i>menuName</i>)
-
<p>
Public method to get a reference to the main context menu or a submenu.
</p>
+
<dl>
<dt><i>menuName</i> (str)</dt>
@@ -5747,10 +5755,10 @@
<a NAME="Editor.getMouseClickHandler" ID="Editor.getMouseClickHandler"></a>
<h4>Editor.getMouseClickHandler</h4>
<b>getMouseClickHandler</b>(<i>modifiers, button</i>)
-
<p>
Public method to get a registered mouse click handler.
</p>
+
<dl>
<dt><i>modifiers</i> (Qt.KeyboardModifiers)</dt>
@@ -5777,11 +5785,11 @@
<a NAME="Editor.getMouseClickHandlers" ID="Editor.getMouseClickHandlers"></a>
<h4>Editor.getMouseClickHandlers</h4>
<b>getMouseClickHandlers</b>(<i>name</i>)
-
<p>
Public method to get all registered mouse click handlers of
a plug-in.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -5805,10 +5813,10 @@
<a NAME="Editor.getNoName" ID="Editor.getNoName"></a>
<h4>Editor.getNoName</h4>
<b>getNoName</b>(<i></i>)
-
<p>
Public method to get the display string for an unnamed editor.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5824,10 +5832,10 @@
<a NAME="Editor.getSearchIndicatorLines" ID="Editor.getSearchIndicatorLines"></a>
<h4>Editor.getSearchIndicatorLines</h4>
<b>getSearchIndicatorLines</b>(<i></i>)
-
<p>
Public method to get the lines containing a search indicator.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5843,10 +5851,10 @@
<a NAME="Editor.getSearchSelectionHighlight" ID="Editor.getSearchSelectionHighlight"></a>
<h4>Editor.getSearchSelectionHighlight</h4>
<b>getSearchSelectionHighlight</b>(<i></i>)
-
<p>
Public method to get the start and end of the selection highlight.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5862,11 +5870,11 @@
<a NAME="Editor.getSearchText" ID="Editor.getSearchText"></a>
<h4>Editor.getSearchText</h4>
<b>getSearchText</b>(<i>selectionOnly=False</i>)
-
<p>
Public method to determine the selection or the current word for the
next search operation.
</p>
+
<dl>
<dt><i>selectionOnly</i> (bool)</dt>
@@ -5890,10 +5898,10 @@
<a NAME="Editor.getSharingStatus" ID="Editor.getSharingStatus"></a>
<h4>Editor.getSharingStatus</h4>
<b>getSharingStatus</b>(<i></i>)
-
<p>
Public method to get some share status info.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5911,10 +5919,10 @@
<a NAME="Editor.getSpellingLanguage" ID="Editor.getSpellingLanguage"></a>
<h4>Editor.getSpellingLanguage</h4>
<b>getSpellingLanguage</b>(<i></i>)
-
<p>
Public method to get the current spelling language.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5930,10 +5938,10 @@
<a NAME="Editor.getSyntaxErrorLines" ID="Editor.getSyntaxErrorLines"></a>
<h4>Editor.getSyntaxErrorLines</h4>
<b>getSyntaxErrorLines</b>(<i></i>)
-
<p>
Public method to get the lines containing a syntax error.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5949,10 +5957,10 @@
<a NAME="Editor.getTaskLines" ID="Editor.getTaskLines"></a>
<h4>Editor.getTaskLines</h4>
<b>getTaskLines</b>(<i></i>)
-
<p>
Public method to get the lines containing a task.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5968,10 +5976,10 @@
<a NAME="Editor.getVcsConflictMarkerLines" ID="Editor.getVcsConflictMarkerLines"></a>
<h4>Editor.getVcsConflictMarkerLines</h4>
<b>getVcsConflictMarkerLines</b>(<i></i>)
-
<p>
Public method to determine the lines containing a VCS conflict marker.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -5987,10 +5995,10 @@
<a NAME="Editor.getWarningLines" ID="Editor.getWarningLines"></a>
<h4>Editor.getWarningLines</h4>
<b>getWarningLines</b>(<i></i>)
-
<p>
Public method to get the lines containing a warning.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6006,10 +6014,10 @@
<a NAME="Editor.getWord" ID="Editor.getWord"></a>
<h4>Editor.getWord</h4>
<b>getWord</b>(<i>line, index, direction=0, useWordChars=True, forCompletion=False</i>)
-
<p>
Public method to get the word at a position.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -6051,10 +6059,10 @@
<a NAME="Editor.getWordBoundaries" ID="Editor.getWordBoundaries"></a>
<h4>Editor.getWordBoundaries</h4>
<b>getWordBoundaries</b>(<i>line, index, useWordChars=True, forCompletion=False</i>)
-
<p>
Public method to get the word boundaries at a position.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -6091,10 +6099,10 @@
<a NAME="Editor.getWordLeft" ID="Editor.getWordLeft"></a>
<h4>Editor.getWordLeft</h4>
<b>getWordLeft</b>(<i>line, index</i>)
-
<p>
Public method to get the word to the left of a position.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -6121,10 +6129,10 @@
<a NAME="Editor.getWordRight" ID="Editor.getWordRight"></a>
<h4>Editor.getWordRight</h4>
<b>getWordRight</b>(<i>line, index</i>)
-
<p>
Public method to get the word to the right of a position.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -6151,17 +6159,17 @@
<a NAME="Editor.gotoLastEditPosition" ID="Editor.gotoLastEditPosition"></a>
<h4>Editor.gotoLastEditPosition</h4>
<b>gotoLastEditPosition</b>(<i></i>)
-
<p>
Public method to move the cursor to the last edit position.
</p>
+
<a NAME="Editor.gotoLine" ID="Editor.gotoLine"></a>
<h4>Editor.gotoLine</h4>
<b>gotoLine</b>(<i>line, pos=1, firstVisible=False, expand=False</i>)
-
<p>
Public method to jump to the beginning of a line.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -6185,10 +6193,10 @@
<a NAME="Editor.gotoMethodClass" ID="Editor.gotoMethodClass"></a>
<h4>Editor.gotoMethodClass</h4>
<b>gotoMethodClass</b>(<i>goUp=False</i>)
-
<p>
Public method to go to the next Python method or class definition.
</p>
+
<dl>
<dt><i>goUp</i> (bool)</dt>
@@ -6199,10 +6207,10 @@
<a NAME="Editor.gotoReferenceHandler" ID="Editor.gotoReferenceHandler"></a>
<h4>Editor.gotoReferenceHandler</h4>
<b>gotoReferenceHandler</b>(<i>referencesList</i>)
-
<p>
Public method to handle a list of references to perform a goto.
</p>
+
<dl>
<dt><i>referencesList</i> (ReferenceItem)</dt>
@@ -6213,24 +6221,24 @@
<a NAME="Editor.gotoSyntaxError" ID="Editor.gotoSyntaxError"></a>
<h4>Editor.gotoSyntaxError</h4>
<b>gotoSyntaxError</b>(<i></i>)
-
<p>
Public slot to handle the 'Goto syntax error' context menu action.
</p>
+
<a NAME="Editor.handleMonospacedEnable" ID="Editor.handleMonospacedEnable"></a>
<h4>Editor.handleMonospacedEnable</h4>
<b>handleMonospacedEnable</b>(<i></i>)
-
<p>
Public slot to handle the Use Monospaced Font context menu entry.
</p>
+
<a NAME="Editor.handleRenamed" ID="Editor.handleRenamed"></a>
<h4>Editor.handleRenamed</h4>
<b>handleRenamed</b>(<i>fn</i>)
-
<p>
Public method to handle the editorRenamed signal.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -6241,10 +6249,10 @@
<a NAME="Editor.hasBookmarks" ID="Editor.hasBookmarks"></a>
<h4>Editor.hasBookmarks</h4>
<b>hasBookmarks</b>(<i></i>)
-
<p>
Public method to check for the presence of bookmarks.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6260,10 +6268,10 @@
<a NAME="Editor.hasBreakpoints" ID="Editor.hasBreakpoints"></a>
<h4>Editor.hasBreakpoints</h4>
<b>hasBreakpoints</b>(<i></i>)
-
<p>
Public method to check for the presence of breakpoints.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6279,10 +6287,10 @@
<a NAME="Editor.hasChangeMarkers" ID="Editor.hasChangeMarkers"></a>
<h4>Editor.hasChangeMarkers</h4>
<b>hasChangeMarkers</b>(<i></i>)
-
<p>
Public method to determine, if this editor contains any change markers.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6298,10 +6306,10 @@
<a NAME="Editor.hasCoverageMarkers" ID="Editor.hasCoverageMarkers"></a>
<h4>Editor.hasCoverageMarkers</h4>
<b>hasCoverageMarkers</b>(<i></i>)
-
<p>
Public method to test, if there are coverage markers.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6317,10 +6325,10 @@
<a NAME="Editor.hasMiniMenu" ID="Editor.hasMiniMenu"></a>
<h4>Editor.hasMiniMenu</h4>
<b>hasMiniMenu</b>(<i></i>)
-
<p>
Public method to check the miniMenu flag.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6336,10 +6344,10 @@
<a NAME="Editor.hasSyntaxErrors" ID="Editor.hasSyntaxErrors"></a>
<h4>Editor.hasSyntaxErrors</h4>
<b>hasSyntaxErrors</b>(<i></i>)
-
<p>
Public method to check for the presence of syntax errors.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6355,10 +6363,10 @@
<a NAME="Editor.hasTaskMarkers" ID="Editor.hasTaskMarkers"></a>
<h4>Editor.hasTaskMarkers</h4>
<b>hasTaskMarkers</b>(<i></i>)
-
<p>
Public method to determine, if this editor contains any task markers.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6374,10 +6382,10 @@
<a NAME="Editor.hasWarnings" ID="Editor.hasWarnings"></a>
<h4>Editor.hasWarnings</h4>
<b>hasWarnings</b>(<i></i>)
-
<p>
Public method to check for the presence of warnings.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6393,10 +6401,10 @@
<a NAME="Editor.highlight" ID="Editor.highlight"></a>
<h4>Editor.highlight</h4>
<b>highlight</b>(<i>line=None, error=False, syntaxError=False</i>)
-
<p>
Public method to highlight [or de-highlight] a particular line.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -6416,10 +6424,10 @@
<a NAME="Editor.highlightSearchSelection" ID="Editor.highlightSearchSelection"></a>
<h4>Editor.highlightSearchSelection</h4>
<b>highlightSearchSelection</b>(<i>startLine, startIndex, endLine, endIndex</i>)
-
<p>
Public method to set a highlight for the selection at the start of a search.
</p>
+
<dl>
<dt><i>startLine</i> (int)</dt>
@@ -6442,21 +6450,20 @@
<a NAME="Editor.highlightVisible" ID="Editor.highlightVisible"></a>
<h4>Editor.highlightVisible</h4>
<b>highlightVisible</b>(<i></i>)
-
<p>
Public method to make sure that the highlight is visible.
</p>
+
<a NAME="Editor.indentLineOrSelection" ID="Editor.indentLineOrSelection"></a>
<h4>Editor.indentLineOrSelection</h4>
<b>indentLineOrSelection</b>(<i></i>)
-
<p>
Public slot to indent the current line or current selection.
</p>
+
<a NAME="Editor.insertDocstring" ID="Editor.insertDocstring"></a>
<h4>Editor.insertDocstring</h4>
<b>insertDocstring</b>(<i></i>)
-
<p>
Public method to generate and insert a docstring for the function under
the cursor.
@@ -6465,13 +6472,14 @@
Note: This method is called via a keyboard shortcut or through the
global 'Edit' menu.
</p>
+
<a NAME="Editor.isClone" ID="Editor.isClone"></a>
<h4>Editor.isClone</h4>
<b>isClone</b>(<i>editor</i>)
-
<p>
Public method to test, if the given editor is a clone.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -6494,10 +6502,10 @@
<a NAME="Editor.isCythonFile" ID="Editor.isCythonFile"></a>
<h4>Editor.isCythonFile</h4>
<b>isCythonFile</b>(<i></i>)
-
<p>
Public method to return a flag indicating a Cython file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6513,10 +6521,10 @@
<a NAME="Editor.isJavascriptFile" ID="Editor.isJavascriptFile"></a>
<h4>Editor.isJavascriptFile</h4>
<b>isJavascriptFile</b>(<i></i>)
-
<p>
Public method to return a flag indicating a Javascript file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6532,10 +6540,10 @@
<a NAME="Editor.isLastEditPositionAvailable" ID="Editor.isLastEditPositionAvailable"></a>
<h4>Editor.isLastEditPositionAvailable</h4>
<b>isLastEditPositionAvailable</b>(<i></i>)
-
<p>
Public method to check, if a last edit position is available.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6551,10 +6559,10 @@
<a NAME="Editor.isMicroPythonFile" ID="Editor.isMicroPythonFile"></a>
<h4>Editor.isMicroPythonFile</h4>
<b>isMicroPythonFile</b>(<i></i>)
-
<p>
Public method to return a flag indicating a MicroPython file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6570,11 +6578,11 @@
<a NAME="Editor.isProjectFile" ID="Editor.isProjectFile"></a>
<h4>Editor.isProjectFile</h4>
<b>isProjectFile</b>(<i></i>)
-
<p>
Public method to check, if the file of the editor belongs to the current
project.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6590,10 +6598,10 @@
<a NAME="Editor.isPy3File" ID="Editor.isPy3File"></a>
<h4>Editor.isPy3File</h4>
<b>isPy3File</b>(<i></i>)
-
<p>
Public method to return a flag indicating a Python3 file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6609,10 +6617,10 @@
<a NAME="Editor.isPyFile" ID="Editor.isPyFile"></a>
<h4>Editor.isPyFile</h4>
<b>isPyFile</b>(<i></i>)
-
<p>
Public method to return a flag indicating a Python (2 or 3) file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6628,10 +6636,10 @@
<a NAME="Editor.isRubyFile" ID="Editor.isRubyFile"></a>
<h4>Editor.isRubyFile</h4>
<b>isRubyFile</b>(<i></i>)
-
<p>
Public method to return a flag indicating a Ruby file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -6647,7 +6655,6 @@
<a NAME="Editor.isSpellCheckRegion" ID="Editor.isSpellCheckRegion"></a>
<h4>Editor.isSpellCheckRegion</h4>
<b>isSpellCheckRegion</b>(<i>pos</i>)
-
<p>
Public method to check, if the given position is within a region, that
should be spell checked.
@@ -6658,6 +6665,7 @@
files (i.e. those without a file extension) will be checked fully as
well.
</p>
+
<dl>
<dt><i>pos</i> (int)</dt>
@@ -6680,17 +6688,17 @@
<a NAME="Editor.joinLines" ID="Editor.joinLines"></a>
<h4>Editor.joinLines</h4>
<b>joinLines</b>(<i></i>)
-
<p>
Public slot to join the current line with the next one.
</p>
+
<a NAME="Editor.keyPressEvent" ID="Editor.keyPressEvent"></a>
<h4>Editor.keyPressEvent</h4>
<b>keyPressEvent</b>(<i>ev</i>)
-
<p>
Protected method to handle the user input a key at a time.
</p>
+
<dl>
<dt><i>ev</i> (QKeyEvent)</dt>
@@ -6701,52 +6709,52 @@
<a NAME="Editor.macroDelete" ID="Editor.macroDelete"></a>
<h4>Editor.macroDelete</h4>
<b>macroDelete</b>(<i></i>)
-
<p>
Public method to delete a macro.
</p>
+
<a NAME="Editor.macroLoad" ID="Editor.macroLoad"></a>
<h4>Editor.macroLoad</h4>
<b>macroLoad</b>(<i></i>)
-
<p>
Public method to load a macro from a file.
</p>
+
<a NAME="Editor.macroRecordingStart" ID="Editor.macroRecordingStart"></a>
<h4>Editor.macroRecordingStart</h4>
<b>macroRecordingStart</b>(<i></i>)
-
<p>
Public method to start macro recording.
</p>
+
<a NAME="Editor.macroRecordingStop" ID="Editor.macroRecordingStop"></a>
<h4>Editor.macroRecordingStop</h4>
<b>macroRecordingStop</b>(<i></i>)
-
<p>
Public method to stop macro recording.
</p>
+
<a NAME="Editor.macroRun" ID="Editor.macroRun"></a>
<h4>Editor.macroRun</h4>
<b>macroRun</b>(<i></i>)
-
<p>
Public method to execute a macro.
</p>
+
<a NAME="Editor.macroSave" ID="Editor.macroSave"></a>
<h4>Editor.macroSave</h4>
<b>macroSave</b>(<i></i>)
-
<p>
Public method to save a macro to a file.
</p>
+
<a NAME="Editor.menuEditBreakpoint" ID="Editor.menuEditBreakpoint"></a>
<h4>Editor.menuEditBreakpoint</h4>
<b>menuEditBreakpoint</b>(<i>line=None</i>)
-
<p>
Public slot to handle the 'Edit breakpoint' context menu action.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -6757,38 +6765,38 @@
<a NAME="Editor.menuNextBreakpoint" ID="Editor.menuNextBreakpoint"></a>
<h4>Editor.menuNextBreakpoint</h4>
<b>menuNextBreakpoint</b>(<i></i>)
-
<p>
Public slot to handle the 'Next breakpoint' context menu action.
</p>
+
<a NAME="Editor.menuPreviousBreakpoint" ID="Editor.menuPreviousBreakpoint"></a>
<h4>Editor.menuPreviousBreakpoint</h4>
<b>menuPreviousBreakpoint</b>(<i></i>)
-
<p>
Public slot to handle the 'Previous breakpoint' context menu action.
</p>
+
<a NAME="Editor.menuToggleBookmark" ID="Editor.menuToggleBookmark"></a>
<h4>Editor.menuToggleBookmark</h4>
<b>menuToggleBookmark</b>(<i></i>)
-
<p>
Public slot to handle the 'Toggle bookmark' context menu action.
</p>
+
<a NAME="Editor.menuToggleBreakpoint" ID="Editor.menuToggleBreakpoint"></a>
<h4>Editor.menuToggleBreakpoint</h4>
<b>menuToggleBreakpoint</b>(<i></i>)
-
<p>
Public slot to handle the 'Toggle breakpoint' context menu action.
</p>
+
<a NAME="Editor.mouseDoubleClickEvent" ID="Editor.mouseDoubleClickEvent"></a>
<h4>Editor.mouseDoubleClickEvent</h4>
<b>mouseDoubleClickEvent</b>(<i>evt</i>)
-
<p>
Protected method to handle mouse double click events.
</p>
+
<dl>
<dt><i>evt</i> (QMouseEvent)</dt>
@@ -6799,10 +6807,10 @@
<a NAME="Editor.mousePressEvent" ID="Editor.mousePressEvent"></a>
<h4>Editor.mousePressEvent</h4>
<b>mousePressEvent</b>(<i>event</i>)
-
<p>
Protected method to handle the mouse press event.
</p>
+
<dl>
<dt><i>event</i> (QMouseEvent)</dt>
@@ -6813,10 +6821,10 @@
<a NAME="Editor.mouseReleaseEvent" ID="Editor.mouseReleaseEvent"></a>
<h4>Editor.mouseReleaseEvent</h4>
<b>mouseReleaseEvent</b>(<i>evt</i>)
-
<p>
Protected method calling a registered mouse click handler function.
</p>
+
<dl>
<dt><i>evt</i> (QMouseEvent)</dt>
@@ -6827,10 +6835,10 @@
<a NAME="Editor.newBreakpointWithProperties" ID="Editor.newBreakpointWithProperties"></a>
<h4>Editor.newBreakpointWithProperties</h4>
<b>newBreakpointWithProperties</b>(<i>line, properties</i>)
-
<p>
Public method to set a new breakpoint and its properties.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -6846,115 +6854,115 @@
<a NAME="Editor.nextBookmark" ID="Editor.nextBookmark"></a>
<h4>Editor.nextBookmark</h4>
<b>nextBookmark</b>(<i></i>)
-
<p>
Public slot to handle the 'Next bookmark' context menu action.
</p>
+
<a NAME="Editor.nextChange" ID="Editor.nextChange"></a>
<h4>Editor.nextChange</h4>
<b>nextChange</b>(<i></i>)
-
<p>
Public slot to handle the 'Next change' context menu action.
</p>
+
<a NAME="Editor.nextTask" ID="Editor.nextTask"></a>
<h4>Editor.nextTask</h4>
<b>nextTask</b>(<i></i>)
-
<p>
Public slot to handle the 'Next task' context menu action.
</p>
+
<a NAME="Editor.nextUncovered" ID="Editor.nextUncovered"></a>
<h4>Editor.nextUncovered</h4>
<b>nextUncovered</b>(<i></i>)
-
<p>
Public slot to handle the 'Next uncovered' context menu action.
</p>
+
<a NAME="Editor.nextWarning" ID="Editor.nextWarning"></a>
<h4>Editor.nextWarning</h4>
<b>nextWarning</b>(<i></i>)
-
<p>
Public slot to handle the 'Next warning' context menu action.
</p>
+
<a NAME="Editor.previousBookmark" ID="Editor.previousBookmark"></a>
<h4>Editor.previousBookmark</h4>
<b>previousBookmark</b>(<i></i>)
-
<p>
Public slot to handle the 'Previous bookmark' context menu action.
</p>
+
<a NAME="Editor.previousChange" ID="Editor.previousChange"></a>
<h4>Editor.previousChange</h4>
<b>previousChange</b>(<i></i>)
-
<p>
Public slot to handle the 'Previous change' context menu action.
</p>
+
<a NAME="Editor.previousTask" ID="Editor.previousTask"></a>
<h4>Editor.previousTask</h4>
<b>previousTask</b>(<i></i>)
-
<p>
Public slot to handle the 'Previous task' context menu action.
</p>
+
<a NAME="Editor.previousUncovered" ID="Editor.previousUncovered"></a>
<h4>Editor.previousUncovered</h4>
<b>previousUncovered</b>(<i></i>)
-
<p>
Public slot to handle the 'Previous uncovered' context menu action.
</p>
+
<a NAME="Editor.previousWarning" ID="Editor.previousWarning"></a>
<h4>Editor.previousWarning</h4>
<b>previousWarning</b>(<i></i>)
-
<p>
Public slot to handle the 'Previous warning' context menu action.
</p>
+
<a NAME="Editor.printFile" ID="Editor.printFile"></a>
<h4>Editor.printFile</h4>
<b>printFile</b>(<i></i>)
-
<p>
Public slot to print the text.
</p>
+
<a NAME="Editor.printPreviewFile" ID="Editor.printPreviewFile"></a>
<h4>Editor.printPreviewFile</h4>
<b>printPreviewFile</b>(<i></i>)
-
<p>
Public slot to show a print preview of the text.
</p>
+
<a NAME="Editor.projectClosed" ID="Editor.projectClosed"></a>
<h4>Editor.projectClosed</h4>
<b>projectClosed</b>(<i></i>)
-
<p>
Public slot to handle the closing of a project.
</p>
+
<a NAME="Editor.projectLexerAssociationsChanged" ID="Editor.projectLexerAssociationsChanged"></a>
<h4>Editor.projectLexerAssociationsChanged</h4>
<b>projectLexerAssociationsChanged</b>(<i></i>)
-
<p>
Public slot to handle changes of the project lexer associations.
</p>
+
<a NAME="Editor.projectOpened" ID="Editor.projectOpened"></a>
<h4>Editor.projectOpened</h4>
<b>projectOpened</b>(<i></i>)
-
<p>
Public slot to handle the opening of a project.
</p>
+
<a NAME="Editor.readFile" ID="Editor.readFile"></a>
<h4>Editor.readFile</h4>
<b>readFile</b>(<i>fn, createIt=False, encoding="", noempty=False</i>)
-
<p>
Public method to read the text from a file.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -6979,17 +6987,17 @@
<a NAME="Editor.readSettings" ID="Editor.readSettings"></a>
<h4>Editor.readSettings</h4>
<b>readSettings</b>(<i></i>)
-
<p>
Public slot to read the settings into our lexer.
</p>
+
<a NAME="Editor.receive" ID="Editor.receive"></a>
<h4>Editor.receive</h4>
<b>receive</b>(<i>command</i>)
-
<p>
Public slot to handle received editor commands.
</p>
+
<dl>
<dt><i>command</i> (str)</dt>
@@ -7000,35 +7008,34 @@
<a NAME="Editor.recordModificationTime" ID="Editor.recordModificationTime"></a>
<h4>Editor.recordModificationTime</h4>
<b>recordModificationTime</b>(<i></i>)
-
<p>
Public slot to record the modification time of our file.
</p>
+
<a NAME="Editor.redo" ID="Editor.redo"></a>
<h4>Editor.redo</h4>
<b>redo</b>(<i></i>)
-
<p>
Public method to redo the last recorded change.
</p>
+
<a NAME="Editor.refresh" ID="Editor.refresh"></a>
<h4>Editor.refresh</h4>
<b>refresh</b>(<i></i>)
-
<p>
Public slot to refresh the editor contents.
</p>
+
<a NAME="Editor.refreshCoverageAnnotations" ID="Editor.refreshCoverageAnnotations"></a>
<h4>Editor.refreshCoverageAnnotations</h4>
<b>refreshCoverageAnnotations</b>(<i></i>)
-
<p>
Public method to refresh the code coverage annotations.
</p>
+
<a NAME="Editor.registerMouseHoverHelpFunction" ID="Editor.registerMouseHoverHelpFunction"></a>
<h4>Editor.registerMouseHoverHelpFunction</h4>
<b>registerMouseHoverHelpFunction</b>(<i>func</i>)
-
<p>
Public method to register a mouse hover help function.
</p>
@@ -7036,6 +7043,7 @@
Note: Only one plugin should provide this function. Otherwise
the last one wins.
</p>
+
<dl>
<dt><i>func</i> (func)</dt>
@@ -7047,10 +7055,10 @@
<a NAME="Editor.removeCallTipHook" ID="Editor.removeCallTipHook"></a>
<h4>Editor.removeCallTipHook</h4>
<b>removeCallTipHook</b>(<i>key</i>)
-
<p>
Public method to remove a previously registered calltip provider.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -7061,10 +7069,10 @@
<a NAME="Editor.removeClone" ID="Editor.removeClone"></a>
<h4>Editor.removeClone</h4>
<b>removeClone</b>(<i>editor</i>)
-
<p>
Public method to remove a clone from our list.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -7075,11 +7083,11 @@
<a NAME="Editor.removeCompletionListHook" ID="Editor.removeCompletionListHook"></a>
<h4>Editor.removeCompletionListHook</h4>
<b>removeCompletionListHook</b>(<i>key</i>)
-
<p>
Public method to remove a previously registered completion list
provider.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -7090,10 +7098,10 @@
<a NAME="Editor.removeMouseClickHandler" ID="Editor.removeMouseClickHandler"></a>
<h4>Editor.removeMouseClickHandler</h4>
<b>removeMouseClickHandler</b>(<i>modifiers, button</i>)
-
<p>
Public method to un-registered a mouse click handler.
</p>
+
<dl>
<dt><i>modifiers</i> (Qt.KeyboardModifiers)</dt>
@@ -7108,11 +7116,11 @@
<a NAME="Editor.removeMouseClickHandlers" ID="Editor.removeMouseClickHandlers"></a>
<h4>Editor.removeMouseClickHandlers</h4>
<b>removeMouseClickHandlers</b>(<i>name</i>)
-
<p>
Public method to un-registered all mouse click handlers of
a plug-in.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -7123,17 +7131,17 @@
<a NAME="Editor.resetOnlineChangeTraceInfo" ID="Editor.resetOnlineChangeTraceInfo"></a>
<h4>Editor.resetOnlineChangeTraceInfo</h4>
<b>resetOnlineChangeTraceInfo</b>(<i></i>)
-
<p>
Public slot to reset the online change trace info.
</p>
+
<a NAME="Editor.resizeEvent" ID="Editor.resizeEvent"></a>
<h4>Editor.resizeEvent</h4>
<b>resizeEvent</b>(<i>evt</i>)
-
<p>
Protected method handling resize events.
</p>
+
<dl>
<dt><i>evt</i> (QResizeEvent)</dt>
@@ -7144,17 +7152,17 @@
<a NAME="Editor.revertToUnmodified" ID="Editor.revertToUnmodified"></a>
<h4>Editor.revertToUnmodified</h4>
<b>revertToUnmodified</b>(<i></i>)
-
<p>
Public method to revert back to the last saved state.
</p>
+
<a NAME="Editor.saveFile" ID="Editor.saveFile"></a>
<h4>Editor.saveFile</h4>
<b>saveFile</b>(<i>saveas=False, path=None</i>)
-
<p>
Public method to save the text to a file.
</p>
+
<dl>
<dt><i>saveas</i> (bool)</dt>
@@ -7181,10 +7189,10 @@
<a NAME="Editor.saveFileAs" ID="Editor.saveFileAs"></a>
<h4>Editor.saveFileAs</h4>
<b>saveFileAs</b>(<i>path=None</i>)
-
<p>
Public method to save a file with a new name.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -7207,10 +7215,10 @@
<a NAME="Editor.saveFileCopy" ID="Editor.saveFileCopy"></a>
<h4>Editor.saveFileCopy</h4>
<b>saveFileCopy</b>(<i>path=None</i>)
-
<p>
Public method to save a copy of the file.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -7233,31 +7241,31 @@
<a NAME="Editor.searchCurrentWordBackward" ID="Editor.searchCurrentWordBackward"></a>
<h4>Editor.searchCurrentWordBackward</h4>
<b>searchCurrentWordBackward</b>(<i></i>)
-
<p>
Public slot to search the current word backward.
</p>
+
<a NAME="Editor.searchCurrentWordForward" ID="Editor.searchCurrentWordForward"></a>
<h4>Editor.searchCurrentWordForward</h4>
<b>searchCurrentWordForward</b>(<i></i>)
-
<p>
Public slot to search the current word forward.
</p>
+
<a NAME="Editor.selectCurrentWord" ID="Editor.selectCurrentWord"></a>
<h4>Editor.selectCurrentWord</h4>
<b>selectCurrentWord</b>(<i></i>)
-
<p>
Public method to select the current word.
</p>
+
<a NAME="Editor.selectWord" ID="Editor.selectWord"></a>
<h4>Editor.selectWord</h4>
<b>selectWord</b>(<i>line, index</i>)
-
<p>
Public method to select the word at a position.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -7272,18 +7280,18 @@
<a NAME="Editor.sendSharedEdit" ID="Editor.sendSharedEdit"></a>
<h4>Editor.sendSharedEdit</h4>
<b>sendSharedEdit</b>(<i></i>)
-
<p>
Public slot to end a shared edit session for the editor and
send the changes.
</p>
+
<a NAME="Editor.setAutoCompletionEnabled" ID="Editor.setAutoCompletionEnabled"></a>
<h4>Editor.setAutoCompletionEnabled</h4>
<b>setAutoCompletionEnabled</b>(<i>enable</i>)
-
<p>
Public method to enable/disable autocompletion.
</p>
+
<dl>
<dt><i>enable</i> (bool)</dt>
@@ -7294,17 +7302,17 @@
<a NAME="Editor.setAutoSpellChecking" ID="Editor.setAutoSpellChecking"></a>
<h4>Editor.setAutoSpellChecking</h4>
<b>setAutoSpellChecking</b>(<i></i>)
-
<p>
Public method to set the automatic spell checking.
</p>
+
<a NAME="Editor.setFileName" ID="Editor.setFileName"></a>
<h4>Editor.setFileName</h4>
<b>setFileName</b>(<i>name</i>)
-
<p>
Public method to set the file name of the current file.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -7315,10 +7323,10 @@
<a NAME="Editor.setHighlight" ID="Editor.setHighlight"></a>
<h4>Editor.setHighlight</h4>
<b>setHighlight</b>(<i>startLine, startIndex, endLine, endIndex</i>)
-
<p>
Public method to set a text highlight.
</p>
+
<dl>
<dt><i>startLine</i> (int)</dt>
@@ -7341,10 +7349,10 @@
<a NAME="Editor.setLanguage" ID="Editor.setLanguage"></a>
<h4>Editor.setLanguage</h4>
<b>setLanguage</b>(<i>filename, initTextDisplay=True, propagate=True, pyname=""</i>)
-
<p>
Public method to set a lexer language.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -7369,10 +7377,10 @@
<a NAME="Editor.setMonospaced" ID="Editor.setMonospaced"></a>
<h4>Editor.setMonospaced</h4>
<b>setMonospaced</b>(<i>on</i>)
-
<p>
Public method to set/reset a monospaced font.
</p>
+
<dl>
<dt><i>on</i> (bool)</dt>
@@ -7383,10 +7391,10 @@
<a NAME="Editor.setMouseClickHandler" ID="Editor.setMouseClickHandler"></a>
<h4>Editor.setMouseClickHandler</h4>
<b>setMouseClickHandler</b>(<i>name, modifiers, button, function</i>)
-
<p>
Public method to set a mouse click handler.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -7421,10 +7429,10 @@
<a NAME="Editor.setNoName" ID="Editor.setNoName"></a>
<h4>Editor.setNoName</h4>
<b>setNoName</b>(<i>noName</i>)
-
<p>
Public method to set the display string for an unnamed editor.
</p>
+
<dl>
<dt><i>noName</i> (str)</dt>
@@ -7435,10 +7443,10 @@
<a NAME="Editor.setSearchIndicator" ID="Editor.setSearchIndicator"></a>
<h4>Editor.setSearchIndicator</h4>
<b>setSearchIndicator</b>(<i>startPos, indicLength</i>)
-
<p>
Public method to set a search indicator for the given range.
</p>
+
<dl>
<dt><i>startPos</i> (int)</dt>
@@ -7453,18 +7461,18 @@
<a NAME="Editor.setSpellingForProject" ID="Editor.setSpellingForProject"></a>
<h4>Editor.setSpellingForProject</h4>
<b>setSpellingForProject</b>(<i></i>)
-
<p>
Public method to set the spell checking options for files belonging
to the current project.
</p>
+
<a NAME="Editor.shareConnected" ID="Editor.shareConnected"></a>
<h4>Editor.shareConnected</h4>
<b>shareConnected</b>(<i>connected</i>)
-
<p>
Public method to handle a change of the connected state.
</p>
+
<dl>
<dt><i>connected</i> (bool)</dt>
@@ -7475,10 +7483,10 @@
<a NAME="Editor.shareEditor" ID="Editor.shareEditor"></a>
<h4>Editor.shareEditor</h4>
<b>shareEditor</b>(<i>share</i>)
-
<p>
Public method to set the shared status of the editor.
</p>
+
<dl>
<dt><i>share</i> (bool)</dt>
@@ -7489,18 +7497,18 @@
<a NAME="Editor.shortenEmptyLines" ID="Editor.shortenEmptyLines"></a>
<h4>Editor.shortenEmptyLines</h4>
<b>shortenEmptyLines</b>(<i></i>)
-
<p>
Public slot to compress lines consisting solely of whitespace
characters.
</p>
+
<a NAME="Editor.showMouseHoverHelpData" ID="Editor.showMouseHoverHelpData"></a>
<h4>Editor.showMouseHoverHelpData</h4>
<b>showMouseHoverHelpData</b>(<i>line, index, data</i>)
-
<p>
Public method to show the mouse hover help data.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -7519,45 +7527,45 @@
<a NAME="Editor.smartIndentLineOrSelection" ID="Editor.smartIndentLineOrSelection"></a>
<h4>Editor.smartIndentLineOrSelection</h4>
<b>smartIndentLineOrSelection</b>(<i></i>)
-
<p>
Public slot to indent current line smartly.
</p>
+
<a NAME="Editor.sortLines" ID="Editor.sortLines"></a>
<h4>Editor.sortLines</h4>
<b>sortLines</b>(<i></i>)
-
<p>
Public slot to sort the lines spanned by a rectangular selection.
</p>
+
<a NAME="Editor.startSharedEdit" ID="Editor.startSharedEdit"></a>
<h4>Editor.startSharedEdit</h4>
<b>startSharedEdit</b>(<i></i>)
-
<p>
Public slot to start a shared edit session for the editor.
</p>
+
<a NAME="Editor.streamCommentLineOrSelection" ID="Editor.streamCommentLineOrSelection"></a>
<h4>Editor.streamCommentLineOrSelection</h4>
<b>streamCommentLineOrSelection</b>(<i></i>)
-
<p>
Public slot to stream comment the current line or current selection.
</p>
+
<a NAME="Editor.streamUncommentLineOrSelection" ID="Editor.streamUncommentLineOrSelection"></a>
<h4>Editor.streamUncommentLineOrSelection</h4>
<b>streamUncommentLineOrSelection</b>(<i></i>)
-
<p>
Public slot to stream uncomment the current line or current selection.
</p>
+
<a NAME="Editor.toggleBookmark" ID="Editor.toggleBookmark"></a>
<h4>Editor.toggleBookmark</h4>
<b>toggleBookmark</b>(<i>line</i>)
-
<p>
Public method to toggle a bookmark.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -7568,7 +7576,6 @@
<a NAME="Editor.toggleComment" ID="Editor.toggleComment"></a>
<h4>Editor.toggleComment</h4>
<b>toggleComment</b>(<i></i>)
-
<p>
Public slot to toggle a block or stream comment.
</p>
@@ -7577,20 +7584,21 @@
comment. Otherwise a stream comment is used if that is supported. If
none of these are supported, the request is ignored silently.
</p>
+
<a NAME="Editor.toggleCurrentFold" ID="Editor.toggleCurrentFold"></a>
<h4>Editor.toggleCurrentFold</h4>
<b>toggleCurrentFold</b>(<i></i>)
-
<p>
Public slot to toggle the fold containing the current line.
</p>
+
<a NAME="Editor.toggleSyntaxError" ID="Editor.toggleSyntaxError"></a>
<h4>Editor.toggleSyntaxError</h4>
<b>toggleSyntaxError</b>(<i>line, index, setError, msg="", show=False</i>)
-
<p>
Public method to toggle a syntax error indicator.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -7618,13 +7626,13 @@
<a NAME="Editor.toggleWarning" ID="Editor.toggleWarning"></a>
<h4>Editor.toggleWarning</h4>
<b>toggleWarning</b>(<i>line, col, setWarning, msg="", warningType=EditorWarningKind.Code, </i>)
-
<p>
Public method to toggle a warning indicator.
</p>
<p>
Note: This method is used to set pyflakes and code style warnings.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -7652,7 +7660,6 @@
<a NAME="Editor.uncommentLineOrSelection" ID="Editor.uncommentLineOrSelection"></a>
<h4>Editor.uncommentLineOrSelection</h4>
<b>uncommentLineOrSelection</b>(<i></i>)
-
<p>
Public slot to uncomment the current line or current selection.
</p>
@@ -7661,27 +7668,28 @@
Otherwise a stream comment is used if that is supported. If none of
these are supported, the request is ignored silently.
</p>
+
<a NAME="Editor.undo" ID="Editor.undo"></a>
<h4>Editor.undo</h4>
<b>undo</b>(<i></i>)
-
<p>
Public method to undo the last recorded change.
</p>
+
<a NAME="Editor.unindentLineOrSelection" ID="Editor.unindentLineOrSelection"></a>
<h4>Editor.unindentLineOrSelection</h4>
<b>unindentLineOrSelection</b>(<i></i>)
-
<p>
Public slot to unindent the current line or current selection.
</p>
+
<a NAME="Editor.unregisterMouseHoverHelpFunction" ID="Editor.unregisterMouseHoverHelpFunction"></a>
<h4>Editor.unregisterMouseHoverHelpFunction</h4>
<b>unregisterMouseHoverHelpFunction</b>(<i>func</i>)
-
<p>
Public method to unregister a mouse hover help function.
</p>
+
<dl>
<dt><i>func</i> (func)</dt>
@@ -7693,17 +7701,17 @@
<a NAME="Editor.updateMarkerMap" ID="Editor.updateMarkerMap"></a>
<h4>Editor.updateMarkerMap</h4>
<b>updateMarkerMap</b>(<i></i>)
-
<p>
Public method to initiate an update of the marker map.
</p>
+
<a NAME="Editor.viewportEvent" ID="Editor.viewportEvent"></a>
<h4>Editor.viewportEvent</h4>
<b>viewportEvent</b>(<i>evt</i>)
-
<p>
Protected method handling event of the viewport.
</p>
+
<dl>
<dt><i>evt</i> (QEvent)</dt>
@@ -7726,10 +7734,10 @@
<a NAME="Editor.wheelEvent" ID="Editor.wheelEvent"></a>
<h4>Editor.wheelEvent</h4>
<b>wheelEvent</b>(<i>evt</i>)
-
<p>
Protected method to handle wheel events.
</p>
+
<dl>
<dt><i>evt</i> (QWheelEvent)</dt>
@@ -7740,10 +7748,10 @@
<a NAME="Editor.writeFile" ID="Editor.writeFile"></a>
<h4>Editor.writeFile</h4>
<b>writeFile</b>(<i>fn, backup=True</i>)
-
<p>
Public method to write the text to a file.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -7772,65 +7780,82 @@
<hr />
<a NAME="EditorIconId" ID="EditorIconId"></a>
<h2>EditorIconId</h2>
-
<p>
Class defining the completion icon IDs.
</p>
+
<h3>Derived from</h3>
enum.IntEnum
<h3>Class Attributes</h3>
-
<table>
-<tr><td>Attribute</td></tr><tr><td>AttributePrivate</td></tr><tr><td>AttributeProtected</td></tr><tr><td>Class</td></tr><tr><td>ClassPrivate</td></tr><tr><td>ClassProtected</td></tr><tr><td>Enum</td></tr><tr><td>FromDocument</td></tr><tr><td>Keywords</td></tr><tr><td>Method</td></tr><tr><td>MethodPrivate</td></tr><tr><td>MethodProtected</td></tr><tr><td>Module</td></tr><tr><td>TemplateImage</td></tr>
+<tr><td>Attribute</td></tr>
+<tr><td>AttributePrivate</td></tr>
+<tr><td>AttributeProtected</td></tr>
+<tr><td>Class</td></tr>
+<tr><td>ClassPrivate</td></tr>
+<tr><td>ClassProtected</td></tr>
+<tr><td>Enum</td></tr>
+<tr><td>FromDocument</td></tr>
+<tr><td>Keywords</td></tr>
+<tr><td>Method</td></tr>
+<tr><td>MethodPrivate</td></tr>
+<tr><td>MethodProtected</td></tr>
+<tr><td>Module</td></tr>
+<tr><td>TemplateImage</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="EditorWarningKind" ID="EditorWarningKind"></a>
<h2>EditorWarningKind</h2>
-
<p>
Class defining the kind of warnings supported by the Editor class.
</p>
+
<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
-
<table>
-<tr><td>Code</td></tr><tr><td>Error</td></tr><tr><td>Info</td></tr><tr><td>Python</td></tr><tr><td>Style</td></tr>
+<tr><td>Code</td></tr>
+<tr><td>Error</td></tr>
+<tr><td>Info</td></tr>
+<tr><td>Python</td></tr>
+<tr><td>Style</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
