--- a/Documentation/Source/eric6.Plugins.PluginPipInterface.html Tue Jun 12 19:01:06 2018 +0200
+++ b/Documentation/Source/eric6.Plugins.PluginPipInterface.html Tue Jun 12 19:02:21 2018 +0200
@@ -37,9 +37,6 @@
<h3>Functions</h3>
<table>
<tr>
-<td><a href="#_findDefaultExecutables">_findDefaultExecutables</a></td>
-<td>Restricted function to determine the name and path of the executables.</td>
-</tr><tr>
<td><a href="#createPipPage">createPipPage</a></td>
<td>Module function to create the pip configuration page.</td>
</tr><tr>
@@ -49,9 +46,6 @@
<td><a href="#getConfigData">getConfigData</a></td>
<td>Module function returning data as required by the configuration dialog.</td>
</tr><tr>
-<td><a href="#getExePath">getExePath</a></td>
-<td></td>
-</tr><tr>
<td><a href="#prepareUninstall">prepareUninstall</a></td>
<td>Module function to prepare for an un-installation.</td>
</tr>
@@ -63,10 +57,10 @@
Class implementing the pip interface plug-in.
</p><h3>Signals</h3>
<dl>
-<dt>currentPipChanged(exe)</dt>
+<dt>currentEnvironmentChanged(str)</dt>
<dd>
-emitted to signal a change of the current
- pip executable
+emitted to signal a change of the
+ currently selected virtual environment
</dd>
</dl>
<h3>Derived from</h3>
@@ -94,9 +88,6 @@
<td><a href="#PipInterfacePlugin.deactivate">deactivate</a></td>
<td>Public method to deactivate this plugin.</td>
</tr><tr>
-<td><a href="#PipInterfacePlugin.getDefaultPipExecutables">getDefaultPipExecutables</a></td>
-<td>Public method to get the default list of pip executables.</td>
-</tr><tr>
<td><a href="#PipInterfacePlugin.getMenu">getMenu</a></td>
<td>Public method to get a reference to the requested menu.</td>
</tr><tr>
@@ -104,10 +95,10 @@
<td>Public method to get the names of all menus.</td>
</tr><tr>
<td><a href="#PipInterfacePlugin.getPreferences">getPreferences</a></td>
-<td>Public method to retrieve the various refactoring settings.</td>
+<td>Public method to retrieve the various pip related settings.</td>
</tr><tr>
<td><a href="#PipInterfacePlugin.setPreferences">setPreferences</a></td>
-<td>Public method to store the various refactoring settings.</td>
+<td>Public method to store the various pip related settings.</td>
</tr>
</table>
<h3>Static Methods</h3>
@@ -137,39 +128,39 @@
</p><dl>
<dt>Returns:</dt>
<dd>
-tuple of None and activation status (boolean)
+tuple of None and activation status
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (None, bool)
</dd>
</dl><a NAME="PipInterfacePlugin.deactivate" ID="PipInterfacePlugin.deactivate"></a>
<h4>PipInterfacePlugin.deactivate</h4>
<b>deactivate</b>(<i></i>)
<p>
Public method to deactivate this plugin.
-</p><a NAME="PipInterfacePlugin.getDefaultPipExecutables" ID="PipInterfacePlugin.getDefaultPipExecutables"></a>
-<h4>PipInterfacePlugin.getDefaultPipExecutables</h4>
-<b>getDefaultPipExecutables</b>(<i></i>)
-<p>
- Public method to get the default list of pip executables.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-list of pip executables (list of string)
-</dd>
-</dl><a NAME="PipInterfacePlugin.getMenu" ID="PipInterfacePlugin.getMenu"></a>
+</p><a NAME="PipInterfacePlugin.getMenu" ID="PipInterfacePlugin.getMenu"></a>
<h4>PipInterfacePlugin.getMenu</h4>
<b>getMenu</b>(<i>name</i>)
<p>
Public method to get a reference to the requested menu.
</p><dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-name of the menu (string)
+name of the menu
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-reference to the menu (QMenu) or None, if no
+reference to the menu or None, if no
menu with the given name exists
</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+QMenu or None
+</dd>
</dl><a NAME="PipInterfacePlugin.getMenuNames" ID="PipInterfacePlugin.getMenuNames"></a>
<h4>PipInterfacePlugin.getMenuNames</h4>
<b>getMenuNames</b>(<i></i>)
@@ -178,57 +169,49 @@
</p><dl>
<dt>Returns:</dt>
<dd>
-menu names (list of string)
+menu names
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl><a NAME="PipInterfacePlugin.getPreferences" ID="PipInterfacePlugin.getPreferences"></a>
<h4>PipInterfacePlugin.getPreferences</h4>
<b>getPreferences</b>(<i>key</i>)
<p>
- Public method to retrieve the various refactoring settings.
+ Public method to retrieve the various pip related settings.
</p><dl>
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
<dd>
the key of the value to get
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested refactoring setting
+the requested setting
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+any
</dd>
</dl><a NAME="PipInterfacePlugin.setPreferences" ID="PipInterfacePlugin.setPreferences"></a>
<h4>PipInterfacePlugin.setPreferences</h4>
<b>setPreferences</b>(<i>key, value</i>)
<p>
- Public method to store the various refactoring settings.
+ Public method to store the various pip related settings.
</p><dl>
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
<dd>
-the key of the setting to be set (string)
-</dd><dt><i>value</i></dt>
+the key of the setting to be set
+</dd><dt><i>value</i> (any)</dt>
<dd>
the value to be set
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
-<a NAME="_findDefaultExecutables" ID="_findDefaultExecutables"></a>
-<h2>_findDefaultExecutables</h2>
-<b>_findDefaultExecutables</b>(<i>majorVersion</i>)
-<p>
- Restricted function to determine the name and path of the executables.
-</p><dl>
-<dt><i>majorVersion</i></dt>
-<dd>
-major python version of the executables (int)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-path names of the executables (list of string)
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
<a NAME="createPipPage" ID="createPipPage"></a>
<h2>createPipPage</h2>
<b>createPipPage</b>(<i>configDlg</i>)
@@ -274,12 +257,6 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
-<a NAME="getExePath" ID="getExePath"></a>
-<h2>getExePath</h2>
-<b>getExePath</b>(<i>branch, access, versionStr</i>)
-
-<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
<a NAME="prepareUninstall" ID="prepareUninstall"></a>
<h2>prepareUninstall</h2>
<b>prepareUninstall</b>(<i></i>)
