--- a/eric6/Documentation/Source/eric6.QScintilla.Editor.html Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/eric6.QScintilla.Editor.html Mon Feb 01 10:38:16 2021 +0100
@@ -23,7 +23,7 @@
<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>
@@ -36,7 +36,7 @@
<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>
@@ -50,7 +50,7 @@
<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>
@@ -181,7 +181,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>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>
@@ -369,6 +369,10 @@
<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>
@@ -517,6 +521,10 @@
<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>
@@ -605,6 +613,10 @@
<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>
@@ -1073,6 +1085,10 @@
<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>
@@ -1157,6 +1173,10 @@
<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>
@@ -1329,6 +1349,10 @@
<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>
@@ -1861,7 +1885,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
new position for the calltip (integer)
</dd>
@@ -1894,12 +1918,12 @@
</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>
@@ -1947,7 +1971,7 @@
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>
@@ -1968,7 +1992,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
dummy file name to be used for binding a lexer (string)
</dd>
@@ -2012,7 +2036,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
commands to change old into new (string)
</dd>
@@ -2256,7 +2280,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
create pixmap (QPixmap)
</dd>
@@ -2283,6 +2307,20 @@
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>)
@@ -2346,7 +2384,7 @@
<dd>
changed encoding (string)
</dd>
-<dt><i>propagate=</i></dt>
+<dt><i>propagate</i></dt>
<dd>
flag indicating to propagate the change (boolean)
</dd>
@@ -2415,7 +2453,7 @@
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>
@@ -2442,7 +2480,7 @@
</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)
@@ -2457,7 +2495,7 @@
info.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
file name of the coverage file (string)
</dd>
@@ -2492,7 +2530,7 @@
</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
@@ -2512,7 +2550,7 @@
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)
@@ -2533,7 +2571,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
override value; None in case nothing is defined
</dd>
@@ -2553,7 +2591,7 @@
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>
@@ -2573,7 +2611,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
file name (string)
</dd>
@@ -2632,7 +2670,7 @@
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>
@@ -2645,7 +2683,7 @@
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>
@@ -2658,7 +2696,7 @@
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>
@@ -2671,7 +2709,7 @@
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>
@@ -2684,7 +2722,7 @@
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>
@@ -2697,7 +2735,7 @@
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>
@@ -2710,7 +2748,7 @@
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>
@@ -2730,7 +2768,7 @@
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>
@@ -2743,7 +2781,7 @@
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>
@@ -2756,7 +2794,7 @@
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>
@@ -2769,7 +2807,7 @@
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>
@@ -2788,7 +2826,7 @@
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>
@@ -2807,6 +2845,14 @@
<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>)
@@ -2827,7 +2873,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a commented line (boolean)
</dd>
@@ -2848,7 +2894,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating the result (boolean)
</dd>
@@ -2866,7 +2912,7 @@
<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>
@@ -2938,7 +2984,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
EditorConfig dictionary
</dd>
@@ -2986,7 +3032,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
margin number (integer, -1 for no margin)
</dd>
@@ -3126,7 +3172,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
normalized encoding (string)
</dd>
@@ -3138,6 +3184,26 @@
<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>)
@@ -3175,7 +3241,7 @@
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>
@@ -3334,7 +3400,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
modified completion text
</dd>
@@ -3354,7 +3420,7 @@
</p>
<dl>
-<dt><i>propagate=</i></dt>
+<dt><i>propagate</i></dt>
<dd>
flag indicating to propagate the change (boolean)
</dd>
@@ -3430,7 +3496,7 @@
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>
@@ -3543,11 +3609,11 @@
<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>
@@ -3989,12 +4055,12 @@
</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>
@@ -4042,7 +4108,7 @@
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>
@@ -4055,7 +4121,7 @@
Public method to test the calltips availability.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating the availability of calltips (boolean)
</dd>
@@ -4068,7 +4134,7 @@
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)
@@ -4083,7 +4149,7 @@
</p>
<dl>
-<dt><i>send=</i></dt>
+<dt><i>send</i></dt>
<dd>
flag indicating to send the CancelEdit command (boolean)
</dd>
@@ -4104,9 +4170,9 @@
</p>
<dl>
-<dt><i>evt</i></dt>
-<dd>
-the event, that was generated (QEvent)
+<dt><i>evt</i> (QEvent)</dt>
+<dd>
+the event, that was generated
</dd>
</dl>
<a NAME="Editor.checkDirty" ID="Editor.checkDirty"></a>
@@ -4117,7 +4183,7 @@
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>
@@ -4257,7 +4323,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a successful close of the editor (boolean)
</dd>
@@ -4361,7 +4427,7 @@
line.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating the presence of a breakpoint (boolean)
</dd>
@@ -4374,7 +4440,7 @@
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>
@@ -4449,6 +4515,22 @@
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>)
@@ -4462,7 +4544,7 @@
<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>
@@ -4481,7 +4563,7 @@
<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>
@@ -4495,15 +4577,21 @@
</p>
<dl>
-<dt><i>evt</i></dt>
-<dd>
-reference to the event (QEvent)
-</dd>
-</dl>
-<dl>
-<dt>Returns:</dt>
-<dd>
-flag indicating, if the event was handled (boolean)
+<dt><i>evt</i> (QEvent)</dt>
+<dd>
+reference to the event
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating, if the event was handled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Editor.expandFoldWithChildren" ID="Editor.expandFoldWithChildren"></a>
@@ -4570,9 +4658,9 @@
</p>
<dl>
-<dt><i>event</i></dt>
-<dd>
-the event object (QFocusEvent)
+<dt><i>event</i> (QFocusEvent)</dt>
+<dd>
+the event object
</dd>
</dl>
<a NAME="Editor.focusOutEvent" ID="Editor.focusOutEvent"></a>
@@ -4584,9 +4672,9 @@
</p>
<dl>
-<dt><i>event</i></dt>
-<dd>
-the event object (QFocusEvent)
+<dt><i>event</i> (QFocusEvent)</dt>
+<dd>
+the event object
</dd>
</dl>
<a NAME="Editor.gestureEvent" ID="Editor.gestureEvent"></a>
@@ -4598,9 +4686,9 @@
</p>
<dl>
-<dt><i>evt</i></dt>
-<dd>
-reference to the gesture event (QGestureEvent
+<dt><i>evt</i> (QGestureEvent)</dt>
+<dd>
+reference to the gesture event
</dd>
</dl>
<a NAME="Editor.getApiLanguage" ID="Editor.getApiLanguage"></a>
@@ -4611,7 +4699,7 @@
Public method to get the API language of the editor.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
API language
</dd>
@@ -4630,7 +4718,7 @@
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>
@@ -4643,7 +4731,7 @@
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)
@@ -4657,7 +4745,7 @@
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>
@@ -4677,7 +4765,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
function providing calltips
</dd>
@@ -4696,7 +4784,7 @@
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>
@@ -4709,7 +4797,7 @@
Public method to retrieve a reference to the completer object.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the completer object (CompleterBase)
</dd>
@@ -4729,7 +4817,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
function providing completion list
</dd>
@@ -4748,7 +4836,7 @@
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>
@@ -4761,7 +4849,7 @@
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>
@@ -4774,12 +4862,31 @@
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>)
@@ -4795,7 +4902,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
value of requested setting
</dd>
@@ -4814,7 +4921,7 @@
Public method to return the current encoding.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
current encoding (string)
</dd>
@@ -4827,7 +4934,7 @@
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>
@@ -4840,7 +4947,7 @@
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>
@@ -4854,7 +4961,7 @@
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)
@@ -4868,7 +4975,7 @@
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>
@@ -4882,19 +4989,19 @@
</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>
@@ -4907,7 +5014,7 @@
Public method to retrieve a reference to the lexer object.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the lexer object (Lexer)
</dd>
@@ -4927,7 +5034,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the requested menu (QMenu) or None
</dd>
@@ -4951,7 +5058,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
plug-in name and registered function
</dd>
@@ -4978,7 +5085,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
registered mouse click handlers as list of modifiers,
mouse button and function
@@ -4998,7 +5105,7 @@
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>
@@ -5011,7 +5118,7 @@
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>
@@ -5033,7 +5140,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
selection or current word (string)
</dd>
@@ -5046,7 +5153,7 @@
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
@@ -5062,7 +5169,7 @@
Public method to get the current spelling language.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
current spelling language
</dd>
@@ -5081,7 +5188,7 @@
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>
@@ -5094,7 +5201,7 @@
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)
@@ -5108,7 +5215,7 @@
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>
@@ -5121,7 +5228,7 @@
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>
@@ -5140,7 +5247,7 @@
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>
@@ -5153,7 +5260,7 @@
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)
@@ -5181,14 +5288,14 @@
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>
@@ -5210,14 +5317,14 @@
<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)
@@ -5242,7 +5349,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the word to the left of that position (string)
</dd>
@@ -5266,7 +5373,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the word to the right of that position (string)
</dd>
@@ -5291,16 +5398,16 @@
<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>
@@ -5355,7 +5462,7 @@
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>
@@ -5368,7 +5475,7 @@
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>
@@ -5381,7 +5488,7 @@
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>
@@ -5394,7 +5501,7 @@
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>
@@ -5407,7 +5514,7 @@
Public method to check the miniMenu flag.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a minimized context menu (boolean)
</dd>
@@ -5420,7 +5527,7 @@
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>
@@ -5433,7 +5540,7 @@
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>
@@ -5446,7 +5553,7 @@
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>
@@ -5488,6 +5595,18 @@
<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>)
@@ -5503,7 +5622,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a clone
</dd>
@@ -5522,7 +5641,7 @@
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>
@@ -5535,7 +5654,7 @@
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>
@@ -5548,7 +5667,7 @@
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>
@@ -5567,7 +5686,7 @@
Public method to return a flag indicating a Python2 file.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag reporting always False
</dd>
@@ -5586,7 +5705,7 @@
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>
@@ -5599,7 +5718,7 @@
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>
@@ -5612,7 +5731,7 @@
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>
@@ -5639,7 +5758,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating pos is in a spell check region
</dd>
@@ -5666,9 +5785,9 @@
</p>
<dl>
-<dt><i>ev</i></dt>
-<dd>
-key event (QKeyEvent)
+<dt><i>ev</i> (QKeyEvent)</dt>
+<dd>
+key event
</dd>
</dl>
<a NAME="Editor.macroDelete" ID="Editor.macroDelete"></a>
@@ -5778,9 +5897,9 @@
</p>
<dl>
-<dt><i>event</i></dt>
-<dd>
-the mouse press event (QMouseEvent)
+<dt><i>event</i> (QMouseEvent)</dt>
+<dd>
+the mouse press event
</dd>
</dl>
<a NAME="Editor.mouseReleaseEvent" ID="Editor.mouseReleaseEvent"></a>
@@ -5934,12 +6053,12 @@
<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)
@@ -6072,9 +6191,9 @@
</p>
<dl>
-<dt><i>evt</i></dt>
-<dd>
-reference to the resize event (QResizeEvent)
+<dt><i>evt</i> (QResizeEvent)</dt>
+<dd>
+reference to the resize event
</dd>
</dl>
<a NAME="Editor.revertToUnmodified" ID="Editor.revertToUnmodified"></a>
@@ -6103,7 +6222,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
@@ -6121,14 +6240,14 @@
<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
@@ -6149,7 +6268,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
@@ -6268,11 +6387,11 @@
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>
@@ -6318,7 +6437,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success
</dd>
@@ -6413,7 +6532,7 @@
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>
@@ -6519,7 +6638,7 @@
<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)
@@ -6554,7 +6673,7 @@
<dd>
warning message (string)
</dd>
-<dt><i>warningType=</i></dt>
+<dt><i>warningType</i></dt>
<dd>
type of warning message (integer)
</dd>
@@ -6610,15 +6729,21 @@
</p>
<dl>
-<dt><i>evt</i></dt>
-<dd>
-reference to the event (QEvent)
-</dd>
-</dl>
-<dl>
-<dt>Returns:</dt>
-<dd>
-flag indiating that the event was handled (boolean)
+<dt><i>evt</i> (QEvent)</dt>
+<dd>
+reference to the event
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indiating that the event was handled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Editor.wheelEvent" ID="Editor.wheelEvent"></a>
@@ -6630,9 +6755,9 @@
</p>
<dl>
-<dt><i>evt</i></dt>
-<dd>
-reference to the wheel event (QWheelEvent)
+<dt><i>evt</i> (QWheelEvent)</dt>
+<dd>
+reference to the wheel event
</dd>
</dl>
<a NAME="Editor.writeFile" ID="Editor.writeFile"></a>
@@ -6654,7 +6779,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
