diff -r e440aaf179ce -r 64157aeb0312 src/eric7/Documentation/Source/eric7.QScintilla.QsciScintillaCompat.html
--- a/src/eric7/Documentation/Source/eric7.QScintilla.QsciScintillaCompat.html Wed Dec 20 19:28:22 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.QsciScintillaCompat.html Thu Dec 21 12:03:40 2023 +0100
@@ -563,9 +563,9 @@
</p>
<dl>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
<dd>
-parent widget (QWidget)
+parent widget
</dd>
</dl>
<a NAME="QsciScintillaCompat.__doSearchTarget" ID="QsciScintillaCompat.__doSearchTarget"></a>
@@ -578,7 +578,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a successful search (boolean)
+flag indicating a successful search
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.__modificationChanged" ID="QsciScintillaCompat.__modificationChanged"></a>
@@ -590,9 +596,9 @@
</p>
<dl>
-<dt><i>m</i></dt>
+<dt><i>m</i> (bool)</dt>
<dd>
-modification status (boolean)
+modification status
</dd>
</dl>
<a NAME="QsciScintillaCompat.__setFoldMarker" ID="QsciScintillaCompat.__setFoldMarker"></a>
@@ -604,13 +610,13 @@
</p>
<dl>
-<dt><i>marknr</i></dt>
+<dt><i>marknr</i> (int)</dt>
<dd>
-marker number to define (integer)
+marker number to define
</dd>
-<dt><i>mark</i></dt>
+<dt><i>mark</i> (int)</dt>
<dd>
-fold mark symbol to be used (integer)
+fold mark symbol to be used
</dd>
</dl>
<a NAME="QsciScintillaCompat.__userListActivated" ID="QsciScintillaCompat.__userListActivated"></a>
@@ -628,13 +634,13 @@
</p>
<dl>
-<dt><i>listId</i></dt>
+<dt><i>listId</i> (int)</dt>
<dd>
-the ID of the user list (integer)
+the ID of the user list
</dd>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
<dd>
-the selected text (string)
+the selected text
</dd>
</dl>
<a NAME="QsciScintillaCompat._encodeString" ID="QsciScintillaCompat._encodeString"></a>
@@ -646,15 +652,21 @@
</p>
<dl>
-<dt><i>string</i></dt>
+<dt><i>string</i> (str)</dt>
<dd>
-string to be encoded (str)
+string to be encoded
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-encoded string (bytes)
+encoded string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
</dd>
</dl>
<a NAME="QsciScintillaCompat.addCursor" ID="QsciScintillaCompat.addCursor"></a>
@@ -706,16 +718,22 @@
</p>
<dl>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
<dd>
-position in the text (integer)
+position in the text
</dd>
</dl>
<dl>
<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)
+ position is negative or past the end of the document
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
</dd>
</dl>
<a NAME="QsciScintillaCompat.canPaste" ID="QsciScintillaCompat.canPaste"></a>
@@ -755,16 +773,22 @@
</p>
<dl>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
<dd>
-position in the text (integer)
+position in the text
</dd>
</dl>
<dl>
<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)
+ position is negative or past the end of the document
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="QsciScintillaCompat.clearAllIndicators" ID="QsciScintillaCompat.clearAllIndicators"></a>
@@ -776,7 +800,7 @@
</p>
<dl>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
<dd>
number of the indicator (integer,
QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
@@ -798,26 +822,26 @@
</p>
<dl>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
<dd>
number of the indicator (integer,
QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd>
-<dt><i>sline</i></dt>
+<dt><i>sline</i> (int)</dt>
<dd>
-line number of the indicator start (integer)
+line number of the indicator start
</dd>
-<dt><i>sindex</i></dt>
+<dt><i>sindex</i> (int)</dt>
<dd>
-index of the indicator start (integer)
+index of the indicator start
</dd>
-<dt><i>eline</i></dt>
+<dt><i>eline</i> (int)</dt>
<dd>
-line number of the indicator end (integer)
+line number of the indicator end
</dd>
-<dt><i>eindex</i></dt>
+<dt><i>eindex</i> (int)</dt>
<dd>
-index of the indicator end (integer)
+index of the indicator end
</dd>
</dl>
<a NAME="QsciScintillaCompat.clearIndicatorRange" ID="QsciScintillaCompat.clearIndicatorRange"></a>
@@ -829,18 +853,18 @@
</p>
<dl>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
<dd>
number of the indicator (integer,
QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd>
-<dt><i>spos</i></dt>
+<dt><i>spos</i> (int)</dt>
<dd>
-position of the indicator start (integer)
+position of the indicator start
</dd>
-<dt><i>length</i></dt>
+<dt><i>length</i> (int)</dt>
<dd>
-length of the indicator (integer)
+length of the indicator
</dd>
</dl>
<a NAME="QsciScintillaCompat.clearKeys" ID="QsciScintillaCompat.clearKeys"></a>
@@ -867,7 +891,13 @@
<dl>
<dt>Return:</dt>
<dd>
-absolute position of the cursor (integer)
+absolute position of the cursor
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.currentStyle" ID="QsciScintillaCompat.currentStyle"></a>
@@ -880,7 +910,13 @@
<dl>
<dt>Return:</dt>
<dd>
-style at the current position (integer)
+style at the current position
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.delete" ID="QsciScintillaCompat.delete"></a>
@@ -934,15 +970,21 @@
</p>
<dl>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
<dd>
-text from which to determine the eol string (string)
+text from which to determine the eol string
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-eol string (string)
+eol string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="QsciScintillaCompat.editorCommand" ID="QsciScintillaCompat.editorCommand"></a>
@@ -954,9 +996,9 @@
</p>
<dl>
-<dt><i>cmd</i></dt>
+<dt><i>cmd</i> (int)</dt>
<dd>
-the scintilla command to be performed (integer)
+the scintilla command to be performed
</dd>
</dl>
<a NAME="QsciScintillaCompat.enableMultiCursorSupport" ID="QsciScintillaCompat.enableMultiCursorSupport"></a>
@@ -979,15 +1021,21 @@
</p>
<dl>
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QEvent)</dt>
<dd>
-event object to handle (QEvent)
+event object to handle
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-result of the event handling (boolean)
+result of the event handling
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.extendSelectionLeft" ID="QsciScintillaCompat.extendSelectionLeft"></a>
@@ -1078,15 +1126,15 @@
</dd>
<dt><i>ws_</i> (bool)</dt>
<dd>
-flag indicating a word start search (boolean)
+flag indicating a word start search
</dd>
<dt><i>posix</i> (bool)</dt>
<dd>
-
+flag indicating a POSIX regular expression
</dd>
<dt><i>cxx11</i> (bool)</dt>
<dd>
-
+flag indicating a CXX-11 regular expression
</dd>
</dl>
<dl>
@@ -1111,7 +1159,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a successful search (boolean)
+flag indicating a successful search
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.flashFindIndicator" ID="QsciScintillaCompat.flashFindIndicator"></a>
@@ -1123,21 +1177,21 @@
</p>
<dl>
-<dt><i>sline</i></dt>
+<dt><i>sline</i> (int)</dt>
<dd>
-line number of the indicator start (integer)
+line number of the indicator start
</dd>
-<dt><i>sindex</i></dt>
+<dt><i>sindex</i> (int)</dt>
<dd>
-index of the indicator start (integer)
+index of the indicator start
</dd>
-<dt><i>eline</i></dt>
+<dt><i>eline</i> (int)</dt>
<dd>
-line number of the indicator end (integer)
+line number of the indicator end
</dd>
-<dt><i>eindex</i></dt>
+<dt><i>eindex</i> (int)</dt>
<dd>
-index of the indicator end (integer)
+index of the indicator end
</dd>
</dl>
<a NAME="QsciScintillaCompat.focusOutEvent" ID="QsciScintillaCompat.focusOutEvent"></a>
@@ -1149,9 +1203,9 @@
</p>
<dl>
-<dt><i>event</i></dt>
+<dt><i>event</i> (QFocusEvent)</dt>
<dd>
-event object (QFocusEvent)
+event object
</dd>
</dl>
<a NAME="QsciScintillaCompat.foldExpandedAt" ID="QsciScintillaCompat.foldExpandedAt"></a>
@@ -1163,15 +1217,21 @@
</p>
<dl>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int)</dt>
<dd>
-line number (integer)
+line number
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the fold expansion state of the line (boolean)
+flag indicating the fold expansion state of the line
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.foldFlagsAt" ID="QsciScintillaCompat.foldFlagsAt"></a>
@@ -1183,15 +1243,21 @@
</p>
<dl>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int)</dt>
<dd>
-line number (integer)
+line number
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-fold flags of the given line (integer)
+fold flags of the given line
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.foldHeaderAt" ID="QsciScintillaCompat.foldHeaderAt"></a>
@@ -1204,15 +1270,21 @@
</p>
<dl>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int)</dt>
<dd>
-line number (integer)
+line number
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a fold header line (boolean)
+flag indicating a fold header line
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.foldLevelAt" ID="QsciScintillaCompat.foldLevelAt"></a>
@@ -1224,15 +1296,21 @@
</p>
<dl>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int)</dt>
<dd>
-line number (integer)
+line number
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-fold level of the given line (integer)
+fold level of the given line
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.getCaretLineAlwaysVisible" ID="QsciScintillaCompat.getCaretLineAlwaysVisible"></a>
@@ -1246,7 +1324,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating an always visible caret line (boolean)
+flag indicating an always visible caret line
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.getCursorFlashTime" ID="QsciScintillaCompat.getCursorFlashTime"></a>
@@ -1265,7 +1349,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flash time of the cursor in milliseconds (integer)
+flash time of the cursor in milliseconds
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.getDocLineFromVisibleLine" ID="QsciScintillaCompat.getDocLineFromVisibleLine"></a>
@@ -1305,7 +1395,13 @@
<dl>
<dt>Return:</dt>
<dd>
-end position of the last styling run (integer)
+end position of the last styling run
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.getEolIndicator" ID="QsciScintillaCompat.getEolIndicator"></a>
@@ -1318,7 +1414,13 @@
<dl>
<dt>Return:</dt>
<dd>
-eol indicator (string)
+eol indicator
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="QsciScintillaCompat.getFileName" ID="QsciScintillaCompat.getFileName"></a>
@@ -1331,7 +1433,13 @@
<dl>
<dt>Return:</dt>
<dd>
-filename of the displayed file (string)
+filename of the displayed file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="QsciScintillaCompat.getFoundTarget" ID="QsciScintillaCompat.getFoundTarget"></a>
@@ -1345,7 +1453,12 @@
<dt>Return:</dt>
<dd>
found target as a tuple of starting position and target length
- (integer, integer)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int)
</dd>
</dl>
<a NAME="QsciScintillaCompat.getGlobalCursorPosition" ID="QsciScintillaCompat.getGlobalCursorPosition"></a>
@@ -1409,19 +1522,25 @@
</p>
<dl>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
<dd>
-ID of the indicator (integer)
+ID of the indicator
</dd>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
<dd>
-position within the indicator (integer)
+position within the indicator
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-end position of the indicator (integer)
+end position of the indicator
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.getIndicatorRange" ID="QsciScintillaCompat.getIndicatorRange"></a>
@@ -1466,19 +1585,25 @@
</p>
<dl>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
<dd>
-ID of the indicator (integer)
+ID of the indicator
</dd>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
<dd>
-position within the indicator (integer)
+position within the indicator
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-start position of the indicator (integer)
+start position of the indicator
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.getLineSeparator" ID="QsciScintillaCompat.getLineSeparator"></a>
@@ -1491,7 +1616,13 @@
<dl>
<dt>Return:</dt>
<dd>
-eol string (string)
+eol string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="QsciScintillaCompat.getRectangularSelection" ID="QsciScintillaCompat.getRectangularSelection"></a>
@@ -1505,7 +1636,12 @@
<dt>Return:</dt>
<dd>
tuple with start line and index and end line and index
- (tuple of four int)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int, int, int)
</dd>
</dl>
<a NAME="QsciScintillaCompat.getSelectionCount" ID="QsciScintillaCompat.getSelectionCount"></a>
@@ -1518,7 +1654,13 @@
<dl>
<dt>Return:</dt>
<dd>
-number of active selection (integer)
+number of active selection
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.getSelectionN" ID="QsciScintillaCompat.getSelectionN"></a>
@@ -1531,16 +1673,22 @@
</p>
<dl>
-<dt><i>index</i></dt>
+<dt><i>index</i> (int)</dt>
<dd>
-index of the selection (integer)
+index of the selection
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-tuple with start line and index and end line and index
- (tuple of four int) for the given selection
+tuple with start line and index and end line and index for the
+ given selection
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int, int, int)
</dd>
</dl>
<a NAME="QsciScintillaCompat.getSelections" ID="QsciScintillaCompat.getSelections"></a>
@@ -1555,7 +1703,13 @@
<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)
+ of each active selection
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of [tuple of (int, int, int, int)]
</dd>
</dl>
<a NAME="QsciScintillaCompat.getSubStyleRange" ID="QsciScintillaCompat.getSubStyleRange"></a>
@@ -1621,7 +1775,13 @@
<dl>
<dt>Return:</dt>
<dd>
-zoom factor (integer)
+zoom factor
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.gotoNextIndicator" ID="QsciScintillaCompat.gotoNextIndicator"></a>
@@ -1638,20 +1798,25 @@
</p>
<dl>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
<dd>
-ID of the indicator to search (integer)
+ID of the indicator to search
</dd>
-<dt><i>wrap</i></dt>
+<dt><i>wrap</i> (bool)</dt>
<dd>
-flag indicating to wrap around at the beginning of the
- text (boolean)
+flag indicating to wrap around at the beginning of the text
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating if the indicator was found (boolean)
+flag indicating if the indicator was found
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.gotoPreviousIndicator" ID="QsciScintillaCompat.gotoPreviousIndicator"></a>
@@ -1669,20 +1834,25 @@
</p>
<dl>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
<dd>
-ID of the indicator to search (integer)
+ID of the indicator to search
</dd>
-<dt><i>wrap</i></dt>
+<dt><i>wrap</i> (bool)</dt>
<dd>
-flag indicating to wrap around at the beginning of the
- text (boolean)
+flag indicating to wrap around at the beginning of the text
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating if the indicator was found (boolean)
+flag indicating if the indicator was found
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.hasIndicator" ID="QsciScintillaCompat.hasIndicator"></a>
@@ -1694,20 +1864,26 @@
</p>
<dl>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
<dd>
number of the indicator (integer,
QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
<dd>
-position to test (integer)
+position to test
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the existence of the indicator (boolean)
+flag indicating the existence of the indicator
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.hasSelectedText" ID="QsciScintillaCompat.hasSelectedText"></a>
@@ -1723,7 +1899,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the presence of selected text (boolean)
+flag indicating the presence of selected text
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.hasSelection" ID="QsciScintillaCompat.hasSelection"></a>
@@ -1736,7 +1918,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the presence of a selection (boolean)
+flag indicating the presence of a selection
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.hideFindIndicator" ID="QsciScintillaCompat.hideFindIndicator"></a>
@@ -1760,6 +1948,12 @@
SC_IV_LOOKFORWARD or SC_IV_LOOKBOTH)
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</dl>
<a NAME="QsciScintillaCompat.indicatorDefine" ID="QsciScintillaCompat.indicatorDefine"></a>
<h4>QsciScintillaCompat.indicatorDefine</h4>
<b>indicatorDefine</b>(<i>indicator, style, color</i>)
@@ -1769,12 +1963,12 @@
</p>
<dl>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
<dd>
number of the indicator (integer,
QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd>
-<dt><i>style</i></dt>
+<dt><i>style</i> (int)</dt>
<dd>
style to be used for the indicator
(QsciScintilla.INDIC_PLAIN, QsciScintilla.INDIC_SQUIGGLE,
@@ -1791,9 +1985,9 @@
QsciScintilla.INDIC_POINT, QsciScintilla.INDIC_POINTCHARACTER
depending upon QScintilla version)
</dd>
-<dt><i>color</i></dt>
+<dt><i>color</i> (QColor)</dt>
<dd>
-color to be used by the indicator (QColor)
+color to be used by the indicator
</dd>
</dl>
<dl>
@@ -1813,7 +2007,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the modification status (boolean)
+flag indicating the modification status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.lineAt" ID="QsciScintillaCompat.lineAt"></a>
@@ -1829,16 +2029,21 @@
</p>
<dl>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int or QPoint)</dt>
<dd>
-position to calculate the line for (integer or QPoint)
+position to calculate the line for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-linenumber at position or -1, if there is no line at pos
- (integer, zero based)
+linenumber at position or -1, if there is no line at pos (zero based)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.lineEndPosition" ID="QsciScintillaCompat.lineEndPosition"></a>
@@ -1850,16 +2055,21 @@
</p>
<dl>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int)</dt>
<dd>
-line number (integer)
+line number
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
position of the line end disregarding line end characters
- (integer)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.lineIndexFromPoint" ID="QsciScintillaCompat.lineIndexFromPoint"></a>
@@ -1898,7 +2108,13 @@
<dl>
<dt>Return:</dt>
<dd>
-amount of visible lines (integer)
+amount of visible lines
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.monospacedStyles" ID="QsciScintillaCompat.monospacedStyles"></a>
@@ -1910,9 +2126,9 @@
</p>
<dl>
-<dt><i>font</i></dt>
+<dt><i>font</i> (QFont)</dt>
<dd>
-font to be used (QFont)
+font to be used
</dd>
</dl>
<a NAME="QsciScintillaCompat.moveCursorLeft" ID="QsciScintillaCompat.moveCursorLeft"></a>
@@ -1967,15 +2183,21 @@
</p>
<dl>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
<dd>
-position (integer)
+position
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-position after the given one (integer)
+position after the given one
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.positionBefore" ID="QsciScintillaCompat.positionBefore"></a>
@@ -1988,15 +2210,21 @@
</p>
<dl>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
<dd>
-position (integer)
+position
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-position before the given one (integer)
+position before the given one
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.positionFromPoint" ID="QsciScintillaCompat.positionFromPoint"></a>
@@ -2009,16 +2237,22 @@
</p>
<dl>
-<dt><i>point</i></dt>
+<dt><i>point</i> (QPoint)</dt>
<dd>
-point in the window (QPoint)
+point in the window
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-scintilla position (integer) or -1 to indicate, that the point
- is not near any character
+scintilla position or -1 to indicate, that the point is not near
+ any character
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.replaceTarget" ID="QsciScintillaCompat.replaceTarget"></a>
@@ -2030,9 +2264,9 @@
</p>
<dl>
-<dt><i>replaceStr</i></dt>
+<dt><i>replaceStr</i> (str)</dt>
<dd>
-replacement string or regexp (string)
+replacement string or regexp
</dd>
</dl>
<a NAME="QsciScintillaCompat.scrollVertical" ID="QsciScintillaCompat.scrollVertical"></a>
@@ -2044,10 +2278,10 @@
</p>
<dl>
-<dt><i>lines</i></dt>
+<dt><i>lines</i> (int)</dt>
<dd>
number of lines to scroll (negative scrolls up,
- positive scrolls down) (integer)
+ positive scrolls down)
</dd>
</dl>
<a NAME="QsciScintillaCompat.selectionIsRectangle" ID="QsciScintillaCompat.selectionIsRectangle"></a>
@@ -2060,7 +2294,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a rectangular selection (boolean)
+flag indicating a rectangular selection
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="QsciScintillaCompat.setAutoCompletionWidgetSize" ID="QsciScintillaCompat.setAutoCompletionWidgetSize"></a>
@@ -2091,10 +2331,10 @@
</p>
<dl>
-<dt><i>alwaysVisible</i></dt>
+<dt><i>alwaysVisible</i> (bool)</dt>
<dd>
flag indicating that the caret line shall be
- visible even if the editor doesn't have the focus (boolean)
+ visible even if the editor doesn't have the focus
</dd>
</dl>
<a NAME="QsciScintillaCompat.setCurrentIndicator" ID="QsciScintillaCompat.setCurrentIndicator"></a>
@@ -2106,7 +2346,7 @@
</p>
<dl>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
<dd>
number of the indicator (integer,
QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
@@ -2134,9 +2374,9 @@
</p>
<dl>
-<dt><i>time</i></dt>
+<dt><i>time</i> (int)</dt>
<dd>
-flash time of the cursor in milliseconds (integer)
+flash time of the cursor in milliseconds
</dd>
</dl>
<a NAME="QsciScintillaCompat.setEolModeByEolString" ID="QsciScintillaCompat.setEolModeByEolString"></a>
@@ -2148,9 +2388,9 @@
</p>
<dl>
-<dt><i>eolStr</i></dt>
+<dt><i>eolStr</i> (str)</dt>
<dd>
-eol string (string)
+eol string
</dd>
</dl>
<a NAME="QsciScintillaCompat.setFoldMarkersColors" ID="QsciScintillaCompat.setFoldMarkersColors"></a>
@@ -2163,13 +2403,13 @@
</p>
<dl>
-<dt><i>foreColor</i></dt>
+<dt><i>foreColor</i> (QColor)</dt>
<dd>
-foreground color (QColor)
+foreground color
</dd>
-<dt><i>backColor</i></dt>
+<dt><i>backColor</i> (QColor)</dt>
<dd>
-background color (QColor)
+background color
</dd>
</dl>
<a NAME="QsciScintillaCompat.setFolding" ID="QsciScintillaCompat.setFolding"></a>
@@ -2181,13 +2421,13 @@
</p>
<dl>
-<dt><i>style</i></dt>
+<dt><i>style</i> (int)</dt>
<dd>
-folding style to set (integer)
+folding style to set
</dd>
-<dt><i>margin</i></dt>
+<dt><i>margin</i> (int)</dt>
<dd>
-margin number (integer)
+margin number
</dd>
</dl>
<a NAME="QsciScintillaCompat.setIndentationGuideView" ID="QsciScintillaCompat.setIndentationGuideView"></a>
@@ -2199,7 +2439,7 @@
</p>
<dl>
-<dt><i>view</i></dt>
+<dt><i>view</i> (int)</dt>
<dd>
view of the indentation guides (SC_IV_NONE, SC_IV_REAL,
SC_IV_LOOKFORWARD or SC_IV_LOOKBOTH)
@@ -2214,26 +2454,26 @@
</p>
<dl>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
<dd>
number of the indicator (integer,
QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd>
-<dt><i>sline</i></dt>
+<dt><i>sline</i> (int)</dt>
<dd>
-line number of the indicator start (integer)
+line number of the indicator start
</dd>
-<dt><i>sindex</i></dt>
+<dt><i>sindex</i> (int)</dt>
<dd>
-index of the indicator start (integer)
+index of the indicator start
</dd>
-<dt><i>eline</i></dt>
+<dt><i>eline</i> (int)</dt>
<dd>
-line number of the indicator end (integer)
+line number of the indicator end
</dd>
-<dt><i>eindex</i></dt>
+<dt><i>eindex</i> (int)</dt>
<dd>
-index of the indicator end (integer)
+index of the indicator end
</dd>
</dl>
<a NAME="QsciScintillaCompat.setIndicatorRange" ID="QsciScintillaCompat.setIndicatorRange"></a>
@@ -2245,18 +2485,18 @@
</p>
<dl>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
<dd>
number of the indicator (integer,
QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX)
</dd>
-<dt><i>spos</i></dt>
+<dt><i>spos</i> (int)</dt>
<dd>
-position of the indicator start (integer)
+position of the indicator start
</dd>
-<dt><i>length</i></dt>
+<dt><i>length</i> (int)</dt>
<dd>
-length of the indicator (integer)
+length of the indicator
</dd>
</dl>
<a NAME="QsciScintillaCompat.setLexer" ID="QsciScintillaCompat.setLexer"></a>
@@ -2268,9 +2508,9 @@
</p>
<dl>
-<dt><i>lex</i></dt>
+<dt><i>lex</i> (QsciScintilla.QLexer)</dt>
<dd>
-the lexer to be set or None to reset it.
+lexer to be set or None to reset it.
</dd>
</dl>
<a NAME="QsciScintillaCompat.setModified" ID="QsciScintillaCompat.setModified"></a>
@@ -2282,9 +2522,9 @@
</p>
<dl>
-<dt><i>m</i></dt>
+<dt><i>m</i> (bool)</dt>
<dd>
-new modification status (boolean)
+new modification status
</dd>
</dl>
<a NAME="QsciScintillaCompat.setPrintColorMode" ID="QsciScintillaCompat.setPrintColorMode"></a>
@@ -2310,21 +2550,21 @@
</p>
<dl>
-<dt><i>startLine</i></dt>
+<dt><i>startLine</i> (int)</dt>
<dd>
-line number of the start of the selection (int)
+line number of the start of the selection
</dd>
-<dt><i>startIndex</i></dt>
+<dt><i>startIndex</i> (int)</dt>
<dd>
-index number of the start of the selection (int)
+index number of the start of the selection
</dd>
-<dt><i>endLine</i></dt>
+<dt><i>endLine</i> (int)</dt>
<dd>
-line number of the end of the selection (int)
+line number of the end of the selection
</dd>
-<dt><i>endIndex</i></dt>
+<dt><i>endIndex</i> (int)</dt>
<dd>
-index number of the end of the selection (int)
+index number of the end of the selection
</dd>
</dl>
<a NAME="QsciScintillaCompat.setRectangularSelectionModifier" ID="QsciScintillaCompat.setRectangularSelectionModifier"></a>
@@ -2351,13 +2591,13 @@
</p>
<dl>
-<dt><i>length</i></dt>
+<dt><i>length</i> (int)</dt>
<dd>
-length of text to style (integer)
+length of text to style
</dd>
-<dt><i>style</i></dt>
+<dt><i>style</i> (int)</dt>
<dd>
-style to set for text (integer)
+style to set for text
</dd>
</dl>
<a NAME="QsciScintillaCompat.setVirtualSpaceOptions" ID="QsciScintillaCompat.setVirtualSpaceOptions"></a>
@@ -2369,9 +2609,9 @@
</p>
<dl>
-<dt><i>options</i></dt>
+<dt><i>options</i> (int)</dt>
<dd>
-usage options to set (integer, 0 to 3)
+usage options to set (0 to 3)
</dd>
</dl>
<a NAME="QsciScintillaCompat.setWrapStartIndent" ID="QsciScintillaCompat.setWrapStartIndent"></a>
@@ -2398,21 +2638,21 @@
</p>
<dl>
-<dt><i>sline</i></dt>
+<dt><i>sline</i> (int)</dt>
<dd>
-line number of the indicator start (integer)
+line number of the indicator start
</dd>
-<dt><i>sindex</i></dt>
+<dt><i>sindex</i> (int)</dt>
<dd>
-index of the indicator start (integer)
+index of the indicator start
</dd>
-<dt><i>eline</i></dt>
+<dt><i>eline</i> (int)</dt>
<dd>
-line number of the indicator end (integer)
+line number of the indicator end
</dd>
-<dt><i>eindex</i></dt>
+<dt><i>eindex</i> (int)</dt>
<dd>
-index of the indicator end (integer)
+index of the indicator end
</dd>
</dl>
<a NAME="QsciScintillaCompat.showUserList" ID="QsciScintillaCompat.showUserList"></a>
@@ -2424,13 +2664,13 @@
</p>
<dl>
-<dt><i>listId</i></dt>
+<dt><i>listId</i> (int)</dt>
<dd>
-id of the list (integer)
+id of the list
</dd>
-<dt><i>lst</i></dt>
+<dt><i>lst</i> (list of str)</dt>
<dd>
-list to be show (list of strings)
+list to be show
</dd>
</dl>
<a NAME="QsciScintillaCompat.startStyling" ID="QsciScintillaCompat.startStyling"></a>
@@ -2442,13 +2682,13 @@
</p>
<dl>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
<dd>
-styling positition to start at (integer)
+styling positition to start at
</dd>
-<dt><i>mask</i></dt>
+<dt><i>mask</i> (int)</dt>
<dd>
-mask of bits to use for styling (integer)
+mask of bits to use for styling
</dd>
</dl>
<a NAME="QsciScintillaCompat.styleAt" ID="QsciScintillaCompat.styleAt"></a>
@@ -2460,16 +2700,22 @@
</p>
<dl>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
<dd>
-position in the text (integer)
+position in the text
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
style at the requested position or 0, if the position
- is negative or past the end of the document (integer)
+ is negative or past the end of the document
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="QsciScintillaCompat.updateUserListSize" ID="QsciScintillaCompat.updateUserListSize"></a>
@@ -2496,9 +2742,9 @@
</p>
<dl>
-<dt><i>zoom</i></dt>
+<dt><i>zoom</i> (int)</dt>
<dd>
-zoom factor increment (integer)
+zoom factor increment
</dd>
</dl>
<a NAME="QsciScintillaCompat.zoomOut" ID="QsciScintillaCompat.zoomOut"></a>
@@ -2510,9 +2756,9 @@
</p>
<dl>
-<dt><i>zoom</i></dt>
+<dt><i>zoom</i> (int)</dt>
<dd>
-zoom factor decrement (integer)
+zoom factor decrement
</dd>
</dl>
<a NAME="QsciScintillaCompat.zoomTo" ID="QsciScintillaCompat.zoomTo"></a>
@@ -2524,9 +2770,9 @@
</p>
<dl>
-<dt><i>zoom</i></dt>
+<dt><i>zoom</i> (int)</dt>
<dd>
-zoom factor (integer)
+zoom factor
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
