eric7/Documentation/Source/eric7.JediInterface.AssistantJedi.html

<!DOCTYPE html>
<html><head>
<title>eric7.JediInterface.AssistantJedi</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.JediInterface.AssistantJedi</h1>

<p>
Module implementing the Jedi assistant plug-in.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#AssistantJedi">AssistantJedi</a></td>
<td>Class implementing the Jedi assistant interface.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="AssistantJedi" ID="AssistantJedi"></a>
<h2>AssistantJedi</h2>

<p>
    Class implementing the Jedi assistant interface.
</p>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#AssistantJedi.__init__">AssistantJedi</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__connectEditor">__connectEditor</a></td>
<td>Private method to connect an editor.</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__connectMouseClickHandler">__connectMouseClickHandler</a></td>
<td>Private method to connect the mouse click handler to an editor.</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__determineLanguage">__determineLanguage</a></td>
<td>Private method to determine the valid language strings.</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__disconnectEditor">__disconnectEditor</a></td>
<td>Private method to disconnect an editor.</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__disconnectMouseClickHandler">__disconnectMouseClickHandler</a></td>
<td>Private method to disconnect the mouse click handler from an editor.</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__editorClosed">__editorClosed</a></td>
<td>Private slot called, when an editor was closed.</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__editorLanguageChanged">__editorLanguageChanged</a></td>
<td>Private slot to handle the language change of an editor.</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__editorOpened">__editorOpened</a></td>
<td>Private slot called, when a new editor was opened.</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__preferencesChanged">__preferencesChanged</a></td>
<td>Private slot handling changes of the Disassembly viewer settings.</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__setAutoCompletionHook">__setAutoCompletionHook</a></td>
<td>Private method to set the autocompletion hook.</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__setCalltipsHook">__setCalltipsHook</a></td>
<td>Private method to set the calltip hook.</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__unsetAutoCompletionHook">__unsetAutoCompletionHook</a></td>
<td>Private method to unset the autocompletion hook.</td>
</tr>
<tr>
<td><a href="#AssistantJedi.__unsetCalltipsHook">__unsetCalltipsHook</a></td>
<td>Private method to unset the calltip hook.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="AssistantJedi.__init__" ID="AssistantJedi.__init__"></a>
<h4>AssistantJedi (Constructor)</h4>
<b>AssistantJedi</b>(<i>ui, viewManager, project</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>ui</i> (UserInterface)</dt>
<dd>
reference to the user interface object
</dd>
<dt><i>viewManager</i> (ViewManager)</dt>
<dd>
reference to the viewmanager object
</dd>
<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
</dl>
<a NAME="AssistantJedi.__connectEditor" ID="AssistantJedi.__connectEditor"></a>
<h4>AssistantJedi.__connectEditor</h4>
<b>__connectEditor</b>(<i>editor</i>)

<p>
        Private method to connect an editor.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
</dl>
<a NAME="AssistantJedi.__connectMouseClickHandler" ID="AssistantJedi.__connectMouseClickHandler"></a>
<h4>AssistantJedi.__connectMouseClickHandler</h4>
<b>__connectMouseClickHandler</b>(<i>editor</i>)

<p>
        Private method to connect the mouse click handler to an editor.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
</dl>
<a NAME="AssistantJedi.__determineLanguage" ID="AssistantJedi.__determineLanguage"></a>
<h4>AssistantJedi.__determineLanguage</h4>
<b>__determineLanguage</b>(<i></i>)

<p>
        Private method to determine the valid language strings.
</p>
<dl>
<dt>Return:</dt>
<dd>
list of valid language strings
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<a NAME="AssistantJedi.__disconnectEditor" ID="AssistantJedi.__disconnectEditor"></a>
<h4>AssistantJedi.__disconnectEditor</h4>
<b>__disconnectEditor</b>(<i>editor</i>)

<p>
        Private method to disconnect an editor.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
</dl>
<a NAME="AssistantJedi.__disconnectMouseClickHandler" ID="AssistantJedi.__disconnectMouseClickHandler"></a>
<h4>AssistantJedi.__disconnectMouseClickHandler</h4>
<b>__disconnectMouseClickHandler</b>(<i>editor</i>)

<p>
        Private method to disconnect the mouse click handler from an editor.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
</dl>
<a NAME="AssistantJedi.__editorClosed" ID="AssistantJedi.__editorClosed"></a>
<h4>AssistantJedi.__editorClosed</h4>
<b>__editorClosed</b>(<i>editor</i>)

<p>
        Private slot called, when an editor was closed.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
</dl>
<a NAME="AssistantJedi.__editorLanguageChanged" ID="AssistantJedi.__editorLanguageChanged"></a>
<h4>AssistantJedi.__editorLanguageChanged</h4>
<b>__editorLanguageChanged</b>(<i>language</i>)

<p>
        Private slot to handle the language change of an editor.
</p>
<dl>

<dt><i>language</i> (str)</dt>
<dd>
programming language of the editor
</dd>
</dl>
<a NAME="AssistantJedi.__editorOpened" ID="AssistantJedi.__editorOpened"></a>
<h4>AssistantJedi.__editorOpened</h4>
<b>__editorOpened</b>(<i>editor</i>)

<p>
        Private slot called, when a new editor was opened.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the new editor
</dd>
</dl>
<a NAME="AssistantJedi.__preferencesChanged" ID="AssistantJedi.__preferencesChanged"></a>
<h4>AssistantJedi.__preferencesChanged</h4>
<b>__preferencesChanged</b>(<i></i>)

<p>
        Private slot handling changes of the Disassembly viewer settings.
</p>
<a NAME="AssistantJedi.__setAutoCompletionHook" ID="AssistantJedi.__setAutoCompletionHook"></a>
<h4>AssistantJedi.__setAutoCompletionHook</h4>
<b>__setAutoCompletionHook</b>(<i>editor</i>)

<p>
        Private method to set the autocompletion hook.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
</dl>
<a NAME="AssistantJedi.__setCalltipsHook" ID="AssistantJedi.__setCalltipsHook"></a>
<h4>AssistantJedi.__setCalltipsHook</h4>
<b>__setCalltipsHook</b>(<i>editor</i>)

<p>
        Private method to set the calltip hook.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
</dl>
<a NAME="AssistantJedi.__unsetAutoCompletionHook" ID="AssistantJedi.__unsetAutoCompletionHook"></a>
<h4>AssistantJedi.__unsetAutoCompletionHook</h4>
<b>__unsetAutoCompletionHook</b>(<i>editor</i>)

<p>
        Private method to unset the autocompletion hook.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
</dl>
<a NAME="AssistantJedi.__unsetCalltipsHook" ID="AssistantJedi.__unsetCalltipsHook"></a>
<h4>AssistantJedi.__unsetCalltipsHook</h4>
<b>__unsetCalltipsHook</b>(<i>editor</i>)

<p>
        Private method to unset the calltip hook.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>