eric: comparison eric6/Documentation/Source/eric6.QScintilla.Editor.html

-:866adc8c315b
+:0acf98cd089a
 <body>
 <a NAME="top" ID="top"></a>
 <h1>eric6.QScintilla.Editor</h1>
 <p>
-Module implementing the editor component of the eric6 IDE.
+Module implementing the editor component of the eric IDE.
 </p>
 <h3>Global Attributes</h3>
 <table>
 <tr><td>EditorAutoCompletionListID</td></tr><tr><td>TemplateCompletionListID</td></tr>
 <table>
 <tr>
 <td><a href="#Editor">Editor</a></td>
-<td>Class implementing the editor component of the eric6 IDE.</td>
+<td>Class implementing the editor component of the eric IDE.</td>
 </tr>
 </table>
 <h3>Functions</h3>
 <table>
 <hr />
 <a NAME="Editor" ID="Editor"></a>
 <h2>Editor</h2>
 <p>
-Class implementing the editor component of the eric6 IDE.
+Class implementing the editor component of the eric IDE.
 </p>
 <h3>Signals</h3>
 <dl>
 <dt>autoCompletionAPIsAvailable(bool)</dt>
 <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>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>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>WarningStyle</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</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>
 <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>
 <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.__popupDocstringMenu">__popupDocstringMenu</a></td>
+<td>Private slot 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>
 <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 slot to ensure, that the specified line is visible.</td>
 </tr>
 <tr>
 <td><a href="#Editor.ensureVisibleTop">ensureVisibleTop</a></td>
 <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 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>
 <dd>
 position into the text (integer)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 new position for the calltip (integer)
 </dd>
 </dl>
 <a NAME="Editor.__applyTemplate" ID="Editor.__applyTemplate"></a>
 <p>
 Private method to start auto-completion via plug-ins.
 </p>
 <dl>
-<dt><i>auto=</i></dt>
+<dt><i>auto</i></dt>
 <dd>
 flag indicating a call from the __charAdded method
 (boolean)
 </dd>
-<dt><i>context=</i> (bool or None)</dt>
+<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>
 <dt><i>filename</i></dt>
 <dd>
 filename used to determine the associated lexer
 language (string)
 </dd>
-<dt><i>pyname=</i></dt>
+<dt><i>pyname</i></dt>
 <dd>
 name of the pygments lexer to use (string)
 </dd>
 </dl>
 <a NAME="Editor.__bindName" ID="Editor.__bindName"></a>
 first line of text to use in the generation process
 (string)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 dummy file name to be used for binding a lexer (string)
 </dd>
 </dl>
 <a NAME="Editor.__breakPointDataAboutToBeChanged" ID="Editor.__breakPointDataAboutToBeChanged"></a>
 <dd>
 new text (string)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 commands to change old into new (string)
 </dd>
 </dl>
 <a NAME="Editor.__callTip" ID="Editor.__callTip"></a>
 <dd>
 width of the marker line (integer)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 create pixmap (QPixmap)
 </dd>
 </dl>
 <a NAME="Editor.__cursorPositionChanged" ID="Editor.__cursorPositionChanged"></a>
 <dt><i>index</i></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>
 <dt><i>encoding</i></dt>
 <dd>
 changed encoding (string)
 </dd>
-<dt><i>propagate=</i></dt>
+<dt><i>propagate</i></dt>
 <dd>
 flag indicating to propagate the change (boolean)
 </dd>
 </dl>
 <a NAME="Editor.__encodingsMenuTriggered" ID="Editor.__encodingsMenuTriggered"></a>
 <p>
 Private method to get the text from cursor position for autocompleting.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 text left of cursor position
 </dd>
 </dl>
 <dl>
 <dd>
 position to get character at (integer)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 requested character or "", if there are no more (string) and
 the next position (i.e. pos - 1)
 </dd>
 </dl>
 <p>
 Private method to get the file name of the file containing coverage
 info.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 file name of the coverage file (string)
 </dd>
 </dl>
 <a NAME="Editor.__getEditorConfig" ID="Editor.__getEditorConfig"></a>
 <dd>
 reference to an EditorConfig object or None
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 value of requested setting or None if nothing was found and
 nodefault parameter was True
 </dd>
 </dl>
 <p>
 Private method to select a macro name from the list of macros.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 Tuple of macro name and a flag, indicating, if the user
 pressed ok or canceled the operation. (string, boolean)
 </dd>
 </dl>
 <dd>
 Preferences option key
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 override value; None in case nothing is defined
 </dd>
 </dl>
 <dl>
 <p>
 Private method to return the Python main version or 0 if it's
 not a Python file at all.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 Python version or 0 if it's not a Python file (int)
 </dd>
 </dl>
 <a NAME="Editor.__getSaveFileName" ID="Editor.__getSaveFileName"></a>
 <dd>
 directory to save the file in (string)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 file name (string)
 </dd>
 </dl>
 <a NAME="Editor.__ignoreSpellingAlways" ID="Editor.__ignoreSpellingAlways"></a>
 <p>
 Private method used to setup the Checks context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
 </dl>
 <a NAME="Editor.__initContextMenuChecks" ID="Editor.__initContextMenuChecks"></a>
 <p>
 Private method used to setup the Checks context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
 </dl>
 <a NAME="Editor.__initContextMenuEncodings" ID="Editor.__initContextMenuEncodings"></a>
 <p>
 Private method used to setup the Encodings context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
 </dl>
 <a NAME="Editor.__initContextMenuEol" ID="Editor.__initContextMenuEol"></a>
 <p>
 Private method to setup the eol context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
 </dl>
 <a NAME="Editor.__initContextMenuExporters" ID="Editor.__initContextMenuExporters"></a>
 <p>
 Private method used to setup the Exporters context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
 </dl>
 <a NAME="Editor.__initContextMenuGraphics" ID="Editor.__initContextMenuGraphics"></a>
 <p>
 Private method used to setup the diagrams context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
 </dl>
 <a NAME="Editor.__initContextMenuLanguages" ID="Editor.__initContextMenuLanguages"></a>
 <p>
 Private method used to setup the Languages context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
 </dl>
 <a NAME="Editor.__initContextMenuMargins" ID="Editor.__initContextMenuMargins"></a>
 <p>
 Private method used to setup the Reopen With Encoding context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
 </dl>
 <a NAME="Editor.__initContextMenuResources" ID="Editor.__initContextMenuResources"></a>
 <p>
 Private method used to setup the Resources context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
 </dl>
 <a NAME="Editor.__initContextMenuShow" ID="Editor.__initContextMenuShow"></a>
 <p>
 Private method used to setup the Show context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
 </dl>
 <a NAME="Editor.__initContextMenuSpellLanguages" ID="Editor.__initContextMenuSpellLanguages"></a>
 <p>
 Private method to setup the spell checking languages context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu
 </dd>
 </dl>
 <dl>
 <p>
 Private method used to setup the Tools context sub menu.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the generated menu (QMenu)
 </dd>
 </dl>
 <a NAME="Editor.__initOnlineChangeTrace" ID="Editor.__initOnlineChangeTrace"></a>
 <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>
 <dd>
 comment string to check against (string)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a commented line (boolean)
 </dd>
 </dl>
 <a NAME="Editor.__isStartChar" ID="Editor.__isStartChar"></a>
 <dd>
 character to be checked (one character string)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the result (boolean)
 </dd>
 </dl>
 <a NAME="Editor.__languageChanged" ID="Editor.__languageChanged"></a>
 <dt><i>language</i></dt>
 <dd>
 language to be set (string)
 </dd>
-<dt><i>propagate=</i></dt>
+<dt><i>propagate</i></dt>
 <dd>
 flag indicating to propagate the change (boolean)
 </dd>
 </dl>
 <a NAME="Editor.__languageMenuTriggered" ID="Editor.__languageMenuTriggered"></a>
 <dd>
 name of the file
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 EditorConfig dictionary
 </dd>
 </dl>
 <dl>
 <dd>
 x position (integer)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 margin number (integer, -1 for no margin)
 </dd>
 </dl>
 <a NAME="Editor.__markOccurrences" ID="Editor.__markOccurrences"></a>
 <dd>
 encoding to be normalized (string)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 normalized encoding (string)
 </dd>
 </dl>
 <a NAME="Editor.__onlineChangeTraceTimerTimeout" ID="Editor.__onlineChangeTraceTimerTimeout"></a>
 <b>__onlineChangeTraceTimerTimeout</b>(<i></i>)
 <p>
 Private slot to mark added and changed lines.
 </p>
+<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
+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>
 <p>
 Private method to extract flags and process them.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of change flags (list of string)
 </dd>
 </dl>
 <a NAME="Editor.__processRequestSyncCommand" ID="Editor.__processRequestSyncCommand"></a>
 <dd>
 completion text
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 modified completion text
 </dd>
 </dl>
 <dl>
 <p>
 Private method used to reset the language selection.
 </p>
 <dl>
-<dt><i>propagate=</i></dt>
+<dt><i>propagate</i></dt>
 <dd>
 flag indicating to propagate the change (boolean)
 </dd>
 </dl>
 <a NAME="Editor.__resetOnlineChangeTraceInfo" ID="Editor.__resetOnlineChangeTraceInfo"></a>
 <p>
 Private method to select a specific pygments lexer.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 name of the selected pygments lexer (string)
 </dd>
 </dl>
 <a NAME="Editor.__send" ID="Editor.__send"></a>
 <dt><i>language</i></dt>
 <dd>
 spell checking language to be set (string)
 </dd>
-<dt><i>pwl=</i></dt>
+<dt><i>pwl</i></dt>
 <dd>
 name of the personal/project word list (string)
 </dd>
-<dt><i>pel=</i></dt>
+<dt><i>pel</i></dt>
 <dd>
 name of the personal/project exclude list (string)
 </dd>
 </dl>
 <a NAME="Editor.__setTabAndIndent" ID="Editor.__setTabAndIndent"></a>
 <p>
 Public method to start auto-completion.
 </p>
 <dl>
-<dt><i>auto=</i></dt>
+<dt><i>auto</i></dt>
 <dd>
 flag indicating a call from the __charAdded method
 (boolean)
 </dd>
-<dt><i>context=</i></dt>
+<dt><i>context</i></dt>
 <dd>
 flag indicating to complete a context (boolean)
 </dd>
 </dl>
 <a NAME="Editor.autoCompleteQScintilla" ID="Editor.autoCompleteQScintilla"></a>
 <p>
 Public method to check for API availablity.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating autocompletion from APIs is available (boolean)
 </dd>
 </dl>
 <a NAME="Editor.canProvideCallTipps" ID="Editor.canProvideCallTipps"></a>
 <p>
 Public method to test the calltips availability.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the availability of calltips (boolean)
 </dd>
 </dl>
 <a NAME="Editor.canProvideDynamicAutoCompletion" ID="Editor.canProvideDynamicAutoCompletion"></a>
 <p>
 Public method to test the dynamic auto-completion availability.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the availability of dynamic auto-completion
 (boolean)
 </dd>
 </dl>
 <p>
 Public slot to cancel a shared edit session for the editor.
 </p>
 <dl>
-<dt><i>send=</i></dt>
+<dt><i>send</i></dt>
 <dd>
 flag indicating to send the CancelEdit command (boolean)
 </dd>
 </dl>
 <a NAME="Editor.changeEvent" ID="Editor.changeEvent"></a>
 other modes. This is to make the editor windows work nicer
 with the QWorkspace.
 </p>
 <dl>
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QEvent)</dt>
 <dd>
-the event, that was generated (QEvent)
+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>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating successful reset of the dirty flag (boolean)
 </dd>
 </dl>
 <a NAME="Editor.checkSpelling" ID="Editor.checkSpelling"></a>
 <dd>
 ignored
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a successful close of the editor (boolean)
 </dd>
 </dl>
 <a NAME="Editor.closeIt" ID="Editor.closeIt"></a>
 <p>
 Public method to check for the presence of a breakpoint at the current
 line.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the presence of a breakpoint (boolean)
 </dd>
 </dl>
 <a NAME="Editor.determineFileType" ID="Editor.determineFileType"></a>
 <p>
 Public method to determine the file type using various tests.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 type of the displayed file or an empty string (string)
 </dd>
 </dl>
 <a NAME="Editor.dragEnterEvent" ID="Editor.dragEnterEvent"></a>
 <dt><i>cmd</i></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>
 <dt><i>line</i> (int)</dt>
 <dd>
 line number to make visible
 </dd>
-<dt><i>expand=</i> (bool)</dt>
+<dt><i>expand</i> (bool)</dt>
 <dd>
 flag indicating to expand all folds
 </dd>
 </dl>
 <a NAME="Editor.ensureVisibleTop" ID="Editor.ensureVisibleTop"></a>
 <dt><i>line</i> (int)</dt>
 <dd>
 line number to make visible
 </dd>
-<dt><i>expand=</i> (bool)</dt>
+<dt><i>expand</i> (bool)</dt>
 <dd>
 flag indicating to expand all folds
 </dd>
 </dl>
 <a NAME="Editor.event" ID="Editor.event"></a>
 <p>
 Public method handling events.
 </p>
 <dl>
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QEvent)</dt>
 <dd>
-reference to the event (QEvent)
+reference to the event
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
-flag indicating, if the event was handled (boolean)
+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>)
 assuming, that it is in the vicinity of the old position after the
 reread.
 </p>
 <dl>
-<dt><i>event</i></dt>
+<dt><i>event</i> (QFocusEvent)</dt>
 <dd>
-the event object (QFocusEvent)
+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></dt>
+<dt><i>event</i> (QFocusEvent)</dt>
 <dd>
-the event object (QFocusEvent)
+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></dt>
+<dt><i>evt</i> (QGestureEvent)</dt>
 <dd>
-reference to the gesture event (QGestureEvent
+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>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 API language
 </dd>
 </dl>
 <dl>
 <p>
 Public method to get the lines containing a bookmark.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of lines containing a bookmark (list of integer)
 </dd>
 </dl>
 <a NAME="Editor.getBookmarks" ID="Editor.getBookmarks"></a>
 <p>
 Public method to retrieve the bookmarks.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 sorted list of all lines containing a bookmark
 (list of integer)
 </dd>
 </dl>
 <p>
 Public method to get the lines containing a breakpoint.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of lines containing a breakpoint (list of integer)
 </dd>
 </dl>
 <a NAME="Editor.getCallTipHook" ID="Editor.getCallTipHook"></a>
 <dd>
 name of the provider
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 function providing calltips
 </dd>
 </dl>
 <dl>
 <p>
 Public method to get the lines containing a change.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of lines containing a change (list of integer)
 </dd>
 </dl>
 <a NAME="Editor.getCompleter" ID="Editor.getCompleter"></a>
 <p>
 Public method to retrieve a reference to the completer object.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the completer object (CompleterBase)
 </dd>
 </dl>
 <a NAME="Editor.getCompletionListHook" ID="Editor.getCompletionListHook"></a>
 <dd>
 name of the provider
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 function providing completion list
 </dd>
 </dl>
 <dl>
 <p>
 Public method to get the lines containing a coverage marker.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of lines containing a coverage marker (list of integer)
 </dd>
 </dl>
 <a NAME="Editor.getCurrentWord" ID="Editor.getCurrentWord"></a>
 <p>
 Public method to get the word at the current position.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the word at that current position (string)
 </dd>
 </dl>
 <a NAME="Editor.getCurrentWordBoundaries" ID="Editor.getCurrentWordBoundaries"></a>
 <p>
 Public method to get the word boundaries at the current position.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple with start and end indexes of the current word
 (integer, integer)
+</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>)
 <dd>
 Preferences option key
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 value of requested setting
 </dd>
 </dl>
 <dl>
 <p>
 Public method to return the current encoding.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 current encoding (string)
 </dd>
 </dl>
 <a NAME="Editor.getFileName" ID="Editor.getFileName"></a>
 <p>
 Public method to return the name of the file being displayed.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 filename of the displayed file (string)
 </dd>
 </dl>
 <a NAME="Editor.getFileType" ID="Editor.getFileType"></a>
 <p>
 Public method to return the type of the file being displayed.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 type of the displayed file (string)
 </dd>
 </dl>
 <a NAME="Editor.getFileTypeByFlag" ID="Editor.getFileTypeByFlag"></a>
 <p>
 Public method to return the type of the file, if it was set by an
 eflag: marker.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 type of the displayed file, if set by an eflag: marker or an
 empty string (string)
 </dd>
 </dl>
 <p>
 Public method to return the position of the highlight bar.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 line number of the highlight bar (integer)
 </dd>
 </dl>
 <a NAME="Editor.getLanguage" ID="Editor.getLanguage"></a>
 <p>
 Public method to retrieve the language of the editor.
 </p>
 <dl>
-<dt><i>normalized=</i></dt>
+<dt><i>normalized</i></dt>
 <dd>
 flag indicating to normalize some Pygments
 lexer names (boolean)
 </dd>
-<dt><i>forPygments=</i></dt>
+<dt><i>forPygments</i></dt>
 <dd>
 flag indicating to normalize some lexer
 names for Pygments (boolean)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 language of the editor (string)
 </dd>
 </dl>
 <a NAME="Editor.getLexer" ID="Editor.getLexer"></a>
 <p>
 Public method to retrieve a reference to the lexer object.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the lexer object (Lexer)
 </dd>
 </dl>
 <a NAME="Editor.getMenu" ID="Editor.getMenu"></a>
 <dd>
 name of the menu (string)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the requested menu (QMenu) or None
 </dd>
 </dl>
 <a NAME="Editor.getMouseClickHandler" ID="Editor.getMouseClickHandler"></a>
 <dd>
 mouse button of the handler
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 plug-in name and registered function
 </dd>
 </dl>
 <dl>
 <dd>
 name of the plug-in
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 registered mouse click handlers as list of modifiers,
 mouse button and function
 </dd>
 </dl>
 <p>
 Public method to get the display string for an unnamed editor.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 display string for this unnamed editor (string)
 </dd>
 </dl>
 <a NAME="Editor.getSearchIndicatorLines" ID="Editor.getSearchIndicatorLines"></a>
 <p>
 Public method to get the lines containing a search indicator.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of lines containing a search indicator (list of integer)
 </dd>
 </dl>
 <a NAME="Editor.getSearchText" ID="Editor.getSearchText"></a>
 flag indicating that only selected text should be
 returned (boolean)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 selection or current word (string)
 </dd>
 </dl>
 <a NAME="Editor.getSharingStatus" ID="Editor.getSharingStatus"></a>
 <p>
 Public method to get some share status info.
 </p>
 <dl>
-<dt>Returns:</dt>
+<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
 (boolean, boolean, boolean, boolean)
 <p>
 Public method to get the current spelling language.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 current spelling language
 </dd>
 </dl>
 <dl>
 <p>
 Public method to get the lines containing a syntax error.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of lines containing a syntax error (list of integer)
 </dd>
 </dl>
 <a NAME="Editor.getSyntaxErrors" ID="Editor.getSyntaxErrors"></a>
 <p>
 Public method to retrieve the syntax error markers.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 sorted list of all lines containing a syntax error
 (list of integer)
 </dd>
 </dl>
 <p>
 Public method to get the lines containing a task.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of lines containing a task (list of integer)
 </dd>
 </dl>
 <a NAME="Editor.getVcsConflictMarkerLines" ID="Editor.getVcsConflictMarkerLines"></a>
 <p>
 Public method to determine the lines containing a VCS conflict marker.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of line numbers containg a VCS conflict marker
 </dd>
 </dl>
 <dl>
 <p>
 Public method to get the lines containing a warning.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of lines containing a warning (list of integer)
 </dd>
 </dl>
 <a NAME="Editor.getWarnings" ID="Editor.getWarnings"></a>
 <p>
 Public method to retrieve the warning markers.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 sorted list of all lines containing a warning
 (list of integer)
 </dd>
 </dl>
 <dt><i>direction</i></dt>
 <dd>
 direction to look in (0 = whole word, 1 = left,
 2 = right)
 </dd>
-<dt><i>useWordChars=</i></dt>
+<dt><i>useWordChars</i></dt>
 <dd>
 flag indicating to use the wordCharacters
 method (boolean)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the word at that position (string)
 </dd>
 </dl>
 <a NAME="Editor.getWordBoundaries" ID="Editor.getWordBoundaries"></a>
 </dd>
 <dt><i>index</i></dt>
 <dd>
 position to look at (int)
 </dd>
-<dt><i>useWordChars=</i></dt>
+<dt><i>useWordChars</i></dt>
 <dd>
 flag indicating to use the wordCharacters
 method (boolean)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple with start and end indexes of the word at the position
 (integer, integer)
 </dd>
 </dl>
 <dd>
 position to look at (int)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the word to the left of that position (string)
 </dd>
 </dl>
 <a NAME="Editor.getWordRight" ID="Editor.getWordRight"></a>
 <dd>
 position to look at (int)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 the word to the right of that position (string)
 </dd>
 </dl>
 <a NAME="Editor.gotoLastEditPosition" ID="Editor.gotoLastEditPosition"></a>
 <dt><i>line</i> (int)</dt>
 <dd>
 line number to go to
 </dd>
-<dt><i>pos=</i> (int)</dt>
+<dt><i>pos</i> (int)</dt>
 <dd>
 position in line to go to
 </dd>
-<dt><i>firstVisible=</i> (bool)</dt>
+<dt><i>firstVisible</i> (bool)</dt>
 <dd>
 flag indicating to make the line the first
 visible line
 </dd>
-<dt><i>expand=</i> (bool)</dt>
+<dt><i>expand</i> (bool)</dt>
 <dd>
 flag indicating to expand all folds
 </dd>
 </dl>
 <a NAME="Editor.gotoMethodClass" ID="Editor.gotoMethodClass"></a>
 <p>
 Public method to check for the presence of bookmarks.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the presence of bookmarks (boolean)
 </dd>
 </dl>
 <a NAME="Editor.hasBreakpoints" ID="Editor.hasBreakpoints"></a>
 <p>
 Public method to check for the presence of breakpoints.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the presence of breakpoints (boolean)
 </dd>
 </dl>
 <a NAME="Editor.hasChangeMarkers" ID="Editor.hasChangeMarkers"></a>
 <p>
 Public method to determine, if this editor contains any change markers.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the presence of change markers (boolean)
 </dd>
 </dl>
 <a NAME="Editor.hasCoverageMarkers" ID="Editor.hasCoverageMarkers"></a>
 <p>
 Public method to test, if there are coverage markers.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the presence of coverage markers (boolean)
 </dd>
 </dl>
 <a NAME="Editor.hasMiniMenu" ID="Editor.hasMiniMenu"></a>
 <p>
 Public method to check the miniMenu flag.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a minimized context menu (boolean)
 </dd>
 </dl>
 <a NAME="Editor.hasSyntaxErrors" ID="Editor.hasSyntaxErrors"></a>
 <p>
 Public method to check for the presence of syntax errors.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the presence of syntax errors (boolean)
 </dd>
 </dl>
 <a NAME="Editor.hasTaskMarkers" ID="Editor.hasTaskMarkers"></a>
 <p>
 Public method to determine, if this editor contains any task markers.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the presence of task markers (boolean)
 </dd>
 </dl>
 <a NAME="Editor.hasWarnings" ID="Editor.hasWarnings"></a>
 <p>
 Public method to check for the presence of warnings.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the presence of warnings (boolean)
 </dd>
 </dl>
 <a NAME="Editor.highlight" ID="Editor.highlight"></a>
 <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>
 <dd>
 reference to the cloned editor
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a clone
 </dd>
 </dl>
 <dl>
 <p>
 Public method to return a flag indicating a Javascript file.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a Javascript file (boolean)
 </dd>
 </dl>
 <a NAME="Editor.isLastEditPositionAvailable" ID="Editor.isLastEditPositionAvailable"></a>
 <p>
 Public method to check, if a last edit position is available.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating availability (boolean)
 </dd>
 </dl>
 <a NAME="Editor.isMicroPythonFile" ID="Editor.isMicroPythonFile"></a>
 <p>
 Public method to return a flag indicating a MicroPython file.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a MicroPython file
 </dd>
 </dl>
 <dl>
 <p>
 Public method to return a flag indicating a Python2 file.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag reporting always False
 </dd>
 </dl>
 <dl>
 <p>
 Public method to return a flag indicating a Python3 file.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a Python3 file (boolean)
 </dd>
 </dl>
 <a NAME="Editor.isPyFile" ID="Editor.isPyFile"></a>
 <p>
 Public method to return a flag indicating a Python (2 or 3) file.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a Python3 file (boolean)
 </dd>
 </dl>
 <a NAME="Editor.isRubyFile" ID="Editor.isRubyFile"></a>
 <p>
 Public method to return a flag indicating a Ruby file.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a Ruby file (boolean)
 </dd>
 </dl>
 <a NAME="Editor.isSpellCheckRegion" ID="Editor.isSpellCheckRegion"></a>
 <dd>
 position to be checked
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating pos is in a spell check region
 </dd>
 </dl>
 <dl>
 <p>
 Protected method to handle the user input a key at a time.
 </p>
 <dl>
-<dt><i>ev</i></dt>
+<dt><i>ev</i> (QKeyEvent)</dt>
 <dd>
-key event (QKeyEvent)
+key event
 </dd>
 </dl>
 <a NAME="Editor.macroDelete" ID="Editor.macroDelete"></a>
 <h4>Editor.macroDelete</h4>
 <b>macroDelete</b>(<i></i>)
 <p>
 Protected method to handle the mouse press event.
 </p>
 <dl>
-<dt><i>event</i></dt>
+<dt><i>event</i> (QMouseEvent)</dt>
 <dd>
-the mouse press event (QMouseEvent)
+the mouse press event
 </dd>
 </dl>
 <a NAME="Editor.mouseReleaseEvent" ID="Editor.mouseReleaseEvent"></a>
 <h4>Editor.mouseReleaseEvent</h4>
 <b>mouseReleaseEvent</b>(<i>evt</i>)
 <dt><i>fn</i></dt>
 <dd>
 filename to read from (string)
 </dd>
-<dt><i>createIt=</i></dt>
+<dt><i>createIt</i></dt>
 <dd>
 flag indicating the creation of a new file, if the
 given one doesn't exist (boolean)
 </dd>
-<dt><i>encoding=</i></dt>
+<dt><i>encoding</i></dt>
 <dd>
 encoding to be used to read the file (string)
 (Note: this parameter overrides encoding detection)
 </dd>
 </dl>
 <p>
 Protected method handling resize events.
 </p>
 <dl>
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QResizeEvent)</dt>
 <dd>
-reference to the resize event (QResizeEvent)
+reference to the resize event
 </dd>
 </dl>
 <a NAME="Editor.revertToUnmodified" ID="Editor.revertToUnmodified"></a>
 <h4>Editor.revertToUnmodified</h4>
 <b>revertToUnmodified</b>(<i></i>)
 <dd>
 directory to save the file in (string)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success (boolean)
 </dd>
 </dl>
 <a NAME="Editor.saveFileAs" ID="Editor.saveFileAs"></a>
 <dt><i>path</i></dt>
 <dd>
 directory to save the file in (string)
 </dd>
-<dt><i>toProject=</i></dt>
+<dt><i>toProject</i></dt>
 <dd>
 flag indicating a save to project operation
 (boolean)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple of two values (boolean, string) giving a success
 indicator and the name of the saved file
 </dd>
 </dl>
 <dd>
 directory to save the file in (string)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success (boolean)
 </dd>
 </dl>
 <a NAME="Editor.searchCurrentWordBackward" ID="Editor.searchCurrentWordBackward"></a>
 <dt><i>initTextDisplay</i></dt>
 <dd>
 flag indicating an initialization of the text
 display is required as well (boolean)
 </dd>
-<dt><i>propagate=</i></dt>
+<dt><i>propagate</i></dt>
 <dd>
 flag indicating to propagate the change (boolean)
 </dd>
-<dt><i>pyname=</i></dt>
+<dt><i>pyname</i></dt>
 <dd>
 name of the pygments lexer to use (string)
 </dd>
 </dl>
 <a NAME="Editor.setMonospaced" ID="Editor.setMonospaced"></a>
 <dd>
 handler function
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success
 </dd>
 </dl>
 <dl>
 <p>
 Public slot to check the autosave flags.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating this editor should be saved (boolean)
 </dd>
 </dl>
 <a NAME="Editor.smartIndentLineOrSelection" ID="Editor.smartIndentLineOrSelection"></a>
 </dd>
 <dt><i>msg</i></dt>
 <dd>
 error message (string)
 </dd>
-<dt><i>show=</i></dt>
+<dt><i>show</i></dt>
 <dd>
 flag indicating to set the cursor to the error position
 (boolean)
 </dd>
 </dl>
 </dd>
 <dt><i>msg</i></dt>
 <dd>
 warning message (string)
 </dd>
-<dt><i>warningType=</i></dt>
+<dt><i>warningType</i></dt>
 <dd>
 type of warning message (integer)
 </dd>
 </dl>
 <a NAME="Editor.uncommentLine" ID="Editor.uncommentLine"></a>
 <p>
 Protected method handling event of the viewport.
 </p>
 <dl>
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QEvent)</dt>
 <dd>
-reference to the event (QEvent)
+reference to the event
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
-flag indiating that the event was handled (boolean)
+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></dt>
+<dt><i>evt</i> (QWheelEvent)</dt>
 <dd>
-reference to the wheel event (QWheelEvent)
+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>)
 <dd>
 flag indicating to save a backup (boolean)
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating success (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.QScintilla.Editor.html

eric6/Documentation/Source/eric6.QScintilla.Editor.html