src/eric7/Documentation/Source/eric7.QScintilla.Editor.html

<!DOCTYPE html>
<html><head>
<title>eric7.QScintilla.Editor</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<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>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#Editor">Editor</a></td>
<td>Class implementing the editor component of the eric IDE.</td>
</tr>
<tr>
<td><a href="#EditorIconId">EditorIconId</a></td>
<td>Class defining the completion icon IDs.</td>
</tr>
<tr>
<td><a href="#EditorWarningKind">EditorWarningKind</a></td>
<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>

<dt>autoCompletionAPIsAvailable(bool)</dt>
<dd>
emitted after the autocompletion
        function has been configured
</dd>
<dt>bookmarkToggled(QsciScintillaCompat)</dt>
<dd>
emitted when a bookmark is
        toggled
</dd>
<dt>breakpointToggled(QsciScintillaCompat)</dt>
<dd>
emitted when a breakpoint
        is toggled
</dd>
<dt>captionChanged(str, QsciScintillaCompat)</dt>
<dd>
emitted when the caption
        is updated. Typically due to a readOnly attribute change.
</dd>
<dt>changeMarkersUpdated(QsciScintillaCompat)</dt>
<dd>
emitted when the change
        markers were updated
</dd>
<dt>coverageMarkersShown(bool)</dt>
<dd>
emitted after the coverage markers have
        been shown or cleared
</dd>
<dt>cursorChanged(str, int, int)</dt>
<dd>
emitted when the cursor position
        was changed
</dd>
<dt>cursorLineChanged(int)</dt>
<dd>
emitted when the cursor line was changed
</dd>
<dt>editorAboutToBeSaved(str)</dt>
<dd>
emitted before the editor is saved
</dd>
<dt>editorRenamed(str)</dt>
<dd>
emitted after the editor got a new name
        (i.e. after a 'Save As')
</dd>
<dt>editorSaved(str)</dt>
<dd>
emitted after the editor has been saved
</dd>
<dt>encodingChanged(str)</dt>
<dd>
emitted when the editors encoding was set. The
            encoding name is passed as a parameter.
</dd>
<dt>eolChanged(str)</dt>
<dd>
emitted when the editors eol type was set. The eol
        string is passed as a parameter.
</dd>
<dt>languageChanged(str)</dt>
<dd>
emitted when the editors language was set. The
        language is passed as a parameter.
</dd>
<dt>lastEditPositionAvailable()</dt>
<dd>
emitted when a last edit position is
        available
</dd>
<dt>modificationStatusChanged(bool, QsciScintillaCompat)</dt>
<dd>
emitted when
        the modification status has changed
</dd>
<dt>mouseDoubleClick(position, buttons)</dt>
<dd>
emitted to signal a mouse
        double click somewhere in the editor area
</dd>
<dt>redoAvailable(bool)</dt>
<dd>
emitted to signal the redo availability
</dd>
<dt>refreshed()</dt>
<dd>
emitted to signal a refresh of the editor contents
</dd>
<dt>settingsRead()</dt>
<dd>
emitted to signal, that the settings have been read
        and set
</dd>
<dt>showMenu(str, QMenu, QsciScintillaCompat)</dt>
<dd>
emitted when a menu is
        about to be shown. The name of the menu, a reference to the menu and
        a reference to the editor are given.
</dd>
<dt>spellLanguageChanged(str)</dt>
<dd>
emitted when the editor spell check
            language was set. The language is passed as a parameter.
</dd>
<dt>syntaxerrorToggled(QsciScintillaCompat)</dt>
<dd>
emitted when a syntax error
        was discovered
</dd>
<dt>taskMarkersUpdated(QsciScintillaCompat)</dt>
<dd>
emitted when the task
        markers were updated
</dd>
<dt>undoAvailable(bool)</dt>
<dd>
emitted to signal the undo availability
</dd>
</dl>
<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>
</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>
</tr>
<tr>
<td><a href="#Editor.__aboutToShowContextMenu">__aboutToShowContextMenu</a></td>
<td>Private slot handling the aboutToShow signal of the context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__addBreakPoint">__addBreakPoint</a></td>
<td>Private method to add a new breakpoint.</td>
</tr>
<tr>
<td><a href="#Editor.__addBreakPoints">__addBreakPoints</a></td>
<td>Private slot to add breakpoints.</td>
</tr>
<tr>
<td><a href="#Editor.__addFileAliasResource">__addFileAliasResource</a></td>
<td>Private method to handle the Add aliased file context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__addFileResource">__addFileResource</a></td>
<td>Private method to handle the Add file context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__addFileResources">__addFileResources</a></td>
<td>Private method to handle the Add files context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__addLocalizedResource">__addLocalizedResource</a></td>
<td>Private method to handle the Add localized resource context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__addResourceFrame">__addResourceFrame</a></td>
<td>Private method to handle the Add resource frame context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__addToSpellingDictionary">__addToSpellingDictionary</a></td>
<td>Private slot to add the word below the spelling context menu to the dictionary.</td>
</tr>
<tr>
<td><a href="#Editor.__adjustedCallTipPosition">__adjustedCallTipPosition</a></td>
<td>Private method to calculate an adjusted position for showing calltips.</td>
</tr>
<tr>
<td><a href="#Editor.__applyTemplate">__applyTemplate</a></td>
<td>Private method to apply a template by name.</td>
</tr>
<tr>
<td><a href="#Editor.__autoComplete">__autoComplete</a></td>
<td>Private method to start auto-completion via plug-ins.</td>
</tr>
<tr>
<td><a href="#Editor.__autocompletionCancelled">__autocompletionCancelled</a></td>
<td>Private slot to handle the cancellation of an auto-completion list.</td>
</tr>
<tr>
<td><a href="#Editor.__autosave">__autosave</a></td>
<td>Private slot to save the contents of the editor automatically.</td>
</tr>
<tr>
<td><a href="#Editor.__autosaveEnable">__autosaveEnable</a></td>
<td>Private slot handling the autosave enable context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__bindCompleter">__bindCompleter</a></td>
<td>Private method to set the correct typing completer depending on language.</td>
</tr>
<tr>
<td><a href="#Editor.__bindLexer">__bindLexer</a></td>
<td>Private method to set the correct lexer depending on language.</td>
</tr>
<tr>
<td><a href="#Editor.__bindName">__bindName</a></td>
<td>Private method to generate a dummy filename for binding a lexer.</td>
</tr>
<tr>
<td><a href="#Editor.__boxCommentLine">__boxCommentLine</a></td>
<td>Private slot to box comment the current line.</td>
</tr>
<tr>
<td><a href="#Editor.__boxCommentSelection">__boxCommentSelection</a></td>
<td>Private slot to box comment the current selection.</td>
</tr>
<tr>
<td><a href="#Editor.__breakPointDataAboutToBeChanged">__breakPointDataAboutToBeChanged</a></td>
<td>Private slot to handle the dataAboutToBeChanged signal of the breakpoint model.</td>
</tr>
<tr>
<td><a href="#Editor.__calculateChanges">__calculateChanges</a></td>
<td>Private method to determine change commands to convert old text into new text.</td>
</tr>
<tr>
<td><a href="#Editor.__callTip">__callTip</a></td>
<td>Private method to show call tips provided by a plugin.</td>
</tr>
<tr>
<td><a href="#Editor.__cancelMouseHoverHelp">__cancelMouseHoverHelp</a></td>
<td>Private slot cancelling the display of mouse hover help.</td>
</tr>
<tr>
<td><a href="#Editor.__changeBreakPoints">__changeBreakPoints</a></td>
<td>Private slot to set changed breakpoints.</td>
</tr>
<tr>
<td><a href="#Editor.__charAdded">__charAdded</a></td>
<td>Private slot called to handle the user entering a character.</td>
</tr>
<tr>
<td><a href="#Editor.__checkEncoding">__checkEncoding</a></td>
<td>Private method to check the selected encoding of the encodings submenu.</td>
</tr>
<tr>
<td><a href="#Editor.__checkEol">__checkEol</a></td>
<td>Private method to check the selected eol type of the eol submenu.</td>
</tr>
<tr>
<td><a href="#Editor.__checkLanguage">__checkLanguage</a></td>
<td>Private method to check the selected language of the language submenu.</td>
</tr>
<tr>
<td><a href="#Editor.__checkSpellLanguage">__checkSpellLanguage</a></td>
<td>Private slot to check the selected spell check language action.</td>
</tr>
<tr>
<td><a href="#Editor.__checkSpellingSelection">__checkSpellingSelection</a></td>
<td>Private slot to spell check the current selection.</td>
</tr>
<tr>
<td><a href="#Editor.__checkSpellingWord">__checkSpellingWord</a></td>
<td>Private slot to check the word below the spelling context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__clearBreakpoints">__clearBreakpoints</a></td>
<td>Private method to clear all breakpoints.</td>
</tr>
<tr>
<td><a href="#Editor.__clearCompletionsCache">__clearCompletionsCache</a></td>
<td>Private method to clear the auto-completions cache.</td>
</tr>
<tr>
<td><a href="#Editor.__clearTypedWarning">__clearTypedWarning</a></td>
<td>Private method to clear warnings of a specific kind.</td>
</tr>
<tr>
<td><a href="#Editor.__codeCoverageHideAnnotations">__codeCoverageHideAnnotations</a></td>
<td>Private method to handle the hide code coverage annotations context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__commentLine">__commentLine</a></td>
<td>Private slot to comment the current line.</td>
</tr>
<tr>
<td><a href="#Editor.__commentSelection">__commentSelection</a></td>
<td>Private slot to comment the current selection.</td>
</tr>
<tr>
<td><a href="#Editor.__completionListSelected">__completionListSelected</a></td>
<td>Private slot to handle the selection from the completion list.</td>
</tr>
<tr>
<td><a href="#Editor.__contextClose">__contextClose</a></td>
<td>Private slot handling the close context menu entry.</td>
</tr>
<tr>
<td><a href="#Editor.__contextMenuCollapseFoldWithChildren">__contextMenuCollapseFoldWithChildren</a></td>
<td>Private slot to handle the context menu collapse with children action.</td>
</tr>
<tr>
<td><a href="#Editor.__contextMenuExpandFoldWithChildren">__contextMenuExpandFoldWithChildren</a></td>
<td>Private slot to handle the context menu expand with children action.</td>
</tr>
<tr>
<td><a href="#Editor.__contextMenuSpellingTriggered">__contextMenuSpellingTriggered</a></td>
<td>Private slot to handle the selection of a suggestion of the spelling context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__contextSave">__contextSave</a></td>
<td>Private slot handling the save context menu entry.</td>
</tr>
<tr>
<td><a href="#Editor.__contextSaveAs">__contextSaveAs</a></td>
<td>Private slot handling the save as context menu entry.</td>
</tr>
<tr>
<td><a href="#Editor.__contextSaveCopy">__contextSaveCopy</a></td>
<td>Private slot handling the save copy context menu entry.</td>
</tr>
<tr>
<td><a href="#Editor.__convertTabs">__convertTabs</a></td>
<td>Private slot to automatically convert tabulators to spaces upon loading.</td>
</tr>
<tr>
<td><a href="#Editor.__createChangeMarkerPixmap">__createChangeMarkerPixmap</a></td>
<td>Private method to create a pixmap for the change markers.</td>
</tr>
<tr>
<td><a href="#Editor.__cursorPositionChanged">__cursorPositionChanged</a></td>
<td>Private slot to handle the cursorPositionChanged signal.</td>
</tr>
<tr>
<td><a href="#Editor.__delayedDocstringMenuPopup">__delayedDocstringMenuPopup</a></td>
<td>Private method to test, if the user might want to insert a docstring.</td>
</tr>
<tr>
<td><a href="#Editor.__deleteAllChangeMarkers">__deleteAllChangeMarkers</a></td>
<td>Private slot to delete all change markers.</td>
</tr>
<tr>
<td><a href="#Editor.__deleteBreakPoints">__deleteBreakPoints</a></td>
<td>Private slot to delete breakpoints.</td>
</tr>
<tr>
<td><a href="#Editor.__deselectAll">__deselectAll</a></td>
<td>Private slot handling the deselect all context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__dispatchCommand">__dispatchCommand</a></td>
<td>Private method to dispatch received commands.</td>
</tr>
<tr>
<td><a href="#Editor.__encodingChanged">__encodingChanged</a></td>
<td>Private slot to handle a change of the encoding.</td>
</tr>
<tr>
<td><a href="#Editor.__encodingsMenuTriggered">__encodingsMenuTriggered</a></td>
<td>Private method to handle the selection of an encoding.</td>
</tr>
<tr>
<td><a href="#Editor.__eolChanged">__eolChanged</a></td>
<td>Private slot to handle a change of the eol mode.</td>
</tr>
<tr>
<td><a href="#Editor.__eolMenuTriggered">__eolMenuTriggered</a></td>
<td>Private method to handle the selection of an eol type.</td>
</tr>
<tr>
<td><a href="#Editor.__executeSelection">__executeSelection</a></td>
<td>Private slot to execute the selected text in the shell window.</td>
</tr>
<tr>
<td><a href="#Editor.__getAcText">__getAcText</a></td>
<td>Private method to get the text from cursor position for autocompleting.</td>
</tr>
<tr>
<td><a href="#Editor.__getCharacter">__getCharacter</a></td>
<td>Private method to get the character to the left of the current position in the current line.</td>
</tr>
<tr>
<td><a href="#Editor.__getCodeCoverageFile">__getCodeCoverageFile</a></td>
<td>Private method to get the file name of the file containing coverage info.</td>
</tr>
<tr>
<td><a href="#Editor.__getEditorConfig">__getEditorConfig</a></td>
<td>Private method to get the requested option via EditorConfig.</td>
</tr>
<tr>
<td><a href="#Editor.__getMacroName">__getMacroName</a></td>
<td>Private method to select a macro name from the list of macros.</td>
</tr>
<tr>
<td><a href="#Editor.__getOverrideValue">__getOverrideValue</a></td>
<td>Private method to get an override value for the current file type.</td>
</tr>
<tr>
<td><a href="#Editor.__getPyVersion">__getPyVersion</a></td>
<td>Private method to return the Python main version or 0 if it's not a Python file at all.</td>
</tr>
<tr>
<td><a href="#Editor.__getSaveFileName">__getSaveFileName</a></td>
<td>Private method to get the name of the file to be saved.</td>
</tr>
<tr>
<td><a href="#Editor.__ignoreSpellingAlways">__ignoreSpellingAlways</a></td>
<td>Private to always ignore the word below the spelling context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__indentLine">__indentLine</a></td>
<td>Private method to indent or unindent the current line.</td>
</tr>
<tr>
<td><a href="#Editor.__indentSelection">__indentSelection</a></td>
<td>Private method to indent or unindent the current selection.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenu">__initContextMenu</a></td>
<td>Private method used to setup the context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuAutocompletion">__initContextMenuAutocompletion</a></td>
<td>Private method used to setup the Checks context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuChecks">__initContextMenuChecks</a></td>
<td>Private method used to setup the Checks context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuEncodings">__initContextMenuEncodings</a></td>
<td>Private method used to setup the Encodings context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuEol">__initContextMenuEol</a></td>
<td>Private method to setup the eol context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuFormatting">__initContextMenuFormatting</a></td>
<td>Private method used to setup the Code Formatting context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuGraphics">__initContextMenuGraphics</a></td>
<td>Private method used to setup the diagrams context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuLanguages">__initContextMenuLanguages</a></td>
<td>Private method used to setup the Languages context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuMargins">__initContextMenuMargins</a></td>
<td>Private method used to setup the context menu for the margins.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuReopenWithEncoding">__initContextMenuReopenWithEncoding</a></td>
<td>Private method used to setup the Reopen With Encoding context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuResources">__initContextMenuResources</a></td>
<td>Private method used to setup the Resources context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuShow">__initContextMenuShow</a></td>
<td>Private method used to setup the Show context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuSpellCheck">__initContextMenuSpellCheck</a></td>
<td>Private method used to setup the spell checking context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuSpellLanguages">__initContextMenuSpellLanguages</a></td>
<td>Private method to setup the spell checking languages context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initContextMenuTools">__initContextMenuTools</a></td>
<td>Private method used to setup the Tools context sub menu.</td>
</tr>
<tr>
<td><a href="#Editor.__initOnlineChangeTrace">__initOnlineChangeTrace</a></td>
<td>Private slot to initialize the online change trace.</td>
</tr>
<tr>
<td><a href="#Editor.__initOnlineSyntaxCheck">__initOnlineSyntaxCheck</a></td>
<td>Private slot to initialize the online syntax check.</td>
</tr>
<tr>
<td><a href="#Editor.__insertDocstring">__insertDocstring</a></td>
<td>Private slot to generate and insert a docstring for the function under the cursor.</td>
</tr>
<tr>
<td><a href="#Editor.__isCommentedLine">__isCommentedLine</a></td>
<td>Private method to check, if the given line is a comment line as produced by the configured comment rules.</td>
</tr>
<tr>
<td><a href="#Editor.__isStartChar">__isStartChar</a></td>
<td>Private method to check, if a character is an autocompletion start character.</td>
</tr>
<tr>
<td><a href="#Editor.__isStreamCommentedLine">__isStreamCommentedLine</a></td>
<td>Private method to check, if the line is commented by a stream comment.</td>
</tr>
<tr>
<td><a href="#Editor.__languageChanged">__languageChanged</a></td>
<td>Private method handling a change of a connected editor's language.</td>
</tr>
<tr>
<td><a href="#Editor.__languageMenuTriggered">__languageMenuTriggered</a></td>
<td>Private method to handle the selection of a lexer language.</td>
</tr>
<tr>
<td><a href="#Editor.__lmBbookmarks">__lmBbookmarks</a></td>
<td>Private method to handle the 'LMB toggles bookmark' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__lmBbreakpoints">__lmBbreakpoints</a></td>
<td>Private method to handle the 'LMB toggles breakpoint' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__loadDiagram">__loadDiagram</a></td>
<td>Private slot to load a diagram from file.</td>
</tr>
<tr>
<td><a href="#Editor.__loadEditorConfig">__loadEditorConfig</a></td>
<td>Private method to load the EditorConfig properties.</td>
</tr>
<tr>
<td><a href="#Editor.__loadEditorConfigObject">__loadEditorConfigObject</a></td>
<td>Private method to load the EditorConfig properties for the given file name.</td>
</tr>
<tr>
<td><a href="#Editor.__marginClicked">__marginClicked</a></td>
<td>Private slot to handle the marginClicked signal.</td>
</tr>
<tr>
<td><a href="#Editor.__marginHoverEnd">__marginHoverEnd</a></td>
<td>Private slot cancelling the display of syntax error or a warning marker text.</td>
</tr>
<tr>
<td><a href="#Editor.__marginHoverStart">__marginHoverStart</a></td>
<td>Private slot showing the text of a syntax error or a warning marker.</td>
</tr>
<tr>
<td><a href="#Editor.__marginNumber">__marginNumber</a></td>
<td>Private method to calculate the margin number based on a x position.</td>
</tr>
<tr>
<td><a href="#Editor.__markOccurrences">__markOccurrences</a></td>
<td>Private method to mark all occurrences of the current word.</td>
</tr>
<tr>
<td><a href="#Editor.__menuClearBreakpoints">__menuClearBreakpoints</a></td>
<td>Private slot to handle the 'Clear all breakpoints' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__menuToggleBreakpointEnabled">__menuToggleBreakpointEnabled</a></td>
<td>Private slot to handle the 'Enable/Disable breakpoint' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__menuToggleTemporaryBreakpoint">__menuToggleTemporaryBreakpoint</a></td>
<td>Private slot to handle the 'Toggle temporary breakpoint' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__modificationChanged">__modificationChanged</a></td>
<td>Private slot to handle the modificationChanged signal.</td>
</tr>
<tr>
<td><a href="#Editor.__modificationReadOnly">__modificationReadOnly</a></td>
<td>Private slot to handle the modificationAttempted signal.</td>
</tr>
<tr>
<td><a href="#Editor.__modified">__modified</a></td>
<td>Private method to handle changes of the number of lines.</td>
</tr>
<tr>
<td><a href="#Editor.__newView">__newView</a></td>
<td>Private slot to create a new view to an open document.</td>
</tr>
<tr>
<td><a href="#Editor.__newViewNewSplit">__newViewNewSplit</a></td>
<td>Private slot to create a new view to an open document.</td>
</tr>
<tr>
<td><a href="#Editor.__normalizedEncoding">__normalizedEncoding</a></td>
<td>Private method to calculate the normalized encoding string.</td>
</tr>
<tr>
<td><a href="#Editor.__onlineChangeTraceTimerTimeout">__onlineChangeTraceTimerTimeout</a></td>
<td>Private slot to mark added and changed lines.</td>
</tr>
<tr>
<td><a href="#Editor.__performFormatWithBlack">__performFormatWithBlack</a></td>
<td>Private method to format the source code using the 'Black' tool.</td>
</tr>
<tr>
<td><a href="#Editor.__performImportSortingWithIsort">__performImportSortingWithIsort</a></td>
<td>Private method to sort the import statements using the 'isort' tool.</td>
</tr>
<tr>
<td><a href="#Editor.__popupDocstringMenu">__popupDocstringMenu</a></td>
<td>Private method to pop up a menu asking the user, if a docstring should be inserted.</td>
</tr>
<tr>
<td><a href="#Editor.__printPreview">__printPreview</a></td>
<td>Private slot to generate a print preview.</td>
</tr>
<tr>
<td><a href="#Editor.__processEndEditCommand">__processEndEditCommand</a></td>
<td>Private slot to process a remote EndEdit command.</td>
</tr>
<tr>
<td><a href="#Editor.__processFlags">__processFlags</a></td>
<td>Private method to extract flags and process them.</td>
</tr>
<tr>
<td><a href="#Editor.__processRequestSyncCommand">__processRequestSyncCommand</a></td>
<td>Private slot to process a remote RequestSync command.</td>
</tr>
<tr>
<td><a href="#Editor.__processStartEditCommand">__processStartEditCommand</a></td>
<td>Private slot to process a remote StartEdit command.</td>
</tr>
<tr>
<td><a href="#Editor.__processSyncCommand">__processSyncCommand</a></td>
<td>Private slot to process a remote Sync command.</td>
</tr>
<tr>
<td><a href="#Editor.__processSyntaxCheckError">__processSyntaxCheckError</a></td>
<td>Private slot to report an error message of a syntax check.</td>
</tr>
<tr>
<td><a href="#Editor.__processSyntaxCheckResult">__processSyntaxCheckResult</a></td>
<td>Private slot to report the resulting messages of a syntax check.</td>
</tr>
<tr>
<td><a href="#Editor.__projectPropertiesChanged">__projectPropertiesChanged</a></td>
<td>Private slot to handle changes of the project properties.</td>
</tr>
<tr>
<td><a href="#Editor.__refreshAnnotations">__refreshAnnotations</a></td>
<td>Private method to refresh the annotations.</td>
</tr>
<tr>
<td><a href="#Editor.__registerImages">__registerImages</a></td>
<td>Private method to register images for autocompletion lists.</td>
</tr>
<tr>
<td><a href="#Editor.__reinitOnlineChangeTrace">__reinitOnlineChangeTrace</a></td>
<td>Private slot to re-initialize the online change trace.</td>
</tr>
<tr>
<td><a href="#Editor.__removeFromSpellingDictionary">__removeFromSpellingDictionary</a></td>
<td>Private slot to remove the word below the context menu to the dictionary.</td>
</tr>
<tr>
<td><a href="#Editor.__removeTrailingWhitespace">__removeTrailingWhitespace</a></td>
<td>Private method to remove trailing whitespace.</td>
</tr>
<tr>
<td><a href="#Editor.__reopenWithEncodingMenuTriggered">__reopenWithEncodingMenuTriggered</a></td>
<td>Private method to handle the rereading of the file with a selected encoding.</td>
</tr>
<tr>
<td><a href="#Editor.__replaceLeadingUnderscores">__replaceLeadingUnderscores</a></td>
<td>Private method to replace the first two underlines for invers sorting.</td>
</tr>
<tr>
<td><a href="#Editor.__resetLanguage">__resetLanguage</a></td>
<td>Private method used to reset the language selection.</td>
</tr>
<tr>
<td><a href="#Editor.__resetOnlineChangeTraceTimer">__resetOnlineChangeTraceTimer</a></td>
<td>Private method to reset the online syntax check timer.</td>
</tr>
<tr>
<td><a href="#Editor.__resetOnlineSyntaxCheckTimer">__resetOnlineSyntaxCheckTimer</a></td>
<td>Private method to reset the online syntax check timer.</td>
</tr>
<tr>
<td><a href="#Editor.__resizeLinenoMargin">__resizeLinenoMargin</a></td>
<td>Private slot to resize the line numbers margin.</td>
</tr>
<tr>
<td><a href="#Editor.__restoreBreakpoints">__restoreBreakpoints</a></td>
<td>Private method to restore the breakpoints.</td>
</tr>
<tr>
<td><a href="#Editor.__saveDeviceFile">__saveDeviceFile</a></td>
<td>Private method to save the text to a file on the connected device.</td>
</tr>
<tr>
<td><a href="#Editor.__saveLastEditPosition">__saveLastEditPosition</a></td>
<td>Private slot to record the last edit position.</td>
</tr>
<tr>
<td><a href="#Editor.__searchCurrentWord">__searchCurrentWord</a></td>
<td>Private slot to search the next occurrence of the current word.</td>
</tr>
<tr>
<td><a href="#Editor.__selectAll">__selectAll</a></td>
<td>Private slot handling the select all context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__selectPygmentsLexer">__selectPygmentsLexer</a></td>
<td>Private method to select a specific pygments lexer.</td>
</tr>
<tr>
<td><a href="#Editor.__send">__send</a></td>
<td>Private method to send an editor command to remote editors.</td>
</tr>
<tr>
<td><a href="#Editor.__setAnnotation">__setAnnotation</a></td>
<td>Private method to set the annotations for the given line.</td>
</tr>
<tr>
<td><a href="#Editor.__setAnnotationStyles">__setAnnotationStyles</a></td>
<td>Private slot to define the style used by inline annotations.</td>
</tr>
<tr>
<td><a href="#Editor.__setAutoCompletion">__setAutoCompletion</a></td>
<td>Private method to configure the autocompletion function.</td>
</tr>
<tr>
<td><a href="#Editor.__setCallTips">__setCallTips</a></td>
<td>Private method to configure the calltips function.</td>
</tr>
<tr>
<td><a href="#Editor.__setEolMode">__setEolMode</a></td>
<td>Private method to configure the eol mode of the editor.</td>
</tr>
<tr>
<td><a href="#Editor.__setLineMarkerColours">__setLineMarkerColours</a></td>
<td>Private method to set the line marker colours.</td>
</tr>
<tr>
<td><a href="#Editor.__setMarginsDisplay">__setMarginsDisplay</a></td>
<td>Private method to configure margins 0 and 2.</td>
</tr>
<tr>
<td><a href="#Editor.__setSpelling">__setSpelling</a></td>
<td>Private method to initialize the spell checking functionality.</td>
</tr>
<tr>
<td><a href="#Editor.__setSpellingLanguage">__setSpellingLanguage</a></td>
<td>Private method to set the spell checking language.</td>
</tr>
<tr>
<td><a href="#Editor.__setTabAndIndent">__setTabAndIndent</a></td>
<td>Private method to set indentation size and style and tab width.</td>
</tr>
<tr>
<td><a href="#Editor.__setTextDisplay">__setTextDisplay</a></td>
<td>Private method to configure the text display.</td>
</tr>
<tr>
<td><a href="#Editor.__shouldAutosave">__shouldAutosave</a></td>
<td>Private method to check the autosave flags.</td>
</tr>
<tr>
<td><a href="#Editor.__showApplicationDiagram">__showApplicationDiagram</a></td>
<td>Private method to handle the Imports Diagram context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__showClassDiagram">__showClassDiagram</a></td>
<td>Private method to handle the Class Diagram context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__showCodeCoverage">__showCodeCoverage</a></td>
<td>Private method to handle the code coverage context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__showCodeInfo">__showCodeInfo</a></td>
<td>Private slot to handle the context menu action to show code info.</td>
</tr>
<tr>
<td><a href="#Editor.__showCodeMetrics">__showCodeMetrics</a></td>
<td>Private method to handle the code metrics context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__showCompletionsList">__showCompletionsList</a></td>
<td>Private method to show the completions list.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenu">__showContextMenu</a></td>
<td>Private slot to show a context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuAutocompletion">__showContextMenuAutocompletion</a></td>
<td>Private slot called before the autocompletion menu is shown.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuChecks">__showContextMenuChecks</a></td>
<td>Private slot handling the aboutToShow signal of the checks context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuEncodings">__showContextMenuEncodings</a></td>
<td>Private slot handling the aboutToShow signal of the encodings context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuEol">__showContextMenuEol</a></td>
<td>Private slot handling the aboutToShow signal of the eol context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuFormatting">__showContextMenuFormatting</a></td>
<td>Private slot handling the aboutToShow signal of the code formatting context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuGraphics">__showContextMenuGraphics</a></td>
<td>Private slot handling the aboutToShow signal of the diagrams context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuLanguages">__showContextMenuLanguages</a></td>
<td>Private slot handling the aboutToShow signal of the languages context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuMargin">__showContextMenuMargin</a></td>
<td>Private slot handling the aboutToShow signal of the margins context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuResources">__showContextMenuResources</a></td>
<td>Private slot handling the aboutToShow signal of the resources context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuShow">__showContextMenuShow</a></td>
<td>Private slot called before the show menu is shown.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuSpellCheck">__showContextMenuSpellCheck</a></td>
<td>Private slot handling the aboutToShow signal of the spell check context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuSpellLanguages">__showContextMenuSpellLanguages</a></td>
<td>Private slot handling the aboutToShow signal of the spell check languages context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuSpelling">__showContextMenuSpelling</a></td>
<td>Private slot to set up the spelling menu before it is shown.</td>
</tr>
<tr>
<td><a href="#Editor.__showContextMenuTools">__showContextMenuTools</a></td>
<td>Private slot handling the aboutToShow signal of the tools context menu.</td>
</tr>
<tr>
<td><a href="#Editor.__showImportsDiagram">__showImportsDiagram</a></td>
<td>Private method to handle the Imports Diagram context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__showMouseHoverHelp">__showMouseHoverHelp</a></td>
<td>Private slot showing code information about the symbol under the cursor.</td>
</tr>
<tr>
<td><a href="#Editor.__showPackageDiagram">__showPackageDiagram</a></td>
<td>Private method to handle the Package Diagram context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__showProfileData">__showProfileData</a></td>
<td>Private method to handle the show profile data context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__showSyntaxError">__showSyntaxError</a></td>
<td>Private slot to handle the 'Show syntax error message' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__showWarning">__showWarning</a></td>
<td>Private slot to handle the 'Show warning' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.__spellCharAdded">__spellCharAdded</a></td>
<td>Private slot called to handle the user entering a character.</td>
</tr>
<tr>
<td><a href="#Editor.__spellLanguageChanged">__spellLanguageChanged</a></td>
<td>Private slot to handle a change of the spell check language.</td>
</tr>
<tr>
<td><a href="#Editor.__spellLanguagesMenuTriggered">__spellLanguagesMenuTriggered</a></td>
<td>Private method to handle the selection of a spell check language.</td>
</tr>
<tr>
<td><a href="#Editor.__streamCommentLine">__streamCommentLine</a></td>
<td>Private slot to stream comment the current line.</td>
</tr>
<tr>
<td><a href="#Editor.__streamCommentSelection">__streamCommentSelection</a></td>
<td>Private slot to comment the current selection.</td>
</tr>
<tr>
<td><a href="#Editor.__streamUncommentLine">__streamUncommentLine</a></td>
<td>Private slot to stream uncomment the current line.</td>
</tr>
<tr>
<td><a href="#Editor.__streamUncommentSelection">__streamUncommentSelection</a></td>
<td>Private slot to stream uncomment the current selection.</td>
</tr>
<tr>
<td><a href="#Editor.__styleNeeded">__styleNeeded</a></td>
<td>Private slot to handle the need for more styling.</td>
</tr>
<tr>
<td><a href="#Editor.__textChanged">__textChanged</a></td>
<td>Private slot to handle a change of the editor text.</td>
</tr>
<tr>
<td><a href="#Editor.__toggleAutoCompletionEnable">__toggleAutoCompletionEnable</a></td>
<td>Private slot to handle the Enable Autocompletion context menu entry.</td>
</tr>
<tr>
<td><a href="#Editor.__toggleBlockComment">__toggleBlockComment</a></td>
<td>Private slot to toggle the comment of a block.</td>
</tr>
<tr>
<td><a href="#Editor.__toggleBreakpoint">__toggleBreakpoint</a></td>
<td>Private method to toggle a breakpoint.</td>
</tr>
<tr>
<td><a href="#Editor.__toggleBreakpointEnabled">__toggleBreakpointEnabled</a></td>
<td>Private method to toggle a breakpoints enabled status.</td>
</tr>
<tr>
<td><a href="#Editor.__toggleStreamComment">__toggleStreamComment</a></td>
<td>Private slot to toggle the comment of a block.</td>
</tr>
<tr>
<td><a href="#Editor.__toggleTypingAids">__toggleTypingAids</a></td>
<td>Private slot to toggle the typing aids.</td>
</tr>
<tr>
<td><a href="#Editor.__uncommentLine">__uncommentLine</a></td>
<td>Private slot to uncomment the current line.</td>
</tr>
<tr>
<td><a href="#Editor.__uncommentSelection">__uncommentSelection</a></td>
<td>Private slot to uncomment the current selection.</td>
</tr>
<tr>
<td><a href="#Editor.__updateReadOnly">__updateReadOnly</a></td>
<td>Private method to update the readOnly information for this editor.</td>
</tr>
<tr>
<td><a href="#Editor.addCallTipHook">addCallTipHook</a></td>
<td>Public method to set a calltip provider.</td>
</tr>
<tr>
<td><a href="#Editor.addClone">addClone</a></td>
<td>Public method to add a clone to our list.</td>
</tr>
<tr>
<td><a href="#Editor.addCompletionListHook">addCompletionListHook</a></td>
<td>Public method to set an auto-completion list provider.</td>
</tr>
<tr>
<td><a href="#Editor.addedToProject">addedToProject</a></td>
<td>Public method to signal, that this editor has been added to a project.</td>
</tr>
<tr>
<td><a href="#Editor.autoComplete">autoComplete</a></td>
<td>Public method to start auto-completion.</td>
</tr>
<tr>
<td><a href="#Editor.autoCompleteQScintilla">autoCompleteQScintilla</a></td>
<td>Public method to perform an autocompletion using QScintilla methods.</td>
</tr>
<tr>
<td><a href="#Editor.boxCommentLineOrSelection">boxCommentLineOrSelection</a></td>
<td>Public slot to box comment the current line or current selection.</td>
</tr>
<tr>
<td><a href="#Editor.callTip">callTip</a></td>
<td>Public method to show calltips.</td>
</tr>
<tr>
<td><a href="#Editor.canAutoCompleteFromAPIs">canAutoCompleteFromAPIs</a></td>
<td>Public method to check for API availablity.</td>
</tr>
<tr>
<td><a href="#Editor.canProvideCallTipps">canProvideCallTipps</a></td>
<td>Public method to test the calltips availability.</td>
</tr>
<tr>
<td><a href="#Editor.canProvideDynamicAutoCompletion">canProvideDynamicAutoCompletion</a></td>
<td>Public method to test the dynamic auto-completion availability.</td>
</tr>
<tr>
<td><a href="#Editor.cancelSharedEdit">cancelSharedEdit</a></td>
<td>Public method to cancel a shared edit session for the editor.</td>
</tr>
<tr>
<td><a href="#Editor.changeEvent">changeEvent</a></td>
<td>Protected method called to process an event.</td>
</tr>
<tr>
<td><a href="#Editor.checkDirty">checkDirty</a></td>
<td>Public method to check dirty status and open a message window.</td>
</tr>
<tr>
<td><a href="#Editor.checkReadOnly">checkReadOnly</a></td>
<td>Public method to check the 'read only' state.</td>
</tr>
<tr>
<td><a href="#Editor.checkRereadFile">checkRereadFile</a></td>
<td>Public slot to check, if the file needs to be re-read, and refresh it if needed.</td>
</tr>
<tr>
<td><a href="#Editor.checkSpelling">checkSpelling</a></td>
<td>Public slot to perform an interactive spell check of the document.</td>
</tr>
<tr>
<td><a href="#Editor.checkSyntax">checkSyntax</a></td>
<td>Public method to perform an automatic syntax check of the file.</td>
</tr>
<tr>
<td><a href="#Editor.clearAllHighlights">clearAllHighlights</a></td>
<td>Public method to clear all highlights.</td>
</tr>
<tr>
<td><a href="#Editor.clearBookmarks">clearBookmarks</a></td>
<td>Public slot to handle the 'Clear all bookmarks' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.clearBreakpoint">clearBreakpoint</a></td>
<td>Public method to clear a breakpoint.</td>
</tr>
<tr>
<td><a href="#Editor.clearChangeMarkers">clearChangeMarkers</a></td>
<td>Public method to clear all change markers.</td>
</tr>
<tr>
<td><a href="#Editor.clearCodeWarnings">clearCodeWarnings</a></td>
<td>Public slot to clear all code warnings.</td>
</tr>
<tr>
<td><a href="#Editor.clearErrorWarnings">clearErrorWarnings</a></td>
<td>Public slot to clear all error warnings.</td>
</tr>
<tr>
<td><a href="#Editor.clearFlakesWarnings">clearFlakesWarnings</a></td>
<td>Public slot to clear all pyflakes warnings.</td>
</tr>
<tr>
<td><a href="#Editor.clearHighlight">clearHighlight</a></td>
<td>Public method to clear a text highlight.</td>
</tr>
<tr>
<td><a href="#Editor.clearInfoWarnings">clearInfoWarnings</a></td>
<td>Public slot to clear all info warnings.</td>
</tr>
<tr>
<td><a href="#Editor.clearSearchIndicators">clearSearchIndicators</a></td>
<td>Public method to clear all search indicators.</td>
</tr>
<tr>
<td><a href="#Editor.clearSearchSelectionHighlight">clearSearchSelectionHighlight</a></td>
<td>Public method to clear all highlights.</td>
</tr>
<tr>
<td><a href="#Editor.clearStyleWarnings">clearStyleWarnings</a></td>
<td>Public slot to clear all style warnings.</td>
</tr>
<tr>
<td><a href="#Editor.clearStyles">clearStyles</a></td>
<td>Public method to set the styles according the selected Qt style or the selected editor colours.</td>
</tr>
<tr>
<td><a href="#Editor.clearSyntaxError">clearSyntaxError</a></td>
<td>Public slot to handle the 'Clear all syntax error' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.clearWarnings">clearWarnings</a></td>
<td>Public slot to clear all warnings.</td>
</tr>
<tr>
<td><a href="#Editor.close">close</a></td>
<td>Public method called when the window gets closed.</td>
</tr>
<tr>
<td><a href="#Editor.closeIt">closeIt</a></td>
<td>Public method called by the viewmanager to finally get rid of us.</td>
</tr>
<tr>
<td><a href="#Editor.codeCoverageShowAnnotations">codeCoverageShowAnnotations</a></td>
<td>Public method to handle the show code coverage annotations context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.collapseFoldWithChildren">collapseFoldWithChildren</a></td>
<td>Public method to collapse the current fold including its children.</td>
</tr>
<tr>
<td><a href="#Editor.commentLineOrSelection">commentLineOrSelection</a></td>
<td>Public slot to comment the current line or current selection.</td>
</tr>
<tr>
<td><a href="#Editor.completionsListReady">completionsListReady</a></td>
<td>Public method to show the completions determined by a completions provider.</td>
</tr>
<tr>
<td><a href="#Editor.convertEols">convertEols</a></td>
<td>Public method to convert the end-of-line marker.</td>
</tr>
<tr>
<td><a href="#Editor.curLineHasBreakpoint">curLineHasBreakpoint</a></td>
<td>Public method to check for the presence of a breakpoint at the current line.</td>
</tr>
<tr>
<td><a href="#Editor.determineFileType">determineFileType</a></td>
<td>Public method to determine the file type using various tests.</td>
</tr>
<tr>
<td><a href="#Editor.dragEnterEvent">dragEnterEvent</a></td>
<td>Protected method to handle the drag enter event.</td>
</tr>
<tr>
<td><a href="#Editor.dragLeaveEvent">dragLeaveEvent</a></td>
<td>Protected method to handle the drag leave event.</td>
</tr>
<tr>
<td><a href="#Editor.dragMoveEvent">dragMoveEvent</a></td>
<td>Protected method to handle the drag move event.</td>
</tr>
<tr>
<td><a href="#Editor.dropEvent">dropEvent</a></td>
<td>Protected method to handle the drop event.</td>
</tr>
<tr>
<td><a href="#Editor.editorCommand">editorCommand</a></td>
<td>Public method to perform a simple editor command.</td>
</tr>
<tr>
<td><a href="#Editor.encloseSelectedText">encloseSelectedText</a></td>
<td>Local function to enclose the current selection with some characters.</td>
</tr>
<tr>
<td><a href="#Editor.ensureVisible">ensureVisible</a></td>
<td>Public method to ensure, that the specified line is visible.</td>
</tr>
<tr>
<td><a href="#Editor.ensureVisibleTop">ensureVisibleTop</a></td>
<td>Public method to ensure, that the specified line is visible at the top of the editor.</td>
</tr>
<tr>
<td><a href="#Editor.event">event</a></td>
<td>Public method handling events.</td>
</tr>
<tr>
<td><a href="#Editor.expandFoldWithChildren">expandFoldWithChildren</a></td>
<td>Public method to expand the current fold including its children.</td>
</tr>
<tr>
<td><a href="#Editor.expandTabs">expandTabs</a></td>
<td>Public slot to expand tabulators to spaces.</td>
</tr>
<tr>
<td><a href="#Editor.exportFile">exportFile</a></td>
<td>Public method to export the file.</td>
</tr>
<tr>
<td><a href="#Editor.extractTasks">extractTasks</a></td>
<td>Public slot to extract all tasks.</td>
</tr>
<tr>
<td><a href="#Editor.fileRenamed">fileRenamed</a></td>
<td>Public slot to handle the editorRenamed signal.</td>
</tr>
<tr>
<td><a href="#Editor.focusInEvent">focusInEvent</a></td>
<td>Protected method called when the editor receives focus.</td>
</tr>
<tr>
<td><a href="#Editor.focusOutEvent">focusOutEvent</a></td>
<td>Protected method called when the editor loses focus.</td>
</tr>
<tr>
<td><a href="#Editor.gestureEvent">gestureEvent</a></td>
<td>Protected method handling gesture events.</td>
</tr>
<tr>
<td><a href="#Editor.getApiLanguage">getApiLanguage</a></td>
<td>Public method to get the API language of the editor.</td>
</tr>
<tr>
<td><a href="#Editor.getBookmarkLines">getBookmarkLines</a></td>
<td>Public method to get the lines containing a bookmark.</td>
</tr>
<tr>
<td><a href="#Editor.getBookmarks">getBookmarks</a></td>
<td>Public method to retrieve the bookmarks.</td>
</tr>
<tr>
<td><a href="#Editor.getBreakpointLines">getBreakpointLines</a></td>
<td>Public method to get the lines containing a breakpoint.</td>
</tr>
<tr>
<td><a href="#Editor.getCallTipHook">getCallTipHook</a></td>
<td>Public method to get the registered calltip provider.</td>
</tr>
<tr>
<td><a href="#Editor.getChangeLines">getChangeLines</a></td>
<td>Public method to get the lines containing a change.</td>
</tr>
<tr>
<td><a href="#Editor.getCompleter">getCompleter</a></td>
<td>Public method to retrieve a reference to the completer object.</td>
</tr>
<tr>
<td><a href="#Editor.getCompletionListHook">getCompletionListHook</a></td>
<td>Public method to get the registered completion list provider.</td>
</tr>
<tr>
<td><a href="#Editor.getCoverageLines">getCoverageLines</a></td>
<td>Public method to get the lines containing a coverage marker.</td>
</tr>
<tr>
<td><a href="#Editor.getCurrentWord">getCurrentWord</a></td>
<td>Public method to get the word at the current position.</td>
</tr>
<tr>
<td><a href="#Editor.getCurrentWordBoundaries">getCurrentWordBoundaries</a></td>
<td>Public method to get the word boundaries at the current position.</td>
</tr>
<tr>
<td><a href="#Editor.getDocstringGenerator">getDocstringGenerator</a></td>
<td>Public method to get a reference to the docstring generator.</td>
</tr>
<tr>
<td><a href="#Editor.getEditorConfig">getEditorConfig</a></td>
<td>Public method to get the requested option via EditorConfig.</td>
</tr>
<tr>
<td><a href="#Editor.getEncoding">getEncoding</a></td>
<td>Public method to return the current encoding.</td>
</tr>
<tr>
<td><a href="#Editor.getFileName">getFileName</a></td>
<td>Public method to return the name of the file being displayed.</td>
</tr>
<tr>
<td><a href="#Editor.getFileType">getFileType</a></td>
<td>Public method to return the type of the file being displayed.</td>
</tr>
<tr>
<td><a href="#Editor.getFileTypeByFlag">getFileTypeByFlag</a></td>
<td>Public method to return the type of the file, if it was set by an eflag: marker.</td>
</tr>
<tr>
<td><a href="#Editor.getHighlightPosition">getHighlightPosition</a></td>
<td>Public method to return the position of the highlight bar.</td>
</tr>
<tr>
<td><a href="#Editor.getLanguage">getLanguage</a></td>
<td>Public method to retrieve the language of the editor.</td>
</tr>
<tr>
<td><a href="#Editor.getLexer">getLexer</a></td>
<td>Public method to retrieve a reference to the lexer object.</td>
</tr>
<tr>
<td><a href="#Editor.getMenu">getMenu</a></td>
<td>Public method to get a reference to the main context menu or a submenu.</td>
</tr>
<tr>
<td><a href="#Editor.getMouseClickHandler">getMouseClickHandler</a></td>
<td>Public method to get a registered mouse click handler.</td>
</tr>
<tr>
<td><a href="#Editor.getMouseClickHandlers">getMouseClickHandlers</a></td>
<td>Public method to get all registered mouse click handlers of a plug-in.</td>
</tr>
<tr>
<td><a href="#Editor.getNoName">getNoName</a></td>
<td>Public method to get the display string for an unnamed editor.</td>
</tr>
<tr>
<td><a href="#Editor.getSearchIndicatorLines">getSearchIndicatorLines</a></td>
<td>Public method to get the lines containing a search indicator.</td>
</tr>
<tr>
<td><a href="#Editor.getSearchSelectionHighlight">getSearchSelectionHighlight</a></td>
<td>Public method to get the start and end of the selection highlight.</td>
</tr>
<tr>
<td><a href="#Editor.getSearchText">getSearchText</a></td>
<td>Public method to determine the selection or the current word for the next search operation.</td>
</tr>
<tr>
<td><a href="#Editor.getSharingStatus">getSharingStatus</a></td>
<td>Public method to get some share status info.</td>
</tr>
<tr>
<td><a href="#Editor.getSpellingLanguage">getSpellingLanguage</a></td>
<td>Public method to get the current spelling language.</td>
</tr>
<tr>
<td><a href="#Editor.getSyntaxErrorLines">getSyntaxErrorLines</a></td>
<td>Public method to get the lines containing a syntax error.</td>
</tr>
<tr>
<td><a href="#Editor.getTaskLines">getTaskLines</a></td>
<td>Public method to get the lines containing a task.</td>
</tr>
<tr>
<td><a href="#Editor.getVcsConflictMarkerLines">getVcsConflictMarkerLines</a></td>
<td>Public method to determine the lines containing a VCS conflict marker.</td>
</tr>
<tr>
<td><a href="#Editor.getWarningLines">getWarningLines</a></td>
<td>Public method to get the lines containing a warning.</td>
</tr>
<tr>
<td><a href="#Editor.getWord">getWord</a></td>
<td>Public method to get the word at a position.</td>
</tr>
<tr>
<td><a href="#Editor.getWordBoundaries">getWordBoundaries</a></td>
<td>Public method to get the word boundaries at a position.</td>
</tr>
<tr>
<td><a href="#Editor.getWordLeft">getWordLeft</a></td>
<td>Public method to get the word to the left of a position.</td>
</tr>
<tr>
<td><a href="#Editor.getWordRight">getWordRight</a></td>
<td>Public method to get the word to the right of a position.</td>
</tr>
<tr>
<td><a href="#Editor.gotoLastEditPosition">gotoLastEditPosition</a></td>
<td>Public method to move the cursor to the last edit position.</td>
</tr>
<tr>
<td><a href="#Editor.gotoLine">gotoLine</a></td>
<td>Public method to jump to the beginning of a line.</td>
</tr>
<tr>
<td><a href="#Editor.gotoMethodClass">gotoMethodClass</a></td>
<td>Public method to go to the next Python method or class definition.</td>
</tr>
<tr>
<td><a href="#Editor.gotoReferenceHandler">gotoReferenceHandler</a></td>
<td>Public method to handle a list of references to perform a goto.</td>
</tr>
<tr>
<td><a href="#Editor.gotoSyntaxError">gotoSyntaxError</a></td>
<td>Public slot to handle the 'Goto syntax error' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.handleMonospacedEnable">handleMonospacedEnable</a></td>
<td>Public slot to handle the Use Monospaced Font context menu entry.</td>
</tr>
<tr>
<td><a href="#Editor.handleRenamed">handleRenamed</a></td>
<td>Public method to handle the editorRenamed signal.</td>
</tr>
<tr>
<td><a href="#Editor.hasBookmarks">hasBookmarks</a></td>
<td>Public method to check for the presence of bookmarks.</td>
</tr>
<tr>
<td><a href="#Editor.hasBreakpoints">hasBreakpoints</a></td>
<td>Public method to check for the presence of breakpoints.</td>
</tr>
<tr>
<td><a href="#Editor.hasChangeMarkers">hasChangeMarkers</a></td>
<td>Public method to determine, if this editor contains any change markers.</td>
</tr>
<tr>
<td><a href="#Editor.hasCoverageMarkers">hasCoverageMarkers</a></td>
<td>Public method to test, if there are coverage markers.</td>
</tr>
<tr>
<td><a href="#Editor.hasMiniMenu">hasMiniMenu</a></td>
<td>Public method to check the miniMenu flag.</td>
</tr>
<tr>
<td><a href="#Editor.hasSyntaxErrors">hasSyntaxErrors</a></td>
<td>Public method to check for the presence of syntax errors.</td>
</tr>
<tr>
<td><a href="#Editor.hasTaskMarkers">hasTaskMarkers</a></td>
<td>Public method to determine, if this editor contains any task markers.</td>
</tr>
<tr>
<td><a href="#Editor.hasWarnings">hasWarnings</a></td>
<td>Public method to check for the presence of warnings.</td>
</tr>
<tr>
<td><a href="#Editor.highlight">highlight</a></td>
<td>Public method to highlight [or de-highlight] a particular line.</td>
</tr>
<tr>
<td><a href="#Editor.highlightSearchSelection">highlightSearchSelection</a></td>
<td>Public method to set a highlight for the selection at the start of a search.</td>
</tr>
<tr>
<td><a href="#Editor.highlightVisible">highlightVisible</a></td>
<td>Public method to make sure that the highlight is visible.</td>
</tr>
<tr>
<td><a href="#Editor.indentLineOrSelection">indentLineOrSelection</a></td>
<td>Public slot to indent the current line or current selection.</td>
</tr>
<tr>
<td><a href="#Editor.insertDocstring">insertDocstring</a></td>
<td>Public method to generate and insert a docstring for the function under the cursor.</td>
</tr>
<tr>
<td><a href="#Editor.isClone">isClone</a></td>
<td>Public method to test, if the given editor is a clone.</td>
</tr>
<tr>
<td><a href="#Editor.isCythonFile">isCythonFile</a></td>
<td>Public method to return a flag indicating a Cython file.</td>
</tr>
<tr>
<td><a href="#Editor.isJavascriptFile">isJavascriptFile</a></td>
<td>Public method to return a flag indicating a Javascript file.</td>
</tr>
<tr>
<td><a href="#Editor.isLastEditPositionAvailable">isLastEditPositionAvailable</a></td>
<td>Public method to check, if a last edit position is available.</td>
</tr>
<tr>
<td><a href="#Editor.isMicroPythonFile">isMicroPythonFile</a></td>
<td>Public method to return a flag indicating a MicroPython file.</td>
</tr>
<tr>
<td><a href="#Editor.isProjectFile">isProjectFile</a></td>
<td>Public method to check, if the file of the editor belongs to the current project.</td>
</tr>
<tr>
<td><a href="#Editor.isPy3File">isPy3File</a></td>
<td>Public method to return a flag indicating a Python3 file.</td>
</tr>
<tr>
<td><a href="#Editor.isPyFile">isPyFile</a></td>
<td>Public method to return a flag indicating a Python (2 or 3) file.</td>
</tr>
<tr>
<td><a href="#Editor.isRubyFile">isRubyFile</a></td>
<td>Public method to return a flag indicating a Ruby file.</td>
</tr>
<tr>
<td><a href="#Editor.isSpellCheckRegion">isSpellCheckRegion</a></td>
<td>Public method to check, if the given position is within a region, that should be spell checked.</td>
</tr>
<tr>
<td><a href="#Editor.joinLines">joinLines</a></td>
<td>Public slot to join the current line with the next one.</td>
</tr>
<tr>
<td><a href="#Editor.keyPressEvent">keyPressEvent</a></td>
<td>Protected method to handle the user input a key at a time.</td>
</tr>
<tr>
<td><a href="#Editor.macroDelete">macroDelete</a></td>
<td>Public method to delete a macro.</td>
</tr>
<tr>
<td><a href="#Editor.macroLoad">macroLoad</a></td>
<td>Public method to load a macro from a file.</td>
</tr>
<tr>
<td><a href="#Editor.macroRecordingStart">macroRecordingStart</a></td>
<td>Public method to start macro recording.</td>
</tr>
<tr>
<td><a href="#Editor.macroRecordingStop">macroRecordingStop</a></td>
<td>Public method to stop macro recording.</td>
</tr>
<tr>
<td><a href="#Editor.macroRun">macroRun</a></td>
<td>Public method to execute a macro.</td>
</tr>
<tr>
<td><a href="#Editor.macroSave">macroSave</a></td>
<td>Public method to save a macro to a file.</td>
</tr>
<tr>
<td><a href="#Editor.menuEditBreakpoint">menuEditBreakpoint</a></td>
<td>Public slot to handle the 'Edit breakpoint' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.menuNextBreakpoint">menuNextBreakpoint</a></td>
<td>Public slot to handle the 'Next breakpoint' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.menuPreviousBreakpoint">menuPreviousBreakpoint</a></td>
<td>Public slot to handle the 'Previous breakpoint' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.menuToggleBookmark">menuToggleBookmark</a></td>
<td>Public slot to handle the 'Toggle bookmark' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.menuToggleBreakpoint">menuToggleBreakpoint</a></td>
<td>Public slot to handle the 'Toggle breakpoint' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td>
<td>Protected method to handle mouse double click events.</td>
</tr>
<tr>
<td><a href="#Editor.mousePressEvent">mousePressEvent</a></td>
<td>Protected method to handle the mouse press event.</td>
</tr>
<tr>
<td><a href="#Editor.mouseReleaseEvent">mouseReleaseEvent</a></td>
<td>Protected method calling a registered mouse click handler function.</td>
</tr>
<tr>
<td><a href="#Editor.newBreakpointWithProperties">newBreakpointWithProperties</a></td>
<td>Public method to set a new breakpoint and its properties.</td>
</tr>
<tr>
<td><a href="#Editor.nextBookmark">nextBookmark</a></td>
<td>Public slot to handle the 'Next bookmark' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.nextChange">nextChange</a></td>
<td>Public slot to handle the 'Next change' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.nextTask">nextTask</a></td>
<td>Public slot to handle the 'Next task' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.nextUncovered">nextUncovered</a></td>
<td>Public slot to handle the 'Next uncovered' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.nextWarning">nextWarning</a></td>
<td>Public slot to handle the 'Next warning' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.previousBookmark">previousBookmark</a></td>
<td>Public slot to handle the 'Previous bookmark' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.previousChange">previousChange</a></td>
<td>Public slot to handle the 'Previous change' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.previousTask">previousTask</a></td>
<td>Public slot to handle the 'Previous task' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.previousUncovered">previousUncovered</a></td>
<td>Public slot to handle the 'Previous uncovered' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.previousWarning">previousWarning</a></td>
<td>Public slot to handle the 'Previous warning' context menu action.</td>
</tr>
<tr>
<td><a href="#Editor.printFile">printFile</a></td>
<td>Public slot to print the text.</td>
</tr>
<tr>
<td><a href="#Editor.printPreviewFile">printPreviewFile</a></td>
<td>Public slot to show a print preview of the text.</td>
</tr>
<tr>
<td><a href="#Editor.projectClosed">projectClosed</a></td>
<td>Public slot to handle the closing of a project.</td>
</tr>
<tr>
<td><a href="#Editor.projectLexerAssociationsChanged">projectLexerAssociationsChanged</a></td>
<td>Public slot to handle changes of the project lexer associations.</td>
</tr>
<tr>
<td><a href="#Editor.projectOpened">projectOpened</a></td>
<td>Public slot to handle the opening of a project.</td>
</tr>
<tr>
<td><a href="#Editor.readFile">readFile</a></td>
<td>Public method to read the text from a file.</td>
</tr>
<tr>
<td><a href="#Editor.readSettings">readSettings</a></td>
<td>Public slot to read the settings into our lexer.</td>
</tr>
<tr>
<td><a href="#Editor.receive">receive</a></td>
<td>Public slot to handle received editor commands.</td>
</tr>
<tr>
<td><a href="#Editor.recordModificationTime">recordModificationTime</a></td>
<td>Public slot to record the modification time of our file.</td>
</tr>
<tr>
<td><a href="#Editor.redo">redo</a></td>
<td>Public method to redo the last recorded change.</td>
</tr>
<tr>
<td><a href="#Editor.refresh">refresh</a></td>
<td>Public slot to refresh the editor contents.</td>
</tr>
<tr>
<td><a href="#Editor.refreshCoverageAnnotations">refreshCoverageAnnotations</a></td>
<td>Public method to refresh the code coverage annotations.</td>
</tr>
<tr>
<td><a href="#Editor.registerMouseHoverHelpFunction">registerMouseHoverHelpFunction</a></td>
<td>Public method to register a mouse hover help function.</td>
</tr>
<tr>
<td><a href="#Editor.removeCallTipHook">removeCallTipHook</a></td>
<td>Public method to remove a previously registered calltip provider.</td>
</tr>
<tr>
<td><a href="#Editor.removeClone">removeClone</a></td>
<td>Public method to remove a clone from our list.</td>
</tr>
<tr>
<td><a href="#Editor.removeCompletionListHook">removeCompletionListHook</a></td>
<td>Public method to remove a previously registered completion list provider.</td>
</tr>
<tr>
<td><a href="#Editor.removeMouseClickHandler">removeMouseClickHandler</a></td>
<td>Public method to un-registered a mouse click handler.</td>
</tr>
<tr>
<td><a href="#Editor.removeMouseClickHandlers">removeMouseClickHandlers</a></td>
<td>Public method to un-registered all mouse click handlers of a plug-in.</td>
</tr>
<tr>
<td><a href="#Editor.resetDocstringGenerator">resetDocstringGenerator</a></td>
<td>Public method to reset the current docstring generator.</td>
</tr>
<tr>
<td><a href="#Editor.resetOnlineChangeTraceInfo">resetOnlineChangeTraceInfo</a></td>
<td>Public slot to reset the online change trace info.</td>
</tr>
<tr>
<td><a href="#Editor.resizeEvent">resizeEvent</a></td>
<td>Protected method handling resize events.</td>
</tr>
<tr>
<td><a href="#Editor.revertToUnmodified">revertToUnmodified</a></td>
<td>Public method to revert back to the last saved state.</td>
</tr>
<tr>
<td><a href="#Editor.saveFile">saveFile</a></td>
<td>Public method to save the text to a file.</td>
</tr>
<tr>
<td><a href="#Editor.saveFileAs">saveFileAs</a></td>
<td>Public method to save a file with a new name.</td>
</tr>
<tr>
<td><a href="#Editor.saveFileCopy">saveFileCopy</a></td>
<td>Public method to save a copy of the file.</td>
</tr>
<tr>
<td><a href="#Editor.searchCurrentWordBackward">searchCurrentWordBackward</a></td>
<td>Public slot to search the current word backward.</td>
</tr>
<tr>
<td><a href="#Editor.searchCurrentWordForward">searchCurrentWordForward</a></td>
<td>Public slot to search the current word forward.</td>
</tr>
<tr>
<td><a href="#Editor.selectCurrentWord">selectCurrentWord</a></td>
<td>Public method to select the current word.</td>
</tr>
<tr>
<td><a href="#Editor.selectWord">selectWord</a></td>
<td>Public method to select the word at a position.</td>
</tr>
<tr>
<td><a href="#Editor.sendSharedEdit">sendSharedEdit</a></td>
<td>Public slot to end a shared edit session for the editor and send the changes.</td>
</tr>
<tr>
<td><a href="#Editor.setAutoCompletionEnabled">setAutoCompletionEnabled</a></td>
<td>Public method to enable/disable autocompletion.</td>
</tr>
<tr>
<td><a href="#Editor.setAutoSpellChecking">setAutoSpellChecking</a></td>
<td>Public method to set the automatic spell checking.</td>
</tr>
<tr>
<td><a href="#Editor.setFileName">setFileName</a></td>
<td>Public method to set the file name of the current file.</td>
</tr>
<tr>
<td><a href="#Editor.setHighlight">setHighlight</a></td>
<td>Public method to set a text highlight.</td>
</tr>
<tr>
<td><a href="#Editor.setLanguage">setLanguage</a></td>
<td>Public method to set a lexer language.</td>
</tr>
<tr>
<td><a href="#Editor.setMonospaced">setMonospaced</a></td>
<td>Public method to set/reset a monospaced font.</td>
</tr>
<tr>
<td><a href="#Editor.setMouseClickHandler">setMouseClickHandler</a></td>
<td>Public method to set a mouse click handler.</td>
</tr>
<tr>
<td><a href="#Editor.setNoName">setNoName</a></td>
<td>Public method to set the display string for an unnamed editor.</td>
</tr>
<tr>
<td><a href="#Editor.setSearchIndicator">setSearchIndicator</a></td>
<td>Public method to set a search indicator for the given range.</td>
</tr>
<tr>
<td><a href="#Editor.setSpellingForProject">setSpellingForProject</a></td>
<td>Public method to set the spell checking options for files belonging to the current project.</td>
</tr>
<tr>
<td><a href="#Editor.shareConnected">shareConnected</a></td>
<td>Public method to handle a change of the connected state.</td>
</tr>
<tr>
<td><a href="#Editor.shareEditor">shareEditor</a></td>
<td>Public method to set the shared status of the editor.</td>
</tr>
<tr>
<td><a href="#Editor.shortenEmptyLines">shortenEmptyLines</a></td>
<td>Public slot to compress lines consisting solely of whitespace characters.</td>
</tr>
<tr>
<td><a href="#Editor.showMouseHoverHelpData">showMouseHoverHelpData</a></td>
<td>Public method to show the mouse hover help data.</td>
</tr>
<tr>
<td><a href="#Editor.smartIndentLineOrSelection">smartIndentLineOrSelection</a></td>
<td>Public slot to indent current line smartly.</td>
</tr>
<tr>
<td><a href="#Editor.sortLines">sortLines</a></td>
<td>Public slot to sort the lines spanned by a rectangular selection.</td>
</tr>
<tr>
<td><a href="#Editor.startSharedEdit">startSharedEdit</a></td>
<td>Public slot to start a shared edit session for the editor.</td>
</tr>
<tr>
<td><a href="#Editor.streamCommentLineOrSelection">streamCommentLineOrSelection</a></td>
<td>Public slot to stream comment the current line or current selection.</td>
</tr>
<tr>
<td><a href="#Editor.streamUncommentLineOrSelection">streamUncommentLineOrSelection</a></td>
<td>Public slot to stream uncomment the current line or current selection.</td>
</tr>
<tr>
<td><a href="#Editor.toggleBookmark">toggleBookmark</a></td>
<td>Public method to toggle a bookmark.</td>
</tr>
<tr>
<td><a href="#Editor.toggleComment">toggleComment</a></td>
<td>Public slot to toggle a block or stream comment.</td>
</tr>
<tr>
<td><a href="#Editor.toggleCurrentFold">toggleCurrentFold</a></td>
<td>Public slot to toggle the fold containing the current line.</td>
</tr>
<tr>
<td><a href="#Editor.toggleSyntaxError">toggleSyntaxError</a></td>
<td>Public method to toggle a syntax error indicator.</td>
</tr>
<tr>
<td><a href="#Editor.toggleWarning">toggleWarning</a></td>
<td>Public method to toggle a warning indicator.</td>
</tr>
<tr>
<td><a href="#Editor.uncommentLineOrSelection">uncommentLineOrSelection</a></td>
<td>Public slot to uncomment the current line or current selection.</td>
</tr>
<tr>
<td><a href="#Editor.undo">undo</a></td>
<td>Public method to undo the last recorded change.</td>
</tr>
<tr>
<td><a href="#Editor.unindentLineOrSelection">unindentLineOrSelection</a></td>
<td>Public slot to unindent the current line or current selection.</td>
</tr>
<tr>
<td><a href="#Editor.unregisterMouseHoverHelpFunction">unregisterMouseHoverHelpFunction</a></td>
<td>Public method to unregister a mouse hover help function.</td>
</tr>
<tr>
<td><a href="#Editor.updateMarkerMap">updateMarkerMap</a></td>
<td>Public method to initiate an update of the marker map.</td>
</tr>
<tr>
<td><a href="#Editor.viewportEvent">viewportEvent</a></td>
<td>Protected method handling event of the viewport.</td>
</tr>
<tr>
<td><a href="#Editor.wheelEvent">wheelEvent</a></td>
<td>Protected method to handle wheel events.</td>
</tr>
<tr>
<td><a href="#Editor.writeFile">writeFile</a></td>
<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>
<dd>
reference to the debug server object
</dd>
<dt><i>fn</i> (str)</dt>
<dd>
name of the file to be opened. If it is None, a new (empty)
            editor is opened.
</dd>
<dt><i>vm</i> (ViewManager)</dt>
<dd>
reference to the view manager object
</dd>
<dt><i>filetype</i> (str)</dt>
<dd>
type of the source file
</dd>
<dt><i>editor</i> (Editor)</dt>
<dd>
reference to an Editor object, if this is a cloned view
</dd>
<dt><i>tv</i> (TaskViewer)</dt>
<dd>
reference to the task viewer object
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<dl>

<dt>Raises <b>OSError</b>:</dt>
<dd>
raised to indicate an issue accessing the file
</dd>
</dl>
<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>
<dd>
line number of the breakpoint
</dd>
<dt><i>temporary</i> (bool)</dt>
<dd>
flag indicating a temporary breakpoint
</dd>
</dl>
<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>
<dd>
index of parent item
</dd>
<dt><i>start</i> (int)</dt>
<dd>
start row
</dd>
<dt><i>end</i> (int)</dt>
<dd>
end row
</dd>
</dl>
<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>
<dd>
amount the calltip shall be shifted
</dd>
<dt><i>pos</i> (int)</dt>
<dd>
position into the text
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
new position for the calltip
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<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>
<dd>
name of the template to apply
</dd>
<dt><i>language</i> (str)</dt>
<dd>
name of the language (group) to get the template
            from
</dd>
</dl>
<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>
<dd>
flag indicating a call from the __charAdded method
</dd>
<dt><i>context</i> (bool or None)</dt>
<dd>
flag indicating to complete a context
</dd>
</dl>
<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>
<p>
        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>
<dd>
filename used to determine the associated typing
            completer language
</dd>
</dl>
<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>
<dd>
filename used to determine the associated lexer
            language
</dd>
<dt><i>pyname</i> (str)</dt>
<dd>
name of the pygments lexer to use
</dd>
</dl>
<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>
<dd>
first line of text to use in the generation process
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
dummy file name to be used for binding a lexer
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<dd>
start index of the rows to be changed
</dd>
<dt><i>endIndex</i> (QModelIndex)</dt>
<dd>
end index of the rows to be changed
</dd>
</dl>
<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>
<dd>
old text
</dd>
<dt><i>new</i> (str)</dt>
<dd>
new text
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
commands to change old into new
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<dd>
start index of the breakpoints being changed
</dd>
<dt><i>endIndex</i> (QModelIndex)</dt>
<dd>
end index of the breakpoints being changed
</dd>
</dl>
<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>
<dd>
value of the character entered
</dd>
</dl>
<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>
<dd>
name of the file
</dd>
</dl>
<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>
<dd>
kind of warning to clear
</dd>
</dl>
<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>
<dd>
the ID of the user list (should be 1 or 2)
</dd>
<dt><i>txt</i> (str)</dt>
<dd>
the selected text
</dd>
</dl>
<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>
<dd>
reference to the action that was selected
</dd>
</dl>
<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>
<dd>
key of the color to use
</dd>
<dt><i>size</i> (int)</dt>
<dd>
size of the pixmap
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
create pixmap
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QPixmap
</dd>
</dl>
<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>
<p>
        It emits the signal cursorChanged with parameters fileName,
        line and pos.
</p>

<dl>

<dt><i>line</i> (int)</dt>
<dd>
line number of the cursor
</dd>
<dt><i>index</i> (int)</dt>
<dd>
position in line of the cursor
</dd>
</dl>
<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>
<dd>
current cursor position (line and column)
</dd>
</dl>
<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>
<dd>
index of parent item
</dd>
<dt><i>start</i> (int)</dt>
<dd>
start row
</dd>
<dt><i>end</i> (int)</dt>
<dd>
end row
</dd>
</dl>
<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>
<dd>
command to be processed
</dd>
</dl>
<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>
<dd>
changed encoding
</dd>
<dt><i>propagate</i> (bool)</dt>
<dd>
flag indicating to propagate the change
</dd>
</dl>
<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>
<dd>
reference to the action that was triggered
</dd>
</dl>
<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>
<dd>
reference to the action that was triggered
</dd>
</dl>
<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>
text left of cursor position
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<dd>
position to get character at
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
requested character or "", if there are no more and the next position
            (i.e. pos - 1)
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, int)
</dd>
</dl>
<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>
file name of the coverage file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<p>
        If there is no EditorConfig defined, the equivalent built-in option
        will be used (Preferences.getEditor() ). The option must be given as
        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>
<dd>
Preferences option key
</dd>
<dt><i>nodefault</i> (bool)</dt>
<dd>
flag indicating to not get the default value from
            Preferences but return None instead
</dd>
<dt><i>config</i> (dict)</dt>
<dd>
reference to an EditorConfig object or None
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
value of requested setting or None if nothing was found and
            nodefault parameter was True
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
Any
</dd>
</dl>
<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>
Tuple of macro name and a flag, indicating, if the user
            pressed ok or canceled the operation.
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, bool)
</dd>
</dl>
<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>
<dd>
Preferences option key
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
override value; None in case nothing is defined
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
Any
</dd>
</dl>
<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>
Python version or 0 if it's not a Python file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<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>
<dd>
directory to save the file in
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
file name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<dd>
flag indicating an indent operation
            <br />If the flag is true, an indent operation is performed.
            Otherwise the current line is unindented.
</dd>
</dl>
<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>
<dd>
flag indicating an indent operation
            <br />If the flag is true, an indent operation is performed.
            Otherwise the current line is unindented.
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
reference to the generated menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
<dd>
text of the line to check
</dd>
<dt><i>commentStr</i> (str)</dt>
<dd>
comment string to check against
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a commented line
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
character to be checked
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating the result
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
text of the line to check
</dd>
<dt><i>streamCommentStr</i> (dict)</dt>
<dd>
dictionary containing the stream comment start and
            end strings
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a stream commented line
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
language to be set
</dd>
<dt><i>propagate</i> (bool)</dt>
<dd>
flag indicating to propagate the change
</dd>
</dl>
<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>
<dd>
reference to the action that was triggered
</dd>
</dl>
<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>
<dd>
name of the file
</dd>
</dl>
<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>
<dd>
name of the file
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
EditorConfig dictionary
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<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>
<dd>
id of the clicked margin
</dd>
<dt><i>line</i> (int)</dt>
<dd>
line number of the click
</dd>
<dt><i>modifiers</i> (Qt.KeyboardModifiers)</dt>
<dd>
keyboard modifiers
</dd>
</dl>
<a NAME="Editor.__marginHoverEnd" ID="Editor.__marginHoverEnd"></a>
<h4>Editor.__marginHoverEnd</h4>
<b>__marginHoverEnd</b>(<i></i>)
<p>
        Private slot cancelling the display of syntax error or a warning marker text.
</p>

<a NAME="Editor.__marginHoverStart" ID="Editor.__marginHoverStart"></a>
<h4>Editor.__marginHoverStart</h4>
<b>__marginHoverStart</b>(<i>pos, x, y</i>)
<p>
        Private slot showing the text of a syntax error or a warning marker.
</p>

<dl>

<dt><i>pos</i> (int)</dt>
<dd>
mouse position into the document
</dd>
<dt><i>x</i> (int)</dt>
<dd>
x-value of mouse screen position
</dd>
<dt><i>y</i> (int)</dt>
<dd>
y-value of mouse screen position
</dd>
</dl>
<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>
<dd>
x position
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
margin number (integer, -1 for no margin)
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<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>
<p>
        It emits the signal modificationStatusChanged with parameters
        m and self.
</p>

<dl>

<dt><i>m</i> (bool)</dt>
<dd>
modification status
</dd>
</dl>
<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>
<dd>
start position of change
</dd>
<dt><i>mtype</i> (int)</dt>
<dd>
flags identifying the change
</dd>
<dt><i>text</i> (str)</dt>
<dd>
text that is given to the Undo system
</dd>
<dt><i>length</i> (int)</dt>
<dd>
length of the change
</dd>
<dt><i>linesAdded</i> (int)</dt>
<dd>
number of added/deleted lines
</dd>
<dt><i>line</i> (int)</dt>
<dd>
line number of a fold level or marker change
</dd>
<dt><i>foldNow</i> (int)</dt>
<dd>
new fold level
</dd>
<dt><i>foldPrev</i> (int)</dt>
<dd>
previous fold level
</dd>
<dt><i>token</i> (int)</dt>
<dd>
???
</dd>
<dt><i>annotationLinesAdded</i> (int)</dt>
<dd>
number of added/deleted annotation lines
</dd>
</dl>
<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>
<dd>
encoding to be normalized
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
normalized encoding
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<p>
        Following actions are supported.
        <ul>
        <li>BlackFormattingAction.Format - the code reformatting is performed</li>
        <li>BlackFormattingAction.Check - a check is performed, if code formatting
            is necessary</li>
        <li>BlackFormattingAction.Diff - a unified diff of potential code formatting
            changes is generated</li>
        </ul>
</p>

<dl>

<dt><i>action</i> (BlackFormattingAction)</dt>
<dd>
formatting operation to be performed
</dd>
</dl>
<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>
<p>
        Following actions are supported.
        <ul>
        <li>IsortFormattingAction.Sort - the import statement sorting is performed</li>
        <li>IsortFormattingAction.Check - a check is performed, if import statement
            resorting is necessary</li>
        <li>IsortFormattingAction.Diff - a unified diff of potential import statement
            changes is generated</li>
        </ul>
</p>

<dl>

<dt><i>action</i> (IsortFormattingAction)</dt>
<dd>
sorting operation to be performed
</dd>
</dl>
<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>
<dd>
line contents when the delay timer was started
</dd>
<dt><i>lastCursorPosition</i> (tuple of (int, int))</dt>
<dd>
position of the cursor when the delay timer
            was started (line and index)
</dd>
</dl>
<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>
<dd>
reference to the printer object
</dd>
</dl>
<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>
<dd>
string containing the command parameters
</dd>
</dl>
<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>
list of change flags
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<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>
<dd>
string containing the command parameters
</dd>
</dl>
<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>
<dd>
string containing the command parameters
</dd>
</dl>
<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>
<dd>
string containing the command parameters
</dd>
</dl>
<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>
<dd>
filename of the file
</dd>
<dt><i>msg</i> (str)</dt>
<dd>
error message
</dd>
</dl>
<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>
<dd>
filename of the checked file
</dd>
<dt><i>problems</i> (dict)</dt>
<dd>
dictionary with the keys 'error' and 'warnings' which
            hold a list containing details about the error/ warnings
            (file name, line number, column, codestring (only at syntax
            errors), the message)
</dd>
</dl>
<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>
<dd>
reference to the action that was triggered
</dd>
</dl>
<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>
<dd>
completion text
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
modified completion text
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<dd>
flag indicating to propagate the change
</dd>
</dl>
<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>
<dd>
flag indicating a 'save as' action (defaults to False)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating success
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
flag indicating the search direction
</dd>
</dl>
<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>
name of the selected pygments lexer
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<dd>
command token
</dd>
<dt><i>args</i> (str)</dt>
<dd>
arguments for the command
</dd>
</dl>
<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>
<dd>
number of the line that needs annotation
</dd>
</dl>
<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>
<dd>
spell checking language to be set
</dd>
<dt><i>pwl</i> (str)</dt>
<dd>
name of the personal/project word list
</dd>
<dt><i>pel</i> (str)</dt>
<dd>
name of the personal/project exclude list
</dd>
</dl>
<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>
flag indicating this editor should be saved
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
completions to be shown
</dd>
</dl>
<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>
<dd>
position for the context menu
</dd>
</dl>
<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>
<dd>
reference to the menu to be shown
</dd>
</dl>
<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>
<dd>
mouse position into the document
</dd>
<dt><i>x</i> (int)</dt>
<dd>
x-value of mouse screen position
</dd>
<dt><i>y</i> (int)</dt>
<dd>
y-value of mouse screen position
</dd>
</dl>
<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>
<dd>
line number to show the syntax error for
</dd>
</dl>
<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>
<dd>
line number to show the warning for
</dd>
</dl>
<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>
<dd>
value of the character entered
</dd>
</dl>
<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>
<dd>
new spell check language
</dd>
<dt><i>propagate</i> (bool)</dt>
<dd>
flag indicating to propagate the change
</dd>
</dl>
<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>
<dd>
reference to the action that was triggered
</dd>
</dl>
<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>
<dd>
end position, that needs styling
</dd>
</dl>
<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>
<p>
        This slot defers the handling to the next time the event loop
        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>
<p>
        If the editor contains selected text and the start line is not commented, it
        will be commented. Otherwise the selection will be un-commented. In case there
        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>
<dd>
line number of the breakpoint
</dd>
<dt><i>temporary</i> (bool)</dt>
<dd>
flag indicating a temporary breakpoint
</dd>
</dl>
<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>
<dd>
line number of the breakpoint
</dd>
</dl>
<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>
<p>
        If the editor contains selected text and the start line is not commented, it
        will be commented. Otherwise the selection will be un-commented. In case there
        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>
<p>
        If bForce is True, then updates everything regardless if
        the attributes have actually changed, such as during
        initialization time.  A signal is emitted after the
        caption change.
</p>

<dl>

<dt><i>bForce</i> (bool)</dt>
<dd>
True to force change, False to only update and emit
                signal if there was an attribute change.
</dd>
</dl>
<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>
<dd>
name of the provider
</dd>
<dt><i>func</i> (function(editor, int, int) -> list of str)</dt>
<dd>
function providing calltips. func
            should be a function taking a reference to the editor,
            a position into the text and the amount of commas to the
            left of the cursor. It should return the possible
            calltips as a list of strings.
</dd>
</dl>
<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>
<dd>
reference to the cloned editor
</dd>
</dl>
<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>
<dd>
name of the provider
</dd>
<dt><i>func</i> (function(editor, bool) -> list of str in case async is False)</dt>
<dd>
function providing completion list. func
            should be a function taking a reference to the editor and
            a boolean indicating to complete a context. It should return
            the possible completions as a list of strings.
            and function(editor, bool, str) returning nothing in case async
            is True
</dd>
<dt><i>asynchroneous</i> (bool)</dt>
<dd>
flag indicating an asynchroneous function
</dd>
</dl>
<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>
<dd>
flag indicating a call from the __charAdded method
</dd>
<dt><i>context</i> (bool)</dt>
<dd>
flag indicating to complete a context
</dd>
</dl>
<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>
flag indicating autocompletion from APIs is available
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating the availability of calltips
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating the availability of dynamic auto-completion
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
flag indicating to send the CancelEdit command
</dd>
</dl>
<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>
<p>
        This implements special handling for the events showMaximized,
        showMinimized and showNormal. The windows caption is shortened
        for the minimized mode and reset to the full filename for the
        other modes. This is to make the editor windows work nicer
        with the QWorkspace.
</p>

<dl>

<dt><i>evt</i> (QEvent)</dt>
<dd>
the event, that was generated
</dd>
</dl>
<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>
flag indicating successful reset of the dirty flag
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicate a 'read only' state
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<p>
        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>
<dd>
line number of the breakpoint
</dd>
</dl>
<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>
<dd>
line of the highlight start
</dd>
<dt><i>startIndex</i> (int)</dt>
<dd>
index of the highlight start
</dd>
<dt><i>endLine</i> (int)</dt>
<dd>
line of the highlight end
</dd>
<dt><i>endIndex</i> (int)</dt>
<dd>
index of the highlight end
</dd>
</dl>
<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>
<p>
        This overwritten method redirects the action to our
        ViewManager.closeEditor, which in turn calls our closeIt
        method.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating a successful close of the editor
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
flag indicating to not show any dialog (defaults to
            False)
</dd>
<dt><i>coverageFile</i> (str (optional))</dt>
<dd>
path of the file containing the code coverage data
            (defaults to None)
</dd>
</dl>
<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>
<dd>
number of line to be expanded
</dd>
</dl>
<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>
<p>
        If the lexer supports a block comment, that is used for commenting.
        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>
<dd>
list of possible completions
</dd>
<dt><i>acText</i> (str)</dt>
<dd>
text to be completed
</dd>
</dl>
<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>
<p>
        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>
<dd>
end-of-line mode
</dd>
</dl>
<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>
flag indicating the presence of a breakpoint
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
type of the displayed file or an empty string
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<dd>
the drag enter event
</dd>
</dl>
<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>
<dd>
the drag leave event
</dd>
</dl>
<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>
<dd>
the drag move event
</dd>
</dl>
<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>
<dd>
the drop event
</dd>
</dl>
<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>
<dd>
the scintilla command to be performed
</dd>
</dl>
<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>
<dd>
string to use to enclose the selection
                (one or two characters)
</dd>
</dl>
<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>
<dd>
line number to make visible
</dd>
<dt><i>expand</i> (bool)</dt>
<dd>
flag indicating to expand all folds
</dd>
</dl>
<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>
<dd>
line number to make visible
</dd>
<dt><i>expand</i> (bool)</dt>
<dd>
flag indicating to expand all folds
</dd>
</dl>
<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>
<dd>
reference to the event
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating, if the event was handled
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
number of line to be expanded
</dd>
</dl>
<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>
<dd>
format the file should be exported into
</dd>
</dl>
<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>
<dd>
filename to be set for the editor
</dd>
</dl>
<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>
<p>
        This method checks for modifications of the current file and
        rereads it upon request. The cursor is placed at the current position
        assuming, that it is in the vicinity of the old position after the
        reread.
</p>

<dl>

<dt><i>event</i> (QFocusEvent)</dt>
<dd>
the event object
</dd>
</dl>
<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>
<dd>
the event object
</dd>
</dl>
<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>
<dd>
reference to the gesture event
</dd>
</dl>
<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>
API language
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
list of lines containing a bookmark
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of int
</dd>
</dl>
<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>
sorted list of all lines containing a bookmark
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of int
</dd>
</dl>
<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>
list of lines containing a breakpoint
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of int
</dd>
</dl>
<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>
<dd>
name of the provider
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
function providing calltips
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
function or None
</dd>
</dl>
<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>
list of lines containing a change
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of int
</dd>
</dl>
<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>
the completer object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
CompleterBase
</dd>
</dl>
<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>
<dd>
name of the provider
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
function providing completion list
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
function or None
</dd>
</dl>
<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>
list of lines containing a coverage marker
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of int
</dd>
</dl>
<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>
the word at that current position
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
tuple with start and end indexes of the current word
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (int, int)
</dd>
</dl>
<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>
reference to the docstring generator
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
BaseDocstringGenerator
</dd>
</dl>
<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>
<dd>
Preferences option key
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
value of requested setting
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
Any
</dd>
</dl>
<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>
current encoding
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
filename of the displayed file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
type of the displayed file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
type of the displayed file, if set by an eflag: marker or an
            empty string
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
line number of the highlight bar
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<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>
<dd>
flag indicating to normalize some Pygments
            lexer names
</dd>
<dt><i>forPygments</i> (bool)</dt>
<dd>
flag indicating to normalize some lexer
            names for Pygments
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
language of the editor
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
the lexer object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
Lexer
</dd>
</dl>
<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>
<dd>
name of the menu
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the requested menu or None
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<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>
<dd>
keyboard modifiers of the handler
</dd>
<dt><i>button</i> (Qt.MouseButton)</dt>
<dd>
mouse button of the handler
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
plug-in name and registered function
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of str and func
</dd>
</dl>
<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>
<dd>
name of the plug-in
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
registered mouse click handlers as list of modifiers,
            mouse button and function
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of tuple of (Qt.KeyboardModifiers, Qt.MouseButton, func)
</dd>
</dl>
<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>
display string for this unnamed editor
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
list of lines containing a search indicator
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of int
</dd>
</dl>
<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>
tuple containing the start line and index and the end line and index
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (int, int, int, int)
</dd>
</dl>
<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>
<dd>
flag indicating that only selected text should be
            returned
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
selection or current word
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
tuple indicating, if the editor is sharable, the sharing
            status, if it is inside a locally initiated shared edit session
            and if it is inside a remotely initiated shared edit session
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (bool, bool, bool, bool)
</dd>
</dl>
<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>
current spelling language
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
list of lines containing a syntax error
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of int
</dd>
</dl>
<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>
list of lines containing a task
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of int
</dd>
</dl>
<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>
list of line numbers containg a VCS conflict marker
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of int
</dd>
</dl>
<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>
list of lines containing a warning
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of int
</dd>
</dl>
<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>
<dd>
number of line to look at
</dd>
<dt><i>index</i> (int)</dt>
<dd>
position to look at
</dd>
<dt><i>direction</i> (int)</dt>
<dd>
direction to look in (0 = whole word, 1 = left,
            2 = right)
</dd>
<dt><i>useWordChars</i> (bool (optional))</dt>
<dd>
flag indicating to use the wordCharacters
            method (defaults to True)
</dd>
<dt><i>forCompletion</i> (bool (optional))</dt>
<dd>
flag indicating a modification for completions (defaults
            to False)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
the word at that position
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<dd>
number of line to look at
</dd>
<dt><i>index</i> (int)</dt>
<dd>
position to look at
</dd>
<dt><i>useWordChars</i> (bool (optional))</dt>
<dd>
flag indicating to use the wordCharacters
            method (defaults to True)
</dd>
<dt><i>forCompletion</i> (bool (optional))</dt>
<dd>
flag indicating a modification for completions (defaults
            to False)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
tuple with start and end indexes of the word at the position
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (int, int)
</dd>
</dl>
<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>
<dd>
number of line to look at
</dd>
<dt><i>index</i> (int)</dt>
<dd>
position to look at
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
the word to the left of that position
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<dd>
number of line to look at
</dd>
<dt><i>index</i> (int)</dt>
<dd>
position to look at
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
the word to the right of that position
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<dd>
line number to go to
</dd>
<dt><i>pos</i> (int)</dt>
<dd>
position in line to go to
</dd>
<dt><i>firstVisible</i> (bool)</dt>
<dd>
flag indicating to make the line the first
            visible line
</dd>
<dt><i>expand</i> (bool)</dt>
<dd>
flag indicating to expand all folds
</dd>
</dl>
<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>
<dd>
flag indicating the move direction
</dd>
</dl>
<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>
<dd>
list of references for a 'goto' action
</dd>
</dl>
<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>
<dd>
filename to be set for the editor
</dd>
</dl>
<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>
flag indicating the presence of bookmarks
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating the presence of breakpoints
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating the presence of change markers
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating the presence of coverage markers
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating a minimized context menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating the presence of syntax errors
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating the presence of task markers
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating the presence of warnings
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
line number to highlight
</dd>
<dt><i>error</i> (bool)</dt>
<dd>
flag indicating whether the error highlight should be
            used
</dd>
<dt><i>syntaxError</i> (bool)</dt>
<dd>
flag indicating a syntax error
</dd>
</dl>
<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>
<dd>
line of the selection start
</dd>
<dt><i>startIndex</i> (int)</dt>
<dd>
index of the selection start
</dd>
<dt><i>endLine</i> (int)</dt>
<dd>
line of the selection end
</dd>
<dt><i>endIndex</i> (int)</dt>
<dd>
index of the selection end
</dd>
</dl>
<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.
</p>
<p>
        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>
<dd>
reference to the cloned editor
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a clone
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating a Cython file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating a Javascript file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating availability
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating a MicroPython file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating a project file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating a Python3 file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating a Python3 file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
flag indicating a Ruby file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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.
</p>
<p>
        For files with a configured full text file extension all regions will
        be regarded as to be checked. Depending on configuration, all unknown
        files (i.e. those without a file extension) will be checked fully as
        well.
</p>

<dl>

<dt><i>pos</i> (int)</dt>
<dd>
position to be checked
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating pos is in a spell check region
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
key event
</dd>
</dl>
<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>
<dd>
line number of the breakpoint to edit
</dd>
</dl>
<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>
<dd>
reference to the mouse event
</dd>
</dl>
<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>
<dd>
the mouse press event
</dd>
</dl>
<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>
<dd>
event object
</dd>
</dl>
<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>
<dd>
line number of the breakpoint
</dd>
<dt><i>properties</i> (tuple of (str, bool, bool, int))</dt>
<dd>
properties for the breakpoint
                (condition, temporary flag, enabled flag, ignore count)
</dd>
</dl>
<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>
<dd>
filename to read from
</dd>
<dt><i>createIt</i> (bool (optional))</dt>
<dd>
flag indicating the creation of a new file, if the
            given one doesn't exist (defaults to False)
</dd>
<dt><i>encoding</i> (str (optional))</dt>
<dd>
encoding to be used to read the file (defaults to "")
            (Note: this parameter overrides encoding detection)
</dd>
<dt><i>noempty</i> (bool (optional))</dt>
<dd>
flag indicating to not set an empty text (defaults to False)
</dd>
</dl>
<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>
<dd>
command string
</dd>
</dl>
<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>
<p>
        Note: Only one plugin should provide this function. Otherwise
        the last one wins.
</p>

<dl>

<dt><i>func</i> (func)</dt>
<dd>
function accepting a reference to the calling editor and
            the line and column position (zero based each)
</dd>
</dl>
<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>
<dd>
name of the provider
</dd>
</dl>
<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>
<dd>
reference to the cloned editor
</dd>
</dl>
<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>
<dd>
name of the provider
</dd>
</dl>
<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>
<dd>
keyboard modifiers of the handler
</dd>
<dt><i>button</i> (Qt.MouseButton)</dt>
<dd>
mouse button of the handler
</dd>
</dl>
<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>
<dd>
name of the plug-in
</dd>
</dl>
<a NAME="Editor.resetDocstringGenerator" ID="Editor.resetDocstringGenerator"></a>
<h4>Editor.resetDocstringGenerator</h4>
<b>resetDocstringGenerator</b>(<i></i>)
<p>
        Public method to reset the current docstring generator.
</p>

<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>
<dd>
reference to the resize event
</dd>
</dl>
<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>
<dd>
flag indicating a 'save as' action
</dd>
<dt><i>path</i> (str)</dt>
<dd>
directory to save the file in
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating success
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
directory to save the file in
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
tuple containing a success indicator and the name of the saved file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (bool, str)
</dd>
</dl>
<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>
<dd>
directory to save the file in
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating success
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
number of line to look at
</dd>
<dt><i>index</i> (int)</dt>
<dd>
position to look at
</dd>
</dl>
<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>
<dd>
flag indicating the desired autocompletion status
</dd>
</dl>
<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>
<dd>
name of the current file
</dd>
</dl>
<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>
<dd>
line of the highlight start
</dd>
<dt><i>startIndex</i> (int)</dt>
<dd>
index of the highlight start
</dd>
<dt><i>endLine</i> (int)</dt>
<dd>
line of the highlight end
</dd>
<dt><i>endIndex</i> (int)</dt>
<dd>
index of the highlight end
</dd>
</dl>
<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>
<dd>
filename used to determine the associated lexer
            language
</dd>
<dt><i>initTextDisplay</i> (bool)</dt>
<dd>
flag indicating an initialization of the text
            display is required as well
</dd>
<dt><i>propagate</i> (bool)</dt>
<dd>
flag indicating to propagate the change
</dd>
<dt><i>pyname</i> (str)</dt>
<dd>
name of the pygments lexer to use
</dd>
</dl>
<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>
<dd>
flag to indicate usage of a monospace font
</dd>
</dl>
<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>
<dd>
name of the plug-in (or 'internal') setting this handler
</dd>
<dt><i>modifiers</i> (Qt.KeyboardModifiers or int)</dt>
<dd>
keyboard modifiers of the handler
</dd>
<dt><i>button</i> (Qt.MouseButton or int)</dt>
<dd>
mouse button of the handler
</dd>
<dt><i>function</i> (func)</dt>
<dd>
handler function
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating success
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
display string for this unnamed editor
</dd>
</dl>
<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>
<dd>
start position of the indicator
</dd>
<dt><i>indicLength</i> (int)</dt>
<dd>
length of the indicator
</dd>
</dl>
<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>
<dd>
flag indicating the connected state
</dd>
</dl>
<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>
<dd>
flag indicating the share status
</dd>
</dl>
<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>
<dd>
line of mouse cursor position
</dd>
<dt><i>index</i> (int)</dt>
<dd>
column of mouse cursor position
</dd>
<dt><i>data</i> (str)</dt>
<dd>
information text to be shown
</dd>
</dl>
<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>
<dd>
line number of the bookmark
</dd>
</dl>
<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>
<p>
        If the lexer supports a block comment, that is used for toggling the
        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>
<dd>
line number of the syntax error
</dd>
<dt><i>index</i> (int)</dt>
<dd>
index number of the syntax error
</dd>
<dt><i>setError</i> (bool)</dt>
<dd>
flag indicating if the error marker should be
            set or deleted
</dd>
<dt><i>msg</i> (str)</dt>
<dd>
error message
</dd>
<dt><i>show</i> (bool)</dt>
<dd>
flag indicating to set the cursor to the error position
</dd>
</dl>
<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>
<dd>
line number of the warning
</dd>
<dt><i>col</i> (int)</dt>
<dd>
column of the warning
</dd>
<dt><i>setWarning</i> (bool)</dt>
<dd>
flag indicating if the warning marker should be
            set or deleted
</dd>
<dt><i>msg</i> (str)</dt>
<dd>
warning message
</dd>
<dt><i>warningType</i> (EditorWarningKind)</dt>
<dd>
type of warning message
</dd>
</dl>
<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>
<p>
        If the lexer supports a block comment, that is used for uncommenting.
        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>
<dd>
function accepting a reference to the calling editor and
            the line and column position (zero based each)
</dd>
</dl>
<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>
<dd>
reference to the event
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indiating that the event was handled
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
reference to the wheel event
</dd>
</dl>
<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>
<dd>
filename to write to
</dd>
<dt><i>backup</i> (bool)</dt>
<dd>
flag indicating to save a backup
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating success
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<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>
</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>
</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>