src/eric7/Documentation/Source/eric7.Plugins.PluginEricapi.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.PluginEricapi</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.PluginEricapi</h1>
<p>
Module implementing the Ericapi plugin.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>__header__</td></tr>
<tr><td>error</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#EricapiPlugin">EricapiPlugin</a></td>
<td>Class implementing the Ericapi plugin.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr>
<td><a href="#exeDisplayData">exeDisplayData</a></td>
<td>Public method to support the display of some executable info.</td>
</tr>
</table>

<hr />
<hr />
<a NAME="EricapiPlugin" ID="EricapiPlugin"></a>
<h2>EricapiPlugin</h2>
<p>
    Class implementing the Ericapi plugin.
</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="#EricapiPlugin.__init__">EricapiPlugin</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricapiPlugin.__doEricapi">__doEricapi</a></td>
<td>Private slot to perform the eric7_api API generation.</td>
</tr>
<tr>
<td><a href="#EricapiPlugin.__ericapiProcessFinished">__ericapiProcessFinished</a></td>
<td>Private slot to perform actions after the API data was generated.</td>
</tr>
<tr>
<td><a href="#EricapiPlugin.__execDialogFinished">__execDialogFinished</a></td>
<td>Private slot to handle the execution dialog being closed.</td>
</tr>
<tr>
<td><a href="#EricapiPlugin.__initialize">__initialize</a></td>
<td>Private slot to (re)initialize the plugin.</td>
</tr>
<tr>
<td><a href="#EricapiPlugin.__projectShowMenu">__projectShowMenu</a></td>
<td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
</tr>
<tr>
<td><a href="#EricapiPlugin.activate">activate</a></td>
<td>Public method to activate this plugin.</td>
</tr>
<tr>
<td><a href="#EricapiPlugin.deactivate">deactivate</a></td>
<td>Public method to deactivate this plugin.</td>
</tr>
</table>

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


<a NAME="EricapiPlugin.__init__" ID="EricapiPlugin.__init__"></a>
<h4>EricapiPlugin (Constructor)</h4>
<b>EricapiPlugin</b>(<i>ui</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>ui</i> (UserInterface)</dt>
<dd>
reference to the user interface object
</dd>
</dl>
<a NAME="EricapiPlugin.__doEricapi" ID="EricapiPlugin.__doEricapi"></a>
<h4>EricapiPlugin.__doEricapi</h4>
<b>__doEricapi</b>(<i></i>)
<p>
        Private slot to perform the eric7_api API generation.
</p>

<a NAME="EricapiPlugin.__ericapiProcessFinished" ID="EricapiPlugin.__ericapiProcessFinished"></a>
<h4>EricapiPlugin.__ericapiProcessFinished</h4>
<b>__ericapiProcessFinished</b>(<i></i>)
<p>
        Private slot to perform actions after the API data was generated.
</p>

<a NAME="EricapiPlugin.__execDialogFinished" ID="EricapiPlugin.__execDialogFinished"></a>
<h4>EricapiPlugin.__execDialogFinished</h4>
<b>__execDialogFinished</b>(<i></i>)
<p>
        Private slot to handle the execution dialog being closed.
</p>

<a NAME="EricapiPlugin.__initialize" ID="EricapiPlugin.__initialize"></a>
<h4>EricapiPlugin.__initialize</h4>
<b>__initialize</b>(<i></i>)
<p>
        Private slot to (re)initialize the plugin.
</p>

<a NAME="EricapiPlugin.__projectShowMenu" ID="EricapiPlugin.__projectShowMenu"></a>
<h4>EricapiPlugin.__projectShowMenu</h4>
<b>__projectShowMenu</b>(<i>menuName, _menu</i>)
<p>
        Private slot called, when the the project menu or a submenu is
        about to be shown.
</p>

<dl>

<dt><i>menuName</i> (str)</dt>
<dd>
name of the menu to be shown
</dd>
<dt><i>_menu</i> (QMenu)</dt>
<dd>
reference to the menu (unused)
</dd>
</dl>
<a NAME="EricapiPlugin.activate" ID="EricapiPlugin.activate"></a>
<h4>EricapiPlugin.activate</h4>
<b>activate</b>(<i></i>)
<p>
        Public method to activate this plugin.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple of None and activation status
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="EricapiPlugin.deactivate" ID="EricapiPlugin.deactivate"></a>
<h4>EricapiPlugin.deactivate</h4>
<b>deactivate</b>(<i></i>)
<p>
        Public method to deactivate this plugin.
</p>

<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="exeDisplayData" ID="exeDisplayData"></a>
<h2>exeDisplayData</h2>
<b>exeDisplayData</b>(<i></i>)
<p>
    Public method to support the display of some executable info.
</p>

<dl>
<dt>Return:</dt>
<dd>
dictionary containing the data to query the presence of
        the executable
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>