AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.Assistant.html

changeset 140
a0ea7418d433
parent 136
5cfe53b474a9
child 163
842fce9b31ce
equal deleted inserted replaced
139:fc0bf084f32a 140:a0ea7418d433
24 Module implementing the eric assistant, an alternative autocompletion and 24 Module implementing the eric assistant, an alternative autocompletion and
25 calltips system. 25 calltips system.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>AcsAPIs</td></tr><tr><td>AcsDocument</td></tr><tr><td>AcsOther</td></tr><tr><td>AcsProject</td></tr> 29 <tr><td>AcsAPIs</td></tr><tr><td>AcsDocument</td></tr><tr><td>AcsProject</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#Assistant">Assistant</a></td> 34 <td><a href="#Assistant">Assistant</a></td>
59 <table> 59 <table>
60 <tr> 60 <tr>
61 <td><a href="#Assistant.__init__">Assistant</a></td> 61 <td><a href="#Assistant.__init__">Assistant</a></td>
62 <td>Constructor</td> 62 <td>Constructor</td>
63 </tr><tr> 63 </tr><tr>
64 <td><a href="#Assistant.__completionListSelected">__completionListSelected</a></td>
65 <td>Private slot to handle the selection from the completion list.</td>
66 </tr><tr>
67 <td><a href="#Assistant.__editorClosed">__editorClosed</a></td> 64 <td><a href="#Assistant.__editorClosed">__editorClosed</a></td>
68 <td>Private slot called, when an editor was closed.</td> 65 <td>Private slot called, when an editor was closed.</td>
69 </tr><tr> 66 </tr><tr>
70 <td><a href="#Assistant.__editorOpened">__editorOpened</a></td> 67 <td><a href="#Assistant.__editorOpened">__editorOpened</a></td>
71 <td>Private slot called, when a new editor was opened.</td> 68 <td>Private slot called, when a new editor was opened.</td>
109 <td><a href="#Assistant.__unsetCalltipsHook">__unsetCalltipsHook</a></td> 106 <td><a href="#Assistant.__unsetCalltipsHook">__unsetCalltipsHook</a></td>
110 <td>Private method to unset the calltip hook.</td> 107 <td>Private method to unset the calltip hook.</td>
111 </tr><tr> 108 </tr><tr>
112 <td><a href="#Assistant.activate">activate</a></td> 109 <td><a href="#Assistant.activate">activate</a></td>
113 <td>Public method to perform actions upon activation.</td> 110 <td>Public method to perform actions upon activation.</td>
114 </tr><tr>
115 <td><a href="#Assistant.autocomplete">autocomplete</a></td>
116 <td>Public method to determine the autocompletion proposals.</td>
117 </tr><tr> 111 </tr><tr>
118 <td><a href="#Assistant.calltips">calltips</a></td> 112 <td><a href="#Assistant.calltips">calltips</a></td>
119 <td>Public method to return a list of calltips.</td> 113 <td>Public method to return a list of calltips.</td>
120 </tr><tr> 114 </tr><tr>
121 <td><a href="#Assistant.deactivate">deactivate</a></td> 115 <td><a href="#Assistant.deactivate">deactivate</a></td>
142 <dd> 136 <dd>
143 reference to the plugin object 137 reference to the plugin object
144 </dd><dt><i>parent</i></dt> 138 </dd><dt><i>parent</i></dt>
145 <dd> 139 <dd>
146 parent (QObject) 140 parent (QObject)
147 </dd>
148 </dl><a NAME="Assistant.__completionListSelected" ID="Assistant.__completionListSelected"></a>
149 <h4>Assistant.__completionListSelected</h4>
150 <b>__completionListSelected</b>(<i>userListId, txt</i>)
151 <p>
152 Private slot to handle the selection from the completion list.
153 </p><dl>
154 <dt><i>userListId</i></dt>
155 <dd>
156 the ID of the user list (should be 1) (integer)
157 </dd><dt><i>txt</i></dt>
158 <dd>
159 the selected text (string)
160 </dd> 141 </dd>
161 </dl><a NAME="Assistant.__editorClosed" ID="Assistant.__editorClosed"></a> 142 </dl><a NAME="Assistant.__editorClosed" ID="Assistant.__editorClosed"></a>
162 <h4>Assistant.__editorClosed</h4> 143 <h4>Assistant.__editorClosed</h4>
163 <b>__editorClosed</b>(<i>editor</i>) 144 <b>__editorClosed</b>(<i>editor</i>)
164 <p> 145 <p>
429 </dl><a NAME="Assistant.activate" ID="Assistant.activate"></a> 410 </dl><a NAME="Assistant.activate" ID="Assistant.activate"></a>
430 <h4>Assistant.activate</h4> 411 <h4>Assistant.activate</h4>
431 <b>activate</b>(<i></i>) 412 <b>activate</b>(<i></i>)
432 <p> 413 <p>
433 Public method to perform actions upon activation. 414 Public method to perform actions upon activation.
434 </p><a NAME="Assistant.autocomplete" ID="Assistant.autocomplete"></a> 415 </p><a NAME="Assistant.calltips" ID="Assistant.calltips"></a>
435 <h4>Assistant.autocomplete</h4>
436 <b>autocomplete</b>(<i>editor, context</i>)
437 <p>
438 Public method to determine the autocompletion proposals.
439 </p><dl>
440 <dt><i>editor</i></dt>
441 <dd>
442 reference to the editor object, that called this method
443 (QScintilla.Editor)
444 </dd><dt><i>context</i></dt>
445 <dd>
446 flag indicating to autocomplete a context (boolean)
447 </dd>
448 </dl><a NAME="Assistant.calltips" ID="Assistant.calltips"></a>
449 <h4>Assistant.calltips</h4> 416 <h4>Assistant.calltips</h4>
450 <b>calltips</b>(<i>editor, pos, commas</i>) 417 <b>calltips</b>(<i>editor, pos, commas</i>)
451 <p> 418 <p>
452 Public method to return a list of calltips. 419 Public method to return a list of calltips.
453 </p><dl> 420 </p><dl>

eric ide

mercurial