eric: comparison src/eric7/Documentation/Source/eric7.QScintilla.Editor.html

-:e26fa3b06f4f
+:e6e270b705c2
 <h3>Derived from</h3>
 QsciScintillaCompat
 <h3>Class Attributes</h3>
 <table>
-<tr><td>AttributeID</td></tr><tr><td>AttributePrivateID</td></tr><tr><td>AttributeProtectedID</td></tr><tr><td>CancelEditToken</td></tr><tr><td>ClassID</td></tr><tr><td>ClassPrivateID</td></tr><tr><td>ClassProtectedID</td></tr><tr><td>EncloseChars</td></tr><tr><td>EndEditToken</td></tr><tr><td>EnumID</td></tr><tr><td>FromDocumentID</td></tr><tr><td>KeywordsID</td></tr><tr><td>MethodID</td></tr><tr><td>MethodPrivateID</td></tr><tr><td>MethodProtectedID</td></tr><tr><td>ModuleID</td></tr><tr><td>RequestSyncToken</td></tr><tr><td>Separator</td></tr><tr><td>StartEditToken</td></tr><tr><td>SyncToken</td></tr><tr><td>TemplateImageID</td></tr><tr><td>VcsConflictMarkerLineRegExpList</td></tr><tr><td>WarningCode</td></tr><tr><td>WarningPython</td></tr><tr><td>WarningStyle</td></tr>
+<tr><td>AttributeID</td></tr><tr><td>AttributePrivateID</td></tr><tr><td>AttributeProtectedID</td></tr><tr><td>CancelEditToken</td></tr><tr><td>ClassID</td></tr><tr><td>ClassPrivateID</td></tr><tr><td>ClassProtectedID</td></tr><tr><td>EncloseChars</td></tr><tr><td>EndEditToken</td></tr><tr><td>EnumID</td></tr><tr><td>FromDocumentID</td></tr><tr><td>KeywordsID</td></tr><tr><td>MethodID</td></tr><tr><td>MethodPrivateID</td></tr><tr><td>MethodProtectedID</td></tr><tr><td>ModuleID</td></tr><tr><td>RequestSyncToken</td></tr><tr><td>Separator</td></tr><tr><td>StartEditToken</td></tr><tr><td>SyncToken</td></tr><tr><td>TemplateImageID</td></tr><tr><td>VcsConflictMarkerLineRegExpList</td></tr><tr><td>WarningCode</td></tr><tr><td>WarningInfo</td></tr><tr><td>WarningPython</td></tr><tr><td>WarningStyle</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></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 slot to set the correct typing completer depending on language.</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 slot to set the correct lexer depending on language.</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>
 <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 slot to clear all breakpoints.</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>
 <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.__languageChanged">__languageChanged</a></td>
-<td>Private slot handling a change of a connected editor's language.</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>
 <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 slot to pop up a menu asking the user, if a docstring should be inserted.</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>
 <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 slot to set the spell checking language.</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>
 <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 slot to cancel a shared edit session for the editor.</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.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><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 slot to collapse the current fold including its children.</td>
+<td>Public method to collapse the current fold including its children.</td>
 </tr>
 <tr>
 <td><a href="#Editor.commentLine">commentLine</a></td>
 <td>Public slot to comment the current line.</td>
 </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 slot to ensure, that the specified line is visible.</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 slot to ensure, that the specified line is visible at the top of the editor.</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 slot to expand the current fold including its children.</td>
+<td>Public method to expand the current fold including its children.</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.getSyntaxErrorLines">getSyntaxErrorLines</a></td>
 <td>Public method to get the lines containing a syntax error.</td>
 </tr>
 <tr>
-<td><a href="#Editor.getSyntaxErrors">getSyntaxErrors</a></td>
-<td>Public method to retrieve the syntax error markers.</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>
 <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.getWarnings">getWarnings</a></td>
-<td>Public method to retrieve the warning markers.</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><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 slot to jump to the beginning of a line.</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>
 <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 slot to handle the editorRenamed signal.</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>
 <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 slot to read the text from a file.</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>
 <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 slot to save a file with a new name.</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>
 <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 slot to handle a change of the connected state.</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 slot to set the shared status of the editor.</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.shouldAutosave">shouldAutosave</a></td>
-<td>Public slot to check the autosave flags.</td>
+<td>Public method to check the autosave flags.</td>
 </tr>
 <tr>
 <td><a href="#Editor.showMouseHoverHelpData">showMouseHoverHelpData</a></td>
 <td>Public method to show the mouse hover help data.</td>
 </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 slot to write the text to a file.</td>
+<td>Public method to write the text to a file.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <p>
 Private slot to add breakpoints.
 </p>
 <dl>
-<dt><i>parentIndex</i></dt>
+<dt><i>parentIndex</i> (QModelIndex)</dt>
 <dd>
-index of parent item (QModelIndex)
+index of parent item
 </dd>
-<dt><i>start</i></dt>
+<dt><i>start</i> (int)</dt>
 <dd>
-start row (integer)
+start row
 </dd>
-<dt><i>end</i></dt>
+<dt><i>end</i> (int)</dt>
 <dd>
-end row (integer)
+end row
 </dd>
 </dl>
 <a NAME="Editor.__addFileAliasResource" ID="Editor.__addFileAliasResource"></a>
 <h4>Editor.__addFileAliasResource</h4>
 <b>__addFileAliasResource</b>(<i></i>)
 <a NAME="Editor.__bindCompleter" ID="Editor.__bindCompleter"></a>
 <h4>Editor.__bindCompleter</h4>
 <b>__bindCompleter</b>(<i>filename</i>)
 <p>
-Private slot to set the correct typing completer depending on language.
+Private method to set the correct typing completer depending on language.
 </p>
 <dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
 filename used to determine the associated typing
-completer language (string)
+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 slot to set the correct lexer depending on language.
+Private method to set the correct lexer depending on language.
 </p>
 <dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
 filename used to determine the associated lexer
-language (string)
+language
 </dd>
-<dt><i>pyname</i></dt>
+<dt><i>pyname</i> (str)</dt>
 <dd>
-name of the pygments lexer to use (string)
+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>)
 Private slot to handle the dataAboutToBeChanged signal of the
 breakpoint model.
 </p>
 <dl>
-<dt><i>startIndex</i></dt>
+<dt><i>startIndex</i> (QModelIndex)</dt>
 <dd>
-start index of the rows to be changed (QModelIndex)
+start index of the rows to be changed
 </dd>
-<dt><i>endIndex</i></dt>
+<dt><i>endIndex</i> (QModelIndex)</dt>
 <dd>
-end index of the rows to be changed (QModelIndex)
+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 slot to set changed breakpoints.
 </p>
 <dl>
-<dt><i>startIndex</i></dt>
+<dt><i>startIndex</i> (QModelIndex)</dt>
 <dd>
 start index of the breakpoints being changed
-(QModelIndex)
+</dd>
-</dd>
+<dt><i>endIndex</i> (QModelIndex)</dt>
-<dt><i>endIndex</i></dt>
 <dd>
 end index of the breakpoints being changed
-(QModelIndex)
 </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></dt>
+<dt><i>charNumber</i> (int)</dt>
 <dd>
-value of the character entered (integer)
+value of the character entered
 </dd>
 </dl>
 <a NAME="Editor.__checkEncoding" ID="Editor.__checkEncoding"></a>
 <h4>Editor.__checkEncoding</h4>
 <b>__checkEncoding</b>(<i></i>)
 <a NAME="Editor.__clearBreakpoints" ID="Editor.__clearBreakpoints"></a>
 <h4>Editor.__clearBreakpoints</h4>
 <b>__clearBreakpoints</b>(<i>fileName</i>)
 <p>
-Private slot to clear all breakpoints.
+Private method to clear all breakpoints.
 </p>
 <dl>
-<dt><i>fileName</i></dt>
+<dt><i>fileName</i> (str)</dt>
 <dd>
-name of the file (string)
+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 slot to handle the selection from the completion list.
 </p>
 <dl>
-<dt><i>listId</i></dt>
+<dt><i>listId</i> (int)</dt>
 <dd>
-the ID of the user list (should be 1 or 2) (integer)
+the ID of the user list (should be 1 or 2)
 </dd>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
 <dd>
-the selected text (string)
+the selected text
 </dd>
 </dl>
 <a NAME="Editor.__contextClose" ID="Editor.__contextClose"></a>
 <h4>Editor.__contextClose</h4>
 <b>__contextClose</b>(<i></i>)
 Private slot to handle the selection of a suggestion of the spelling
 context menu.
 </p>
 <dl>
-<dt><i>action</i></dt>
+<dt><i>action</i> (QAction)</dt>
 <dd>
-reference to the action that was selected (QAction)
+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>)
 It emits the signal cursorChanged with parameters fileName,
 line and pos.
 </p>
 <dl>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int)</dt>
 <dd>
 line number of the cursor
 </dd>
-<dt><i>index</i></dt>
+<dt><i>index</i> (int)</dt>
 <dd>
 position in line of the cursor
 </dd>
 </dl>
 <a NAME="Editor.__delayedDocstringMenuPopup" ID="Editor.__delayedDocstringMenuPopup"></a>
 <p>
 Private slot to delete breakpoints.
 </p>
 <dl>
-<dt><i>parentIndex</i></dt>
+<dt><i>parentIndex</i> (QModelIndex)</dt>
 <dd>
-index of parent item (QModelIndex)
+index of parent item
 </dd>
-<dt><i>start</i></dt>
+<dt><i>start</i> (int)</dt>
 <dd>
-start row (integer)
+start row
 </dd>
-<dt><i>end</i></dt>
+<dt><i>end</i> (int)</dt>
 <dd>
-end row (integer)
+end row
 </dd>
 </dl>
 <a NAME="Editor.__deselectAll" ID="Editor.__deselectAll"></a>
 <h4>Editor.__deselectAll</h4>
 <b>__deselectAll</b>(<i></i>)
 <p>
 Private slot to handle a change of the encoding.
 </p>
 <dl>
-<dt><i>encoding</i></dt>
+<dt><i>encoding</i> (str)</dt>
 <dd>
-changed encoding (string)
+changed encoding
 </dd>
-<dt><i>propagate</i></dt>
+<dt><i>propagate</i> (bool)</dt>
 <dd>
-flag indicating to propagate the change (boolean)
+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>)
 <a NAME="Editor.__languageChanged" ID="Editor.__languageChanged"></a>
 <h4>Editor.__languageChanged</h4>
 <b>__languageChanged</b>(<i>language, propagate=True</i>)
 <p>
-Private slot handling a change of a connected editor's language.
+Private method handling a change of a connected editor's language.
 </p>
 <dl>
 <dt><i>language</i></dt>
 <dd>
 <p>
 Private slot to handle the marginClicked signal.
 </p>
 <dl>
-<dt><i>margin</i></dt>
+<dt><i>margin</i> (int)</dt>
 <dd>
-id of the clicked margin (integer)
+id of the clicked margin
 </dd>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int)</dt>
 <dd>
-line number of the click (integer)
+line number of the click
 </dd>
-<dt><i>modifiers</i></dt>
+<dt><i>modifiers</i> (Qt.KeyboardModifiers)</dt>
 <dd>
-keyboard modifiers (Qt.KeyboardModifiers)
+keyboard modifiers
 </dd>
 </dl>
 <a NAME="Editor.__marginNumber" ID="Editor.__marginNumber"></a>
 <h4>Editor.__marginNumber</h4>
 <b>__marginNumber</b>(<i>xPos</i>)
 It emits the signal modificationStatusChanged with parameters
 m and self.
 </p>
 <dl>
-<dt><i>m</i></dt>
+<dt><i>m</i> (bool)</dt>
 <dd>
 modification status
 </dd>
 </dl>
 <a NAME="Editor.__modificationReadOnly" ID="Editor.__modificationReadOnly"></a>
 <a NAME="Editor.__popupDocstringMenu" ID="Editor.__popupDocstringMenu"></a>
 <h4>Editor.__popupDocstringMenu</h4>
 <b>__popupDocstringMenu</b>(<i>lastLineText, lastCursorPosition</i>)
 <p>
-Private slot to pop up a menu asking the user, if a docstring should be
+Private method to pop up a menu asking the user, if a docstring should be
 inserted.
 </p>
 <dl>
 <dt><i>lastLineText</i> (str)</dt>
 <p>
 Private slot to process a remote EndEdit command.
 </p>
 <dl>
-<dt><i>argsString</i></dt>
+<dt><i>argsString</i> (str)</dt>
 <dd>
-string containing the command parameters (string)
+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 slot to process a remote RequestSync command.
 </p>
 <dl>
-<dt><i>argsString</i></dt>
+<dt><i>argsString</i> (str)</dt>
 <dd>
-string containing the command parameters (string)
+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></dt>
+<dt><i>argsString</i> (str)</dt>
 <dd>
-string containing the command parameters (string)
+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></dt>
+<dt><i>argsString</i> (str)</dt>
 <dd>
-string containing the command parameters (string)
+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 the resulting messages of a syntax check.
 </p>
 <dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-filename of the checked file (str)
+filename of the checked file
 </dd>
-<dt><i>problems</i></dt>
+<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) (dict)
+errors), the message)
 </dd>
 </dl>
 <a NAME="Editor.__projectPropertiesChanged" ID="Editor.__projectPropertiesChanged"></a>
 <h4>Editor.__projectPropertiesChanged</h4>
 <b>__projectPropertiesChanged</b>(<i></i>)
 <a NAME="Editor.__setSpellingLanguage" ID="Editor.__setSpellingLanguage"></a>
 <h4>Editor.__setSpellingLanguage</h4>
 <b>__setSpellingLanguage</b>(<i>language, pwl="", pel=""</i>)
 <p>
-Private slot to set the spell checking language.
+Private method to set the spell checking language.
 </p>
 <dl>
 <dt><i>language</i></dt>
 <dd>
 Private slot to handle the 'Show syntax error message'
 context menu action.
 </p>
 <dl>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int)</dt>
 <dd>
-line number to show the syntax error for (integer)
+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></dt>
+<dt><i>line</i> (int)</dt>
 <dd>
-line number to show the warning for (integer)
+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></dt>
+<dt><i>charNumber</i> (int)</dt>
 <dd>
-value of the character entered (integer)
+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 the need for more styling.
 </p>
 <dl>
-<dt><i>position</i></dt>
+<dt><i>position</i> (int)</dt>
 <dd>
-end position, that needs styling (integer)
+end position, that needs styling
 </dd>
 </dl>
 <a NAME="Editor.__textChanged" ID="Editor.__textChanged"></a>
 <h4>Editor.__textChanged</h4>
 <b>__textChanged</b>(<i></i>)
 <a NAME="Editor.cancelSharedEdit" ID="Editor.cancelSharedEdit"></a>
 <h4>Editor.cancelSharedEdit</h4>
 <b>cancelSharedEdit</b>(<i>send=True</i>)
 <p>
-Public slot to cancel a shared edit session for the editor.
+Public method to cancel a shared edit session for the editor.
 </p>
 <dl>
 <dt><i>send</i></dt>
 <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>
 <a NAME="Editor.collapseFoldWithChildren" ID="Editor.collapseFoldWithChildren"></a>
 <h4>Editor.collapseFoldWithChildren</h4>
 <b>collapseFoldWithChildren</b>(<i>line=-1</i>)
 <p>
-Public slot to collapse the current fold including its children.
+Public method to collapse the current fold including its children.
 </p>
 <dl>
 <dt><i>line</i> (int)</dt>
 <dd>
 <a NAME="Editor.ensureVisible" ID="Editor.ensureVisible"></a>
 <h4>Editor.ensureVisible</h4>
 <b>ensureVisible</b>(<i>line, expand=False</i>)
 <p>
-Public slot to ensure, that the specified line is visible.
+Public method to ensure, that the specified line is visible.
 </p>
 <dl>
 <dt><i>line</i> (int)</dt>
 <dd>
 <a NAME="Editor.ensureVisibleTop" ID="Editor.ensureVisibleTop"></a>
 <h4>Editor.ensureVisibleTop</h4>
 <b>ensureVisibleTop</b>(<i>line, expand=False</i>)
 <p>
-Public slot to ensure, that the specified line is visible at the top
+Public method to ensure, that the specified line is visible at the top
 of the editor.
 </p>
 <dl>
 <dt><i>line</i> (int)</dt>
 <a NAME="Editor.expandFoldWithChildren" ID="Editor.expandFoldWithChildren"></a>
 <h4>Editor.expandFoldWithChildren</h4>
 <b>expandFoldWithChildren</b>(<i>line=-1</i>)
 <p>
-Public slot to expand the current fold including its children.
+Public method to expand the current fold including its children.
 </p>
 <dl>
 <dt><i>line</i> (int)</dt>
 <dd>
 <p>
 Public slot to handle the editorRenamed signal.
 </p>
 <dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str.)</dt>
 <dd>
-filename to be set for the editor (string).
+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>)
 <dt>Return:</dt>
 <dd>
 list of lines containing a syntax error (list of integer)
 </dd>
 </dl>
-<a NAME="Editor.getSyntaxErrors" ID="Editor.getSyntaxErrors"></a>
-<h4>Editor.getSyntaxErrors</h4>
-<b>getSyntaxErrors</b>(<i></i>)
-<p>
-Public method to retrieve the syntax error markers.
-</p>
-<dl>
-<dt>Return:</dt>
-<dd>
-sorted list of all lines containing a syntax error
-(list of integer)
-</dd>
-</dl>
 <a NAME="Editor.getTaskLines" ID="Editor.getTaskLines"></a>
 <h4>Editor.getTaskLines</h4>
 <b>getTaskLines</b>(<i></i>)
 <p>
 <dt>Return:</dt>
 <dd>
 list of lines containing a warning (list of integer)
 </dd>
 </dl>
-<a NAME="Editor.getWarnings" ID="Editor.getWarnings"></a>
-<h4>Editor.getWarnings</h4>
-<b>getWarnings</b>(<i></i>)
-<p>
-Public method to retrieve the warning markers.
-</p>
-<dl>
-<dt>Return:</dt>
-<dd>
-sorted list of all lines containing a warning
-(list of integer)
-</dd>
-</dl>
 <a NAME="Editor.getWord" ID="Editor.getWord"></a>
 <h4>Editor.getWord</h4>
 <b>getWord</b>(<i>line, index, direction=0, useWordChars=True</i>)
 <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 slot to jump to the beginning of a line.
+Public method to jump to the beginning of a line.
 </p>
 <dl>
 <dt><i>line</i> (int)</dt>
 <dd>
 <a NAME="Editor.handleRenamed" ID="Editor.handleRenamed"></a>
 <h4>Editor.handleRenamed</h4>
 <b>handleRenamed</b>(<i>fn</i>)
 <p>
-Public slot to handle the editorRenamed signal.
+Public method to handle the editorRenamed signal.
 </p>
 <dl>
 <dt><i>fn</i></dt>
 <dd>
 <p>
 Public slot to handle the 'Edit breakpoint' context menu action.
 </p>
 <dl>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int)</dt>
 <dd>
-linenumber of the breakpoint to edit
+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>)
 <a NAME="Editor.readFile" ID="Editor.readFile"></a>
 <h4>Editor.readFile</h4>
 <b>readFile</b>(<i>fn, createIt=False, encoding=""</i>)
 <p>
-Public slot to read the text from a file.
+Public method to read the text from a file.
 </p>
 <dl>
 <dt><i>fn</i></dt>
 <dd>
 <p>
 Public slot to handle received editor commands.
 </p>
 <dl>
-<dt><i>command</i></dt>
+<dt><i>command</i> (str)</dt>
 <dd>
-command string (string)
+command string
 </dd>
 </dl>
 <a NAME="Editor.redo" ID="Editor.redo"></a>
 <h4>Editor.redo</h4>
 <b>redo</b>(<i></i>)
 <a NAME="Editor.saveFileAs" ID="Editor.saveFileAs"></a>
 <h4>Editor.saveFileAs</h4>
 <b>saveFileAs</b>(<i>path=None</i>)
 <p>
-Public slot to save a file with a new name.
+Public method to save a file with a new name.
 </p>
 <dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-directory to save the file in (string)
+directory to save the file in
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of two values (boolean, string) giving a success
+tuple containing a success indicator and the name of the saved file
-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>)
 <a NAME="Editor.shareConnected" ID="Editor.shareConnected"></a>
 <h4>Editor.shareConnected</h4>
 <b>shareConnected</b>(<i>connected</i>)
 <p>
-Public slot to handle a change of the connected state.
+Public method to handle a change of the connected state.
 </p>
 <dl>
 <dt><i>connected</i></dt>
 <dd>
 <a NAME="Editor.shareEditor" ID="Editor.shareEditor"></a>
 <h4>Editor.shareEditor</h4>
 <b>shareEditor</b>(<i>share</i>)
 <p>
-Public slot to set the shared status of the editor.
+Public method to set the shared status of the editor.
 </p>
 <dl>
 <dt><i>share</i></dt>
 <dd>
 <a NAME="Editor.shouldAutosave" ID="Editor.shouldAutosave"></a>
 <h4>Editor.shouldAutosave</h4>
 <b>shouldAutosave</b>(<i></i>)
 <p>
-Public slot to check the autosave flags.
+Public method to check the autosave flags.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 flag indicating this editor should be saved (boolean)
 <a NAME="Editor.writeFile" ID="Editor.writeFile"></a>
 <h4>Editor.writeFile</h4>
 <b>writeFile</b>(<i>fn, backup=True</i>)
 <p>
-Public slot to write the text to a file.
+Public method to write the text to a file.
 </p>
 <dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-filename to write to (string)
+filename to write to
 </dd>
-<dt><i>backup</i></dt>
+<dt><i>backup</i> (bool)</dt>
 <dd>
-flag indicating to save a backup (boolean)
+flag indicating to save a backup
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>

Mercurial Repositories > eric / file comparison

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

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