src/eric7/Documentation/Source/eric7.QScintilla.Editor.html

branch
eric7
changeset 10345
175e6f023126
parent 10307
c685f4e12916
child 10376
4146ac0fd307
diff -r 2f2e3294186d -r 175e6f023126 src/eric7/Documentation/Source/eric7.QScintilla.Editor.html
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html	Mon Nov 27 10:24:47 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html	Mon Nov 27 14:45:11 2023 +0100
@@ -5566,66 +5566,87 @@
 </dl>
 <a NAME="Editor.getWord" ID="Editor.getWord"></a>
 <h4>Editor.getWord</h4>
-<b>getWord</b>(<i>line, index, direction=0, useWordChars=True</i>)
+<b>getWord</b>(<i>line, index, direction=0, useWordChars=True, forCompletion=False</i>)
 
 <p>
         Public method to get the word at a position.
 </p>
 <dl>
 
-<dt><i>line</i></dt>
-<dd>
-number of line to look at (int)
-</dd>
-<dt><i>index</i></dt>
-<dd>
-position to look at (int)
-</dd>
-<dt><i>direction</i></dt>
+<dt><i>line</i> (int)</dt>
+<dd>
+number of line to look at
+</dd>
+<dt><i>index</i> (int)</dt>
+<dd>
+position to look at
+</dd>
+<dt><i>direction</i> (int)</dt>
 <dd>
 direction to look in (0 = whole word, 1 = left,
             2 = right)
 </dd>
-<dt><i>useWordChars</i></dt>
+<dt><i>useWordChars</i> (bool (optional))</dt>
 <dd>
 flag indicating to use the wordCharacters
-            method (boolean)
+            method (defaults to True)
+</dd>
+<dt><i>forCompletion</i> (bool (optional))</dt>
+<dd>
+flag indicating a modification for completions (defaults
+            to False)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-the word at that position (string)
+the word at that position
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Editor.getWordBoundaries" ID="Editor.getWordBoundaries"></a>
 <h4>Editor.getWordBoundaries</h4>
-<b>getWordBoundaries</b>(<i>line, index, useWordChars=True</i>)
+<b>getWordBoundaries</b>(<i>line, index, useWordChars=True, forCompletion=False</i>)
 
 <p>
         Public method to get the word boundaries at a position.
 </p>
 <dl>
 
-<dt><i>line</i></dt>
-<dd>
-number of line to look at (int)
-</dd>
-<dt><i>index</i></dt>
-<dd>
-position to look at (int)
-</dd>
-<dt><i>useWordChars</i></dt>
+<dt><i>line</i> (int)</dt>
+<dd>
+number of line to look at
+</dd>
+<dt><i>index</i> (int)</dt>
+<dd>
+position to look at
+</dd>
+<dt><i>useWordChars</i> (bool (optional))</dt>
 <dd>
 flag indicating to use the wordCharacters
-            method (boolean)
+            method (defaults to True)
+</dd>
+<dt><i>forCompletion</i> (bool (optional))</dt>
+<dd>
+flag indicating a modification for completions (defaults
+            to False)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 tuple with start and end indexes of the word at the position
-            (integer, integer)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int)
 </dd>
 </dl>
 <a NAME="Editor.getWordLeft" ID="Editor.getWordLeft"></a>

eric ide

mercurial