--- a/eric6/Documentation/Source/eric6.QScintilla.QsciScintillaCompat.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.QScintilla.QsciScintillaCompat.html Sat Jan 16 16:51:23 2021 +0100 @@ -590,7 +590,7 @@ Private method to perform the search in target. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a successful search (boolean) </dd> @@ -642,7 +642,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> encoded string (bytes) </dd> @@ -684,7 +684,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> raw character at the requested position or empty bytes, if the position is negative or past the end of the document (bytes) @@ -699,7 +699,7 @@ clipboard contains some text). </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the availability of 'paste' </dd> @@ -726,7 +726,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> character at the requested position or empty string, if the position is negative or past the end of the document (string) @@ -830,7 +830,7 @@ Public method to get a list of line numbers of collapsed folds. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of line numbers of folded lines (list of integer) </dd> @@ -843,7 +843,7 @@ Public method to get the current position. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> absolute position of the cursor (integer) </dd> @@ -856,7 +856,7 @@ Public method to get the style at the current position. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> style at the current position (integer) </dd> @@ -918,7 +918,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> eol string (string) </dd> @@ -956,7 +956,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> result of the event handling (boolean) </dd> @@ -1061,7 +1061,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a successful search </dd> @@ -1080,7 +1080,7 @@ Public method to find the next occurrence in the target range. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a successful search (boolean) </dd> @@ -1140,7 +1140,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the fold expansion state of the line (boolean) </dd> @@ -1160,7 +1160,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> fold flags of the given line (integer) </dd> @@ -1181,7 +1181,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a fold header line (boolean) </dd> @@ -1201,7 +1201,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> fold level of the given line (integer) </dd> @@ -1215,7 +1215,7 @@ the editor doesn't have the focus. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating an always visible caret line (boolean) </dd> @@ -1234,7 +1234,7 @@ flash time, then hidden for the same amount of time. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flash time of the cursor in milliseconds (integer) </dd> @@ -1255,7 +1255,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> document line number </dd> @@ -1274,7 +1274,7 @@ Public method to get the last styled position. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> end position of the last styling run (integer) </dd> @@ -1287,7 +1287,7 @@ Public method to get the eol indicator for the current eol mode. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> eol indicator (string) </dd> @@ -1300,7 +1300,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> @@ -1313,7 +1313,7 @@ Public method to get the recently found target. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> found target as a tuple of starting position and target length (integer, integer) @@ -1338,7 +1338,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> end position of the indicator (integer) </dd> @@ -1362,7 +1362,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> start position of the indicator (integer) </dd> @@ -1375,7 +1375,7 @@ Public method to get the line separator for the current eol mode. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> eol string (string) </dd> @@ -1388,7 +1388,7 @@ Public method to retrieve the start and end of a rectangular selection. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple with start line and index and end line and index (tuple of four int) @@ -1402,7 +1402,7 @@ Public method to get the number of active selections. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> number of active selection (integer) </dd> @@ -1423,7 +1423,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple with start line and index and end line and index (tuple of four int) for the given selection @@ -1438,7 +1438,7 @@ selections. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of tuples with start line and index and end line and index of each active selection (list of tuples of four int) @@ -1459,7 +1459,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> start index of the sub style and their count </dd> @@ -1486,7 +1486,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> visible line number </dd> @@ -1505,7 +1505,7 @@ Public method used to retrieve the current zoom factor. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> zoom factor (integer) </dd> @@ -1535,7 +1535,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating if the indicator was found (boolean) </dd> @@ -1566,7 +1566,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating if the indicator was found (boolean) </dd> @@ -1591,7 +1591,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the existence of the indicator (boolean) </dd> @@ -1607,7 +1607,7 @@ This is an overriding method to cope with a bug in QsciScintilla. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the presence of selected text (boolean) </dd> @@ -1620,7 +1620,7 @@ Public method to check for a selection. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the presence of a selection (boolean) </dd> @@ -1640,7 +1640,7 @@ Public method to get the indentation guide view. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> indentation guide view (SC_IV_NONE, SC_IV_REAL, SC_IV_LOOKFORWARD or SC_IV_LOOKBOTH) @@ -1697,7 +1697,7 @@ Public method to return the modification status. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the modification status (boolean) </dd> @@ -1721,7 +1721,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> linenumber at position or -1, if there is no line at pos (integer, zero based) @@ -1742,7 +1742,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> position of the line end disregarding line end characters (integer) @@ -1763,7 +1763,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple of line number (integer) and index number (integer) </dd> @@ -1776,7 +1776,7 @@ Public method to get the amount of visible lines. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> amount of visible lines (integer) </dd> @@ -1853,7 +1853,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> position after the given one (integer) </dd> @@ -1874,7 +1874,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> position before the given one (integer) </dd> @@ -1898,7 +1898,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> absolute position in the editor (integer) </dd> @@ -1919,7 +1919,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> scintilla position (integer) or -1 to indicate, that the point is not near any character @@ -1962,7 +1962,7 @@ Public method to check, if the current selection is rectangular. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a rectangular selection (boolean) </dd> @@ -2337,7 +2337,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> style at the requested position or 0, if the position is negative or past the end of the document (integer) @@ -2411,7 +2411,7 @@ Module function to return the QScintilla version. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> QScintilla version (integer) </dd>