Documentation/Source/eric6.QScintilla.Editor.html

changeset 4271
480434472ac1
parent 4134
c04c703d1ca4
child 4286
255f56eb7f05
--- a/Documentation/Source/eric6.QScintilla.Editor.html	Sat May 30 20:16:47 2015 +0200
+++ b/Documentation/Source/eric6.QScintilla.Editor.html	Sun May 31 17:30:12 2015 +0200
@@ -602,9 +602,15 @@
 <td><a href="#Editor.__updateReadOnly">__updateReadOnly</a></td>
 <td>Private method to update the readOnly information for this editor.</td>
 </tr><tr>
+<td><a href="#Editor.addCallTipHook">addCallTipHook</a></td>
+<td>Public method to set a calltip provider.</td>
+</tr><tr>
 <td><a href="#Editor.addClone">addClone</a></td>
 <td>Public method to add a clone to our list.</td>
 </tr><tr>
+<td><a href="#Editor.addCompletionListHook">addCompletionListHook</a></td>
+<td>Public method to set an auto-completion list provider.</td>
+</tr><tr>
 <td><a href="#Editor.addedToProject">addedToProject</a></td>
 <td>Public method to signal, that this editor has been added to a project.</td>
 </tr><tr>
@@ -758,12 +764,18 @@
 <td><a href="#Editor.getBreakpointLines">getBreakpointLines</a></td>
 <td>Public method to get the lines containing a breakpoint.</td>
 </tr><tr>
+<td><a href="#Editor.getCallTipHook">getCallTipHook</a></td>
+<td>Public method to get the registered calltip provider.</td>
+</tr><tr>
 <td><a href="#Editor.getChangeLines">getChangeLines</a></td>
 <td>Public method to get the lines containing a change.</td>
 </tr><tr>
 <td><a href="#Editor.getCompleter">getCompleter</a></td>
 <td>Public method to retrieve a reference to the completer object.</td>
 </tr><tr>
+<td><a href="#Editor.getCompletionListHook">getCompletionListHook</a></td>
+<td>Public method to get the registered completion list provider.</td>
+</tr><tr>
 <td><a href="#Editor.getCoverageLines">getCoverageLines</a></td>
 <td>Public method to get the lines containing a coverage marker.</td>
 </tr><tr>
@@ -1013,9 +1025,15 @@
 <td><a href="#Editor.refreshCoverageAnnotations">refreshCoverageAnnotations</a></td>
 <td>Public method to refresh the code coverage annotations.</td>
 </tr><tr>
+<td><a href="#Editor.removeCallTipHook">removeCallTipHook</a></td>
+<td>Public method to remove a previously registered calltip provider.</td>
+</tr><tr>
 <td><a href="#Editor.removeClone">removeClone</a></td>
 <td>Public method to remove a clone from our list.</td>
 </tr><tr>
+<td><a href="#Editor.removeCompletionListHook">removeCompletionListHook</a></td>
+<td>Public method to remove a previously registered completion list provider.</td>
+</tr><tr>
 <td><a href="#Editor.resizeEvent">resizeEvent</a></td>
 <td>Protected method handling resize events.</td>
 </tr><tr>
@@ -2496,6 +2514,23 @@
 True to force change, False to only update and emit
                 signal if there was an attribute change.
 </dd>
+</dl><a NAME="Editor.addCallTipHook" ID="Editor.addCallTipHook"></a>
+<h4>Editor.addCallTipHook</h4>
+<b>addCallTipHook</b>(<i>key, func</i>)
+<p>
+        Public method to set a calltip provider.
+</p><dl>
+<dt><i>key</i> (str)</dt>
+<dd>
+name of the provider
+</dd><dt><i>func</i> (function(editor, int, int) -> list of str)</dt>
+<dd>
+function providing calltips. func
+            should be a function taking a reference to the editor,
+            a position into the text and the amount of commas to the
+            left of the cursor. It should return the possible
+            calltips as a list of strings.
+</dd>
 </dl><a NAME="Editor.addClone" ID="Editor.addClone"></a>
 <h4>Editor.addClone</h4>
 <b>addClone</b>(<i>editor</i>)
@@ -2506,6 +2541,22 @@
 <dd>
 reference to the cloned editor (Editor)
 </dd>
+</dl><a NAME="Editor.addCompletionListHook" ID="Editor.addCompletionListHook"></a>
+<h4>Editor.addCompletionListHook</h4>
+<b>addCompletionListHook</b>(<i>key, func</i>)
+<p>
+        Public method to set an auto-completion list provider.
+</p><dl>
+<dt><i>key</i> (str)</dt>
+<dd>
+name of the provider
+</dd><dt><i>func</i> (function(editor, bool) -> list of str)</dt>
+<dd>
+function providing completion list. func
+            should be a function taking a reference to the editor and
+            a boolean indicating to complete a context. It should return
+            the possible completions as a list of strings.
+</dd>
 </dl><a NAME="Editor.addedToProject" ID="Editor.addedToProject"></a>
 <h4>Editor.addedToProject</h4>
 <b>addedToProject</b>(<i></i>)
@@ -2954,6 +3005,26 @@
 <dd>
 list of lines containing a breakpoint (list of integer)
 </dd>
+</dl><a NAME="Editor.getCallTipHook" ID="Editor.getCallTipHook"></a>
+<h4>Editor.getCallTipHook</h4>
+<b>getCallTipHook</b>(<i>key</i>)
+<p>
+        Public method to get the registered calltip provider.
+</p><dl>
+<dt><i>key</i> (str)</dt>
+<dd>
+name of the provider
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+function providing calltips
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+function or None
+</dd>
 </dl><a NAME="Editor.getChangeLines" ID="Editor.getChangeLines"></a>
 <h4>Editor.getChangeLines</h4>
 <b>getChangeLines</b>(<i></i>)
@@ -2974,6 +3045,26 @@
 <dd>
 the completer object (CompleterBase)
 </dd>
+</dl><a NAME="Editor.getCompletionListHook" ID="Editor.getCompletionListHook"></a>
+<h4>Editor.getCompletionListHook</h4>
+<b>getCompletionListHook</b>(<i>key</i>)
+<p>
+        Public method to get the registered completion list provider.
+</p><dl>
+<dt><i>key</i> (str)</dt>
+<dd>
+name of the provider
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+function providing completion list
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+function or None
+</dd>
 </dl><a NAME="Editor.getCoverageLines" ID="Editor.getCoverageLines"></a>
 <h4>Editor.getCoverageLines</h4>
 <b>getCoverageLines</b>(<i></i>)
@@ -3736,7 +3827,17 @@
 <b>refreshCoverageAnnotations</b>(<i></i>)
 <p>
         Public method to refresh the code coverage annotations.
-</p><a NAME="Editor.removeClone" ID="Editor.removeClone"></a>
+</p><a NAME="Editor.removeCallTipHook" ID="Editor.removeCallTipHook"></a>
+<h4>Editor.removeCallTipHook</h4>
+<b>removeCallTipHook</b>(<i>key</i>)
+<p>
+        Public method to remove a previously registered calltip provider.
+</p><dl>
+<dt><i>key</i> (str)</dt>
+<dd>
+name of the provider
+</dd>
+</dl><a NAME="Editor.removeClone" ID="Editor.removeClone"></a>
 <h4>Editor.removeClone</h4>
 <b>removeClone</b>(<i>editor</i>)
 <p>
@@ -3746,6 +3847,17 @@
 <dd>
 reference to the cloned editor (Editor)
 </dd>
+</dl><a NAME="Editor.removeCompletionListHook" ID="Editor.removeCompletionListHook"></a>
+<h4>Editor.removeCompletionListHook</h4>
+<b>removeCompletionListHook</b>(<i>key</i>)
+<p>
+        Public method to remove a previously registered completion list
+        provider.
+</p><dl>
+<dt><i>key</i> (str)</dt>
+<dd>
+name of the provider
+</dd>
 </dl><a NAME="Editor.resizeEvent" ID="Editor.resizeEvent"></a>
 <h4>Editor.resizeEvent</h4>
 <b>resizeEvent</b>(<i>evt</i>)

eric ide

mercurial