diff -r e26fa3b06f4f -r e6e270b705c2 src/eric7/Documentation/Source/eric7.QScintilla.Editor.html
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html Thu Nov 02 16:43:22 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html Fri Nov 03 19:36:14 2023 +0100
@@ -167,7 +167,7 @@
<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>
@@ -240,11 +240,11 @@
</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>
@@ -300,7 +300,7 @@
</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>
@@ -524,7 +524,7 @@
</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>
@@ -612,7 +612,7 @@
</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>
@@ -756,7 +756,7 @@
</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>
@@ -968,7 +968,7 @@
</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>
@@ -1015,6 +1015,10 @@
<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>
@@ -1052,7 +1056,7 @@
</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>
@@ -1104,11 +1108,11 @@
</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>
@@ -1116,7 +1120,7 @@
</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>
@@ -1263,10 +1267,6 @@
<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>
@@ -1279,10 +1279,6 @@
<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>
@@ -1304,7 +1300,7 @@
</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>
@@ -1324,7 +1320,7 @@
</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>
@@ -1560,7 +1556,7 @@
</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>
@@ -1624,7 +1620,7 @@
</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>
@@ -1692,11 +1688,11 @@
</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>
@@ -1704,7 +1700,7 @@
</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>
@@ -1792,7 +1788,7 @@
</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>
@@ -1881,17 +1877,17 @@
</p>
<dl>
-<dt><i>parentIndex</i></dt>
-<dd>
-index of parent item (QModelIndex)
-</dd>
-<dt><i>start</i></dt>
-<dd>
-start row (integer)
-</dd>
-<dt><i>end</i></dt>
-<dd>
-end row (integer)
+<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>
@@ -2019,14 +2015,14 @@
<b>__bindCompleter</b>(<i>filename</i>)
<p>
- Private slot to set the correct typing completer depending on language.
-</p>
-<dl>
-
-<dt><i>filename</i></dt>
+ 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 (string)
+ completer language
</dd>
</dl>
<a NAME="Editor.__bindLexer" ID="Editor.__bindLexer"></a>
@@ -2034,18 +2030,18 @@
<b>__bindLexer</b>(<i>filename, pyname=""</i>)
<p>
- Private slot to set the correct lexer depending on language.
-</p>
-<dl>
-
-<dt><i>filename</i></dt>
+ 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 (string)
-</dd>
-<dt><i>pyname</i></dt>
-<dd>
-name of the pygments lexer to use (string)
+ 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>
@@ -2079,13 +2075,13 @@
</p>
<dl>
-<dt><i>startIndex</i></dt>
-<dd>
-start index of the rows to be changed (QModelIndex)
-</dd>
-<dt><i>endIndex</i></dt>
-<dd>
-end index of the rows to be changed (QModelIndex)
+<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>
@@ -2136,15 +2132,13 @@
</p>
<dl>
-<dt><i>startIndex</i></dt>
+<dt><i>startIndex</i> (QModelIndex)</dt>
<dd>
start index of the breakpoints being changed
- (QModelIndex)
-</dd>
-<dt><i>endIndex</i></dt>
+</dd>
+<dt><i>endIndex</i> (QModelIndex)</dt>
<dd>
end index of the breakpoints being changed
- (QModelIndex)
</dd>
</dl>
<a NAME="Editor.__charAdded" ID="Editor.__charAdded"></a>
@@ -2156,9 +2150,9 @@
</p>
<dl>
-<dt><i>charNumber</i></dt>
-<dd>
-value of the character entered (integer)
+<dt><i>charNumber</i> (int)</dt>
+<dd>
+value of the character entered
</dd>
</dl>
<a NAME="Editor.__checkEncoding" ID="Editor.__checkEncoding"></a>
@@ -2208,13 +2202,13 @@
<b>__clearBreakpoints</b>(<i>fileName</i>)
<p>
- Private slot to clear all breakpoints.
-</p>
-<dl>
-
-<dt><i>fileName</i></dt>
-<dd>
-name of the file (string)
+ 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>
@@ -2256,13 +2250,13 @@
</p>
<dl>
-<dt><i>listId</i></dt>
-<dd>
-the ID of the user list (should be 1 or 2) (integer)
-</dd>
-<dt><i>txt</i></dt>
-<dd>
-the selected text (string)
+<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>
@@ -2296,9 +2290,9 @@
</p>
<dl>
-<dt><i>action</i></dt>
-<dd>
-reference to the action that was selected (QAction)
+<dt><i>action</i> (QAction)</dt>
+<dd>
+reference to the action that was selected
</dd>
</dl>
<a NAME="Editor.__contextSave" ID="Editor.__contextSave"></a>
@@ -2366,11 +2360,11 @@
</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>
@@ -2405,17 +2399,17 @@
</p>
<dl>
-<dt><i>parentIndex</i></dt>
-<dd>
-index of parent item (QModelIndex)
-</dd>
-<dt><i>start</i></dt>
-<dd>
-start row (integer)
-</dd>
-<dt><i>end</i></dt>
-<dd>
-end row (integer)
+<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>
@@ -2448,13 +2442,13 @@
</p>
<dl>
-<dt><i>encoding</i></dt>
-<dd>
-changed encoding (string)
-</dd>
-<dt><i>propagate</i></dt>
-<dd>
-flag indicating to propagate the change (boolean)
+<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>
@@ -3043,7 +3037,7 @@
<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>
@@ -3143,17 +3137,17 @@
</p>
<dl>
-<dt><i>margin</i></dt>
-<dd>
-id of the clicked margin (integer)
-</dd>
-<dt><i>line</i></dt>
-<dd>
-line number of the click (integer)
-</dd>
-<dt><i>modifiers</i></dt>
-<dd>
-keyboard modifiers (Qt.KeyboardModifiers)
+<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.__marginNumber" ID="Editor.__marginNumber"></a>
@@ -3219,7 +3213,7 @@
</p>
<dl>
-<dt><i>m</i></dt>
+<dt><i>m</i> (bool)</dt>
<dd>
modification status
</dd>
@@ -3376,7 +3370,7 @@
<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>
@@ -3415,9 +3409,9 @@
</p>
<dl>
-<dt><i>argsString</i></dt>
-<dd>
-string containing the command parameters (string)
+<dt><i>argsString</i> (str)</dt>
+<dd>
+string containing the command parameters
</dd>
</dl>
<a NAME="Editor.__processFlags" ID="Editor.__processFlags"></a>
@@ -3442,9 +3436,9 @@
</p>
<dl>
-<dt><i>argsString</i></dt>
-<dd>
-string containing the command parameters (string)
+<dt><i>argsString</i> (str)</dt>
+<dd>
+string containing the command parameters
</dd>
</dl>
<a NAME="Editor.__processStartEditCommand" ID="Editor.__processStartEditCommand"></a>
@@ -3456,9 +3450,9 @@
</p>
<dl>
-<dt><i>argsString</i></dt>
-<dd>
-string containing the command parameters (string)
+<dt><i>argsString</i> (str)</dt>
+<dd>
+string containing the command parameters
</dd>
</dl>
<a NAME="Editor.__processSyncCommand" ID="Editor.__processSyncCommand"></a>
@@ -3470,9 +3464,9 @@
</p>
<dl>
-<dt><i>argsString</i></dt>
-<dd>
-string containing the command parameters (string)
+<dt><i>argsString</i> (str)</dt>
+<dd>
+string containing the command parameters
</dd>
</dl>
<a NAME="Editor.__processSyntaxCheckError" ID="Editor.__processSyntaxCheckError"></a>
@@ -3502,16 +3496,16 @@
</p>
<dl>
-<dt><i>fn</i></dt>
-<dd>
-filename of the checked file (str)
-</dd>
-<dt><i>problems</i></dt>
+<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) (dict)
+ errors), the message)
</dd>
</dl>
<a NAME="Editor.__projectPropertiesChanged" ID="Editor.__projectPropertiesChanged"></a>
@@ -3793,7 +3787,7 @@
<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>
@@ -4056,9 +4050,9 @@
</p>
<dl>
-<dt><i>line</i></dt>
-<dd>
-line number to show the syntax error for (integer)
+<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>
@@ -4070,9 +4064,9 @@
</p>
<dl>
-<dt><i>line</i></dt>
-<dd>
-line number to show the warning for (integer)
+<dt><i>line</i> (int)</dt>
+<dd>
+line number to show the warning for
</dd>
</dl>
<a NAME="Editor.__spellCharAdded" ID="Editor.__spellCharAdded"></a>
@@ -4084,9 +4078,9 @@
</p>
<dl>
-<dt><i>charNumber</i></dt>
-<dd>
-value of the character entered (integer)
+<dt><i>charNumber</i> (int)</dt>
+<dd>
+value of the character entered
</dd>
</dl>
<a NAME="Editor.__spellLanguageChanged" ID="Editor.__spellLanguageChanged"></a>
@@ -4130,9 +4124,9 @@
</p>
<dl>
-<dt><i>position</i></dt>
-<dd>
-end position, that needs styling (integer)
+<dt><i>position</i> (int)</dt>
+<dd>
+end position, that needs styling
</dd>
</dl>
<a NAME="Editor.__textChanged" ID="Editor.__textChanged"></a>
@@ -4383,7 +4377,7 @@
<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>
@@ -4531,6 +4525,13 @@
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>)
@@ -4625,7 +4626,7 @@
<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>
@@ -4792,7 +4793,7 @@
<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>
@@ -4810,7 +4811,7 @@
<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>
@@ -4855,7 +4856,7 @@
<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>
@@ -4894,9 +4895,9 @@
</p>
<dl>
-<dt><i>fn</i></dt>
-<dd>
-filename to be set for the editor (string).
+<dt><i>fn</i> (str.)</dt>
+<dd>
+filename to be set for the editor
</dd>
</dl>
<a NAME="Editor.focusInEvent" ID="Editor.focusInEvent"></a>
@@ -5468,20 +5469,6 @@
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>)
@@ -5527,20 +5514,6 @@
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>)
@@ -5665,7 +5638,7 @@
<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>
@@ -5734,7 +5707,7 @@
<b>handleRenamed</b>(<i>fn</i>)
<p>
- Public slot to handle the editorRenamed signal.
+ Public method to handle the editorRenamed signal.
</p>
<dl>
@@ -6233,9 +6206,9 @@
</p>
<dl>
-<dt><i>line</i></dt>
-<dd>
-linenumber of the breakpoint to edit
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the breakpoint to edit
</dd>
</dl>
<a NAME="Editor.menuNextBreakpoint" ID="Editor.menuNextBreakpoint"></a>
@@ -6437,7 +6410,7 @@
<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>
@@ -6472,9 +6445,9 @@
</p>
<dl>
-<dt><i>command</i></dt>
-<dd>
-command string (string)
+<dt><i>command</i> (str)</dt>
+<dd>
+command string
</dd>
</dl>
<a NAME="Editor.redo" ID="Editor.redo"></a>
@@ -6650,20 +6623,25 @@
<b>saveFileAs</b>(<i>path=None</i>)
<p>
- Public slot to save a file with a new name.
-</p>
-<dl>
-
-<dt><i>path</i></dt>
-<dd>
-directory to save the file in (string)
+ 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 of two values (boolean, string) giving a success
- indicator and the name of the saved file
+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>
@@ -6920,7 +6898,7 @@
<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>
@@ -6934,7 +6912,7 @@
<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>
@@ -6956,7 +6934,7 @@
<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>
@@ -7230,23 +7208,29 @@
<b>writeFile</b>(<i>fn, backup=True</i>)
<p>
- Public slot to write the text to a file.
-</p>
-<dl>
-
-<dt><i>fn</i></dt>
-<dd>
-filename to write to (string)
-</dd>
-<dt><i>backup</i></dt>
-<dd>
-flag indicating to save a backup (boolean)
+ 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 (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
