Mercurial Repositories > eric / file diff

diff: eric6/Documentation/Source/eric6.QScintilla.QsciScintillaCompat.html

eric6/Documentation/Source/eric6.QScintilla.QsciScintillaCompat.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 7998
cd41c844862f
child 8492
41629677e72d
--- a/eric6/Documentation/Source/eric6.QScintilla.QsciScintillaCompat.html	Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/eric6.QScintilla.QsciScintillaCompat.html	Mon Feb 01 10:38:16 2021 +0100
@@ -290,6 +290,10 @@
 <td>Public method to get the recently found target.</td>
 </tr>
 <tr>
+<td><a href="#QsciScintillaCompat.getGlobalCursorPosition">getGlobalCursorPosition</a></td>
+<td>Public method to determine the point of the cursor.</td>
+</tr>
+<tr>
 <td><a href="#QsciScintillaCompat.getIndicatorEndPos">getIndicatorEndPos</a></td>
 <td>Public method to get the end position of an indicator at a position.</td>
 </tr>
@@ -318,6 +322,10 @@
 <td>Public method to get the start and end coordinates of all active selections.</td>
 </tr>
 <tr>
+<td><a href="#QsciScintillaCompat.getSubStyleRange">getSubStyleRange</a></td>
+<td>Public method to get the sub style range for given style number.</td>
+</tr>
+<tr>
 <td><a href="#QsciScintillaCompat.getVisibleLineFromDocLine">getVisibleLineFromDocLine</a></td>
 <td>Public method to convert a document line number to a visible line number (i.e.</td>
 </tr>
@@ -586,7 +594,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>
@@ -638,7 +646,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 encoded string (bytes)
 </dd>
@@ -680,7 +688,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)
@@ -695,7 +703,7 @@
         clipboard contains some text).
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the availability of 'paste'
 </dd>
@@ -722,7 +730,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)
@@ -826,7 +834,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>
@@ -839,7 +847,7 @@
         Public method to get the current position.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 absolute position of the cursor (integer)
 </dd>
@@ -852,7 +860,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>
@@ -914,7 +922,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 eol string (string)
 </dd>
@@ -952,7 +960,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 result of the event handling (boolean)
 </dd>
@@ -1057,7 +1065,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a successful search
 </dd>
@@ -1076,7 +1084,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>
@@ -1136,7 +1144,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the fold expansion state of the line (boolean)
 </dd>
@@ -1156,7 +1164,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 fold flags of the given line (integer)
 </dd>
@@ -1177,7 +1185,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating a fold header line (boolean)
 </dd>
@@ -1197,7 +1205,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 fold level of the given line (integer)
 </dd>
@@ -1211,7 +1219,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>
@@ -1230,7 +1238,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>
@@ -1251,7 +1259,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 document line number
 </dd>
@@ -1270,7 +1278,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>
@@ -1283,7 +1291,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>
@@ -1296,7 +1304,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>
@@ -1309,12 +1317,31 @@
         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)
 </dd>
 </dl>
+<a NAME="QsciScintillaCompat.getGlobalCursorPosition" ID="QsciScintillaCompat.getGlobalCursorPosition"></a>
+<h4>QsciScintillaCompat.getGlobalCursorPosition</h4>
+<b>getGlobalCursorPosition</b>(<i></i>)
+
+<p>
+            Public method to determine the point of the cursor.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+point of the cursor
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QPoint
+</dd>
+</dl>
 <a NAME="QsciScintillaCompat.getIndicatorEndPos" ID="QsciScintillaCompat.getIndicatorEndPos"></a>
 <h4>QsciScintillaCompat.getIndicatorEndPos</h4>
 <b>getIndicatorEndPos</b>(<i>indicator, pos</i>)
@@ -1334,7 +1361,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 end position of the indicator (integer)
 </dd>
@@ -1358,7 +1385,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 start position of the indicator (integer)
 </dd>
@@ -1371,7 +1398,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>
@@ -1384,7 +1411,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)
@@ -1398,7 +1425,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>
@@ -1419,7 +1446,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
@@ -1434,12 +1461,38 @@
         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)
 </dd>
 </dl>
+<a NAME="QsciScintillaCompat.getSubStyleRange" ID="QsciScintillaCompat.getSubStyleRange"></a>
+<h4>QsciScintillaCompat.getSubStyleRange</h4>
+<b>getSubStyleRange</b>(<i>styleNr</i>)
+
+<p>
+        Public method to get the sub style range for given style number.
+</p>
+<dl>
+
+<dt><i>styleNr</i> (int)</dt>
+<dd>
+Number of the base style
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+start index of the sub style and their count
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int, int
+</dd>
+</dl>
 <a NAME="QsciScintillaCompat.getVisibleLineFromDocLine" ID="QsciScintillaCompat.getVisibleLineFromDocLine"></a>
 <h4>QsciScintillaCompat.getVisibleLineFromDocLine</h4>
 <b>getVisibleLineFromDocLine</b>(<i>docLine</i>)
@@ -1456,7 +1509,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 visible line number
 </dd>
@@ -1475,7 +1528,7 @@
         Public method used to retrieve the current zoom factor.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 zoom factor (integer)
 </dd>
@@ -1505,7 +1558,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating if the indicator was found (boolean)
 </dd>
@@ -1536,7 +1589,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating if the indicator was found (boolean)
 </dd>
@@ -1561,7 +1614,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the existence of the indicator (boolean)
 </dd>
@@ -1577,7 +1630,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>
@@ -1590,7 +1643,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>
@@ -1610,7 +1663,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)
@@ -1667,7 +1720,7 @@
         Public method to return the modification status.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the modification status (boolean)
 </dd>
@@ -1691,7 +1744,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)
@@ -1712,7 +1765,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 position of the line end disregarding line end characters
             (integer)
@@ -1733,7 +1786,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple of line number (integer) and index number (integer)
 </dd>
@@ -1746,7 +1799,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>
@@ -1823,7 +1876,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 position after the given one (integer)
 </dd>
@@ -1844,7 +1897,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 position before the given one (integer)
 </dd>
@@ -1868,7 +1921,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 absolute position in the editor (integer)
 </dd>
@@ -1889,7 +1942,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
@@ -1932,7 +1985,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>
@@ -2307,7 +2360,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)
@@ -2381,7 +2434,7 @@
     Module function to return the QScintilla version.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 QScintilla version (integer)
 </dd>

Mercurial Repository: eric

eric ide

mercurial