diff -r c4c17121eff8 -r a21d673a8f99 eric6/Documentation/Source/eric6.QScintilla.Editor.html
--- a/eric6/Documentation/Source/eric6.QScintilla.Editor.html Sat Jan 16 16:50:00 2021 +0100
+++ b/eric6/Documentation/Source/eric6.QScintilla.Editor.html Sat Jan 16 16:51:23 2021 +0100
@@ -1865,7 +1865,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
new position for the calltip (integer)
</dd>
@@ -1972,7 +1972,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
dummy file name to be used for binding a lexer (string)
</dd>
@@ -2016,7 +2016,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
commands to change old into new (string)
</dd>
@@ -2260,7 +2260,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
create pixmap (QPixmap)
</dd>
@@ -2419,7 +2419,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>
@@ -2446,7 +2446,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)
@@ -2461,7 +2461,7 @@
info.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
file name of the coverage file (string)
</dd>
@@ -2496,7 +2496,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
@@ -2516,7 +2516,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)
@@ -2537,7 +2537,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
override value; None in case nothing is defined
</dd>
@@ -2557,7 +2557,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>
@@ -2577,7 +2577,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
file name (string)
</dd>
@@ -2636,7 +2636,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>
@@ -2649,7 +2649,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>
@@ -2662,7 +2662,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>
@@ -2675,7 +2675,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>
@@ -2688,7 +2688,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>
@@ -2701,7 +2701,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>
@@ -2714,7 +2714,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>
@@ -2734,7 +2734,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>
@@ -2747,7 +2747,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>
@@ -2760,7 +2760,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>
@@ -2773,7 +2773,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>
@@ -2792,7 +2792,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>
@@ -2831,7 +2831,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a commented line (boolean)
</dd>
@@ -2852,7 +2852,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating the result (boolean)
</dd>
@@ -2942,7 +2942,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
EditorConfig dictionary
</dd>
@@ -2990,7 +2990,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
margin number (integer, -1 for no margin)
</dd>
@@ -3130,7 +3130,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
normalized encoding (string)
</dd>
@@ -3179,7 +3179,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>
@@ -3338,7 +3338,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
modified completion text
</dd>
@@ -3434,7 +3434,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>
@@ -4046,7 +4046,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>
@@ -4059,7 +4059,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>
@@ -4072,7 +4072,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)
@@ -4121,7 +4121,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>
@@ -4261,7 +4261,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a successful close of the editor (boolean)
</dd>
@@ -4365,7 +4365,7 @@
line.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating the presence of a breakpoint (boolean)
</dd>
@@ -4378,7 +4378,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>
@@ -4521,7 +4521,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating, if the event was handled
</dd>
@@ -4637,7 +4637,7 @@
Public method to get the API language of the editor.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
API language
</dd>
@@ -4656,7 +4656,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>
@@ -4669,7 +4669,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)
@@ -4683,7 +4683,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>
@@ -4703,7 +4703,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
function providing calltips
</dd>
@@ -4722,7 +4722,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>
@@ -4735,7 +4735,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>
@@ -4755,7 +4755,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
function providing completion list
</dd>
@@ -4774,7 +4774,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>
@@ -4787,7 +4787,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>
@@ -4800,7 +4800,7 @@
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)
@@ -4821,7 +4821,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
value of requested setting
</dd>
@@ -4840,7 +4840,7 @@
Public method to return the current encoding.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
current encoding (string)
</dd>
@@ -4853,7 +4853,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>
@@ -4866,7 +4866,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>
@@ -4880,7 +4880,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)
@@ -4894,7 +4894,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>
@@ -4920,7 +4920,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
language of the editor (string)
</dd>
@@ -4933,7 +4933,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>
@@ -4953,7 +4953,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the requested menu (QMenu) or None
</dd>
@@ -4977,7 +4977,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
plug-in name and registered function
</dd>
@@ -5004,7 +5004,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
registered mouse click handlers as list of modifiers,
mouse button and function
@@ -5024,7 +5024,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>
@@ -5037,7 +5037,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>
@@ -5059,7 +5059,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
selection or current word (string)
</dd>
@@ -5072,7 +5072,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
@@ -5088,7 +5088,7 @@
Public method to get the current spelling language.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
current spelling language
</dd>
@@ -5107,7 +5107,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>
@@ -5120,7 +5120,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)
@@ -5134,7 +5134,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>
@@ -5147,7 +5147,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>
@@ -5166,7 +5166,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>
@@ -5179,7 +5179,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)
@@ -5214,7 +5214,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the word at that position (string)
</dd>
@@ -5243,7 +5243,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
tuple with start and end indexes of the word at the position
(integer, integer)
@@ -5268,7 +5268,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the word to the left of that position (string)
</dd>
@@ -5292,7 +5292,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the word to the right of that position (string)
</dd>
@@ -5381,7 +5381,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>
@@ -5394,7 +5394,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>
@@ -5407,7 +5407,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>
@@ -5420,7 +5420,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>
@@ -5433,7 +5433,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>
@@ -5446,7 +5446,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>
@@ -5459,7 +5459,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>
@@ -5472,7 +5472,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>
@@ -5529,7 +5529,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a clone
</dd>
@@ -5548,7 +5548,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>
@@ -5561,7 +5561,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>
@@ -5574,7 +5574,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>
@@ -5593,7 +5593,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>
@@ -5612,7 +5612,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>
@@ -5625,7 +5625,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>
@@ -5638,7 +5638,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>
@@ -5665,7 +5665,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating pos is in a spell check region
</dd>
@@ -6129,7 +6129,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
@@ -6154,7 +6154,7 @@
</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
@@ -6175,7 +6175,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
@@ -6344,7 +6344,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success
</dd>
@@ -6439,7 +6439,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>
@@ -6642,7 +6642,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indiating that the event was handled
</dd>
@@ -6686,7 +6686,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
