Mercurial Repositories > Eric Assistant / file diff

--- a/AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.Assistant.html	Sat Jul 30 10:55:32 2011 +0200
+++ b/AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.Assistant.html	Sun Sep 25 17:18:48 2011 +0200
@@ -52,6 +52,10 @@
 <table>
 <tr><td>None</td></tr>
 </table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
 <h3>Methods</h3>
 <table>
 <tr>
@@ -67,9 +71,15 @@
 <td><a href="#Assistant.__editorOpened">__editorOpened</a></td>
 <td>Private slot called, when a new editor was opened.</td>
 </tr><tr>
+<td><a href="#Assistant.__getApiCalltips">__getApiCalltips</a></td>
+<td>Private method to determine calltips from APIs.</td>
+</tr><tr>
 <td><a href="#Assistant.__getApiCompletions">__getApiCompletions</a></td>
 <td>Private method to determine a list of completions from an API object.</td>
 </tr><tr>
+<td><a href="#Assistant.__getCalltipsFromDocument">__getCalltipsFromDocument</a></td>
+<td>Private method to determine calltips from the document.</td>
+</tr><tr>
 <td><a href="#Assistant.__getCharacter">__getCharacter</a></td>
 <td>Private method to get the character to the left of the current position in the current line.</td>
 </tr><tr>
@@ -110,6 +120,10 @@
 <td>Public method to enable or disable a feature.</td>
 </tr>
 </table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
 <a NAME="Assistant.__init__" ID="Assistant.__init__"></a>
 <h4>Assistant (Constructor)</h4>
 <b>Assistant</b>(<i>plugin, parent=None</i>)
@@ -156,9 +170,39 @@
 <dd>
 reference to the new editor (QScintilla.Editor)
 </dd>
+</dl><a NAME="Assistant.__getApiCalltips" ID="Assistant.__getApiCalltips"></a>
+<h4>Assistant.__getApiCalltips</h4>
+<b>__getApiCalltips</b>(<i>api, word, commas, prefix, module, editor</i>)
+<p>
+        Private method to determine calltips from APIs.
+</p><dl>
+<dt><i>api</i></dt>
+<dd>
+reference to the API object to be used (APIsManager.DbAPIs)
+</dd><dt><i>word</i></dt>
+<dd>
+function to get calltips for (string)
+</dd><dt><i>commas</i></dt>
+<dd>
+minimum number of commas contained in the calltip (integer)
+</dd><dt><i>prefix</i></dt>
+<dd>
+prefix of the word to be completed (string)
+</dd><dt><i>module</i></dt>
+<dd>
+reference to the scanned module info (Module)
+</dd><dt><i>editor</i></dt>
+<dd>
+reference to the editor object (QScintilla.Editor)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+list of calltips (list of string)
+</dd>
 </dl><a NAME="Assistant.__getApiCompletions" ID="Assistant.__getApiCompletions"></a>
 <h4>Assistant.__getApiCompletions</h4>
-<b>__getApiCompletions</b>(<i>api, word, context</i>)
+<b>__getApiCompletions</b>(<i>api, word, context, prefix, module, editor</i>)
 <p>
         Private method to determine a list of completions from an API object.
 </p><dl>
@@ -171,12 +215,45 @@
 </dd><dt><i>context</i></dt>
 <dd>
 flag indicating to autocomplete a context (boolean)
+</dd><dt><i>prefix</i></dt>
+<dd>
+prefix of the word to be completed (string)
+</dd><dt><i>module</i></dt>
+<dd>
+reference to the scanned module info (Module)
+</dd><dt><i>editor</i></dt>
+<dd>
+reference to the editor object (QScintilla.Editor)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 list of possible completions (list of strings)
 </dd>
+</dl><a NAME="Assistant.__getCalltipsFromDocument" ID="Assistant.__getCalltipsFromDocument"></a>
+<h4>Assistant.__getCalltipsFromDocument</h4>
+<b>__getCalltipsFromDocument</b>(<i>word, prefix, module, editor</i>)
+<p>
+        Private method to determine calltips from the document.
+</p><dl>
+<dt><i>word</i></dt>
+<dd>
+function to get calltips for (string)
+</dd><dt><i>prefix</i></dt>
+<dd>
+prefix of the word to be completed (string)
+</dd><dt><i>module</i></dt>
+<dd>
+reference to the scanned module info (Module)
+</dd><dt><i>editor</i></dt>
+<dd>
+reference to the editor object (QScintilla.Editor)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+list of calltips (list of string)
+</dd>
 </dl><a NAME="Assistant.__getCharacter" ID="Assistant.__getCharacter"></a>
 <h4>Assistant.__getCharacter</h4>
 <b>__getCharacter</b>(<i>pos, editor</i>)
@@ -294,7 +371,7 @@
         Public method to perform actions upon deactivation.
 </p><a NAME="Assistant.getCompletionsFromDocument" ID="Assistant.getCompletionsFromDocument"></a>
 <h4>Assistant.getCompletionsFromDocument</h4>
-<b>getCompletionsFromDocument</b>(<i>editor, word, context, sep</i>)
+<b>getCompletionsFromDocument</b>(<i>editor, word, context, sep, prefix, module</i>)
 <p>
         Public method to determine autocompletion proposals from the document.
 </p><dl>
@@ -310,6 +387,12 @@
 </dd><dt><i>sep</i></dt>
 <dd>
 separator string (string)
+</dd><dt><i>prefix</i></dt>
+<dd>
+prefix of the word to be completed (string)
+</dd><dt><i>module</i></dt>
+<dd>
+reference to the scanned module info (Module)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>